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.
Wallet and rate-limit checks may apply depending on the endpoint.

Endpoint

txt

POST http://identity.stg.parthiantechnology.com/api/v1/proof-of-address/extract

Endpoint

txt

POST http://identity.stg.parthiantechnology.com/api/v1/proof-of-address/extract-base64

Endpoint

txt

POST http://identity.stg.parthiantechnology.com/api/v1/proof-of-address/extract/jobs

Endpoint

txt

GET http://identity.stg.parthiantechnology.com/api/v1/proof-of-address/jobs/{request_id}

Multipart Request

bash

curl -X POST "http://identity.stg.parthiantechnology.com/api/v1/proof-of-address/extract" \
  -H "x-api-key: sk_test_your_key" \
  -F "file=@proof-address.pdf"

Base64 Request

json

{
  "file_name": "proof-address.pdf",
  "content_type": "application/pdf",
  "document_base64": "JVBERi0xLjQK..."
}

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",
    "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"
}