Skip to main content
cURL
curl -X POST https://api.origoid.com/mex/id/v1/qr-extractions \
  -H "x-api-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{"back": "string"}'
{
  "status": "OK",
  "type": "SUCCESS",
  "message": "Document processed successfully",
  "data": {
    "documentType": "INE",
    "model": "G",
    "personalInfo": {
      "givenNames": "MARIA FERNANDA",
      "firstSurname": "LOPEZ",
      "secondSurname": "GARCIA",
      "gender": "M",
      "curp": "LOGF950312MDFPRR08"
    },
    "electoralGeography": {
      "stateCode": "09",
      "stateName": "CIUDAD DE MÉXICO",
      "municipalityCode": "014",
      "municipalityName": "IZTAPALAPA",
      "section": "1832"
    },
    "validity": {
      "issuedYear": "2020",
      "validUntilYear": "2030",
      "emissionDate": "2020-08-15",
      "emissionNumber": "1"
    },
    "security": {
      "cic": "312456789",
      "ocr": "1832054321987"
    },
    "files": [
      {
        "kind": "face",
        "contentType": "image/png",
        "sizeBytes": 20496,
        "content": "iVBORw0KGgoAAAANSUhEUgAAAGAAAACACAIAAAB7vvvt..."
      }
    ]
  },
  "transactionId": "e8cbd7dc-a528-499e-b868-5fa956f30ca9",
  "processedAt": "2026-04-26T10:00:00-06:00",
  "billable": true
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
back
string
required

Back image of the INE credential in Base64 (PNG/JPG). The QR code must be visible. Required.

Response

Extraction results (Strict Envelope Pattern).

​
status
enum<string>
required

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.

Available options:
OK,
ERROR
​
type
string
required

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.

​
message
string
required

Human-readable summary of the result. Always in English (per Language Conventions in the API overview).

​
transactionId
string<uuid>
required

Unique identifier of this request, generated by the API Gateway. Propagated end-to-end for traceability.

​
processedAt
string<date-time>
required

ISO 8601 datetime with Mexico City offset (-06:00). Always set by the API Gateway when the response leaves the system.

​
billable
boolean
required

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.

​
data
object

Response payload. null on error responses. Shape depends on the endpoint — see each operation's response schema.

​
errors
object[]

Per-field error details. Present only on INVALID_REQUEST responses.