API ReferenceImporters

Import Government ID Number Lists

Bulk import government ID number List Items by uploading a CSV file.

Each row should be the details for a new List Item. The columns we allow are:

  • id_number
  • id_class

Common values for id_class include pp for passport and dl for driver license. Please contact us or reach out to support@withpersona.com if you need help getting id_class values.

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.

Request

This endpoint expects an object.
dataobjectRequired

Response

This endpoint returns an Importer object.
dataobject or null
An Importer for government ID number List Items

Errors