Proof of Address

Description

A solution for extracting data from the proof of address by means of an image of the proof of address in base 64.

HTTP method POST

info

Before proceeding, make sure you have your jwt token, if you don't, check the login documentation.

Request header parameter

NAME	REQUIRED	TYPE	DESCRIPTION
Authorization	✅	string	bearer jwt token

URI request parameter

NAME	REQUIRED	TYPE	DESCRIPTION
Document: Telephone or electricity bill	✅	string	Document issued by CFE (Federal Electricity Commission) or TELMEX: (Mexican Telephone Company).

Status code responses

Code	Description
200	OK
400	Bad request
401	Unauthorized
404	Not found
500	Internal server error.

The full documentation error codes can be found here.

Response 200 status code

{
    "QR": "http://ejemplo.com",
    "PreviousDebit": "0.00",
    "street": "123 Calle Principal",
    "city": "Ciudad, Estado",
    "Messagekey": "000",
    "Numericcode": "0123456789",
    "Validationcode": "Codigovalidación123",
    "Colony": "Vecindario",
    "cp": "12345",
    "date": "01 ENE 23",
    "PaymentDeadline": "02 ENE 23",
    "multiplier": "1",
    "name": "John Doe",
    "MeterNumber": "9876AB",
    "ServiceNumber": "1234567890",
    "InvoicedPeriod": "01 ENE 23 - 01 FEB 23",
    "Reference": "Muestra de referencia",
    "rmu": "1234501-01-01-0123456789",
    "rmu2": "1234501-01-01-0123456789",
    "status": "OK",
    "Tariff": "Tarifa de muestra",
    "Type": "Tipo de muestra",
    "totalPay": "0.00",
    "totalPay2": "0.00",
    "validations": {
        "date": "OK",
        "ServiceNumber": "OK",
        "rmu": "REVISAR",
        "tarifa": "OK",
        "totalPay": "OK"
    }
}

Response 400 status code

{
    "traceId": "542fc743fffda052",
    "timestamp": "2023-05-05 11:20:46",
    "code": "IDV-4005",
    "message": "-",
    "data": null
}

Response 401 status code

{
    "timestamp": "YYYY-MM-DDTHH:mm:ss.sssZ",
    "status": 401,
    "error": "Unauthorized",
    "path": "/api/idv-govcheck/v1/mx-identity/{curp}/check-ine"
}

Response 500 status code

{
    "traceId": "43a20f33d4e8730d",
    "timestamp": "yyyy-mm-dd HH:MM:SS",
    "code": "IDV-1001",
    "message": "A generic error has occurred.",
    "data": null
}