Skip to main content

IDV Manually Reviewed

This webhook is triggered when an identity verification (IDV) result has been manually reviewed by a creditor. The webhook fires after a reviewer makes a PASS or FAIL decision on an applicant's identity verification, allowing integrations to react to the outcome of the manual review.

Configuration​

To receive this webhook, set the idvManuallyReviewed callback URL in your integration settings.

Request Body​

The request body is a JSON object with the following properties:

  • retailerId (string, uuid, required): The ID of the retailer associated with the application.
  • applicationId (string, uuid, required): The ID of the application.
  • applicantId (string, uuid, required): The ID of the applicant whose identity verification was reviewed.
  • decision (string, enum, required): The outcome of the manual review. One of: PASS, FAIL.
  • reviewComment (string, nullable): An optional comment provided by the reviewer explaining the decision. Will be null if no comment was provided.
  • isSecondary (boolean, required): Whether the reviewed applicant is a co-applicant (true) or the primary applicant (false).

Example Request Body​

{
  "retailerId": "ebed869d-bdf4-4b0a-8442-5b8f23753247",
  "applicationId": "3aad1c88-a898-460f-b2c7-5f4145250489",
  "applicantId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "decision": "PASS",
  "reviewComment": null,
  "isSecondary": false
}

Response​

We ask that all webhooks return 200 OK status codes to confirm receipt of the webhook. We ask that unless the server is down errors to be logged and still return a 200 OK status code. If the webhook does not return a 200 OK status code, we will retry the webhook up to 10 times with an exponential backoff.