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.
Authorization
oauth2ClientCredentials compliance-kyc:cancelUse your OAuth client credentials to obtain a short-lived Bearer token from POST /oauth/token.
In: header
Scope: compliance-kyc:cancel
Path Parameters
The verification session id returned by the create endpoint.
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
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, "redirect_url": null, "expires_at": "2026-08-30T09:14:22.000Z", "completed_at": null, "created_at": "2026-08-29T09:14:22.000Z" }}POSTIssue a web SDK access token
Get the access token for a HOSTED session, so that the web SDK can open the verification page in a popup on your own page. Call this endpoint from your server, then send `access_token` to your page and call `signa.startSession({ accessToken })`. The token is valid for 30 minutes from when Blaaiz made it. While the current token has more than 10 minutes left, a new call returns the same token. With 10 minutes or less left, the call returns a new token, and the previous token and the previous verification link stop working. A new verification link also stops the current access token. The session must be HOSTED and AWAITING_INPUT, and its verification page must be a page that Blaaiz hosts. The request takes no body. Signa must be enabled for your business. Required scope: `compliance-kyc:create`.
GETGet session applicant data
Read the applicant data that a verification session captured: the name, the date of birth, the country, the nationality, the address, and the identity document. `data` is null when the session captured no applicant data. Webhooks never carry this data. The session must be APPROVED or REJECTED: any other status answers 409. The response carries `Cache-Control: no-store`. Signa must be enabled for your business. Required scope: `compliance-kyc:pii:read`. No scope bundle contains this scope, `full-access` included, so select it by name when you create or rotate your credentials.