Skip to main content
The Document model is used to handle file uploads. You can upload files and associate them with a Customer, Case, or Check. This is essential for any check that requires documentary evidence, such as ID verification (IDV), proof of address, or reviewing a company’s incorporation documents. The typical workflow is to first upload the document to get a document id, and then reference that id when creating a Case or Check. You can also link documents to a Customer to reuse them across multiple cases.
id
integer
required
A unique identifier for the document.
case
integer
The ID of the case this document is associated with.
check
integer
The ID of the check this document is associated with.
customer
integer
The ID of the customer this document is associated with.
file
string
required
The Base64 encoded content of the file.
original_name
string
The original name of the uploaded file.
created_at
string
required
The timestamp when the document was created.
updated_at
string
required
The timestamp when the document was last updated.