v1

latestOpenAPI 3.1.02026-07-2496304466.3 KB

Accounts: ID+V

Start Identity Verification

post/accounts/{account_id}/identity_verification

Path parameters

account_idstring required

An account identifier.

Headers

LMG-Data-Privacy-Access-Principalstring required

LMG-Data-Privacy-Access-Justificationstring required

Request body

redirect_successstring uri required

The redirect target that will be opened after a successful video-identification process.

redirect_failurestring uri required

The redirect target that will be opened after a failed video-identification process.

Example request

{
  "redirect_success": "my-app://brokerage/success",
  "redirect_failure": "my-app://brokerage/failure"
}

Response

Successful Response

urlstring uri required

A web URL. Use this URL to present the user with the web version for initiating the video identification process. For different reasons, it may not be possible for the user to complete the video identification process on the mobile device. In this case, it is a good idea to offer a sharing option, e.g. so they can send the link to their own email address and complete the process on a different device. We expect these reasons (and others) to prevent the video identification process from completing:

<ul> <li>Older devices that lack the resources (e.g. memory) to run the all of components involved at the same time. <li>Devices that are locked down for privacy reasons. This can both be company devices under MDM (mobile device management) or advanced used utiliting parental controls to block any access to the device's microphone and/or camera capabilities. </ul>

video_ident_idstring required

An identifier representing the process on the side of the video identification provider.

Example response

{
  "url": "https://example.com/video-ident?id=123-456-789"
}