Webhook Events & Outcomes

PRIVO fires various webhook events based on a user's interaction with the system. There are two classifications of events:

Verification Events: Verification events are those events that fire when a user has successfully interacted with the PRIVO Verification Widget. For more information see Verificattion Events.

Verification Match Outcomes:

Outcome	Methods	Description
Pass	Offline/Online	Verification passed. User has successfully verified either by online or offline method and ready to proceed futher
Fail	Online	Verification failed. User provided incorrect verification data
Pending	Offine	Verification submitted for manual review.
Declined	Offine	Verification declined by administrator.
Purged	Offine	Verification rejected by expiration policied configured per partner.

VERIFY_VERIFIED:

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

VERIFY_FAILED:

{
    "webhookId": 1234,
    "event": "VERIFY_FAILED"
    "data": {
        "verified": false,
        "verificationMethod": "CreditCard",
        "matchOutcome": "Fail",
        "matchCode": "AuthorizationFailed",
        "message": null,
        "requestID": "35459",
        "redirectUrl": null,
        "partnerDefinedUniqueID": "(some_identifier)",
        "requestTimestamp": 145245796521,
        "locale": "en_US",
        "identificationNumber": null,
        "attemptId": 99247
        },
    "timestamp" : 1552046947107
}

VERIFY_ACCOUNT:

{
    "webhookId": 1234,
    "event": "VERIFY_ACCOUNT"
    "data": {
        "verified": true,
        "verificationMethod": "PrintForm",
        "matchOutcome": "Pending",
        "matchCode": null,
        "message": null,
        "requestID": "35459",
        "redirectUrl": null,
        "partnerDefinedUniqueID": "(some_identifier)",
        "requestTimestamp": 145245796521,
        "locale": "en_US",
        "identificationNumber": null,
        "serviceId" : "583951746...626b6a51673d3d",
        "attemptId": 99247
}

VERIFY_PENDING:

{
    "webhookId": 1234,
    "event": "VERIFY_PENDING"
    "data": {
        "verified": true,
        "verificationMethod": "PrintForm",
        "matchOutcome": "Pending",
        "matchCode": null,
        "message": null,
        "requestID": "35459",
        "redirectUrl": null,
        "partnerDefinedUniqueID": "(some_identifier)",
        "requestTimestamp": 145245796521,
        "locale": "en_US",
        "identificationNumber": null,
        "attemptId": 99247
}

VERIFY_OFFLINE_VERIFIED:

{
    "webhookId": 1234,
    "event": "VERIFY_OFFLINE_VERIFIED"
    "data": {
        "verified": true,
        "verificationMethod": "Phone",
        "matchOutcome": "Pass",
        "matchCode": null,
        "message": null,
        "requestID": "35459",
        "redirectUrl": null,
        "partnerDefinedUniqueID": "(some_identifier)",
        "requestTimestamp": 145245796521,
        "locale": "en_US",
        "identificationNumber": "HL5KDQ",
        "attemptId": 99247
}

VERIFY_REMOVED:

{
    "webhookId": 1234,
    "event": "VERIFY_REMOVED"
    "data": {
        "verified": false,
        "verificationMethod": "PrintForm",
        "matchOutcome": "Declined",
        "matchCode": null,
        "message": null,
        "requestID": "35459",
        "redirectUrl": null,
        "partnerDefinedUniqueID": "(some_identifier)",
        "requestTimestamp": 145245796521,
        "locale": "en_US",
        "identificationNumber": "Jones",
        "attemptId": 99247
}

VERIFY_PURGED:

{
    "webhookId": 1234,
    "event": "VERIFY_PURGED"
    "data": {
        "verified": false,
        "verificationMethod": "Phone",
        "matchOutcome": "Purged",
        "matchCode": null,
        "message": null,
        "requestID": "35459",
        "redirectUrl": null,
        "partnerDefinedUniqueID": "(some_identifier)",
        "requestTimestamp": 145245796521,
        "locale": "en_US",
        "identificationNumber": "HL5KDQ",
        "attemptId": 99247
}

Consent Events: Consent events are those events that fire when a user has successfully interacted with the PRIVO registration system. Actual status of consent populated via type proprty (see CONSENT_ALL, CONSENT_DECLINE or CONSENT_EXPIRE examples ) and may be one of the following values:

APPROVED * EXPIRED * PENDING * POSTPONED

Outcome	Description
PENDING	Consent process was started bit not finised
EXPIRED	Verification failed. User provided incorrect verification data
DENIED	Consent was rejected by user or his granter
APPROVED	Consent approved by user himself or his granter (depending on a user role/age)
POSTPONED	Consent was postponed as it's not meeting requirements (Offline verification was not approved by admin)

CONSENT_ALL:

{
  "privoEvents:": [
    {
      "webhookId": 1234,
      "event": "CONSENT_ALL",
      "data": {
        "type": "APPROVED",
        "requester": {
          "sub": "76617742356c...4e362f64773d3d",
          "birthdate": "2010-03-05",
          "email_verified": false,
          "role_identifier": "(someDefinedRole)",
          "permissions": [
            {
              "on": true,
              "consent_time": 1.624294042e9,
              "request_time": 1.622745196e9,
              "feature_active": true,
              "feature_id": 2281.0,
              "feature_identifier": "(someDefinedFeatureIdentifier)",
              "feature_category": "Standard",
              "feature_name": "Earn and Share Theme Acheivements"
            },
            ...
          ],
          "verification_tier": "D"
        },
        "approver": {
          "sub": "50707077364a...76477313454513d3d",
          "birthdate": "2003-06-03",
          "email_verified": false,
          "role_identifier": "(someDefinedRole)",
          "verification_tier": "D"
        },
        "requestTimestamp": 1624294042550
      },
      "timestamp": 1624294042572
    }
  ]
}

CONSENT_DECLINE:

{
  "privoEvents:": [
    {
      "webhookId": 1234,
      "event": "CONSENT_DECLINE",
      "data": {
        "type": "DENIED",
        "requester": {
          "sub": "76617742356c...4e362f64773d3d",
          "birthdate": "2010-03-05",
          "email_verified": false,
          "role_identifier": "(someDefinedRole)",
          "permissions": [
            {
              "on": false,
              "consent_time": 1.624294042e9,
              "request_time": 1.622745196e9,
              "feature_active": true,
              "feature_id": 2281.0,
              "feature_identifier": "(someDefinedFeatureIdentifier)",
              "feature_category": "Standard",
              "feature_name": "Earn and Share Theme Acheivements"
            },
            ...
          ],
          "verification_tier": "D"
        },
        "approver": {
          "sub": "50707077364a...76477313454513d3d",
          "birthdate": "2003-06-03",
          "email_verified": false,
          "role_identifier": "(someDefinedRole)",
          "verification_tier": "D"
        },
        "requestTimestamp": 1624294042550
      },
      "timestamp": 1624294042572
    }
  ]
}

CONSENT_EXPIRE:

{
  "privoEvents": [
    {
      "webhookId": 15,
      "event": "CONSENT_EXPIRE",
      "data": {
        "type": "EXPIRED",
        "requester": {
          "sub": "34486677467263423...a7157513d3d",
          "zoneinfo": "America/New_York",
          "locale": "en_US",
          "updated_at": "1688515878",
          "birthdate": "2023-06-13",
          "role_identifier": "(someDefinedRole)",
          "registration_role": "(someDefinedRole)",
          "approved": true,
          "shadow_account": false,
          "site_token": "536b632f462b6d7...43425839773d3d",
          "permissions": [
            {
              "on": false,
              "consent_time": null,
              "request_time": 1686658996,
              "feature_active": true,
              "feature_id": 30308,
              "feature_identifier": "(someDefinedFeatureIdentifier)",
              "feature_category": "Standard",
              "feature_name": "(someDefinedFeatureName)",
              "attributes": []
            }
            ...
          ],
          "verification_tier": "A",
          "user_profile": {
            "birthdate": "2023-06-13",
            "registration_role": "(someDefinedRole)",
            "role_identifier": "(someDefinedRole)",
            "site_token": "536b632f462b6d...3425839773d3d",
            "approved": true,
            "shadow_account": false,
            "verification_tier": "A",
            "attributes": [],
            "display_names": []
          },
          "connected_profiles": []
        },
        "approver": {
          "sub": "696a76674...5548513d3d",
          "zoneinfo": "America/New_York",
          "locale": "en_US",
          "updated_at": "1686659007",
          "birthdate": "2005-06-13",
          "email": "(someEmail)",
          "role_identifier": "(someDefinedRole)",
          "registration_role": "(someDefinedRole)",
          "approved": true,
          "shadow_account": false,
          "site_token": "536b632f462b...39773d3d",
          "verification_tier": "C",
          "user_profile": {
            "registration_role": "(someDefinedRole)",
            "role_identifier": "(someDefinedRole)",
            "site_token": "536b632f46...425839773d3d",
            "approved": true,
            "shadow_account": false,
            "verification_tier": "C",
            "attributes": [],
            "display_names": []
          },
          "connected_profiles": []
        },
        "requestTimestamp": 1688515878205
      },
      "timestamp": 1688515881653
    }
  ]
}

Developer Portal

Webhook Events & Outcomes

Verification Match Outcomes:

Consent Outcomes: