Skip to main content
POST
Check verification status

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

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"