Documents

A document represents a single file attached to a given resource. Often these are documents attached to payment orders to provide further context or image files for incoming checks.

Attribute

Description

id string

The unique identifier for the document.

document_type string

A category given to the document, can be null.

documentable_id string

The unique identifier for the associated object.

source string

The source of the document. Can be vendor or customer where vendor is a third-party and customer is your organization that has uploaded the document.

documentable_type string

The type of the associated object. Currently can be one of payment_order, transaction, expected_payment, counterparty, organization, identification, internal_account, or external_account.

file.size int32

The size of the document in bytes.

file.filename string

The original filename of the document.

file.content_type string

The MIME content type of the document.

live_mode boolean

This field will be true if this object was created with a production API key or false if created with a test API key.

{
  "id": "b05dd054-6eea-4cdd-9096-cf3fa8eb6fb7",
  "object": "document",
  "source": "customer",
  "document_type": "Invoice",
  "documentable_id": "00ddb900-317f-4436-8b79-6329c924ef27",
  "documentable_type": "payment_order",
  "file": {
    "size": 1558074,
    "filename": "invoice-6000.pdf",
    "content_type": "application/pdf"
  },
  "document_details": [],
  "live_mode": true,
  "created_at": "2023-06-20T15:58:59Z",
  "updated_at": "2023-06-20T15:58:59Z"
}