Confirm a verification token

curl --request GET \
  --url https://api.example.com/v3/confirmations/{token} \
  --header 'Authorization: Bearer <token>'

{
  "verified": true,
  "external_id": "<string>",
  "verification": {
    "external_id": "<string>",
    "external_tenant_id": "<string>"
  }
}

GET

confirmations

{token}

Confirm a verification token

curl --request GET \
  --url https://api.example.com/v3/confirmations/{token} \
  --header 'Authorization: Bearer <token>'

{
  "verified": true,
  "external_id": "<string>",
  "verification": {
    "external_id": "<string>",
    "external_tenant_id": "<string>"
  }
}

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

token

string

required

The vyt confirmation token the user returned with after verifying.

Successful Response

verified

boolean

required

Authoritative result: true only if the verification passed and the confirmation is unlocked. Gate access on this, not on the client-side vyc hint.

external_id

string | null

required

The external_id attached to the session at initialize, if any.

verification

VerificationRef · object

required

Show child attributes

⌘I