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 Arrival Notices template extracts structured data from shipping and logistics arrival notifications, delivery confirmations, including shipment details, arrival dates, and delivery information.

​
Template Features

Extracts the following information from arrival notice documents:
  • Shipment tracking and identification
  • Consignee and shipper details
  • Cargo specifications and quantities
  • Customs and clearance information
  • Delivery instructions and requirements
  • Logistics and transportation details

​
Usage Example

{
  "fileExtension": "pdf",
  "docuType": "ArrivalNotice",
  "fileData": "base64-encoded-arrival-notice-data"
}

​
Response Format

The template returns structured arrival notice data including:

​
Shipment Information

  • Tracking Number: Unique shipment identifier
  • Arrival Date: Date shipment arrived at destination
  • Estimated Delivery: Expected delivery date
  • Status: Current shipment status
  • Vessel/Transport: Carrier information

​
Consignee Details

  • Consignee Name: Recipient company or individual
  • Consignee Address: Complete delivery address
  • Contact Person: Primary contact for delivery
  • Contact Information: Phone and email details

​
Shipper Information

  • Shipper Name: Sender company or individual
  • Shipper Address: Origin address
  • Contact Person: Shipper contact details
  • Contact Information: Phone and email

​
Cargo Details

  • Description: Detailed cargo description
  • Weight: Total cargo weight
  • Volume: Cargo volume measurements
  • Pieces: Number of packages or items
  • Container Numbers: Shipping container identifiers

​
Customs Information

  • Customs Broker: Customs clearance agent
  • Entry Number: Customs entry identifier
  • Duty Amount: Import duties and taxes
  • Clearance Status: Customs clearance status

​
Delivery Instructions

  • Delivery Requirements: Special handling instructions
  • Signature Requirements: Delivery confirmation needs
  • Business Hours: Preferred delivery times
  • Special Instructions: Additional delivery notes

​
Sample Response

{
  "status": "success",
  "data": {
    "document": {
      "shipmentInfo": {
        "trackingNumber": "TRK-2024-001234",
        "arrivalDate": "2024-01-25",
        "estimatedDelivery": "2024-01-26",
        "status": "Arrived at Destination"
      },
      "consignee": {
        "name": "Global Import Company",
        "address": "456 Import Street, Port City, PC 12345",
        "contactPerson": "John Import",
        "phone": "+1-555-0123"
      },
      "shipper": {
        "name": "Overseas Export Ltd.",
        "address": "789 Export Road, Export City, EC 67890",
        "contactPerson": "Sarah Export",
        "phone": "+44-20-1234-5678"
      },
      "cargoDetails": {
        "description": "Electronic components and machinery parts",
        "weight": "2,500 kg",
        "volume": "15 cubic meters",
        "pieces": 150
      },
      "customsInfo": {
        "customsBroker": "Fast Customs Services",
        "entryNumber": "ENT-2024-001",
        "dutyAmount": 1250.00
      },
      "deliveryInstructions": "Deliver during business hours, signature required"
    },
    "confidence": 0.89
  }
}

​
Supported Arrival Notice Types

  • Ocean Freight Arrival Notices
  • Air Freight Arrival Notices
  • Trucking Arrival Notices
  • Rail Freight Arrival Notices
  • Express Delivery Notices
  • Container Arrival Notices
  • Bulk Cargo Arrival Notices
  • Hazardous Materials Arrival Notices
  • Temperature-Controlled Cargo Notices
  • Oversized Cargo Arrival Notices

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