DocumentationAPI Reference
DocumentationAPI Reference

Documents

A documentdocument - Written, printed, or electronic matter about an individual uploaded during an inquiry to aid in verifying the individual. is a written, printed, or electronic matter provided by an individual, such as a government ID or a utility bill. An inquiryinquiry - A single instance of an individual attempting to verify their identity. can contain zero or more documents. Each inquiry’s relationships field lists the IDs of all associated documents. To authenticate when fetching file URLs, pass the same Authorization header.

Check for the following statuses of a document.

Document Status

Description

Initiated

When the individual is first asked to provide a document, the document is initiated. During this time, a document can be uploaded with files before submitting it for processing.

Submitted

When the individual submits their document, the server processes the document.

Processed

The server is done processing the document.

Errored

If the server fails to process the document.