Cancel a pending verification session
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.
POST
/v1.0/verification-sessions/{id}/cancelIdempotent: cancelling an already-cancelled session returns 200 with the same state. Cancelling a session that has already reached a terminal state (verified/rejected/expired) returns 409. Scope: verification.execute.
| Operation ID | VerificationSessions_Cancel |
| Plane | Product |
| Versioning | In the path |
| Authentication | Authorization: ApiKey {key} |
| Required scope | verification.execute |
| 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. |
409 |
ErrorEnvelope |
The request conflicts with the resource state, or an idempotency key was reused with a different payload. |
429 |
ErrorEnvelope |
Throttled. See rate limits. |
Response headers: x-ms-request-id
Example
curl -X POST "https://api.example.diligence.id/v1.0/verification-sessions/YOUR_ID/cancel" \
-H "Authorization: ApiKey YOUR_API_KEY"