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
}
The Bill of Lading template extracts structured data from transportation documents for cargo and freight shipments, including shipping details, cargo information, and transport terms.

​
Template Features

Extracts the following information from bill of lading documents:
  • Shipping vessel and voyage details
  • Shipper and consignee information
  • Cargo specifications and quantities
  • Freight terms and payment conditions
  • Special handling instructions
  • Transport and delivery terms

​
Usage Example

{
  "fileExtension": "pdf",
  "docuType": "BillofLading",
  "fileData": "base64-encoded-bill-of-lading-data"
}

​
Response Format

The template returns structured bill of lading data including:

​
Bill of Lading Information

  • BL Number: Unique bill of lading identifier
  • Issue Date: Date document was issued
  • Vessel Name: Shipping vessel name
  • Voyage Number: Ship voyage identifier
  • Port of Loading: Origin port
  • Port of Discharge: Destination port

​
Shipper Details

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

​
Consignee Information

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

​
Notify Party

  • Notify Party Name: Party to be notified
  • Notify Party Address: Complete address
  • Contact Information: Phone and email

​
Cargo Details

  • Description: Detailed cargo description
  • Weight: Total cargo weight
  • Measurement: Cargo volume measurements
  • Packages: Number of packages or items
  • Container Numbers: Shipping container identifiers
  • Package Types: Type of packaging used

​
Freight Information

  • Freight Terms: FOB, CIF, EXW, etc.
  • Payment Terms: Prepaid, collect, etc.
  • Special Instructions: Handling requirements
  • Dangerous Goods: Hazardous materials information

​
Sample Response

{
  "status": "success",
  "data": {
    "document": {
      "billOfLadingInfo": {
        "blNumber": "BL-2024-001234",
        "issueDate": "2024-01-20",
        "vessel": "MSC Mediterranean",
        "voyage": "V-123"
      },
      "shipper": {
        "name": "International Trading Co.",
        "address": "123 Trade Street, Trade City, TC 12345",
        "contactPerson": "Mike Trader",
        "phone": "+1-555-0123"
      },
      "consignee": {
        "name": "Global Import Solutions",
        "address": "456 Import Avenue, Port City, PC 67890",
        "contactPerson": "Lisa Import",
        "phone": "+1-555-9876"
      },
      "notifyParty": {
        "name": "Customs Broker Services",
        "address": "789 Broker Street, Broker City, BC 54321"
      },
      "cargoDetails": {
        "description": "Automotive parts and machinery",
        "weight": "5,000 kg",
        "measurement": "25 cubic meters",
        "packages": 200,
        "containerNumbers": ["MSCU1234567", "MSCU7654321"]
      },
      "freightTerms": "FOB Origin",
      "paymentTerms": "Prepaid",
      "specialInstructions": "Handle with care, temperature controlled"
    },
    "confidence": 0.92
  }
}

​
Supported Bill of Lading Types

  • Ocean Bill of Lading
  • Air Waybill
  • Truck Bill of Lading
  • Rail Bill of Lading
  • Multimodal Bill of Lading
  • Through Bill of Lading
  • Clean Bill of Lading
  • Claused Bill of Lading
  • Order Bill of Lading
  • Straight Bill of Lading

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