API ReferenceIdentity Verification

Update identity verification in batch

Headers

AuthorizationstringRequired

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

AuthorizationstringRequired

Request

This endpoint expects a list of objects.
verification_idstringRequired
Unique identifier for a identity verification belonging to a identity verification. This is the primary key for a identity verification and should be unique across all identity verifications. Updates to a identity verification should be made using this identifier.
timestampdatetimeRequired

Original timestamp relating to this IDV information creation/change

verification_providerstringRequired
what 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
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 verifications updated 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