Array API Events

This section lists and describes the webhooks that are triggered when an Array API is invoked.

📘

See How to Receive Webhooks for general information and guidance about webhooks.

OperationEndpointHTTP Status
Users
User CreatedPOST /user/v2201
Authentication
Authentication Question Retrieval SucceededGET /authenticate/v2200
Authentication Question Retrieval FailedGET /authenticate/v2204
Authentication SucceededPOST /authenticate/v2200
Authentication FailedPOST /authenticate/v2401
Custom Authentication SucceededPATCH /authenticate/v2401
User Token GeneratedPOST /authenticate/v2/usertoken200
Authentication Token GeneratedPOST /authenticate/v2/authtoken200
Credit Reports and Scores
Credit Report OrderedPOST /report/v2200
Credit Report RetrievedGET /report/v2200
Credit Report Display Token GeneratedPUT /report/v2200
Credit Score SimulatedPOST /report/v2/score-simulator200
Monitoring
Monitoring Service EnrolledPOST /monitor/v2200
Monitoring Service CancelledDELETE /monitor/v2200
Monitored Element Added (address, bank account, credit card, et al.)POST /monitor/v2/idp/<elementType>201
Monitored Element RemovedDELETE /monitor/v2/idp/<elementType>200

User Created

Sent when a User object is successfully 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 Question Retrieval Succeeded

Sent when authentication questions are successfully retrieved from an authentication provider.

{
  "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",
    "bureau": "tui"
  }
}

Authentication Question Retrieval Failed

{
  "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",
    "bureau": "tui"
  }
}

Authentication Succeeded

{
  "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",
    "bureau": "tui"
  }
}

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",
    "bureau": "tui"
  }
}

Custom Authentication Succeeded

{
  "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
  }
}

User Token Generated

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

Authentication Token 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
  }
}

Credit Report 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",
    "offCycle": "false"
  }
}

Credit Report Retrieved

{
  "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"
  }
}

Credit Report Display Token Generated

{
  "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"
  }
}

Credit Score Simulated

{
  "service": "score-simulator",
  "event": "200",
  "method": "post",
  "path": "/api/report/v2/score-simulator",
  "details": {
    "appKey": "9e864007-e5ee-4f51-b44a-2bfe1acb8e89",
    "userId": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "clientKey": "1q7nWv4CC0Su9b3P8BqAtbnaah7",
    "reportKey": "2185f7c2-e908-4c23-b403-b7a182ae45bb",
    "scoreModifiers": { 
        "modifier1" : "--See below--",
        "modifier2" : "--See below--",
        "modifier3" : "--See below--"
    },
    "change": "-50"
  }
}

In addition to the standard properties, the Credit Score Simulated webhook includes:

  • details.scoreModifiers. Each property in the scoreModifiers object declares a modification to an attribute of the customer's credit report, such as the number of successive on time payments, or the credit limit on a car loan. A new credit score is then calculated given the modified values, and expressed as a delta in the details.change property. The set of modifiers that can be applied depends on the credit bureau that produced the credit report: TransUnion has a slightly larger set of modifiers than Experian. Currently, the score-simulator doesn't apply to Equifax. The modifier objects are listed in the Simulate Credit Score API.

  • details.change. The amount by which the customer's credit score will change after applying the score modifiers.

Monitoring Service Enrolled

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

Monitoring Service Cancelled

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

Monitored Element Added

The form of the webhook that's sent when a customer adds a monitored element (address, bank account, credit card, and so on) is the same regardless of the element type. The only variable is the path value: Each element type has a specific "add an element" resource name.

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

The path URLs that correspond to the element types are:

Element Typepath URL
Bank Account/api/monitoring/v2/idp/bankaccount
Credit Card/api/monitoring/v2/idp/creditcard
Driver License/api/monitoring/v2/idp/driverlicense
Email Address/api/monitoring/v2/idp/email
Medical ID/api/monitoring/v2/idp/medical-id
Passport/api/monitoring/v2/idp/passport
Phone Number/api/monitoring/v2/idp/phone
Postal Address/api/monitoring/v2/idp/address
Social Security Number/api/monitoring/v2/idp/ssn

Monitored Element Removed

{
  "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
  }
}