> ## 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.

# Plantilla de conocimiento de embarque

> Extract structured data from various document types using specialized AI models.

La plantilla de conocimiento de embarque extrae datos estructurados de documentos de transporte para carga y envíos de mercancías, incluyendo detalles de envío, información de la carga y términos de transporte.

## Características de la plantilla

Extrae la siguiente información de documentos de conocimiento de embarque:

* Detalles del buque y el viaje de envío
* Información del remitente y el consignatario
* Especificaciones y cantidades de la carga
* Términos de flete y condiciones de pago
* Instrucciones especiales de manejo
* Términos de transporte y entrega

## Ejemplo de uso

```json theme={null}
{
  "fileExtension": "pdf",
  "docuType": "BillofLading",
  "fileData": "base64-encoded-bill-of-lading-data"
}
```

## Formato de respuesta

La plantilla devuelve datos estructurados del conocimiento de embarque que incluyen:

### Información del conocimiento de embarque

* **BL Number**: Identificador único del conocimiento de embarque
* **Issue Date**: Fecha de emisión del documento
* **Vessel Name**: Nombre del buque de envío
* **Voyage Number**: Identificador del viaje del buque
* **Port of Loading**: Puerto de origen
* **Port of Discharge**: Puerto de destino

### Datos del remitente

* **Shipper Name**: Empresa o persona remitente
* **Shipper Address**: Dirección completa de origen
* **Contact Person**: Datos de contacto del remitente
* **Contact Information**: Teléfono y correo electrónico

### Información del consignatario

* **Consignee Name**: Empresa o persona receptora
* **Consignee Address**: Dirección completa de destino
* **Contact Person**: Datos de contacto del consignatario
* **Contact Information**: Teléfono y correo electrónico

### Parte notificada

* **Notify Party Name**: Parte a notificar
* **Notify Party Address**: Dirección completa
* **Contact Information**: Teléfono y correo electrónico

### Detalles de la carga

* **Description**: Descripción detallada de la carga
* **Weight**: Peso total de la carga
* **Measurement**: Medidas de volumen de la carga
* **Packages**: Número de paquetes o artículos
* **Container Numbers**: Identificadores de contenedores de envío
* **Package Types**: Tipo de embalaje utilizado

### Información del flete

* **Freight Terms**: FOB, CIF, EXW, etc.
* **Payment Terms**: Prepagado, a cobrar, etc.
* **Special Instructions**: Requisitos de manejo
* **Dangerous Goods**: Información de materiales peligrosos

## Respuesta de ejemplo

```json theme={null}
{
  "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
  }
}
```

## Tipos de conocimiento de embarque compatibles

* Conocimiento de embarque marítimo
* Carta de porte aéreo
* Conocimiento de embarque por camión
* Conocimiento de embarque ferroviario
* Conocimiento de embarque multimodal
* Conocimiento de embarque directo
* Conocimiento de embarque limpio
* Conocimiento de embarque con reservas
* Conocimiento de embarque a la orden
* Conocimiento de embarque nominativo


## OpenAPI

````yaml POST /v1/textify/analyzer
openapi: 3.1.0
info:
  title: Textify API
  description: >-
    The Textify API section enables users to analyze files based on their
    extension and document type. By providing the base64 encoded data of the
    file to be analyzed, users can retrieve valuable insights and information.
  version: 1.0.0
servers:
  - url: https://textify-api.argosidentity.com
    description: Production server
security: []
paths:
  /v1/textify/analyzer:
    post:
      summary: Analyze Document
      description: >-
        Analyze a document based on its extension and document type to extract
        structured information.
      operationId: analyzeDocument
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - fileExtension
                - docuType
                - fileData
              properties:
                fileExtension:
                  type: string
                  description: >-
                    The file extension of the document to be analyzed. Must be
                    one of the supported formats.
                  enum:
                    - PDF
                    - TIFF
                    - JPG
                    - PNG
                docuType:
                  type: string
                  description: >-
                    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.
                  enum:
                    - InvoiceMedical
                    - BusinessRegistration
                    - InvoiceGeneral
                    - MedicalObservation
                    - Contract
                    - ArrivalNotice
                    - BillofLading
                    - Jobapplication
                    - BalanceCertificate_KR
                    - ProofOfAddress
                fileData:
                  type: string
                  description: >-
                    The base64 encoded data of the file to be analyzed. The file
                    should be encoded without line breaks or additional
                    formatting.
            examples:
              medical-invoice:
                summary: Medical Invoice Example
                value:
                  fileExtension: PDF
                  docuType: InvoiceMedical
                  fileData: base64-encoded-file-data
              business-registration:
                summary: Business Registration Example
                value:
                  fileExtension: JPG
                  docuType: BusinessRegistration
                  fileData: base64-encoded-file-data
      responses:
        '200':
          description: Successful analysis
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: >-
                      The status of the analysis operation. Returns 'success'
                      when the document analysis is completed successfully.
                    example: success
                  data:
                    type: object
                    description: Extracted structured data from the document
                    properties:
                      patientName:
                        type: string
                        description: >-
                          Full name of the patient as extracted from the medical
                          document
                      hospitalName:
                        type: string
                        description: >-
                          Name of the hospital or medical facility where the
                          services were provided
                      totalAmount:
                        type: number
                        description: Total amount of the medical bill in the local currency
                      services:
                        type: array
                        description: List of medical services provided to the patient
                        items:
                          type: object
                          properties:
                            service:
                              type: string
                              description: >-
                                Name or description of the medical service
                                provided
                            amount:
                              type: number
                              description: >-
                                Cost of the individual service in the local
                                currency
                    example:
                      patientName: John Doe
                      hospitalName: City General Hospital
                      totalAmount: 1500
                      services:
                        - service: Consultation
                          amount: 200
                        - service: Lab Test
                          amount: 300
                  confidence:
                    type: number
                    description: >-
                      Confidence score of the extraction, ranging from 0.0 to
                      1.0. Higher values indicate more reliable extraction
                      results.
                    example: 0.95
                example:
                  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
              examples:
                medical-invoice-response:
                  summary: Medical Invoice Response
                  description: >-
                    Response for medical invoice analysis with patient details
                    and service breakdown
                  value:
                    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
                business-registration-response:
                  summary: Business Registration Response
                  description: >-
                    Response for business registration document analysis with
                    company information
                  value:
                    status: success
                    data:
                      businessName: ABC Corporation
                      registrationNumber: '12345678'
                      businessType: Limited Liability Company
                      address: 123 Business St, Seoul, Korea
                    confidence: 0.92
                general-invoice-response:
                  summary: General Invoice Response
                  description: >-
                    Response for general invoice analysis with customer and item
                    details
                  value:
                    status: success
                    data:
                      invoiceNumber: INV-2024-001
                      customerName: Jane Smith
                      totalAmount: 2500
                      items:
                        - item: Web Development
                          amount: 2000
                        - item: Consultation
                          amount: 500
                    confidence: 0.88
        '400':
          description: >-
            Bad request - The request contains invalid parameters or malformed
            data
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error code or message describing the specific issue
                    example: Invalid file extension
        '401':
          description: Unauthorized - The API key is missing, invalid, or has expired
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Authentication error message
                    example: Invalid API key
        '500':
          description: >-
            Internal server error - An unexpected error occurred during document
            processing
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Server error message indicating the processing failure
                    example: Processing failed
      security:
        - apiKeyAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````