The Person Document object

Use the Document object to create, modify, and/or modify identification documents for Persons
The Person Document object
 last updated: 
September 9, 2022

The table below defines the fields contained within the Document object for Persons.

Field Type Description
docType enum type of document with possible values:
- drivingLicense
- profilePicture
- stateID
- visa
- greenCard
- other
name string optional name of document
description string description of the document
documentNumber string document number
issuingCountry string issuing country (2-alpha ISO code)
issuingState string issuing state or province (2-alpha)
expirationDate string format is YYYY-MM-DD


Create Document: POST /v1/person/{{personId}}/document

Update Document: PATCH /v1/person/{{personId}}/document/{{document_id}}

List All Documents: GET /v1/person/{{personId}}/document

Get Document: GET /v1/person/{{personId}}/document/{{document_id}}

Get Download URL: GET /v1/person/{{personId}}/document/{{document_id}}/download-url

Get Upload URL: GET /v1/person/{{personId}}/document/{{document_id}}/upload-url

Upload Document: PUT <signed-upload-url>

Delete Document: DELETE /v1/person/{{personId}}/document/{{document_id}}

List of allowed MIME types for documents:
- image/jpeg
- image/png
- application/pdf