Sign in

v1

latestOpenAPI 3.0.32026-08-04404186.8 KB
Identity 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
post/v2/identity_verification

Request body

related_company_idstring

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_idstring

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.

timestampstring date-time required

When the identity verification completed, in ISO 8601 format. Use the timestamp from your verification provider's response.

verification_idstring required

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
verification_overall_outcomestring

Result of IDV screening returned from provider

verification_providerstring required

Which verification provider verified those attributes for the person or company. If this is an internal process, mention the name of your company.

verification_type'DOCUMENT_MATCH' | 'DATABASE_MATCH' | 'MANUAL_VERIFICATION'

Example request

[
  {
    "related_company_id": "company-id-12345",
    "related_person_id": "person-id-56789",
    "verification_overall_outcome": "pass"
  }
]

Response

Identity verification added successfully

messagestring required

Provides additional information about the operation result.

organization_idstring required

The organization ID for which the operation was performed.

successboolean required

Indicates if the write operation was successful.

write_countinteger required

The number of records written to the database.