Read a verification session's current status and, once verified, its claim-minimised result
GENERATED — DO NOT EDIT DIRECTLY. Produced from the canonical OpenAPI specification by
developer-docs/tools/generate-reference.mjs. Edits are overwritten on the next run.
GET
/v1.0/verification-sessions/{id}Tenant-scoped: a session created under one tenant is not found (404) for a caller resolved to a different tenant. A Pending session past its expiry is lazily transitioned to Expired on read. Scope: verification.read.
| Operation ID | VerificationSessions_Get |
| Plane | Product |
| Versioning | In the path |
| Authentication | Authorization: ApiKey {key} |
| Required scope | verification.read |
| Concurrency | Not applicable |
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
string |
Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
x-ms-client-request-id |
string |
No | Optional caller-supplied correlation value, echoed back on the response and recorded in diagnostics. It never influences authentication, tenant or environment selection, resource lookup or idempotency. |
Responses
| Status | Body | Meaning |
|---|---|---|
200 |
ApiEnvelopeOfVerificationSessionResponse |
Success. |
401 |
ErrorEnvelope |
Authentication failed — the API key is missing, malformed, revoked or expired. |
403 |
ErrorEnvelope |
Authenticated, but the key does not carry the required scope. |
404 |
ErrorEnvelope |
Not visible to this caller. A resource in another tenant or environment reports as not found. |
429 |
ErrorEnvelope |
Throttled. See rate limits. |
Response headers: x-ms-request-id
Example
curl -X GET "https://api.example.diligence.id/v1.0/verification-sessions/YOUR_ID" \
-H "Authorization: ApiKey YOUR_API_KEY"