Saltar al contenido principal
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
}
La plantilla de comprobante de domicilio extrae datos estructurados de documentos de verificación de dirección, facturas de servicios públicos y certificados de residencia, incluyendo información de dirección y detalles de verificación.

Características de la plantilla

Extrae la siguiente información de documentos de verificación de dirección:
  • Información e identificación del residente
  • Tipo de documento y detalles del proveedor de servicios
  • Información completa de la dirección
  • Detalles de facturación y servicios
  • Vigencia del documento y estado de verificación
  • Métodos y autoridades de verificación de dirección

Ejemplo de uso

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

Formato de respuesta

La plantilla devuelve datos estructurados de comprobante de domicilio que incluyen:

Información del residente

  • Resident Name: Nombre completo del residente
  • Document Type: Tipo de documento de verificación de dirección
  • Service Provider: Nombre de la empresa de servicios públicos
  • Account Number: Identificador de cuenta del servicio

Detalles de la dirección

  • Street Address: Dirección completa de la calle
  • City, State, ZIP: Detalles de ubicación
  • Country: País de residencia
  • Address Type: Residencial, comercial, etc.

Información de facturación

  • Billing Period: Período de servicio cubierto
  • Due Date: Fecha límite de pago
  • Amount: Monto del servicio
  • Service Type: Tipo de servicio público

Información del documento

  • Issue Date: Fecha de emisión del documento
  • Document Number: Identificador único del documento
  • Valid Until: Fecha de vencimiento del documento
  • Document Status: Activo, vencido, etc.

Detalles de verificación

  • Verification Method: Cómo se verificó la dirección
  • Verification Date: Fecha de verificación
  • Verified By: Autoridad que verificó la dirección
  • Verification Status: Confirmado, pendiente, rechazado

Respuesta de ejemplo

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

Tipos de comprobante de domicilio compatibles

  • Facturas de servicios públicos (electricidad, gas, agua)
  • Estados de cuenta bancarios
  • Estados de cuenta de tarjeta de crédito
  • Documentos de seguros
  • Cartas gubernamentales
  • Contratos de alquiler
  • Estados de cuenta hipotecarios
  • Documentos fiscales
  • Cartas de empleo
  • Documentos de inscripción escolar

Autorizaciones

x-api-key
string
header
requerido

Cuerpo

application/json
fileExtension
enum<string>
requerido

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

Opciones disponibles:
PDF,
TIFF,
JPG,
PNG
docuType
enum<string>
requerido

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.
Opciones disponibles:
InvoiceMedical,
BusinessRegistration,
InvoiceGeneral,
MedicalObservation,
Contract,
ArrivalNotice,
BillofLading,
Jobapplication,
BalanceCertificate_KR,
ProofOfAddress
fileData
string
requerido

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

Respuesta

Successful analysis

status
string

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

Ejemplo:

"success"

data
object

Extracted structured data from the document

Ejemplo:
{
"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.

Ejemplo:

0.95