SESSIONS
Read session status
GET
/v1/sessions/{sessionId}Returns the current state and requested verification claims for a session. A successful HTTP response means the status was read, not that verification succeeded; inspect the status field.
Backend integrationYour backend and SDK use a tenant API key.Try it: Console sign-in · selected tenant · Test only · no API key.
Parameters
| Name | Location | Required | Schema | Description |
|---|---|---|---|---|
sessionId | path | Yes | string | Session ID |
Responses
Response 200
Current verification session status
application/json · Response schema
session_idstringrequiredstatusstringrequired- Allowed values
CREATEDPENDINGVERIFYINGVERIFIEDFAILEDEXPIRED livemodebooleanrequiredWhether this session targets live data. False means sandbox/test data.
expires_atstring · date-timeoptionalclaimsobjectoptionalreasonstringoptionalfailure_categorystringoptionalPII-free allow-listed verifier failure category, present only for failed sessions when classified.
Allowed valuesREQUEST_SETUP_REJECTEDWALLET_REJECTED_PRESENTATIONREQUEST_BINDING_INVALIDPRESENTATION_MALFORMEDREQUIRED_DISCLOSURE_MISSINGCREDENTIAL_CLAIM_INVALIDISSUER_TRUST_INVALIDCREDENTIAL_SIGNATURE_INVALIDCREDENTIAL_VALIDITY_INVALIDCREDENTIAL_REVOKEDSIGNING_CERTIFICATE_REVOKEDREVOCATION_STATUS_UNAVAILABLEMDOC_ISSUER_AUTH_INVALIDMDOC_DEVICE_AUTH_INVALIDZKP_VERIFIER_UNAVAILABLESCA_POLICY_NOT_METSCA_AUTHENTICATION_CODE_REUSEDVERIFICATION_UNCLASSIFIEDverification_detailsobjectoptional
View JSON schema
{
"type": "object",
"required": [
"session_id",
"status",
"livemode"
],
"properties": {
"session_id": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"CREATED",
"PENDING",
"VERIFYING",
"VERIFIED",
"FAILED",
"EXPIRED"
]
},
"livemode": {
"type": "boolean",
"description": "Whether this session targets live data. False means sandbox/test data."
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"claims": {
"type": "object"
},
"reason": {
"type": "string"
},
"failure_category": {
"type": "string",
"enum": [
"REQUEST_SETUP_REJECTED",
"WALLET_REJECTED_PRESENTATION",
"REQUEST_BINDING_INVALID",
"PRESENTATION_MALFORMED",
"REQUIRED_DISCLOSURE_MISSING",
"CREDENTIAL_CLAIM_INVALID",
"ISSUER_TRUST_INVALID",
"CREDENTIAL_SIGNATURE_INVALID",
"CREDENTIAL_VALIDITY_INVALID",
"CREDENTIAL_REVOKED",
"SIGNING_CERTIFICATE_REVOKED",
"REVOCATION_STATUS_UNAVAILABLE",
"MDOC_ISSUER_AUTH_INVALID",
"MDOC_DEVICE_AUTH_INVALID",
"ZKP_VERIFIER_UNAVAILABLE",
"SCA_POLICY_NOT_MET",
"SCA_AUTHENTICATION_CODE_REUSED",
"VERIFICATION_UNCLASSIFIED"
],
"description": "PII-free allow-listed verifier failure category, present only for failed sessions when classified."
},
"verification_details": {
"type": "object"
}
}
}Response 401
Error response
application/json · Response schema
errorstringrequiredmessagestringrequired
View JSON schema
{
"type": "object",
"required": [
"error",
"message"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
}
}Response 403
Error response
application/json · Response schema
errorstringrequiredmessagestringrequired
View JSON schema
{
"type": "object",
"required": [
"error",
"message"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
}
}Response 404
Error response
application/json · Response schema
errorstringrequiredmessagestringrequired
View JSON schema
{
"type": "object",
"required": [
"error",
"message"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
}
}Response 429
Error response
application/json · Response schema
errorstringrequiredmessagestringrequired
View JSON schema
{
"type": "object",
"required": [
"error",
"message"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
}
}