Create verification

Start the verification flow for a user by creating a verification.

Provide a secretToken (makes sure no unauthorized person can access a verification's data), a redirectUrl (URL, user is redirected after authentication on Studid is complete) and a serviceName (displayed to your user on Studid for reference).

The Endpoint will respond with a verification id and URL link.
Store a reference of the verification id to the user.
Redirect the user to the provided link to let the user start the authentication process with Studid.

info

Verifications will be deleted automatically 60 minutes after creation.

tip

Look at secretToken like an API key you can choose yourself. Do not share the secretToken as others may be able to access your user's verification data with it.

Request Body — REQUIRED
secretToken string — REQUIRED Possible values: 10 ≤ length ≤ 50 The secretToken is used to access the verification status.
redirectUrl string — REQUIRED Possible values: 1 ≤ length ≤ 50 URL, user is redirected after authentication on Studid is complete.
serviceName string — REQUIRED Possible values: 1 ≤ length ≤ 50 Name of your App/Service

Responses
201 The verification has been successfully created. Schema — OPTIONAL id number — OPTIONAL Verification Id link string — OPTIONAL URL for your user to authenticate with Studid
400 The verification could not be created.
429 You have sent too many requests. Check the HTTP response headers for rate limiting details.