Overview of the document object
Shown below is a sample document object.
{
"id": "doc_ZKWbucus5et5G2CgXStcxA70B",
"object": "document",
"name": "doc_ZKWbucus5et5G2CgXStcxA70B.png",
"content_type": "image/png",
"type": "customer_photo",
"size": 22004,
"customer_accessible": true,
"created_at": 1651057023,
"is_sandbox": true
}
The table below lists the various parameters in the document object.
| Parameter | Type | Description |
|---|---|---|
| id | string | Unique identifier of the document you uploaded in the ZWITCH database. Example: doc_6aVVwhDNxXnmuh6ujqCwZuIWZ. |
| object | string | API object that is returned. Possible value: document |
| name | string | The name of the document on the ZWITCH database. Example: doc_6aVVwhDNxXnmuh6ujqCwZuIWZ.png. |
| content-type | string | The extension of the document you uploaded. Possible value: image/png. |
| type | string | The type of file you uploaded. Possible values:
|
| size | integer | The size of the document in bytes. Example: 369 |
| customer_accessible | boolean | Possible values:
|
| created_at | integer | Unix timestamp when the upload document request was received by ZWITCH. Example: 1640179951 |
| is_sandbox | boolean | The mode in which the API was triggered. Possible values:
|