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](mailto:support@withpersona.com) if you need help getting id_class values.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Headers
Key-Inflection
Determines casing for the API response.
Allowed values:
Idempotency-Key
Ensures the request is idempotent.
Persona-Version
Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).
Query parameters
include
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](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details.
fields
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](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details.
Request
This endpoint expects a multipart form.
data
Response headers
RateLimit-Limit
The maximum number of requests permitted in the current rate limit window for the API key used to authenticate the request. Returned on every authenticated response.
RateLimit-Remaining
The number of requests remaining in the current rate limit window for the API key used to authenticate the request. Returned on every authenticated response.
RateLimit-Reset
The number of seconds until the current rate limit window resets. Returned on every authenticated response.
Request-Id
The unique identifier of the API log entry that recorded this request. Starts with req_. Include this value when reaching out to Persona support. Present on every authenticated response, including error responses.
Persona-Environment-Id
The token of the Persona environment that handled the request. Returned on every authenticated response, including most error responses.
Persona-Organization-Id
The token of the Persona organization that handled the request. Returned on every authenticated response, including most error responses.
Response
This endpoint returns an Importer object.
data
An Importer for government ID number List Items
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error