PlaygroundVerification sessions
Retrieve a verification session
Authorization
BearerAuth AuthorizationBearer <token>
Use a secret API key as the bearer token. Keys are prefixed with
vk_test_ (test mode) or vk_live_ (live mode).
In: header
Path Parameters
id*string
The verification session ID.
Query Parameters
expand[]?array<>
Fields to expand (e.g. results).
Response Body
application/json
application/json
curl -X GET "http://localhost:3000/v1/verification_sessions/string"{
"id": "string",
"object": "verification_session",
"status": "created",
"type": "identity",
"methods": [
"string"
],
"current_method": "string",
"client_reference_id": "string",
"return_url": "string",
"cancel_url": "string",
"client_secret": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"livemode": true,
"expires_at": 0,
"completed_at": 0,
"cancelled_at": 0,
"created": 0,
"updated": 0,
"verification_path": "string",
"use_case": "string",
"age_tier": "string",
"jurisdiction": "string",
"physical_check_required": true,
"user_message": "string",
"compliance": {
"jurisdiction": "string",
"use_case": "string",
"age_tier": "string",
"mdl_acceptance_status": "full",
"mdl_legally_recognized": true,
"physical_check_required": true,
"user_message": "string",
"governing_regulator": "string",
"rule_version": "string"
},
"results": [
{
"id": "string",
"object": "verification_result",
"method": "string",
"status": "string",
"confidence": 0,
"age_estimate": 0,
"age_verified": true,
"identity_verified": true,
"provider_name": "string",
"error_code": "string",
"error_message": "string",
"processing_time_ms": 0,
"created": 0
}
],
"ip_jurisdiction": "string",
"jurisdiction_mismatch": true
}{
"error": {
"type": "invalid_request_error",
"code": "string",
"message": "string",
"param": "string",
"request_id": "string"
}
}