Skip to navigation
API ReferenceIdentity Verification

Add identity verification

Add IDV (Identity Verification) information for a person or company.

Note: Each API call represents a single verification event from one provider at a specific point in time. If you have multiple verification sources or multiple verification attempts, you must make separate API calls for each one.

For example:

  • Document verification from Provider A requires one API call
  • Database verification from Provider B requires another API call
  • Re-verification after data update requires a new API call

Authentication

AuthorizationBearer

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

Request

This endpoint expects a list of objects.
verification_idstringRequired

Unique identifier for an identity verification. This is the primary identifier for an identity verification and should be unique across all identity verifications. Updates to an identity verification should be made using this identifier.

This can reference:

  • Your internal verification record ID
  • The original provider's verification ID (optionally with a prefix)
  • Any unique identifier that allows traceability to the original data source
timestampdatetimeRequired
When the identity verification completed, in ISO 8601 format. Use the timestamp from your verification provider's response.
verification_providerstringRequired
Which verification provider verified those attributes for the person or company. If this is an internal process, mention the name of your company.
verified_datalist of objectsRequired

Array of individual data points verified in this verification event only. Each item represents a specific piece of information (name, DOB, address, etc.) that was checked during this particular verification.

Do not include:

  • Data points from other verification events
  • Aggregated results from multiple verifications
  • Data that wasn't actually verified in this specific check

Example: If this verification only checked name and DOB, only include those two items in the array, even if other data points were verified in previous or separate verification events.

related_company_idstringOptional

Unique identifier of the related company entity (used for business contexts). Only one of related_company_id and related_person_id can be specified.

related_person_idstringOptional

Unique identifier of the related person entity (used for retail contexts or when a person is the subject). Only one of related_company_id and related_person_id can be specified.

verification_overall_outcomestringOptional
Result of IDV screening returned from provider
verification_typeenumOptional
Allowed values:

Response

Identity verification added successfully
successboolean
Indicates if the write operation was successful.
write_countinteger
The number of records written to the database.
messagestring
Provides additional information about the operation result.
organization_idstring
The organization ID for which the operation was performed.

Errors

400
Bad Request Error
401
Unauthorized Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error