Verification Webhooks

In addition to webhooks that fire for onVerifyComplete and onVerifyDone events, partners can listen for additional offline webhooks from the PRIVO system for the status of offline verification responses. Webhooks are setup by a PRIVO Administrator at the partner config level.

For additional security, verification webhook responses will return the partner provided API Key back to partner in the webhook response header.

There are multiple types of webhooks that can be utilized. One such method (recommended) is to use the Key/Value Pair. Partner can define a unique API key for their secure endpoint. For more detailed information, see Callbacks / Webhooks.

VERIFY_OFFLINE_VERIFIEDstringWhen PRIVO Administrator approves an offline verification request.
VERIFY_REMOVEDstringWhen PRIVO Administrator declines an offline verification request.
VERIFY_PURGEDstringWhen verification request was purged according to partner defined expiration policy. Default epiration time is - 30 days.

Sample KEY / VALUE response header:

        "User-Agent":"Apache-HttpClient/4.5.4 (Java/1.8.0_212)",
        "Accept":"text/plain, application/json, application/*+json, */*",

Sample webhook response:

  "webhookId": 1234,
  "event": "VERIFY_VERIFIED"
  "data": {
    "verified": true,
    "transactionID": "45914"
    "verificationMethod": "SSN",
    "matchOutcome": "Pass",
    "matchCode": "6",
    "message": null,
    "requestID": "35459",
    "redirectUrl": null,
    "partnerDefinedUniqueID": "(some_identifier)",
    "requestTimestamp": 145245796521,
    "locale": "en_US",
    "identificationNumber": null,
    "attemptId": 99247