Get by Id Proof of Address OCR

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Intro

This API retrieves a Proof of Address reading you already executed, from the id that query returned.
It is meant for reading a result again without sending the file one more time and at no additional cost.

Important Points

Path parameter

fieldtyperequiredlengthDescription
idAlphanumericYesN/AExecution identifier returned by POST /api/v2/documentos/proof_of_address.

Keep the id: it is the only handle

This service does not index the execution by any business field, so the reading cannot be looked up later by name or service number. The id returned when you execute the query is the only way to get back to it — store it on your side together with whatever record you created.

The file comes back inside the request

The detail includes the request exactly as you sent it, and that carries the whole document in base64. Expect a heavy response — as heavy as the file you uploaded — and avoid dumping it into a log or a screen. If all you need is the extracted data, read the response object and ignore request.

Successful response

The body is the same one returned by Proof of Address: the execution wrapper with the extracted data and its validations.

subfieldDescription
idExecution identifier.
createdAtDate and time the execution started.
finishedAtDate and time it finished.
durationDuration in milliseconds.
statusExecution status.
errorMessageReason, only present when the execution failed.
requestThe body that was sent, including the document in base64.
responseThe data read from the document and its validations.
{
    "id": "6939a1b2c3d4e5f600000d21",
    "createdAt": "2026-05-11T16:03:22.410Z",
    "finishedAt": "2026-05-11T16:03:27.882Z",
    "duration": 5472,
    "status": "SUCCESS",
    "request": {
        "comprobante": "JVBERi0xLjQKJeLjz9MKMy..."
    },
    "response": {
        "status": "OK",
        "tipo": "CFE",
        "codigoValidacion": "ga1644346850.852198",
        "claveMensaje": "0",
        "fecha": "2019-09-12",
        "totalPagar": "51.00",
        "numeroServicio": "574751100520",
        "nombre": "LUISA GUERRERO",
        "calle": "AV BENITO JUAREZ MZ L LT 3 14",
        "referencia": "MIGUEL HIDALGO Y FCO VILLA",
        "colonia": "DIVISION DEL NORTE . C.P. 55200",
        "ciudad": "ECATEPEC DE MORELOS , MEX .",
        "rmu": "5520075-11-07XAXX-010101001CFE",
        "rmu2": "5520075-11-07KAT-010101001CFE",
        "tarifa": "01",
        "codigoNumerico": "015747511005201909130000000512",
        "validaciones": {
            "fecha": "REVISAR",
            "numeroServicio": "OK",
            "totalPagar": "OK",
            "rmu": "OK",
            "tarifa": "OK"
        }
    }
}

Listing the possible not success responses

Not found

The id does not exist or does not belong to your account. You will not receive a body, only a 400 HTTP code.

Unauthorized

It means that the provided API is incorrect and that you are not authorized to access it. You will not receive a body, only a 401 HTTP code.

Path Params
string
required
Response
200
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!