DKBSignDocs

API reference

POSTPublic

Public identity document check

/api/v4/public/envelopes/{signer_uuid}/identity/document-check

Used after rescan attempts are exhausted. Same capture fields as enroll without consent.

Path parameters

FieldTypeDescription
signer_uuid
Required
stringPath parameter signer_uuid.

Query parameters

This endpoint has no query parameters.

Request body

Send as multipart/form-data.

FieldTypeDescription
document
Required
stringID image.
e.g. "example"
document_type
Required
stringcni or passport.
e.g. "passport"
selfie_frames
Required
array3–8 liveness frames.
e.g. ["example"]

Responses

StatusMeaning
200Identity cleared
401Missing or invalid Bearer token.

Request

curl
curl -X POST 'https://api.dkbsigns.com/api/v4/public/envelopes/550e8400-e29b-41d4-a716-446655440000/identity/document-check' \
  -H 'Accept: application/json' \
  -F 'document=example' \
  -F 'document_type=passport' \
  -F 'selfie_frames=example'

Response 200

json
{
  "cleared": true,
  "certificate": {
    "serial": "00:11:22",
    "expires_at": "2027-03-01"
  }
}