Skip to main content
POST
Extract Data (Synchronous)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data
file
file
required

The document file (JPEG, PNG, WEBP, PDF). Max 10MB.

documentType
string
required

Slug of the template to use (e.g. 'cni-senegal') or 'auto'.

fileBack
file

Optional back side of the document.

fraudCheck
boolean
default:false
returnConfidence
boolean
default:false
returnRawText
boolean
default:false

Response

200 - application/json

Successful extraction

referenceId
string
status
enum<string>
Available options:
completed,
failed
documentType
string
result
object
creditsUsed
number