Session data

List the images that a verification session captured: the identity document, the selfie, the proof of address, and the face image from the liveness check. The list holds descriptions only. To download an image, call the document URL endpoint with its id. Blaaiz keeps the face image from the liveness check for 30 days. After that, the list shows it with available: false and unavailable_reason: NOT_RETAINED. 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.

GETapi-prod.blaaiz.com/api/external/compliance/kyc/sessions/{sessionId}/documents

Authorization

oauth2ClientCredentials compliance-kyc:pii:read
AuthorizationBearer <token>

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

In: header

Scope: compliance-kyc:pii:read

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

List session documents
curl --request GET \  --url 'https://example.com/api/external/compliance/kyc/sessions/9f2c7b41-6d3e-4c8a-9a20-1e6f0b5d7c33/documents'
{  "message": "Session documents retrieved successfully.",  "data": [    {      "id": "doc:901",      "kind": "DOCUMENT",      "document_type": "PASSPORT",      "document_side": "FRONT_SIDE",      "content_type": "image/jpeg",      "available": true,      "unavailable_reason": null    },    {      "id": "doc:902",      "kind": "SELFIE",      "document_type": "SELFIE",      "document_side": null,      "content_type": "image/jpeg",      "available": true,      "unavailable_reason": null    },    {      "id": "liveness:reference",      "kind": "LIVENESS_REFERENCE",      "document_type": null,      "document_side": null,      "content_type": "image/jpeg",      "available": false,      "unavailable_reason": "NOT_RETAINED"    }  ]}