Submit an IDV

Submits the person for an IDV by passing the person ID
Person
Submit an IDV
 last updated: 
November 30, 2023

After collecting the individual's information, you can verify the person using an identity document and camera. This type of verification is called Identity Verification (IDV). Submit the person for a IDV verification using this API.

ENDPOINT

  1. POST /v1/person/:id/idv

RESPONSE

  1. {
  2.     "id": "idv-5db17028-1e1d-428a-b9d9-e8d4c5058d2a",
  3.     "url": "https://withpersona.com/verify?inquiry-id=inq_8ZtVdVnMCNanbUT5MvFygMeU",
  4.     "status": "notStarted",
  5.     "createdAt": "2021-12-14T22:12:44Z",
  6.     "modifiedAt": "2021-12-14T22:12:45Z"
  7. }

Invoke the URL in your application to complete the identity verification. This URL is used to open a hosted web-view experience, where the user will take a selfie and upload their ID for verification.

You can also re-submit the person for a IDV by passing the personId in this API. If they have an existing inquiry, you can either resume it:

REQUEST

  1. {
  2.   "action": "resume"
  3. }

Or if needed, you can create a new inquiry:

REQUEST

  1. {
  2.   "action": "new"
  3. }

For more details on configuring your app using the Persona Hosted Flow, please see:

https://docs.withpersona.com/docs/hosted-flow