Validations

Create validation

Use this endpoint to create a new validation for the given account, validation, and associated user details.

The following parameters are required request body fields:

account — Account ID and name.

associated_users — List of details for each user associated with the validation, including associate_user_id, email, phone, and whether a new_user is being created for this validation (default is false).

default_profile_id — The default credential profile associated with this validation.

validation_entity — person or organization.

validation_entity_type — account_user, end_user, or organization.

validation_method — f2f, remote, RA, or manual.

validation_type — advanced+, qualified, or basic.

validation_profile_id — Validation profile ID.

post/api/v1/validation

Request

Request body

validation_entity'person' | 'organization'
validation_entity_type'account_user' | 'end_user' | 'organization'
validation_type'advanced+' | 'qualified' | 'basic'
validation_method'f2f' | 'remote' | 'RA' | 'manual' | 'remote_manual'
default_profile_idstring uuid
validation_profile_idstring

Example request

{
  "account": {
    "id": "account_id"
  }
}

Response

Validation details

created_bystring
modified_onstring date-time
modified_bystring
created_onstring date-time
validation_idstring
validation_entitystring
validation_entity_typestring
validation_typestring
validation_methodstring
validation_status'VALIDATION_CREATED' | 'VALIDATION_ERROR' | 'INVITE_SENT' | 'INVITE_FAILED' | 'PENDING_IDENTITY_PROOFING' | 'APPROVED' | 'REJECTED' | 'ABORTED' | 'DOCUMENT_VERIFICATION_ERROR' | 'REVIEW_PENDING' | 'EXPIRED' | 'PENDING_MANUAL_REVIEW' | 'PENDING_SIGNER_APPROVAL' | 'CANCELLED'
default_profile_idstring
credential_profile_idsstring[]
verifyid_transaction_idstring
expiration_datestring date-time
expiredboolean
rejection_statusstring
validation_enrollment_idstring uuid
validation_profile_idstring uuid
failure_reasonstring
language_codestring
auto_approval_enabledboolean
terms_and_conditionsstring
terms_acceptance_timestring date-time
client_datastring
last_sentstring date-time
invites_numberinteger
cancelationReasonstring
bulk_onboarding_user_idstring
legal_first_namestring
legal_last_namestring
account_idstring

Changes

No recorded changes to this operation across all 1 revision of this API.