Properties
| Name | Type | Description |
|---|---|---|
| active | boolean | Identifies whether the document is active and used for checks. |
| description | string | Your description for the document. |
| fileName | string | Document name. |
| id | string | The unique identifier of the resource. |
| modificationDate | string | The modification date of the document. |
| pages | array | List of document pages |
| type | string | Type of document, used when providing an ID number or uploading a document. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/DocumentReference",
"title": "DocumentReference",
"properties": {
"active": {
"description": "Identifies whether the document is active and used for checks.",
"type": "boolean"
},
"description": {
"description": "Your description for the document.",
"type": "string"
},
"fileName": {
"description": "Document name.",
"type": "string"
},
"id": {
"description": "The unique identifier of the resource.",
"type": "string"
},
"modificationDate": {
"description": "The modification date of the document.",
"format": "date-time",
"type": "string"
},
"pages": {
"description": "List of document pages",
"items": {
"$ref": "#/components/schemas/DocumentPage"
},
"type": "array"
},
"type": {
"description": "Type of document, used when providing an ID number or uploading a document.",
"type": "string"
}
},
"type": "object"
}