Auto (GetBureau) Interface Design v1.1
Auto (GetBureau) Interface Design v1.1
(GetBureau Method)
Technical Specification
Webservice Overview and JSON examples
Version 1.1
Contents
1. Endpoint Details.................................................................................................................... 3
1.1. Webservice Validation .......................................................................................................... 3
2. Data Contract........................................................................................................................ 3
2.1. Service Request .................................................................................................................... 3
2.2. Service Response .................................................................................................................. 3
2.3. Service Response (if errors)................................................................................................... 4
2.3.1. References ............................................................................................................................ 4
2.3.2. Error ..................................................................................................................................... 4
3. Example JSON Request/Responses........................................................................................ 5
3.1. Error ..................................................................................................................................... 5
3.2. Working response without FBL data ...................................................................................... 6
Scenario ErrorCode
AutoSubmissionID submitted is not valid for the AUTO0421
credentials
AutoSubmissionID is from outside allowable time of AUTO0420
bureau-data retrieval
2. Data Contract
The following outlines the list of fields that are accepted in the request, and returned in the response.
2.3.1. References
Field Type Information
CallStatus Enumeration Values:
Success, Failure, Error
EnquiryDate DateTime CCYY-MM-DD HH:MI:SS
FlowID Integer Reference from HD Service
2.3.2. Error
Field Type Information
ErrorCode String A reference to an internal error code
Message String Details of the error message
Response
{
"errors": [
{
"errorCode": "AUTO0420",
"message": "There was no bureau validation setup found or the valid date has expired."
}
],
"references": {
"callStatus": "Error",
"enquiryDate": "2021-07-20T14:51:49.8601446+01:00",
"submissionID": 0,
"flowID": 64832615
}
}
NOTE: This response covers the generic format for an error response from the service. A full list of ErrorCodes and Messages is kept
separately from this document, and can be provided where required.
Response
{
"GetBureauRequestID": 8249,
"ConsumerSummary": {
"CATO": {
"SPI42": "0",
"SPI43": "0",
"SPI44": "46",
"SPI45": "203",
"SPI46": "113504",
"SPI47": "4",
"SPI48": "14",
"SPI49": "28",
"SPI50": "6",
"SPI51": "18",
"SPI52": "42",
"SPI53": "14",
"SPJ54": "-2",
"SPJ55": "-2",
"SPJ56": "-2",
"SPJ58": "-2",
"SPJ60": "-2",
"SPJ61": "-2",
"SPJ62": "-2",
"SPJ63": "-2",
"SPJ65": "-2",
"SPK69": "-9999999",
"SPK70": "-9999999",
"SPK71": "-9999999",
"SPK72": "-9999999",
"SPK73": "-9999999",
"SPK74": "-9999999",
"SPK75": "-9999999",
"SPK76": "-9999999",
"SPK77": "-9999999",
"SPL78": "-9999999",
"SPL79": "-9999999",
"SPL80": "-9999999",
"SPL81": "-99",
"SPL82": "-9999999",
"SPL83": "-9999999",
"SPL84": "-9999999",
"SPL85": "-99",
"SPM86": "-2",
"SPM87": "-9",