Webhook Events

ServiceMethodEvent
userpost201
authenticateget200
authenticateget204
authenticatepost200
authenticatepost401
authenticatepatch200
authenticate/usertokenpost200
authenticate/authtokenpost200
reportpost200
reportget200
reportput200
offerspost200
offersget200
monitoringpost200
monitoringdelete200
monitoringpushpush
monitoringpushpush
alertspushpush

Details & Examples

User was created:

{
  "service": "user",
  "event": 201,
  "method": "post",
  "path": "/api/user/v2",
  "details": {
    "appKey": "9e864007-e5ee-4f51-b44a-2bfe1acb8e89",
    "clientKey": "7f195762-c465-431b-887e-83560e04d1c0",
    "firstName": "Thomas",
    "lastName": "Friedman",
    "address": {
      "street": "535 30 RD A",
      "city": "Grand Junction",
      "state": "CO",
      "zip": "81504"
    }
  }
}

Authentication questions were returned:

{
  "service": "authenticate",
  "event": 200,
  "method": "get",
  "path": "/api/authenticate/v2",
  "details": {
    "appKey": "9e864007-e5ee-4f51-b44a-2bfe1acb8e89",
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "authToken": "135409c0-e5ff-4f4f-8b7f-4672605f6aaf"
  }
}

Authentication questions cannot be returned:

{
  "service": "authenticate",
  "event": 204,
  "method": "get",
  "path": "/api/authenticate/v2",
  "details": {
    "appKey": "9e864007-e5ee-4f51-b44a-2bfe1acb8e89",
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "authToken": "135409c0-e5ff-4f4f-8b7f-4672605f6aaf"
  }
}

Authentication was successful:

{
  "service": "authenticate",
  "event": 200,
  "method": "post",
  "path": "/api/authenticate/v2",
  "details": {
    "appKey": "9e864007-e5ee-4f51-b44a-2bfe1acb8e89",
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "authToken": "135409c0-e5ff-4f4f-8b7f-4672605f6aaf",
    "userToken": "73b55ac8-96e1-43d7-b3e2-b9ef57886c95"
  }
}

Authentication failed:

{
  "service": "authenticate",
  "event": 401,
  "method": "post",
  "path": "/api/authenticate/v2",
  "details": {
    "appKey": "9e864007-e5ee-4f51-b44a-2bfe1acb8e89",
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "authToken": "135409c0-e5ff-4f4f-8b7f-4672605f6aaf"
  }
}

Authentication patch was successful:

{
  "service": "authenticate",
  "event": 200,
  "method": "patch",
  "path": "/api/authenticate/v2",
  "details": {
  "appKey": "9e864007-e5ee-4f51-b44a-2bfe1acb8e89",
  "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
  "authToken": "135409c0-e5ff-4f4f-8b7f-4672605f6aaf"
    "ttlInMinutes": 15
  }
}

New user token was successfully generated:

{
  "service": "authenticate",
  "event": 200,
  "method": "patch",
  "path": "/api/authenticate/v2/usertoken",
  "details": {
    "appKey": "9e864007-e5ee-4f51-b44a-2bfe1acb8e89",
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "authToken": "135409c0-e5ff-4f4f-8b7f-4672605f6aaf",
    "ttlInMinutes": 15
  }
}

New authentication token was successfully generated:

{
  "service": "authenticate",
  "event": 200,
  "method": "post",
  "path": "/api/authenticate/v2/authtoken",
  "details": {
    "appKey": "9e864007-e5ee-4f51-b44a-2bfe1acb8e89",
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "authToken": "135409c0-e5ff-4f4f-8b7f-4672605f6aaf",
    "ttlInMinutes": 15
  }
}

Report was ordered:

{
  "service": "report",
  "event": 200,
  "method": "post",
  "path": "/api/report/v2",
  "details": {
    "appKey": "9e864007-e5ee-4f51-b44a-2bfe1acb8e89",
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "displayToken": "2185f7c2-e908-4c23-b403-b7a182ae45bb",
    "productCode": "tui1bReport",
    "reportKey": "0c09b3ef-883a-490a-9e98-25a0ade91b4d"
  }
}

Report was successfully displayed:

{
  "service": "report",
  "event": 200,
  "method": "get",
  "path": "/api/report/v2",
  "details": {
    "appKey": "9e864007-e5ee-4f51-b44a-2bfe1acb8e89",
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "displayToken": "2185f7c2-e908-4c23-b403-b7a182ae45bb",
    "productCode": "tui1bReport",
    "reportKey": "0c09b3ef-883a-490a-9e98-25a0ade91b4d"
  }
}

Report refresh display token:

{
  "service": "report",
  "event": 200,
  "method": "put",
  "path": "/api/report/v2",
  "details": {
    "appKey": "9e864007-e5ee-4f51-b44a-2bfe1acb8e89",
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "displayToken": "2185f7c2-e908-4c23-b403-b7a182ae45bb",
    "productCode": "tui1bReport",
    "reportKey": "0c09b3ef-883a-490a-9e98-25a0ade91b4d"
  }
}

Offers report was ordered and successfully returned:

Note: The decisionParams and result fields can differ from one offers-decision product to another.

{
  "service": "offers",
  "event": 200,
  "method": "post",
  "path": "/api/offers/v2",
  "details": {
    "appKey": "9e864007-e5ee-4f51-b44a-2bfe1acb8e89",
    "offerId": "99fd0e9b-a76e-411c-88be-061c55f19170",
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "firstName": "Patrick",
    "lastName": "Ihnken",
    "address": {
      "street": "32386 NW 210 RD",
      "city": "Jetmore",
      "state": "KS",
      "zip": "67854"
    },
    "productCode": "offers-999999-decision-3",
    "userConsent": {
      "ipAddress": "172.03.89.100",
      "timestamp": "2020-03-04T12:12:12.000Z",
      "url": "verysecure.com"
    },
    "decisionParams": {
      "monthlyGrossIncome": "12345",
      "dateApplied": "9/1/2020"
    },
    "result": {
      "name": "PATRICK E IHNKEN",
      "dateApplied": null,
      "dateReportGenerated": "2015-06-09",
      "creditScore": "680-700",
      "creditRating": "Good",
      "currentMortgage": "540000-560000",
      "currentMortgagePayment": "4500-4600",
      "debt": 8200,
      "income": null,
      "dti": null,
      "debtAnalysis": {
        "revolvingAccounts": {
          "balance": "152000-153000",
          "monthlyPayment": "100-200",
          "paymentsRemaining": "N/A"
        },
        "studentLoans": {
          "balance": "0-1000",
          "monthlyPayment": "0-100",
          "paymentsRemaining": 0
        },
        "autoFinance": {
          "balance": "41000-42000",
          "monthlyPayment": "1000-1100",
          "paymentsRemaining": 109
        },
        "installmentLoans": {
          "balance": "316000-317000",
          "monthlyPayment": "6900-7000",
          "paymentsRemaining": 366
        },
        "allDebt": {
          "balance": "510000-511000",
          "monthlyPayment": "8200-8300",
          "paymentsRemaining": "N/A"
        }
      },
      "latePayments": {
        "mortgage": {
          "late30DaysCount": 0,
          "late60DaysCount": 0,
          "late90DaysCount": 0
        },
        "revolvingAccounts": {
          "late30DaysCount": 0,
          "late60DaysCount": 0,
          "late90DaysCount": 0
        },
        "studentLoans": {
          "late30DaysCount": 0,
          "late60DaysCount": 0,
          "late90DaysCount": 0
        },
        "autoFinance": {
          "late30DaysCount": 0,
          "late60DaysCount": 0,
          "late90DaysCount": 0
        },
        "installmentLoans": {
          "late30DaysCount": 0,
          "late60DaysCount": 0,
          "late90DaysCount": 0
        }
      },
      "derogatoryAccounts": {
        "openCollections": 0,
        "foreclosures": 0,
        "bankruptcies": 0,
        "reposessions": 0
      },
      "inquiries": []
    }
  }
}

Offers report was successfully displayed:

Note: The result field can differ from one offers-decision product to another.

{
  "service": "offers",
  "event": 200,
  "method": "get",
  "path": "/api/offers/v2",
  "details": {
    "appKey": "9e864007-e5ee-4f51-b44a-2bfe1acb8e89",
    "offerId": "99fd0e9b-a76e-411c-88be-061c55f19170",
    "displayToken": "2185f7c2-e908-4c23-b403-b7a182ae45bb",
    "result": {
      "name": "PATRICK E IHNKEN",
      "dateApplied": null,
      "dateReportGenerated": "2015-06-09",
      "creditScore": "680-700",
      "creditRating": "Good",
      "currentMortgage": "540000-560000",
      "currentMortgagePayment": "4500-4600",
      "debt": 8200,
      "income": null,
      "dti": null,
      "debtAnalysis": {
        "revolvingAccounts": { "balance": "152000-153000", "monthlyPayment": "100-200", "paymentsRemaining": "N/A" },
        "studentLoans": { "balance": "0-1000", "monthlyPayment": "0-100", "paymentsRemaining": 0 },
        "autoFinance": { "balance": "41000-42000", "monthlyPayment": "1000-1100", "paymentsRemaining": 109 },
        "installmentLoans": { "balance": "316000-317000", "monthlyPayment": "6900-7000", "paymentsRemaining": 366 },
        "allDebt": { "balance": "510000-511000", "monthlyPayment": "8200-8300", "paymentsRemaining": "N/A" }
      },
      "latePayments": {
        "mortgage": { "late30DaysCount": 0, "late60DaysCount": 0, "late90DaysCount": 0 },
        "revolvingAccounts": { "late30DaysCount": 0, "late60DaysCount": 0, "late90DaysCount": 0 },
        "studentLoans": { "late30DaysCount": 0, "late60DaysCount": 0, "late90DaysCount": 0 },
        "autoFinance": { "late30DaysCount": 0, "late60DaysCount": 0, "late90DaysCount": 0 },
        "installmentLoans": { "late30DaysCount": 0, "late60DaysCount": 0, "late90DaysCount": 0 }
      },
      "derogatoryAccounts": { "openCollections": 0, "foreclosures": 0, "bankruptcies": 0, "reposessions": 0 },
      "inquiries": []
    }
  }
}

Monitoring was added for user:

{
  "service": "monitoring",
  "event": 200,
  "method": "post",
  "path": "/api/monitoring/v2",
  "details": {
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "userId": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "enrollmentCode": "tui1bStandardMonitoring"
  }
}

Monitoring was cancelled for user:

{
  "service": "monitoring",
  "event": 200,
  "method": "delete",
  "path": "/api/monitoring/v2",
  "details": {
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "userId": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "enrollmentCode": "tui1bStandardMonitoring"
  }
}

Monitoring IDP Add Address Monitor:

{
  "service": "monitoring",
  "event": 201,
  "method": "post",
  "path": "/api/monitoring/v2/idp/address",
  "details": {
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "userId": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "appKey": "fdae239e-96d7-41d8-9b91-a5983041d961"
  }
}

Monitoring IDP Add Bank Account Monitor:

{
  "service": "monitoring",
  "event": 201,
  "method": "post",
  "path": "/api/monitoring/v2/idp/bankaccount",
  "details": {
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "userId": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "appKey": "fdae239e-96d7-41d8-9b91-a5983041d961"
  }
}

Monitoring IDP Add Credit Card Monitor:

{
  "service": "monitoring",
  "event": 201,
  "method": "post",
  "path": "/api/monitoring/v2/idp/creditcard",
  "details": {
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "userId": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "appKey": "fdae239e-96d7-41d8-9b91-a5983041d961"
  }
}

Monitoring IDP Add Drivers License Monitor:

{
  "service": "monitoring",
  "event": 201,
  "method": "post",
  "path": "/api/monitoring/v2/idp/driverlicense",
  "details": {
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "userId": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "appKey": "fdae239e-96d7-41d8-9b91-a5983041d961"
  }
}

Monitoring IDP Add Email Monitor:

{
  "service": "monitoring",
  "event": 201,
  "method": "post",
  "path": "/api/monitoring/v2/idp/email",
  "details": {
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "userId": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "appKey": "fdae239e-96d7-41d8-9b91-a5983041d961"
  }
}

Monitoring IDP Add Medical ID Monitor:

{
  "service": "monitoring",
  "event": 201,
  "method": "post",
  "path": "/api/monitoring/v2/idp/medical-id",
  "details": {
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "userId": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "appKey": "fdae239e-96d7-41d8-9b91-a5983041d961"
  }
}

Monitoring IDP Add Passport Monitor:

{
  "service": "monitoring",
  "event": 201,
  "method": "post",
  "path": "/api/monitoring/v2/idp/passport",
  "details": {
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "userId": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "appKey": "fdae239e-96d7-41d8-9b91-a5983041d961"
  }
}

Monitoring IDP Add Phone Monitor:

{
  "service": "monitoring",
  "event": 201,
  "method": "post",
  "path": "/api/monitoring/v2/idp/phone",
  "details": {
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "userId": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "appKey": "fdae239e-96d7-41d8-9b91-a5983041d961"
  }
}

Monitoring IDP Add SSN Monitor:

{
  "service": "monitoring",
  "event": 201,
  "method": "post",
  "path": "/api/monitoring/v2/idp/ssn",
  "details": {
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "userId": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "appKey": "fdae239e-96d7-41d8-9b91-a5983041d961"
  }
}

Monitoring IDP Remove Monitor:

{
  "service": "monitoring",
  "event": 200,
  "method": "delete",
  "path": "/api/monitoring/v2/idp/monitor",
  "details": {
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "userId": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "appKey": "fdae239e-96d7-41d8-9b91-a5983041d961",
    "monitorId": 1234
  }
}

Credit report dispute alert for a user:

{
  "service": "alerts",
  "event": "push",
  "method": "push",
  "details": {
    "alertDetails": {
      "disputeStatus": "Completion"
    },
    "alertId": 51793712,
    "appKey": "9e864007-e5ee-4f51-b44a-2bfe1acb8e89",
    "bureau": "tui",
    "alertType": "DisputeAlert",
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7"
  }
}

Credit report dispute v2 alert for a user:

{
  "service": "alerts",
  "event": "push",
  "method": "push",
  "details": {
    "alertDetails": {
      "disputeStatus": "Completion"
    },
    "alertId": 51793712,
    "appKey": "9e864007-e5ee-4f51-b44a-2bfe1acb8e89",
    "bureau": "tui",
    "alertType": "DisputeAlert",
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7"
  }
}

Identity protection alert for a user:

{
  "service": "alerts",
  "event": "push",
  "method": "push",
  "details": {
    "alertType": "IDPAlert",
    "alertId": 51793712,
    "appKey": "9e864007-e5ee-4f51-b44a-2bfe1acb8e89",
    "bureau": "idp",
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7"
  }
}

Credit monitoring alert for a user:

Click here to look at all the alert types available. Please check Webhook examples on the page.