Workspace APIDOCUMENT VERIFICATION / STRUCTURED EXTRACTION
Extract named fields from an uploaded document with page-specific evidence and explicit review flags. Machine-readable zones are checked deterministically where applicable.
INSTRUCTIONS TO USE
Start here, then use the detailed request and response reference below.
Use a workspace API key in the Bearer header.
Send a file and a unique Idempotency-Key in a multipart POST.
Follow the returned status and result URLs; check fields, evidence, and review flags.
AUTHENTICATION
Send the API key as a Bearer token. Keep the key on your server. Your workspace must be enabled for this module.
Authorization: Bearer YOUR_AI7_API_KEYREQUEST
Send multipart/form-data with one required file. Emirates ID accepts one optional additional_file for the second side. PDF, PNG and JPEG are supported. The combined upload limit is 25 MiB; the page limit appears below.
For Trade License OCR, set X-AI7-Peppol-Check: true or select the Peppol checkbox to search UAE Directory business cards using the extracted company name. The completed result gains a separate peppol object. The lookup runs against a local UAE snapshot and reports its date; a name match is not proof of legal identity.
Every submission requires a unique Idempotency-Key header (16–128 allowed characters). Repeating the same key and exact files returns the original job without charging again. The API returns HTTP 202 while processing; poll the status and result URLs.
RESPONSE
transaction_idUUIDUnique request reference in the job and result.statusstringQueued, completed, review required, or failed.dataobjectAll documented fields. Any absent field, including a list, is Not Found; a visibly present but unreadable field is Not Readable.evidencearrayField, page, and verified verbatim OCR quote for extracted values.mrzobject or nullICAO checksums for passport or Emirates ID MRZ; integrity is distinct from authenticity.review_flagsarrayUnverified evidence, data mismatch, unreadable fields, document instructions, or failed MRZ checks.processingobjectPage count, malware gate, model versions and bounded provider-call counts.HTTP 202 accepts a job; 200 returns its completed result. HTTP 400/413/415 reject invalid files before processing, 401/403 reject unauthorized access, 422 reports a failed job, and 503 reports unavailable capacity or configuration. A review_required result needs a human check before reliance.
DATA HANDLING
Uploaded files, OCR text, structured result, and any image crops are encrypted in private cloud storage and retained for 30 days. Photo and signature crops, where available, use five-minute signed download links. The result can also be fetched with your API key during retention. The input document is treated as untrusted content, and missing information is left empty rather than invented.
LIVE TESTER
The tester submits to your KYCProbe workspace and shows the JSON result. Your API key remains in this page's memory.
{ "message": "Your JSON response will appear here." }