Skip to main content
POST
/
v1
/
textify
/
analyzer
curl --request POST \
  --url https://textify-api.argosidentity.com/v1/textify/analyzer \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "fileExtension": "PDF",
  "docuType": "InvoiceMedical",
  "fileData": "base64-encoded-file-data"
}
'
{
  "status": "success",
  "data": {
    "patientName": "John Doe",
    "hospitalName": "City General Hospital",
    "totalAmount": 1500,
    "services": [
      {
        "service": "Consultation",
        "amount": 200
      },
      {
        "service": "Lab Test",
        "amount": 300
      }
    ]
  },
  "confidence": 0.95
}

Documentation Index

Fetch the complete documentation index at: https://developers.argosidentity.com/llms.txt

Use this file to discover all available pages before exploring further.

The Proof of Address template extracts structured data from address verification documents, utility bills, and residence certificates, including address information and verification details.

​
Template Features

Extracts the following information from address verification documents:
  • Resident information and identification
  • Document type and service provider details
  • Complete address information
  • Billing and service details
  • Document validity and verification status
  • Address verification methods and authorities

​
Usage Example

{
  "fileExtension": "pdf",
  "docuType": "ProofOfAddress",
  "fileData": "base64-encoded-proof-of-address-data"
}

​
Response Format

The template returns structured proof of address data including:

​
Resident Information

  • Resident Name: Full name of the resident
  • Document Type: Type of address verification document
  • Service Provider: Utility or service company name
  • Account Number: Service account identifier

​
Address Details

  • Street Address: Complete street address
  • City, State, ZIP: Location details
  • Country: Residence country
  • Address Type: Residential, commercial, etc.

​
Billing Information

  • Billing Period: Service period covered
  • Due Date: Payment deadline
  • Amount: Service amount
  • Service Type: Type of utility or service

​
Document Information

  • Issue Date: Date document was issued
  • Document Number: Unique document identifier
  • Valid Until: Document expiration date
  • Document Status: Active, expired, etc.

​
Verification Details

  • Verification Method: How address was verified
  • Verification Date: Date of verification
  • Verified By: Authority that verified address
  • Verification Status: Confirmed, pending, rejected

​
Sample Response

{
  "status": "success",
  "data": {
    "document": {
      "residentInfo": {
        "name": "David Thompson",
        "documentType": "Utility Bill",
        "serviceProvider": "City Electric Company",
        "accountNumber": "ACC-2024-001234"
      },
      "addressDetails": {
        "streetAddress": "789 Residential Lane",
        "city": "Suburb City",
        "state": "SC",
        "zipCode": "54321",
        "country": "United States"
      },
      "billingInfo": {
        "billingPeriod": "January 2024",
        "dueDate": "2024-02-15",
        "amount": 125.50,
        "serviceType": "Electricity"
      },
      "documentInfo": {
        "issueDate": "2024-01-15",
        "documentNumber": "DOC-2024-001",
        "validUntil": "2024-02-15"
      },
      "verificationDetails": {
        "verificationMethod": "Utility Bill",
        "verificationDate": "2024-01-20",
        "verifiedBy": "City Electric Company",
        "verificationStatus": "Confirmed"
      }
    },
    "confidence": 0.91
  }
}

​
Supported Proof of Address Types

  • Utility Bills (Electricity, Gas, Water)
  • Bank Statements
  • Credit Card Statements
  • Insurance Documents
  • Government Letters
  • Rental Agreements
  • Mortgage Statements
  • Tax Documents
  • Employment Letters
  • School Enrollment Documents

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
fileExtension
enum<string>
required

The file extension of the document to be analyzed. Must be one of the supported formats.

Available options:
PDF,
TIFF,
JPG,
PNG
​
docuType
enum<string>
required

The type of document to be analyzed. This determines the extraction model and data structure used for analysis.

Supported Document Types:

  • InvoiceMedical: Medical invoices and bills from healthcare providers, hospitals, clinics, and medical facilities. Extracts patient information, medical services, costs, and billing details.
  • BusinessRegistration: Official business registration documents, corporate certificates, and company formation papers. Extracts business name, registration number, business type, and address information.
  • InvoiceGeneral: Standard commercial invoices from businesses and service providers. Extracts invoice number, customer details, items/services, and payment information.
  • MedicalObservation: Medical reports, patient records, and clinical observation documents. Extracts patient data, medical findings, diagnosis, and treatment information.
  • Contract: Legal contracts, agreements, and binding documents between parties. Extracts contract terms, parties involved, dates, and legal obligations.
  • ArrivalNotice: Shipping and logistics arrival notifications, delivery confirmations. Extracts shipment details, arrival dates, and delivery information.
  • BillofLading: Transportation documents for cargo and freight shipments. Extracts shipping details, cargo information, and transport terms.
  • Jobapplication: Employment applications, resumes, and job-related documents. Extracts applicant information, qualifications, and employment history.
  • BalanceCertificate_KR: Korean bank balance certificates and financial statements. Extracts account information, balance details, and banking data.
  • ProofOfAddress: Address verification documents, utility bills, and residence certificates. Extracts address information and verification details.
Available options:
InvoiceMedical,
BusinessRegistration,
InvoiceGeneral,
MedicalObservation,
Contract,
ArrivalNotice,
BillofLading,
Jobapplication,
BalanceCertificate_KR,
ProofOfAddress
​
fileData
string
required

The base64 encoded data of the file to be analyzed. The file should be encoded without line breaks or additional formatting.

Response

Successful analysis

​
status
string

The status of the analysis operation. Returns 'success' when the document analysis is completed successfully.

Example:

"success"

​
data
object

Extracted structured data from the document

Example:
{
  "patientName": "John Doe",
  "hospitalName": "City General Hospital",
  "totalAmount": 1500,
  "services": [
    { "service": "Consultation", "amount": 200 },
    { "service": "Lab Test", "amount": 300 }
  ]
}
​
confidence
number

Confidence score of the extraction, ranging from 0.0 to 1.0. Higher values indicate more reliable extraction results.

Example:

0.95