{
  "opencollection": "1.0.0",
  "info": {
    "name": "Wove External Authentication Documents API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Documents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List shipment documents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.wove.com/api/v1/external/shipments/:shipmentId/documents",
            "params": [
              {
                "name": "shipmentId",
                "value": "",
                "type": "path",
                "description": "Unique shipment identifier"
              },
              {
                "name": "includeDeleted",
                "value": "",
                "type": "query",
                "description": "Include deleted documents in the response"
              },
              {
                "name": "documentTypes",
                "value": "",
                "type": "query",
                "description": "Filter by document types (comma-separated)"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter by document status"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Retrieve all documents associated with a specific shipment."
        },
        {
          "info": {
            "name": "Upload document",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.wove.com/api/v1/external/shipments/:shipmentId/documents",
            "params": [
              {
                "name": "shipmentId",
                "value": "",
                "type": "path",
                "description": "Unique shipment identifier"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "file",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "documentType",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Upload a single document to a shipment."
        },
        {
          "info": {
            "name": "Get document details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.wove.com/api/v1/external/shipments/:shipmentId/documents/:documentId",
            "params": [
              {
                "name": "shipmentId",
                "value": "",
                "type": "path",
                "description": "Unique shipment identifier"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "Unique document identifier"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Retrieve detailed information about a specific document."
        },
        {
          "info": {
            "name": "Update document",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.wove.com/api/v1/external/shipments/:shipmentId/documents/:documentId",
            "params": [
              {
                "name": "shipmentId",
                "value": "",
                "type": "path",
                "description": "Unique shipment identifier"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "Unique document identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Update document metadata or type."
        },
        {
          "info": {
            "name": "Delete document",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.wove.com/api/v1/external/shipments/:shipmentId/documents/:documentId",
            "params": [
              {
                "name": "shipmentId",
                "value": "",
                "type": "path",
                "description": "Unique shipment identifier"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "Unique document identifier"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Delete a document from the system."
        },
        {
          "info": {
            "name": "Download document",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.wove.com/api/v1/external/shipments/:shipmentId/documents/:documentId/download",
            "params": [
              {
                "name": "shipmentId",
                "value": "",
                "type": "path",
                "description": "Unique shipment identifier"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "Unique document identifier"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Download the original document file."
        },
        {
          "info": {
            "name": "Get extraction status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.wove.com/api/v1/external/shipments/:shipmentId/documents/:documentId/extraction",
            "params": [
              {
                "name": "shipmentId",
                "value": "",
                "type": "path",
                "description": "Unique shipment identifier"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "Unique document identifier"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Get the extraction status and results for a document."
        },
        {
          "info": {
            "name": "Start extraction",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.wove.com/api/v1/external/shipments/:shipmentId/documents/:documentId/extract",
            "params": [
              {
                "name": "shipmentId",
                "value": "",
                "type": "path",
                "description": "Unique shipment identifier"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "Unique document identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Start or restart extraction for a document."
        },
        {
          "info": {
            "name": "Update extracted data",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.wove.com/api/v1/external/shipments/:shipmentId/documents/:documentId/extracted-data",
            "params": [
              {
                "name": "shipmentId",
                "value": "",
                "type": "path",
                "description": "Unique shipment identifier"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "Unique document identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Manually update the extracted data for a document."
        },
        {
          "info": {
            "name": "Get document history",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.wove.com/api/v1/external/shipments/:shipmentId/documents/:documentId/history",
            "params": [
              {
                "name": "shipmentId",
                "value": "",
                "type": "path",
                "description": "Unique shipment identifier"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "Unique document identifier"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Get the history of changes for a document."
        },
        {
          "info": {
            "name": "Validate documents",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.wove.com/api/v1/external/shipments/:shipmentId/documents/validate",
            "params": [
              {
                "name": "shipmentId",
                "value": "",
                "type": "path",
                "description": "Unique shipment identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Validate specific documents within a shipment."
        },
        {
          "info": {
            "name": "Get cross-validation job status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.wove.com/api/v1/external/shipments/:shipmentId/documents/cross-validate/:jobId",
            "params": [
              {
                "name": "shipmentId",
                "value": "",
                "type": "path",
                "description": "Unique shipment identifier"
              },
              {
                "name": "jobId",
                "value": "",
                "type": "path",
                "description": "Unique job identifier"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Check the status and results of a cross-validation job."
        },
        {
          "info": {
            "name": "Get merge job status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.wove.com/api/v1/external/shipments/:shipmentId/documents/merge/:jobId",
            "params": [
              {
                "name": "shipmentId",
                "value": "",
                "type": "path",
                "description": "Unique shipment identifier"
              },
              {
                "name": "jobId",
                "value": "",
                "type": "path",
                "description": "Unique job identifier"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Check the status and results of a document merge operation."
        },
        {
          "info": {
            "name": "Cross-validate documents",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.wove.com/api/v1/external/shipments/:shipmentId/documents/cross-validate",
            "params": [
              {
                "name": "shipmentId",
                "value": "",
                "type": "path",
                "description": "Unique shipment identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Create a cross-validation job to check for inconsistencies between documents in a shipment.\n"
        },
        {
          "info": {
            "name": "Merge shipment documents",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.wove.com/api/v1/external/shipments/:shipmentId/documents/merge",
            "params": [
              {
                "name": "shipmentId",
                "value": "",
                "type": "path",
                "description": "Unique shipment identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Create a job to merge data from multiple documents within a shipment.\nIntelligently combines data from related documents (e.g., commercial invoice and packing list).\n"
        },
        {
          "info": {
            "name": "Analyze document types",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.wove.com/api/v1/external/shipments/:shipmentId/documents/analyze-types",
            "params": [
              {
                "name": "shipmentId",
                "value": "",
                "type": "path",
                "description": "Unique shipment identifier"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "file",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Analyze a document to detect multiple document types within it.\nFor PDFs, this will identify different document types and their page boundaries.\nFor other file types, it will identify the document type based on content.\n"
        },
        {
          "info": {
            "name": "Upload multi-document file",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.wove.com/api/v1/external/shipments/:shipmentId/documents/upload-multi",
            "params": [
              {
                "name": "shipmentId",
                "value": "",
                "type": "path",
                "description": "Unique shipment identifier"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "file",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "types",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Upload a file containing multiple documents.\nFor PDFs with multiple document types, this will create separate document records for each type.\nThe original file is stored once, with virtual splits created for each document type.\n"
        },
        {
          "info": {
            "name": "List entity documents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.wove.com/api/v1/external/entities/:entityType/:entityId/documents",
            "params": [
              {
                "name": "entityType",
                "value": "",
                "type": "path",
                "description": "Type of entity"
              },
              {
                "name": "entityId",
                "value": "",
                "type": "path",
                "description": "Entity ID"
              },
              {
                "name": "includeDeleted",
                "value": "",
                "type": "query",
                "description": "Include deleted documents"
              },
              {
                "name": "documentTypes",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of document types to filter"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter by document status"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Retrieve all documents associated with a specific entity.\nSupports any entity type (shipment, rfq_shipment, etc.).\n"
        },
        {
          "info": {
            "name": "Upload document to entity",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.wove.com/api/v1/external/entities/:entityType/:entityId/documents",
            "params": [
              {
                "name": "entityType",
                "value": "",
                "type": "path",
                "description": "Type of entity"
              },
              {
                "name": "entityId",
                "value": "",
                "type": "path",
                "description": "Entity ID"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "file",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "documentType",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Upload a single document and attach it to an entity.\nDocument type can be auto-detected or explicitly specified.\n"
        },
        {
          "info": {
            "name": "Upload multi-document PDF",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.wove.com/api/v1/external/entities/:entityType/:entityId/documents/multi",
            "params": [
              {
                "name": "entityType",
                "value": "",
                "type": "path",
                "description": "Type of entity"
              },
              {
                "name": "entityId",
                "value": "",
                "type": "path",
                "description": "Entity ID"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "file",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "types",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Upload a single PDF file containing multiple documents.\nThe system will automatically split and classify each document.\n"
        },
        {
          "info": {
            "name": "Get document details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.wove.com/api/v1/external/entities/:entityType/:entityId/documents/:documentId",
            "params": [
              {
                "name": "entityType",
                "value": "",
                "type": "path",
                "description": "Type of entity"
              },
              {
                "name": "entityId",
                "value": "",
                "type": "path",
                "description": "Entity ID"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "Document ID"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Retrieve detailed information about a specific document."
        },
        {
          "info": {
            "name": "Update document metadata",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.wove.com/api/v1/external/entities/:entityType/:entityId/documents/:documentId",
            "params": [
              {
                "name": "entityType",
                "value": "",
                "type": "path",
                "description": "Type of entity"
              },
              {
                "name": "entityId",
                "value": "",
                "type": "path",
                "description": "Entity ID"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "Document ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Update document type or other metadata."
        },
        {
          "info": {
            "name": "Delete document",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.wove.com/api/v1/external/entities/:entityType/:entityId/documents/:documentId",
            "params": [
              {
                "name": "entityType",
                "value": "",
                "type": "path",
                "description": "Type of entity"
              },
              {
                "name": "entityId",
                "value": "",
                "type": "path",
                "description": "Entity ID"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "Document ID"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Delete a document from an entity."
        },
        {
          "info": {
            "name": "Download document",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.wove.com/api/v1/external/entities/:entityType/:entityId/documents/:documentId/download",
            "params": [
              {
                "name": "entityType",
                "value": "",
                "type": "path",
                "description": "Type of entity"
              },
              {
                "name": "entityId",
                "value": "",
                "type": "path",
                "description": "Entity ID"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "Document ID"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Download the original document file."
        },
        {
          "info": {
            "name": "Get document preview URL",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.wove.com/api/v1/external/entities/:entityType/:entityId/documents/:documentId/preview",
            "params": [
              {
                "name": "entityType",
                "value": "",
                "type": "path",
                "description": "Type of entity"
              },
              {
                "name": "entityId",
                "value": "",
                "type": "path",
                "description": "Entity ID"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "Document ID"
              },
              {
                "name": "purpose",
                "value": "",
                "type": "query",
                "description": "Purpose of the preview (for tracking)"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Get a presigned URL for previewing the document."
        },
        {
          "info": {
            "name": "Get document history",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.wove.com/api/v1/external/entities/:entityType/:entityId/documents/:documentId/history",
            "params": [
              {
                "name": "entityType",
                "value": "",
                "type": "path",
                "description": "Type of entity"
              },
              {
                "name": "entityId",
                "value": "",
                "type": "path",
                "description": "Entity ID"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "Document ID"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Retrieve the processing history of a document."
        },
        {
          "info": {
            "name": "Guess document type",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.wove.com/api/v1/external/documents/guess-type",
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "fileName",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "file",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Intelligently guess the type of a document based on its filename and optionally its content.\nUses AI-powered detection to analyze filename patterns and file content for accurate type identification.\n\n**File size limit**: 50MB when uploading file content\n\n**Supported file types for content analysis**:\n- Images (JPEG, PNG, etc.)\n- PDFs\n- Spreadsheets (Excel, CSV)\n- Word documents (DOCX)\n"
        }
      ]
    }
  ],
  "bundled": true
}