v3

latestOpenAPI 3.0.0raw.githubusercontent.com2025-09-151454123.8 KB

Companies

Upload documents to an company

post/companies/{company_id}/documents

Path parameters

company_idstring required

ID of the company to upload document

Response

Company document updated successfully

created_atstring date-time

Timestamp when the document was created or uploaded.

document_typestring

Type/category of the document.

idstring

Unique identifier of the document.

namestring

Name or label for the document.

signed_urlstring uri

Signed URL for accessing the document file.

statestring

Current processing state of the document (e.g., WAITING, PROCESSED).

statusstring

Status of the document reception or approval.

Example response

{
  "checks": [
    {
      "message": "Name matched successfully",
      "name": "name_match",
      "validate": true,
      "weight": 1
    }
  ],
  "created_at": "2025-05-01T12:00:00Z",
  "document_type": "generic",
  "id": "doc_123",
  "name": "generic_doc",
  "signed_url": "https://cdn.example.com/doc.pdf",
  "state": "SUBMITTED",
  "status": "approved",
  "values": [
    {
      "confidence": 0.95,
      "name": "Full Name",
      "value": [
        100,
        200
      ]
    }
  ]
}