{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/document",
"title": "document",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"object": {
"type": "string"
},
"live_mode": {
"type": "boolean",
"description": "This field will be true if this object exists in the live environment or false if it exists in the test environment."
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"discarded_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"document_type": {
"type": "string",
"description": "A category given to the document, can be `null`.",
"nullable": true
},
"source": {
"type": "string",
"description": "The source of the document. Can be `vendor`, `customer`, or `modern_treasury`."
},
"documentable_id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier for the associated object.",
"nullable": true
},
"documentable_type": {
"type": "string",
"enum": [
"connection",
"counterparty",
"expected_payment",
"external_account",
"identification",
"incoming_payment_detail",
"internal_account",
"legal_entity",
"organization",
"payment_order",
"transaction"
],
"description": "The type of the associated object. Currently can be one of `payment_order`, `transaction`, `expected_payment`, `counterparty`, `organization`, `case`, `internal_account`, `decision`, or `external_account`.",
"nullable": true
},
"document_details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/document_detail"
}
},
"file": {
"type": "object",
"properties": {
"size": {
"type": "integer",
"description": "The size of the document in bytes."
},
"filename": {
"type": "string",
"description": "The original filename of the document."
},
"content_type": {
"type": "string",
"description": "The MIME content type of the document."
}
},
"additionalProperties": false,
"minProperties": 3
}
},
"additionalProperties": false,
"minProperties": 12,
"required": [
"id",
"object",
"live_mode",
"created_at",
"updated_at",
"discarded_at",
"document_type",
"source",
"documentable_id",
"documentable_type",
"document_details",
"file"
]
}