SupportDashboard
HomeGet StartedPaymentsCryptoComplianceChangelog

Cancel a verification session

Cancel a session that you no longer need. CANCELLED is terminal: Blaaiz sends no webhook for the session after a cancel, and the verification link stops working. A cancel frees a slot under your open session cap. A cancel on a session that is already terminal is refused with 422: This session has already been cancelled. for a cancelled session, and This session has already reached a final state and cannot be cancelled. for an approved, rejected or expired one. A cancel also closes the person's verification page. The request takes no body. This endpoint stays available even when Signa is disabled for your business. Required scope: compliance-kyc:cancel.

POSTapi-prod.blaaiz.com/api/external/compliance/kyc/sessions/{sessionId}/cancel

Authorization

oauth2ClientCredentials compliance-kyc:cancel
AuthorizationBearer <token>

Use your OAuth client credentials to obtain a short-lived Bearer token from POST /oauth/token.

In: header

Scope: compliance-kyc:cancel

Path Parameters

sessionId*string

The verification session id returned by the create endpoint.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

Cancel a verification session
curl --request POST \  --url 'https://example.com/api/external/compliance/kyc/sessions/9f2c7b41-6d3e-4c8a-9a20-1e6f0b5d7c33/cancel'
{  "message": "Verification session cancelled successfully.",  "data": {    "id": "9f2c7b41-6d3e-4c8a-9a20-1e6f0b5d7c33",    "business_id": "9d4c4ec5-572d-49de-a362-f01ed09f2b1b",    "customer_reference": "user_10482",    "requirements": [      "DOCUMENTS",      "SELFIE",      "FACE_MATCH"    ],    "fulfilment_mode": "HOSTED",    "status": "CANCELLED",    "steps": {      "documents": "PENDING",      "selfie": "PENDING",      "proof_of_address": null    },    "rejection": null,    "expires_at": "2026-08-30T09:14:22.000Z",    "completed_at": null,    "created_at": "2026-08-29T09:14:22.000Z"  }}

POSTIssue a verification link

Issue a new verification link for a HOSTED session. The create response already carries the first link, so call this endpoint only to replace a link that expired or leaked. Read link_expires_at for the new deadline. The previous link may stop working as soon as Blaaiz issues a new one. The link is a live credential for one session: send it over a private channel and keep it out of your logs. The request takes no body. Blaaiz refuses the call when the session is terminal, and when the session is HEADLESS. Every HOSTED session can take a verification link, including a session with no selfie step. Signa must be enabled for your business. Required scope: `compliance-kyc:create`.