The company provided document object represents a document uploaded directly to Check API. This can help fulfill documentation requirements during the company review process. The uploaded file must be a PDF, JPG, or PNG and cannot exceed 6 MB in size.
{
"id": "doc_1fyTzNTwEg1gWwKOqYK9",
"company": "com_kGYEICK22GEzj8trreH3",
"document_type": "940",
"upload_url": "https://sandbox.checkhq.com/company_provided_documents/doc_1fyTzNTwEg1gWwKOqYK9/upload",
"upload_status": "pending",
"file_content_type": null,
"provided_filename": null
}
Attribute | Description |
---|---|
id string | Unique identifier for the document |
company string | ID of the company that this document is associated with |
document_type string | The type of document being uploaded. One of:
|
upload_url string | The Check API URL to be used for uploading the file associated with this object |
upload_status string | The status of the upload. Upload status is "pending" for a newly created object with no associated file upload and "uploaded" for an object whose associated file was successfully uploaded to the upload_url . |
file_content_type string | The content type of the uploaded file. The default value is null for documents in a "pending" state. Uploaded files can only be .jpg, .png, and .pdf, meaning for an "uploaded" document this can be one of:
|
provided_filename string | The filename of the uploaded file. The default value is null and this field is set automatically based on the field uploaded. |