Validations

Invalidate validation

Use this endpoint to invalidate a validation with given validation ID. This will revoke user's existing credentials.

put/api/v1/validation/{validationId}/invalidate

Request

Path parameters

validationIdstring required

Request body

reason_code'KEY_COMPROMISE' | 'AFFILIATION_CHANGED' | 'SUPERSEDED' | 'CESSATION_OF_OPERATION'

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.