Check verification status

Look up whether a verification has been completed. Supply either the short-lived token from the redirect callback, or the external_id you used when creating the verification.

Tokens expire after 15 minutes. After expiry, use external_id instead.

POST /v2/verification/status

Check verification status

cURL

curl --request POST \
  --url https://api.connect.verifyyou.com/v2/verification/status \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "token": "vt:a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "external_id": "user_123"
}
'

200

{
  "verification_complete": true,
  "external_id": "user_123"
}

Authorizations

API-KEY · string · header · required

Your VerifyYou API key.

Body

application/json

Provide either token or external_id (at least one is required).

token · string

Short-lived token from the vy_token redirect query parameter. Expires after 15 minutes.

Example:

"vt:a1b2c3d4-e5f6-7890-abcd-ef1234567890"

external_id · string

The external_id used when creating the verification. Use this for lookups after the token expires.

Example:

"user_123"

Response

200

application/json

Status retrieved successfully.

verification_complete · boolean

true if the user passed the liveness check.

external_id · string

The external_id associated with this verification.

Example:

"user_123"