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.
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 or CONSENT_DECLINE examples at the right section) and may be one of the following values:
- APPROVED * EXPIRED * PENDING * POSTPONED
For more information see Consent 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_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
}
]
}