Capture an identity document
dochorizon_capture_identitySPENDS CREDITS: read an identity document (passport, ID card, driver's licence, visa) with the Identity model: name, date of birth, nationality, document number, expiry, MRZ, validity and fraud checks. WARNING: the result contains personal data of the people on the document; handle it accordingly. It is returned to you only; this server never stores or logs it. Uses your own Doxis AI.dp (Klippa) credits: billed per request or per page depending on the service (extra components in a configuration can add cost), at your project's price (Billing → Pricing in the platform); a new account starts with EUR 25 of free credit. Give the document as exactly one of url (public https), data_base64 (small files) or file_id (a stored file). Images up to 4096 px per side. POST /document_capturing/v1/identity.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Public https URL of the document. Klippa downloads it (must complete within 30 seconds). | |
| file_id | No | A Doxis AI.dp storage file id (from dochorizon_upload_file or a toolkit result). | |
| filename | No | A name for the file (helps content-type detection). | |
| password | No | Password of a protected PDF. Only used for this request. | |
| data_base64 | No | The document as base64 (at most about 1.5 MB of file). Prefer url or file_id for anything bigger. | |
| page_ranges | No | Pages to process, for example '1-3, 5', '2-last', 'first-last' (default: all pages; documents over 50 pages time out). | |
| content_type | No | MIME type, if it cannot be detected. | |
| configuration_slug | No | Slug of a capturing configuration made in the platform (see dochorizon_list_configurations). Optional: the model's defaults apply without it. |