Proof of Address

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.

cURL

curl -X POST https://api.origoid.com/mex/documents/v1/proof-of-address-extractions \
  -H "x-api-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{"file": "<base64 file (PDF, JPG or PNG)>"}'

const response = await fetch("https://api.origoid.com/mex/documents/v1/proof-of-address-extractions", {
  method: "POST",
  headers: {
    "x-api-key": process.env.ORIGOID_API_KEY,
    "content-type": "application/json",
  },
  body: JSON.stringify({
    "file": "<base64 file (PDF, JPG or PNG)>"
  }),
});

if (!response.ok) {
  throw new Error(`HTTP ${response.status}`);
}

const result = await response.json();
console.log(result);

import os
import requests

response = requests.post(
    "https://api.origoid.com/mex/documents/v1/proof-of-address-extractions",
    headers={
        "x-api-key": os.environ["ORIGOID_API_KEY"],
        "content-type": "application/json",
    },
    json={
        "file": "<base64 file (PDF, JPG or PNG)>"
    },
    timeout=30,
)
response.raise_for_status()
result = response.json()
print(result)

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.time.Duration;

public class Example {
    public static void main(String[] args) throws Exception {
        String payload = "{\"file\": \"<base64 file (PDF, JPG or PNG)>\"}";

        HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(10))
            .build();

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.origoid.com/mex/documents/v1/proof-of-address-extractions"))
            .header("x-api-key", System.getenv("ORIGOID_API_KEY"))
            .header("content-type", "application/json")
            .timeout(Duration.ofSeconds(30))
            .POST(HttpRequest.BodyPublishers.ofString(payload))
            .build();

        HttpResponse<String> response = client.send(
            request, HttpResponse.BodyHandlers.ofString()
        );

        System.out.println(response.statusCode());
        System.out.println(response.body());
    }
}

<?php
$payload = '{"file": "<base64 file (PDF, JPG or PNG)>"}';

$ch = curl_init('https://api.origoid.com/mex/documents/v1/proof-of-address-extractions');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => $payload,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTPHEADER => [
        'x-api-key: ' . getenv('ORIGOID_API_KEY'),
        'content-type: application/json',
    ],
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($status >= 400) {
    throw new Exception("HTTP $status");
}

$result = json_decode($response, true);
print_r($result);

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"log"
	"net/http"
	"os"
	"time"
)

func main() {
	payload := []byte(`{"file": "<base64 file (PDF, JPG or PNG)>"}`)
	req, err := http.NewRequest("POST", "https://api.origoid.com/mex/documents/v1/proof-of-address-extractions", bytes.NewBuffer(payload))
	if err != nil { log.Fatal(err) }
	req.Header.Set("x-api-key", os.Getenv("ORIGOID_API_KEY"))
	req.Header.Set("content-type", "application/json")

	client := &http.Client{Timeout: 30 * time.Second}
	resp, err := client.Do(req)
	if err != nil { log.Fatal(err) }
	defer resp.Body.Close()

	var result map[string]any
	if err := json.NewDecoder(resp.Body).Decode(&result); err != nil {
		log.Fatal(err)
	}
	fmt.Println(result)
}

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
        client.DefaultRequestHeaders.Add("x-api-key",
            Environment.GetEnvironmentVariable("ORIGOID_API_KEY"));

        var payload = "{\"file\": \"<base64 file (PDF, JPG or PNG)>\"}";
        var content = new StringContent(payload, Encoding.UTF8, "application/json");

        var response = await client.PostAsync("https://api.origoid.com/mex/documents/v1/proof-of-address-extractions", content);
        response.EnsureSuccessStatusCode();

        var body = await response.Content.ReadAsStringAsync();
        Console.WriteLine(body);
    }
}

{
  "status": "OK",
  "type": "SUCCESS",
  "message": "Proof of address processed successfully",
  "data": {
    "documentType": "PROOF_OF_ADDRESS",
    "provider": "CFE",
    "personalInfo": {
      "fullName": "CARLOS MENDOZA RUIZ",
      "phoneNumber": null
    },
    "address": {
      "street": "CALLE DE LOS PINOS 45 INT 3",
      "neighborhood": "JARDINES DEL VALLE",
      "city": "ZAPOPAN",
      "state": "JAL",
      "zipCode": "45138",
      "reference": "ENTRE ROBLES Y CEDROS",
      "fullAddressRaw": "CALLE DE LOS PINOS 45 INT 3 JARDINES DEL VALLE C.P. 45138 ZAPOPAN , JAL ."
    },
    "billing": {
      "accountNumber": "847291038472",
      "amountDue": {
        "amount": "452.50",
        "currency": "MXN"
      },
      "dueDate": "2023-11-20",
      "paymentCode": "01847291038472311200000004525"
    },
    "validations": {
      "isRecent": false,
      "monthsOld": 28
    }
  },
  "transactionId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "processedAt": "2026-03-15T12:30:00-06:00",
  "billable": true
}

Authorizations

x-api-key

string

header

required

Body

application/json

file

string

required

Proof of Address file in Base64 (PNG, JPG, or PDF).

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 | null

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.

Show child attributes

cURL

curl -X POST https://api.origoid.com/mex/documents/v1/proof-of-address-extractions \
  -H "x-api-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{"file": "<base64 file (PDF, JPG or PNG)>"}'

const response = await fetch("https://api.origoid.com/mex/documents/v1/proof-of-address-extractions", {
  method: "POST",
  headers: {
    "x-api-key": process.env.ORIGOID_API_KEY,
    "content-type": "application/json",
  },
  body: JSON.stringify({
    "file": "<base64 file (PDF, JPG or PNG)>"
  }),
});

if (!response.ok) {
  throw new Error(`HTTP ${response.status}`);
}

const result = await response.json();
console.log(result);

import os
import requests

response = requests.post(
    "https://api.origoid.com/mex/documents/v1/proof-of-address-extractions",
    headers={
        "x-api-key": os.environ["ORIGOID_API_KEY"],
        "content-type": "application/json",
    },
    json={
        "file": "<base64 file (PDF, JPG or PNG)>"
    },
    timeout=30,
)
response.raise_for_status()
result = response.json()
print(result)

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.time.Duration;

public class Example {
    public static void main(String[] args) throws Exception {
        String payload = "{\"file\": \"<base64 file (PDF, JPG or PNG)>\"}";

        HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(10))
            .build();

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.origoid.com/mex/documents/v1/proof-of-address-extractions"))
            .header("x-api-key", System.getenv("ORIGOID_API_KEY"))
            .header("content-type", "application/json")
            .timeout(Duration.ofSeconds(30))
            .POST(HttpRequest.BodyPublishers.ofString(payload))
            .build();

        HttpResponse<String> response = client.send(
            request, HttpResponse.BodyHandlers.ofString()
        );

        System.out.println(response.statusCode());
        System.out.println(response.body());
    }
}

<?php
$payload = '{"file": "<base64 file (PDF, JPG or PNG)>"}';

$ch = curl_init('https://api.origoid.com/mex/documents/v1/proof-of-address-extractions');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => $payload,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTPHEADER => [
        'x-api-key: ' . getenv('ORIGOID_API_KEY'),
        'content-type: application/json',
    ],
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($status >= 400) {
    throw new Exception("HTTP $status");
}

$result = json_decode($response, true);
print_r($result);

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"log"
	"net/http"
	"os"
	"time"
)

func main() {
	payload := []byte(`{"file": "<base64 file (PDF, JPG or PNG)>"}`)
	req, err := http.NewRequest("POST", "https://api.origoid.com/mex/documents/v1/proof-of-address-extractions", bytes.NewBuffer(payload))
	if err != nil { log.Fatal(err) }
	req.Header.Set("x-api-key", os.Getenv("ORIGOID_API_KEY"))
	req.Header.Set("content-type", "application/json")

	client := &http.Client{Timeout: 30 * time.Second}
	resp, err := client.Do(req)
	if err != nil { log.Fatal(err) }
	defer resp.Body.Close()

	var result map[string]any
	if err := json.NewDecoder(resp.Body).Decode(&result); err != nil {
		log.Fatal(err)
	}
	fmt.Println(result)
}

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
        client.DefaultRequestHeaders.Add("x-api-key",
            Environment.GetEnvironmentVariable("ORIGOID_API_KEY"));

        var payload = "{\"file\": \"<base64 file (PDF, JPG or PNG)>\"}";
        var content = new StringContent(payload, Encoding.UTF8, "application/json");

        var response = await client.PostAsync("https://api.origoid.com/mex/documents/v1/proof-of-address-extractions", content);
        response.EnsureSuccessStatusCode();

        var body = await response.Content.ReadAsStringAsync();
        Console.WriteLine(body);
    }
}

{
  "status": "OK",
  "type": "SUCCESS",
  "message": "Proof of address processed successfully",
  "data": {
    "documentType": "PROOF_OF_ADDRESS",
    "provider": "CFE",
    "personalInfo": {
      "fullName": "CARLOS MENDOZA RUIZ",
      "phoneNumber": null
    },
    "address": {
      "street": "CALLE DE LOS PINOS 45 INT 3",
      "neighborhood": "JARDINES DEL VALLE",
      "city": "ZAPOPAN",
      "state": "JAL",
      "zipCode": "45138",
      "reference": "ENTRE ROBLES Y CEDROS",
      "fullAddressRaw": "CALLE DE LOS PINOS 45 INT 3 JARDINES DEL VALLE C.P. 45138 ZAPOPAN , JAL ."
    },
    "billing": {
      "accountNumber": "847291038472",
      "amountDue": {
        "amount": "452.50",
        "currency": "MXN"
      },
      "dueDate": "2023-11-20",
      "paymentCode": "01847291038472311200000004525"
    },
    "validations": {
      "isRecent": false,
      "monthsOld": 28
    }
  },
  "transactionId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "processedAt": "2026-03-15T12:30:00-06:00",
  "billable": true
}

Authentication

RENAPO

Social Security

INE

Biometrics

Compliance

Email

Proof of Address

Fiscal

Banking

Universal Extraction (Proof of Address)

Authorizations

Body

Response