Universal Extraction (Proof of Address)
Credits: 1 per call.
Performs OCR on a Mexican proof-of-address document — utility bills (water, electricity, gas, internet, telephone) and bank statements — and returns the structured data printed on it.
Returns:
provider: the issuing utility or institution (CFE, Telmex, Agua, etc.), so you can apply provider-specific business rules and recognize legitimate document layouts.personalInfo: holder name as printed on the document.address: full address as printed (street, exterior / interior number, neighborhood, municipality, state, postal code).billing: issuance date, account number, period covered.validations: flags about document age, document type detection confidence, and structural consistency checks.
Use this endpoint to automate address verification in KYC flows. The extracted address can be cross-checked against the address your customer submitted at signup.
Authorizations
Body
Proof of Address file in Base64 (PNG, JPG, or PDF).
Response
Extraction results (Strict Envelope Pattern).
High-level outcome. OK means the request was successfully processed (regardless of business result). ERROR means the request was rejected or could not be processed.
OK, ERROR Stable result type code. Includes generic codes (SUCCESS, INVALID_REQUEST, UNAUTHORIZED, SERVICE_UNAVAILABLE, INTERNAL_ERROR, RATE_LIMIT_EXCEEDED) plus endpoint-specific result codes — see this endpoint's response examples.
Human-readable summary of the result. Always in English (per Language Conventions in the API overview).
Unique identifier of this request, generated by the API Gateway. Propagated end-to-end for traceability.
ISO 8601 datetime with Mexico City offset (-06:00). Always set by the API Gateway when the response leaves the system.
Whether this request will be charged against the client's plan. Typically true for successful business results and false for validation errors or system errors that prevented processing.
Response payload. null on error responses. Shape depends on the endpoint — see each operation's response schema.
Per-field error details. Present only on INVALID_REQUEST responses.