DKBSignDocs

API reference

GETPublic

Get public signing session

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

No Bearer token. The signer is identified by the non-guessable signer_uuid.

Before OTP: documents are hidden; title, message, counts, identity, can_sign, and features are still returned. After OTP: documents[] includes uuid, name, positions, preview_url, attachments.

When identity.required is true the identity block includes status, cleared, rescan_required, sla_minutes (30), attempts_left, and optional blocked.

Path parameters

FieldTypeDescription
signer_uuid
Required
stringPath parameter signer_uuid.

Query parameters

This endpoint has no query parameters.

Request body

This endpoint does not accept a request body.

Responses

StatusMeaning
200Public session (documents hidden until OTP)
401Missing or invalid Bearer token.

Request

curl
curl -X GET 'https://api.dkbsigns.com/api/v4/public/envelopes/550e8400-e29b-41d4-a716-446655440000'

Response 200

json
{
  "signer": {
    "uuid": "signer-uuid",
    "full_name": "Jean Dupont",
    "email": "jean@example.com",
    "status": "pending",
    "is_verified": false
  },
  "identity": {
    "required": false
  },
  "envelope": {
    "batch_id": "550e8400-e29b-41d4-a716-446655440000",
    "title": "NDA Q1",
    "signature_level": "advanced",
    "lang": "fr"
  },
  "documents": [],
  "documents_count": 1,
  "can_sign": true,
  "already_signed": false,
  "features": {
    "sms_notifications": true,
    "whatsapp_notifications": false
  }
}