🚧

TransUnion information may not be transmitted by Array to Array clients or third parties, nor may Array clients access, view, share, process, or store TransUnion information.

This operation lets you order credit reports for multiple customers. You specify the customers and the type of credit report for each through an unnamed array of objects in the request body. For example:

[
  {
    "clientKey": "abcd-1234-defgh-5678", 
    "productCode": "exp1bScore" 
  },
  {
    "clientKey": "ijkl-9012-mnop-3456",
    "productCode": "tui1bReportScore"
  },
  {
    "clientKey": "qrst-7890-uvwx-1234",
    "productCode": "credmo3bReportScore"
  }
]

There's no internal restriction on the number of elements in the array; it has successfully fulfilled 500+ orders at a time.

The response body returns your array with some additional properties:

[
  {
    "clientKey": "abcd-1234-defgh-5678",
    "productCode": "exp1bScore",
    "error": 0,
    "displayToken": "2148251b-fa9d-4e5e-bf2a-ac30f7d42f8c",
    "reportKey": "2fcba257-2d08-4c69-92a7-870682e5daed"
  },
  {
    "clientKey": "ijkl-9012-mnop-3456",
    "productCode": "tui1bReportScore",
    "error": 401,
    "displayToken": null,
    "reportKey": null
  },
  {
    "clientKey": "qrst-7890-uvwx-1234",
    "productCode": "credmo3bReportScore",
    "error": 0,
    "displayToken": "c23840a0-2c43-4370-b159-6582571275aa",
    "reportKey": "6c30d771-2328-4095-9550-7ee5ced215ed"
  }
]

The error property is the focal point of an entry in the response array:

  • If error is 0, the report order was successfully fulfilled. The displayToken and reportKey properties are populated with values that you'll use when you retrieve the report.

  • Any other error value means the report order wasn't fulfilled and can't be retrieved. The values themselves (400, 401, 403, and so on) mimic the HTTP status values for the Order a Credit Report operation. For example, in the snippet above, the "error": 401 entry means that the customer identified by ijkl-9012-mnop-3456 hasn't been authenticated.

The fulfilled credit reports must be retrieved individually through repeated calls to Retrieve a Credit Report.

NOTE This operation may only be called from your server. It can't be called from a customer's device.

Language
Click Try It! to start a request and see the response here!