front_base64 | string | Base64 image bytes of the ID front (or passport photo page). ONLY pass base64 you received programmatically from your platform (e.g. an injected chat attachment) — never type or reconstruct image bytes yourself. |
back_base64 | string | Base64 image bytes of the license back (optional, recommended — the barcode reads most accurately). Same rule: programmatically sourced only. |
front_mime_type | string | MIME type of front_base64 (image/jpeg, image/png, image/webp). Defaults to image/jpeg. |
back_mime_type | string | MIME type of back_base64. Defaults to image/jpeg. |
file_path | string | Local path to the ID photo (front of license, or passport photo page). Local/stdio connections only — remote connections without image data receive an upload link instead. |
back_file_path | string | Local path to the back of the license (optional, recommended). Local/stdio connections only. |
document_type | string: drivers_license · state_id · passport | ONLY pass this when the user themselves said what the document is (“here’s my license”) — otherwise omit it; the type is detected from the photo. Never ask up front. |
issuing_country | string | 2-letter ISO country that issued the document (e.g. US, AR). ONLY when the user volunteered it — otherwise omit; it is detected from the photo. Never ask up front. |