API ReferenceDocuments

Submit a Government ID Document

Submits a government ID document for processing. Can only submit initiated documents with photos of the ID attached.

Path parameters

document-idstringRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Key-InflectionenumOptional
Determines casing for the API response.
Allowed values:
Idempotency-KeystringOptional
Ensures the request is idempotent.
Persona-VersionenumOptionalDefaults to 2023-01-05
Allowed values:

Query parameters

includestringOptional

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details.

fieldsmap from strings to stringsOptional

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details.

Response

This endpoint returns a Government ID Document object and (optionally) its related objects in included.

dataobject or null
A Document Government ID object

Errors