Skip to main content
POST
document.records.extract

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
file
string
required

Id of an uploaded file holding one image or PDF, up to 1 MiB, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
country
enum<string>
required

Country of the document or registry.

Available options:
IN,
PH,
ID,
MY,
AE,
VN
recordType
enum<string>
required

Fixed factual record family to read.

Available options:
vaccination,
enterprise_registration,
tax_certificate,
cheque,
vehicle_registration,
business_registration,
tax_registration,
worker_record,
work_permit,
community_record,
company_certificate,
incorporation_articles,
partnership_articles,
family_card,
business_number,
business_license,
legal_deed,
tax_card,
company_registration,
trade_license,
utility_bill
backFile
string

Id of an uploaded file holding one image or PDF, up to 1 MiB, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.