DKBSignDocs

API reference

POSTRequires Bearer token

Detect signature zones

/api/ai/documents/{document_id}/signature-zones

Suggested boxes for signature marks. Optional async=true.

Path parameters

FieldTypeDescription
document_id
Required
stringPath parameter document_id.

Query parameters

FieldTypeDescription
async
booleanIf true, returns 202 and a job id.
e.g. false

Request body

FieldTypeDescription
mode
stringrules_only, rules_then_vision, or vision_only.
e.g. "rules_then_vision"
provider
stringopenai or anthropic.
e.g. "openai"
force
booleanIgnore cached zones.
e.g. false

Responses

StatusMeaning
200Suggested zones
401Missing or invalid Bearer token.

Request

curl
curl -X POST 'https://api.dkbsigns.com/api/ai/documents/uuid_or_id/signature-zones?async=false' \
  -H 'Authorization: Bearer $DKBSIGN_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"mode":"rules_then_vision","provider":"openai","force":false}'

Response 200

json
{
  "document_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "zones": [
    {
      "page": 1,
      "x0": 0.1,
      "y0": 0.7,
      "x1": 0.4,
      "y1": 0.85,
      "type": "signature"
    }
  ]
}