DKBSignDocs

API reference

POSTPublic

Start public identity enrollment

/api/v4/public/envelopes/{signer_uuid}/identity/enroll

Multipart. OTP must already be verified and identity must be required. document_type is cni or passport. selfie_frames[] is 3–8 images. consent must be a truthy value (true, 1, yes, on). 202 with status: pending and sla_minutes: 30. Errors include IDENTITY_LIVENESS_FAILED, IDENTITY_FACE_MISMATCH, IDENTITY_DOCUMENT_UNREADABLE, IDENTITY_CONSENT_REQUIRED, IDENTITY_BLOCKED.

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. "cni"
selfie_frames
Required
array3–8 liveness frames.
e.g. ["example"]
consent
Required
stringMust be true, 1, yes, or on.
e.g. "true"
document_number_last4
stringOptional last 4 digits (masked upstream).
e.g. "1234"

Responses

StatusMeaning
202Enrollment pending
401Missing or invalid Bearer token.

Request

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

Response 202

json
{
  "status": "pending",
  "sla_minutes": 30,
  "already_pending": false
}