Active

Proof of Address AI

Extract normalized proof-of-address information from uploaded files or base64 payloads.

Authentication

Send the tenant API key with `X-API-Key`.
Send `X-Environment` as `sandbox` or `live` where applicable.
Your API key must include the `ai_processing_hub` product scope.
Your tenant must have access to the product in the selected environment.

Endpoint

txt

POST https://ai-processing-hub.stg.parthiantechnology.com/api/v1/proof-of-address/extract

Endpoint

txt

POST https://ai-processing-hub.stg.parthiantechnology.com/api/v1/proof-of-address/extract-base64

Endpoint

txt

POST https://ai-processing-hub.stg.parthiantechnology.com/api/v1/proof-of-address/extract/jobs

Endpoint

txt

GET https://ai-processing-hub.stg.parthiantechnology.com/api/v1/proof-of-address/jobs/{request_id}

Multipart Request

bash

curl -X POST "https://ai-processing-hub.stg.parthiantechnology.com/api/v1/proof-of-address/extract" \
  -H "x-api-key: sk_test_your_key" \
  -F "file=@proof-address.pdf" \
  -F 'hallucination={"lga":false,"state":true,"country":true}'

Base64 Request

json

{
  "file_name": "proof-address.pdf",
  "content_type": "application/pdf",
  "base64_content": "JVBERi0xLjQK...",
  "hallucination": {
    "lga": false,
    "state": true,
    "country": true
  }
}

Controlled Geographic Inference

The optional `hallucination` object enables evidence-grounded inference for individual missing geographic fields. Every option defaults to false. Extracted values are never overwritten, inferred fields require manual review, and inferred values are not appended to the document-visible `full_address`.

Property	Default	Behavior
hallucination.lga	false	Allow the AI provider to infer a missing LGA from clear locality evidence.
hallucination.state	false	Allow a missing state to be inferred or deterministically derived from a recognized LGA.
hallucination.country	false	Allow a missing country to be inferred or deterministically derived from a recognized Nigerian state/LGA.

Response

json

{
  "request_id": "3e5c0f37-77db-4f26-8c29-5f9b4d5e1b90",
  "message": "Proof of address extracted successfully",
  "data": {
    "full_address": "12 Marina Road, Lagos Island, Lagos",
    "street": "12 Marina Road",
    "city": "Lagos Island",
    "state": "Lagos",
    "lga": "Lagos Island",
    "country": "Nigeria",
    "field_metadata": {
      "lga": { "source": "extracted", "confidence": 0.91, "evidence": ["Lagos Island"] },
      "state": { "source": "derived", "confidence": 0.99, "evidence": ["Lagos Island"] },
      "country": { "source": "derived", "confidence": 0.99, "evidence": ["Lagos"] }
    },
    "confidence": 0.91,
    "requires_review": false
  }
}

Async Job Response

json

{
  "request_id": "3e5c0f37-77db-4f26-8c29-5f9b4d5e1b90",
  "status": "queued",
  "message": "Proof of address extraction queued"
}