✳️XDS - Customer Credit Report and Score

With the existing Credit Bureau integration, you are able to retrieve a Customer's Credit Report providing a detailed summary of the customers credit payment history and Credit Score.

Get Credit Report and Score

GET {{baseUrl}}/customers/:customer_id/xds-credit-report

💻 Path Parameters

Name
Type
Description

customer_id*

String

This is UUID for a specific customer that gets generated and returned in the POST Create New Customer response.

📤 API Responses

200 - OK
{
    "data": {
        "id": "74ae008c-5a98-4910-9d80-86ed5d2972fd",
        "xml_response_full": {
            "ReportInformation": {
                "ReportID": "1",
                "ReportName": "Consumer Credit Report"
            },
            "ConsumerDirectorSummary": {
                "DisplayText": "Consumer Director Summary",
                "NumberOfCompanyDirector": "0"
            },
            "ConsumerEnquiryHistory": {
                "DisplayText": "Consumer Enquiry History",
                "EnquiryDate": "2023-02-16",
                "SubscriberName": "Fin Choice WS",
                "SubscriberBusinessTypeDesc": "Personal Finance",
                "CreditGrantorEnquiryReasonDesc": [],
                "SubscriberContact": "011645 9100"
            },
            "ConsumerAddressHistory": [
                {
                    "DisplayText": "Consumer Address History",
                    "ConsumerAddressID": "824629378",
                    "AddressType": "Residential",
                    "AddressTypeInd": "R",
                    "Address1": "27 LANNER STREET",
                    "Address2": "PARKDENE",
                    "Address3": [],
                    "Address4": "BOKSBURG",
                    "PostalCode": "1459",
                    "Address": "27 LANNER STREET PARKDENE BOKSBURG 1459",
                    "LastUpdatedDate": "2022-06-29",
                    "FirstReportedDate": "2022-06-29"
                },
                {
                    "DisplayText": "Consumer Address History",
                    "ConsumerAddressID": "794016639",
                    "AddressType": "Residential",
                    "AddressTypeInd": "R",
                    "Address1": "3 ON BEAUFORT",
                    "Address2": "3 BEAUFORT ROAD",
                    "Address3": "WOODMEAD-OOS BRYANSTON",
                    "Address4": "WOODMEAD-OOS BRYANSTON",
                    "PostalCode": "2191",
                    "Address": "3 ON BEAUFORT 3 BEAUFORT ROAD WOODMEAD-OOS BRYANSTON WOODMEAD-OOS BRYANSTON 2191",
                    "LastUpdatedDate": "2021-04-17",
                    "FirstReportedDate": "2021-03-16"
                },
                {
                    "DisplayText": "Consumer Address History",
                    "ConsumerAddressID": "824629488",
                    "AddressType": "Postal",
                    "AddressTypeInd": "P",
                    "Address1": "27 LANNER ST",
                    "Address2": [],
                    "Address3": [],
                    "Address4": "PARKDENE EXT 2",
                    "PostalCode": "1459",
                    "Address": "27 LANNER ST PARKDENE EXT 2 1459",
                    "LastUpdatedDate": "2022-06-29",
                    "FirstReportedDate": "2022-06-29"
                }
            ],
            "ConsumerTelephoneHistory": [
                {
                    "DisplayText": "Consumer Telephone History",
                    "ConsumerTelephoneID": "578198471",
                    "TelephoneType": "Cellular",
                    "TelephoneTypeInd": "C",
                    "TelCode": "06X",
                    "TelNo": "XXXXXXX",
                    "TelephoneNo": "XXXXXXXXX",
                    "EmailAddress": [],
                    "LastUpdatedDate": "2022-06-29",
                    "FirstReportedDate": "2022-04-11"
                },
                {
                    "DisplayText": "Consumer Telephone History",
                    "ConsumerTelephoneID": "555984011",
                    "TelephoneType": "Work",
                    "TelephoneTypeInd": "W",
                     "TelCode": "06X",
                    "TelNo": "XXXXXXX",
                    "TelephoneNo": "XXXXXXXXX",
                    "EmailAddress": [],
                    "LastUpdatedDate": "2021-01-14",
                    "FirstReportedDate": "2021-01-13"
                },
                {
                    "DisplayText": "Consumer Telephone History",
                    "ConsumerTelephoneID": "555984077",
                    "TelephoneType": "Cellular",
                    "TelephoneTypeInd": "C",
                     "TelCode": "06X",
                    "TelNo": "XXXXXXX",
                    "TelephoneNo": "XXXXXXXXX",
                    "EmailAddress": [],
                    "LastUpdatedDate": "2021-01-14",
                    "FirstReportedDate": "2021-01-13"
                },
                {
                    "DisplayText": "Consumer Telephone History",
                    "ConsumerTelephoneID": "551158465",
                    "TelephoneType": "Cellular",
                    "TelephoneTypeInd": "C",
                    "TelCode": "06X",
                    "TelNo": "XXXXXXX",
                    "TelephoneNo": "XXXXXXXXX",
                    "EmailAddress": [],
                    "LastUpdatedDate": "2020-11-04",
                    "FirstReportedDate": "2016-02-16"
                },
                {
                    "DisplayText": "Consumer Telephone History",
                    "ConsumerTelephoneID": "515076886",
                    "TelephoneType": "Cellular",
                    "TelephoneTypeInd": "C",
                    "TelCode": "0XX",
                    "TelNo": "XX48XX",
                    "TelephoneNo": "0XXX448XXX",
                    "EmailAddress": [],
                    "LastUpdatedDate": "2019-01-23",
                    "FirstReportedDate": "2016-02-16"
                }
            ],
            "ConsumerEmploymentHistory": [
                {
                    "DisplayText": "Consumer Employment History",
                    "EmployerDetail": "CONVERGENCE THREE PTY LTD",
                    "Designation": [],
                    "LastUpdatedDate": "2021-02-05",
                    "FirstReportedDate": "2021-01-13"
                },
                {
                    "DisplayText": "Consumer Employment History",
                    "EmployerDetail": "DELOITTE CONSULTING",
                    "Designation": [],
                    "LastUpdatedDate": "2016-04-13",
                    "FirstReportedDate": "2016-02-16"
                }
            ],
            "ConsumerDetail": {
                "DisplayText": "Consumer Detail",
                "ConsumerID": "146032664",
                "Initials": "JD",
                "FirstName": "JANE",
                "SecondName": "[]",
                "ThirdName": [],
                "Surname": "DOE",
                "MaidenName": [],
                "IDNo": "XXXXXXXXXXXXX",
                "PassportNo": [],
                "BirthDate": "19XX-XX-XX",
                "Gender": "Female",
                "TitleDesc": "Miss",
                "MaritalStatusDesc": "Single",
                "PrivacyStatus": "ACCEPTS CONTACTS",
                "ResidentialAddress": "27 APPLE STREET LIBRADENE BRAKPAN 1459",
                "PostalAddress": "27 APPLE STREET LIBRADENE BRAKPAN 1459",
                "HomeTelephoneNo": "011XX64XXX",
                "WorkTelephoneNo": "011XX7XX0",
                "CellularNo": "0661826290",
                "EmailAddress": [],
                "EmployerDetail": "CONVERGENCE THREE PTY LTD",
                "ReferenceNo": "C58233156-146032664",
                "ExternalReference": [],
                "SpouseFirstName": [],
                "SpouseSurName": []
            },
            "ConsumerFraudIndicatorsSummary": {
                "DisplayText": "Consumer Fraud Indicators Summary",
                "SAFPSListingYN": "No access - SAFPS Members only",
                "HomeAffairsVerificationYN": "Yes",
                "HomeAffairsDeceasedStatus": "No",
                "EmployerFraudVerificationYN": [],
                "ProtectiveVerificationYN": [],
                "HomeAffairsDeceasedDate": []
            },
            "ConsumerScoring": {
                "DisplayText": "Consumer Scoring",
                "SubscriberID": "130565",
                "Unique_Identifier": "146032664",
                "ScoreDate": "2023-06-13",
                "FinalScore": "0.0000",
                "Exception_Code": "LACK OF USABLE ACCOUNT INFORMATION",
                "ReasonCode1": [],
                "ReasonCode2": [],
                "ReasonCode3": [],
                "ModelID": [],
                "classification": "Classification: Low Rating",
                "Description": "Consumer has LOW probability of collection",
                "RiskCategory": "Potential High Risk"
            },
            "ConsumerPropertyInformationSummary": {
                "DisplayText": "Consumer Property Information Summary",
                "TotalProperty": "0",
                "PurchasePrice": "0.0000"
            },
            "AccountTypeLegend": [
                {
                    "DisplayText": "AccountType Legend",
                    "AccountTypeCode": "B",
                    "AccountTypeDesc": "Building Loan"
                },
                {
                    "DisplayText": "AccountType Legend",
                    "AccountTypeCode": "C",
                    "AccountTypeDesc": "Credit Card"
                },
                {
                    "DisplayText": "AccountType Legend",
                    "AccountTypeCode": "D",
                    "AccountTypeDesc": "Debt Recovery"
                },
                {
                    "DisplayText": "AccountType Legend",
                    "AccountTypeCode": "E",
                    "AccountTypeDesc": "Single Credit Facility"
                },
                {
                    "DisplayText": "AccountType Legend",
                    "AccountTypeCode": "F",
                    "AccountTypeDesc": "Open Account"
                },
                {
                    "DisplayText": "AccountType Legend",
                    "AccountTypeCode": "G",
                    "AccountTypeDesc": "Garage Card"
                },
                {
                    "DisplayText": "AccountType Legend",
                    "AccountTypeCode": "H",
                    "AccountTypeDesc": "Home Loan"
                },
                {
                    "DisplayText": "AccountType Legend",
                    "AccountTypeCode": "I",
                    "AccountTypeDesc": "Instalment Account"
                },
                {
                    "DisplayText": "AccountType Legend",
                    "AccountTypeCode": "J",
                    "AccountTypeDesc": "Unsecured Revolving Loan"
                },
                {
                    "DisplayText": "AccountType Legend",
                    "AccountTypeCode": "K",
                    "AccountTypeDesc": "Unsecured Term Loan"
                },
                {
                    "DisplayText": "AccountType Legend",
                    "AccountTypeCode": "L",
                    "AccountTypeDesc": "Life Insurance"
                },
                {
                    "DisplayText": "AccountType Legend",
                    "AccountTypeCode": "N",
                    "AccountTypeDesc": "Pension Backed Lending"
                },
                {
                    "DisplayText": "AccountType Legend",
                    "AccountTypeCode": "O",
                    "AccountTypeDesc": "Open Account"
                },
                {
                    "DisplayText": "AccountType Legend",
                    "AccountTypeCode": "P",
                    "AccountTypeDesc": "Personal Cash Loan"
                },
                {
                    "DisplayText": "AccountType Legend",
                    "AccountTypeCode": "R",
                    "AccountTypeDesc": "Revolving Credit"
                },
                {
                    "DisplayText": "AccountType Legend",
                    "AccountTypeCode": "S",
                    "AccountTypeDesc": "Short Term Insurance"
                },
                {
                    "DisplayText": "AccountType Legend",
                    "AccountTypeCode": "T",
                    "AccountTypeDesc": "Student Loans"
                },
                {
                    "DisplayText": "AccountType Legend",
                    "AccountTypeCode": "U",
                    "AccountTypeDesc": "Utility"
                },
                {
                    "DisplayText": "AccountType Legend",
                    "AccountTypeCode": "V",
                    "AccountTypeDesc": "Overdraft"
                }
            ],
            "ConsumerAccountStatus": [
                {
                    "DisplayText": "Consumer Account Status",
                    "ConsumerAccountID": "361393120",
                    "SubscriberID": "194",
                    "AccountNo": "XXXX360907XXXX0",
                    "SubAccountNo": [],
                    "AccountOpenedDate": "2022-04-11",
                    "SubscriberName": "FNB Credit Card",
                    "CreditLimitAmt": "30000.0000",
                    "CurrentBalanceAmt": "0.0000",
                    "MonthlyInstalmentAmt": "0.0000",
                    "ArrearsAmt": "0.0000",
                    "ArrearsTypeInd": [],
                    "AccountType": "C",
                    "LastPaymentDate": [],
                    "StatusCodeDesc": "Active",
                    "DeferredPaymentDate": [],
                    "ThirdPartyName": [],
                    "NoOfParticipantsInJointLoan": "0"
                },
                {
                    "DisplayText": "Consumer Account Status",
                    "ConsumerAccountID": "333199939",
                    "SubscriberID": "383",
                    "AccountNo": "8XXX5543XXX",
                    "SubAccountNo": [],
                    "AccountOpenedDate": "2021-01-13",
                    "SubscriberName": "Wesbank Motor Loans",
                    "CreditLimitAmt": "288708.0000",
                    "CurrentBalanceAmt": "185467.0000",
                    "MonthlyInstalmentAmt": "4157.0000",
                    "ArrearsAmt": "0.0000",
                    "ArrearsTypeInd": [],
                    "AccountType": "I",
                    "LastPaymentDate": "2022-06-25",
                    "StatusCodeDesc": "Active",
                    "DeferredPaymentDate": [],
                    "ThirdPartyName": [],
                    "NoOfParticipantsInJointLoan": "0"
                },
                {
                    "DisplayText": "Consumer Account Status",
                    "ConsumerAccountID": "252181163",
                    "SubscriberID": "93",
                    "AccountNo": "XXXX2704XX11XXXX",
                    "SubAccountNo": [],
                    "AccountOpenedDate": "2016-02-16",
                    "SubscriberName": "Absa Credit Card",
                    "CreditLimitAmt": "15000.0000",
                    "CurrentBalanceAmt": "207.0000",
                    "MonthlyInstalmentAmt": "80.0000",
                    "ArrearsAmt": "0.0000",
                    "ArrearsTypeInd": [],
                    "AccountType": "C",
                    "LastPaymentDate": "2022-04-20",
                    "StatusCodeDesc": "Active",
                    "DeferredPaymentDate": [],
                    "ThirdPartyName": [],
                    "NoOfParticipantsInJointLoan": "0"
                },
                {
                    "DisplayText": "Consumer Account Status",
                    "ConsumerAccountID": "338397548",
                    "SubscriberID": "2",
                    "AccountNo": "I8244256",
                    "SubAccountNo": [],
                    "AccountOpenedDate": "2021-03-16",
                    "SubscriberName": "Vodacom",
                    "CreditLimitAmt": "0.0000",
                    "CurrentBalanceAmt": "0.0000",
                    "MonthlyInstalmentAmt": "0.0000",
                    "ArrearsAmt": "0.0000",
                    "ArrearsTypeInd": [],
                    "AccountType": "F",
                    "LastPaymentDate": "2022-04-08",
                    "StatusCodeDesc": "Closed",
                    "DeferredPaymentDate": [],
                    "ThirdPartyName": [],
                    "NoOfParticipantsInJointLoan": "0"
                }
            ],
            "Consumer24MonthlyPaymentHeader": {
                "DisplayText": "Consumer 24 Monthly Payment Header",
                "Company": "Company",
                "M24": "JUL 2021",
                "M23": "AUG 2021",
                "M22": "SEP 2021",
                "M21": "OCT 2021",
                "M20": "NOV 2021",
                "M19": "DEC 2021",
                "M18": "JAN 2022",
                "M17": "FEB 2022",
                "M16": "MAR 2022",
                "M15": "APR 2022",
                "M14": "MAY 2022",
                "M13": "JUN 2022",
                "M12": "JUL 2022",
                "M11": "AUG 2022",
                "M10": "SEP 2022",
                "M09": "OCT 2022",
                "M08": "NOV 2022",
                "M07": "DEC 2022",
                "M06": "JAN 2023",
                "M05": "FEB 2023",
                "M04": "MAR 2023",
                "M03": "APR 2023",
                "M02": "MAY 2023",
                "M01": "JUN 2023"
            },
            "Consumer24MonthlyPayment": [
                {
                    "DisplayText": "Consumer 24 Monthly Payment",
                    "AccountOpenedDate": "2022-04-11T00:00:00+02:00",
                    "SubscriberName": "FNB Credit Card",
                    "AccountNo": "XXXX3609072XXXXX",
                    "SubAccountNo": [],
                    "M24": "#",
                    "M23": "#",
                    "M22": "#",
                    "M21": "#",
                    "M20": "#",
                    "M19": "#",
                    "M18": "#",
                    "M17": "#",
                    "M16": "#",
                    "M15": "#",
                    "M14": "#",
                    "M13": "0",
                    "M12": "#",
                    "M11": "#",
                    "M10": "#",
                    "M09": "#",
                    "M08": "#",
                    "M07": "#",
                    "M06": "#",
                    "M05": "#",
                    "M04": "#",
                    "M03": "#",
                    "M02": "#",
                    "M01": "#"
                },
                {
                    "DisplayText": "Consumer 24 Monthly Payment",
                    "AccountOpenedDate": "2021-01-13T00:00:00+02:00",
                    "SubscriberName": "Wesbank Motor Loans",
                    "AccountNo": "85315543907",
                    "SubAccountNo": [],
                    "M24": "0",
                    "M23": "0",
                    "M22": "0",
                    "M21": "0",
                    "M20": "0",
                    "M19": "0",
                    "M18": "0",
                    "M17": "0",
                    "M16": "0",
                    "M15": "0",
                    "M14": "0",
                    "M13": "0",
                    "M12": "#",
                    "M11": "#",
                    "M10": "#",
                    "M09": "#",
                    "M08": "#",
                    "M07": "#",
                    "M06": "#",
                    "M05": "#",
                    "M04": "#",
                    "M03": "#",
                    "M02": "#",
                    "M01": "#"
                },
                {
                    "DisplayText": "Consumer 24 Monthly Payment",
                    "AccountOpenedDate": "2016-02-16T00:00:00+02:00",
                    "SubscriberName": "Absa Credit Card",
                    "AccountNo": "4550270476118000",
                    "SubAccountNo": [],
                    "M24": "0",
                    "M23": "P",
                    "M22": "0",
                    "M21": "0",
                    "M20": "0",
                    "M19": "P",
                    "M18": "0",
                    "M17": "P",
                    "M16": "0",
                    "M15": "0",
                    "M14": "0",
                    "M13": "#",
                    "M12": "#",
                    "M11": "#",
                    "M10": "#",
                    "M09": "#",
                    "M08": "#",
                    "M07": "#",
                    "M06": "#",
                    "M05": "#",
                    "M04": "#",
                    "M03": "#",
                    "M02": "#",
                    "M01": "#"
                },
                {
                    "DisplayText": "Consumer 24 Monthly Payment",
                    "AccountOpenedDate": "2021-03-16T00:00:00+02:00",
                    "SubscriberName": "Vodacom",
                    "AccountNo": "I8244256",
                    "SubAccountNo": [],
                    "M24": "0",
                    "M23": "0",
                    "M22": "0",
                    "M21": "0",
                    "M20": "0",
                    "M19": "0",
                    "M18": "0",
                    "M17": "0",
                    "M16": "0",
                    "M15": "C",
                    "M14": "#",
                    "M13": "#",
                    "M12": "#",
                    "M11": "#",
                    "M10": "#",
                    "M09": "#",
                    "M08": "#",
                    "M07": "#",
                    "M06": "#",
                    "M05": "#",
                    "M04": "#",
                    "M03": "#",
                    "M02": "#",
                    "M01": "#"
                }
            ],
            "ConsumerDefinition": [
                {
                    "DisplayText": "Consumer Definition",
                    "DefinitionCode": "#",
                    "DefinitionDesc": "No data found"
                },
                {
                    "DisplayText": "Consumer Definition",
                    "DefinitionCode": "*",
                    "DefinitionDesc": "Repeat of previous months Status Code"
                },
                {
                    "DisplayText": "Consumer Definition",
                    "DefinitionCode": "0",
                    "DefinitionDesc": "Not in arrears"
                },
                {
                    "DisplayText": "Consumer Definition",
                    "DefinitionCode": "1-9",
                    "DefinitionDesc": "No of months in arrears"
                },
                {
                    "DisplayText": "Consumer Definition",
                    "DefinitionCode": "C",
                    "DefinitionDesc": "Closed"
                },
                {
                    "DisplayText": "Consumer Definition",
                    "DefinitionCode": "P",
                    "DefinitionDesc": "Paid Up"
                }
            ],
            "ConsumerCPANLRDebtSummary": {
                "DisplayText": "Consumer CPANLR Debt Summary",
                "TotalMonthlyInstallmentCPA": "4237.0000",
                "TotalOutStandingDebtCPA": "185674.0000",
                "NoOFActiveAccountsCPA": "3",
                "NoOfAccountInGoodStandingCPA": "3",
                "NoOfAccountInBadStandingCPA": "0",
                "TotalArrearAmountCPA": "0.0000",
                "TotalAdverseAmountCPA": "0.0000",
                "NoOfAccountsOpenedinLast45DaysCPA": "0",
                "NoOfPaidUpOrClosedAccountsCPA": "1",
                "NoOfEnquiriesLast90DaysOWNCPA": "0",
                "NoOfEnquiriesLast90DaysOTHCPA": "0",
                "HighestMonthsinArrearsCPA": "0",
                "TotalMonthlyInstallmentNLR": "0.0000",
                "TotalOutStandingDebtNLR": "0.0000",
                "NoOFActiveAccountsNLR": "0",
                "NoOfAccountInGoodStandingNLR": "0",
                "NoOfAccountInBadStandingNLR": "0",
                "TotalArrearAmountNLR": "0.0000",
                "TotalAdverseAmountNLR": "0.0000",
                "NoOfAccountsOpenedinLast45DaysNLR": "0",
                "NoOfPaidUpOrClosedAccountsNLR": "0",
                "NoOfEnquiriesLast90DaysOWNNLR": "0",
                "NoOfEnquiriesLast90DaysOTHNLR": "0",
                "HighestMonthsinArrearsNLR": "0",
                "TotalMonthlyInstallment": "4237.0000",
                "TotalOutStandingDebt": "185674.0000",
                "NoOFActiveAccounts": "3",
                "NoOfAccountInGoodStanding": "3",
                "NoOfAccountInBadStanding": "0",
                "TotalArrearAmount": "0.0000",
                "HighestMonthsInArrears": [],
                "NoOfAccountsOpenedinLast45Days": "0",
                "NoOfPaidUpOrClosedAccounts": "1",
                "NoOfEnquiriesLast90DaysOWN": "0",
                "NoOfEnquiriesLast90DaysOTH": "0",
                "JudgementCount": "0",
                "TotalJudgmentAmt": "0",
                "MostRecentJudgmentDate": [],
                "CourtNoticeCount": "0",
                "TotalCourtNoticeAmt": "0",
                "MostRecentCourtNoticeDate": [],
                "NoofAccountdefaults": "0",
                "TotalAdverseAmt": "0",
                "MostRecentAdverseDate": [],
                "DefaultListingCount": "0",
                "DefaultListingAmt": "0",
                "RecentDefaultListingDate": [],
                "NoOfEnqinLast24Months": "0",
                "MostRecentEnqDateLast24Months": [],
                "DebtReviewStatus": [],
                "DisputeMessage": []
            },
            "SubscriberInputDetails": {
                "EnquiryDate": "2023-06-13T16:36:20.8257069+02:00",
                "EnquiryType": "Consumer Credit Enquiry",
                "SubscriberName": "Finch-Tech",
                "SubscriberUserName": "Finch Tech",
                "EnquiryInput": "XXXXXXXXXXXXX | DOE",
                "EnquiryReason": "CreditAssesment"
            }
        },
        "credit_score": 670,
        "source": "xds",
        "verified": false
    }
}
400 - Bad Request

Invalid ID Type

[
    {
        "code": "id_number",
        "message": "Passport id field type.",
        "data": {
            "error": "The customer has been created with an id type passport. Enquiries can only be performed on valid RSA ID numbers."
        }
    }
]
401 - Unauthorised
[
    {
        "code": "token-authentication",
        "message": "There was an error authenticating.",
        "data": {
            "error": "We were unable to generate the authentication token."
        }
    }
]
404 - Not Found

Insufficient Credit History

[
    {
        "code": "insufficient_data",
        "message": "Insufficient credit history",
        "data": {
            "error": "There is little to no credit information on the ID number in query."
        }
    }
]

Customer UUID not found

{
    "errors": {
        "code": "entity_not_found",
        "message": "Record not found in customers"
    }
}

✅ Successful Response Breakdown

ReportInformation

ReportID
  • Definition: Internal reference number for report

  • DataType: num

  • Example: 223

ReportName

  • Definition: The name of the report

  • DataType: string

  • Example: Company ABC Credit Report


ConsumerDirectorSummary

NumberOfCompanyDirector
  • Definition: Number of companies the consumer is a director of

  • DataType: num

  • Example: 1


CIPRO Directorship Information

DirectorDesignationDesc

  • Definition: Description of the designation of the director

  • DataType: string

AppointmentDate

  • Definition: Date appointed as a director

  • DataType: date

  • Example: '2020-11-29

CommercialName
  • Definition: The Commercial name of the company

  • DataType: string

  • Example: XDS PTY Ltd

RegistrationNo
  • Definition: The registration number of the company

  • DataType: string

  • Example: B1985/002334/23

PhysicalAddress
  • Definition: Physical address of the company

  • DataType: string

  • Example: 7 St Davides Place

TelephoneNo
  • Definition: The telephone number of the company

  • DataType: string

SICDesc
  • Definition: Code classifying the type of business

  • DataType: string

  • Example: Financial intermediation, insurance, real estate and business services

Director Status
  • Definition: The current status of the director (active, resigned, etc)

  • DataType: string

  • Example: Inactive


ConsumerAddressHistory

Multiple items will be returned depending on the number of addresses recorded against the consumer and will be displayed from latest to oldest

ConsumerAddressID
  • Definition: Internal reference number for the consumers Address details

  • DataType: num

  • Example: 782830023

AddressType
  • Definition: Residential or Postal Address

  • DataType: string

  • Example: Residential

AddressTypeInd
  • Definition: Single digit indicator for the address type

  • DataType: string

  • Example: R

Address1
  • Definition: Residential Address Line 1

  • DataType: string

  • Example: 7259 B PHOMOLONG

Address2
  • Definition: Residential Address Line 2

  • DataType: string

  • Example: 6 EXT

Address3
  • Definition: Residential Address Line 3

  • DataType: string

  • Example: MAMELODI

Address4

  • Definition: Residential Address Line 4

  • DataType: string

PostalCode
  • Definition: Postal code

  • DataType: string

  • Example: 0122

Address
  • Definition: Full address

  • DataType: string

  • Example: 7259 B PHOMOLONG 6 EXT MAMELODI 0122

LastUpdatedDate
  • Definition: Most recent date the address was recorded

  • DataType: date

  • Example: 2020-11-29

FirstReportedDate
  • Definition: First occurence that the address was recorded

  • DataType: date

  • Example: 2020-11-28


ConsumerTelephoneHistory

Note: multiple items will be returned depending on the number of phone numbers recorded against the consumer and will be displayed from latest to oldest

ConsumerTelephoneID
  • Definition: Internal reference number for the consumers telephone number

  • DataType: num

  • Example: 552563203

TelephoneType
  • Definition: Descriptor of the type of phone number

  • DataType: string

  • Example: Work

TelephoneTypeInd
  • Definition: Character indicator for the type of phone number

  • DataType: string

  • Example: W

TelCode
  • Definition: Telephone number prefix - for example area code

  • DataType: string

  • Example: 012

TelNo
  • Definition: The telephone number digits after the area code

  • DataType: string

  • Example: 8040772

TelephoneNo
  • Definition: The full telephone numer

  • DataType: string

  • Example: 0128040772

EmailAddress
  • Definition: Consumer's email address

  • DataType: string

  • Example: Jbloggs@xds.co.za

LastUpdatedDate
  • Definition: Most recent date the telephone number was recorded

  • DataType: date

  • Example: 2020-11-29

FirstReportedDate
  • Definition: Most recent date the telephone number was recorded

  • DataType: date

  • Example: 2020-11-28


ConsumerEmploymentHistory

Note: multiple items will be returned depending on the number of employers recorded against the consumer and will be displayed from latest to oldest

EmployerDetail
  • Definition: The consumer's employer's/company name

  • DataType: string

  • Example: Xpert Decision Systems PTY Ltd

EmployerDetail
  • Definition: The consumer's job title

  • DataType: string

  • Example: Technical Account Manager

Designation
  • Definition: The consumer's job title

  • DataType: string

  • Example: Technical Account Manager

LastUpdatedDate
  • Definition: The most recent time this employer information was recorded

  • DataType: date

  • Example: 2021-04-25

FirstReportedDate
  • Definition: The first time this employer information was recorded

  • DataType: date

  • Example: 2021-03-12


ConsumerDetail

ConsumerID
  • Definition: The unique identifier used for the consumer

  • DataType: num

  • Example: 123456789

Initials
  • Definition: Consumer's initials

  • DataType: string

  • Example: J

FirstName
  • Definition: Consumer's first name

  • DataType: string

  • Example: JOE

SecondName
  • Definition: Consumer's second name

  • DataType: string

ThirdName
  • Definition: Consumer's third name

  • DataType: string

Surname
  • Definition: Consumer's surname as provided by SACCRA members when the consumer first becomes credit active.

  • DataType: string

  • Example: BLOGGS

MaidenName
  • Definition: Consumer's maiden name if applicable

  • DataType: string

IDNo
  • Definition: Consumer's South African identity number

  • DataType: string

  • Example: XXXXXXXXXXXXX

IDNo
  • Definition: Consumer's South African identity number

  • DataType: string

  • Example: XXXXXXXXXXXXX

PassportNo
  • Definition: Consumer's passport number or foreign ID number

  • DataType: string

IDNo
  • Definition: Consumer's South African identity number

  • DataType: string

  • Example: XXXXXXXXXXXXX

BirthDate
  • Definition: Consumer's date of birth

  • DataType: date

  • Example: 19XX-XX-14

Gender
  • Definition: Consumer's gender (Male/Female/Unknown) as submitted via a SACRRA member.

  • DataType: string

  • Example: Male

TitleDesc
  • Definition: Consumer's title description

  • DataType: string

  • Example: Mister

MaritalStatusDesc
  • Definition: Consumer's marital status

  • DataType: string

  • Example: Single

PrivacyStatus
  • Definition: Consumer's privacy status indicates whether the individual can be contacted

  • DataType: string

  • Example: ACCEPTS CONTACTS

ResidentialAddress
  • Definition: Consumer's most recent residential address

  • DataType: string

  • Example: 37 DAHLIA STREET LENASIA GAUTENG 1827

PostalAddress
  • Definition: Consumer's most recent postal address

  • DataType: string

  • Example: STREET 37 DAHLIA STREET LENASIA EXT 2 JOHANNESBURG

HomeTelephoneNo
  • Definition: Consumer's most recent home telephone number

  • DataType: string

  • Example: 0111234567

WorkTelephoneNo
  • Definition: Consumer's work telephone number

  • DataType: string

  • Example: 0116459100

CellularNo
  • Definition: Consumer's cellular number

  • DataType: string

  • Example: 0821234567

EmailAddress
  • Definition: Consumer's email address

  • DataType: string

  • Example: Jblogs@xds.co.za

EmployerDetail
  • Definition: The name of consumer's employer

  • DataType: string

  • Example: XPERT DECISIONS SYSTEMSPTY LTD

ReferenceNo
  • Definition: The reference number used to identify the transaction

  • DataType: string

  • Example: C56883579-139319349

ExternalReference
  • Definition: A reference field provided by the client and returned exactly as provided in the result

  • DataType: string

  • Example: C56883579-139319349

SpouseFirstName
  • Definition: Consumer's spouse's first name

  • DataType: string

  • Example: Jane

SpouseSurName
  • Definition: Consumer's spouse's surname

  • DataType: string

  • Example: Doe


ConsumerFraudIndicatorsSummary

SAFPSListingYN
  • Definition: Does the consumer appear on the SAFPS fraud database

  • DataType: string

  • Example: No

HomeAffairsVerificationYN
  • Definition: Returning “Yes” or “No” if the ID number was an exact match to a dept. of Home Affairs’ record.

  • DataType: string

  • Example: Yes

HomeAffairsDeceasedStatus
  • Definition: Consumer's spouse's surname

  • DataType: string

  • Example: No

EmployerFraudVerificationYN
  • Definition: Consumer's spouse's surname

  • DataType: string

  • Example: Has the consumers employer been flagged for fraud. Only returned is matched

ProtectiveVerificationYN
  • Definition: Consumer's spouse's surname

HomeAffairsDeceasedDate
  • Definition: The date of death as per the DHA

  • DataType: date

  • Example: 2021-03-12


ConsumerScoring

SubscriberID
  • Definition: Requesting client

  • DataType: num

  • Example: 6696

Unique_Identifier
  • Definition: Consumer ID - an internal unique identier for each consumer

  • DataType: num

  • Example: 139319349

ScoreDate
  • Definition: The date upon which the scoring data was run. i.e. the date of the enquiry

  • DataType: date

  • Example: 2022-03-30

FinalScore
  • Definition: The XDS bureau score for the consumer. This is numeric and ranges from a low score of xxx to a max score of xxx

  • DataType: string

  • Example: 713.0000

ReasonCode1
  • Definition: NCR requirement detailing elements contributing to the consumer credit score

  • DataType: string

  • Example: NUMBER OF LISTED SATISFACTORY LONG TERM CREDIT ACCOUNTS

ReasonCode2
  • Definition: NCR requirement detailing elements contributing to the consumer's credit score

  • DataType: string

  • Example: TIME ACCOUNTS ESTABLISHED

ReasonCode3
  • Definition: NCR requirement detailing elements contributing to the consumer's credit score

  • DataType: string

  • Example: NUMBER OF BANKING ACCOUNTS

ModelID
  • Definition: Identifies which of the Bureau models was applied, Clean - where the consumer is not in default, Default - where the consumer has accounts in default and Thin - where the consumer does not have existing records on the bureau

  • DataType: string

  • Example: Model CLEAN

classification
  • Definition: An indication of the risk as determined by the bureau score for example High - xx% chance of default, Medium - xx% chance of default

  • DataType: string

  • Example: Classification: Average Rating

Description
  • Definition: A description of the risk classification

  • DataType: string

  • Example: Consumer has HIGH probability of collection

RiskCategory
  • Definition: An indication of the risk as determined by the bureau. score for example High - xx% chance of default, Medium - xx% chance of default - Reference: Bureau Score Categories

  • DataType: string

  • Example: Medium Risk


ConsumerPropertyInformationSummary

DisplayText
  • Example: Deeds Property Information

AuthorityName
  • Example: LETSEMENG LOCAL MUNICIPALITY

TownshipName
  • Example: LETSEMENG LOCAL MUNICIPALITY

StandNo
  • Example: 633

PortionNo
  • Example: 00000

TitleDeedNo
  • Example: T27530/2009

BuyerName
  • Example: STEENKAMP LUKAS PETRUS

BuyerTypeCode
  • Example: 1

BuyerIDNo
  • Example: 6902245125084

BuyerMaritalStatusCode
  • Example: MARRIED OUT

SellerName
  • Example: LIEBENBERG JOHANN

SellerTypeCode
  • Example: 1

SellerIDNo
  • Example: 5503095030084

SellerMaritalStatusCode
  • Example: MARRIED IN

TransferDate
  • DataType: date

  • Example: 2009-12-14

RegistrarName
  • DataType: string

  • Example: BLOEMFONTEIN

OldTitleDeedNo
  • Example: T13477/2006

AttorneyFirmNo
  • Example: 0

AttorneyFileNo
  • Example: 0

TitleDeedFeeAmt
  • Example: 0.0000

PropertyTypeCode
  • Example: E

StreetNo
  • Example: 663

StreetName
  • Example: JACOBSDAL

SuburbName
  • Example: JACOBSDAL

CityName
  • Example: JACOBSDAL

TransferID
  • Example: 0

ErfNo
  • Example: 663

DeedsOffice
  • Example: BLOEMFONTEIN

PhysicalAddress
  • Example: 633 JACOBSDAL JACOBSDAL JACOBSDAL

PropertyTypeDesc
  • Example: Ervin

ErfSize
  • Example: 2237.0SQM

PurchaseDate
  • Example: 2009-09-17

PurchasePriceAmt
  • Example: 900000.0000

BuyerSharePerc
  • Example: 0.0000

BondHolderName

BondAccountNo

BondAmt

Example: 0.0000


AccountTypeLegend

AccountTypeCode

  • Definition: This is a single digit identifier for the type of account the consumer. has recorded with the bureau - Reference:Account Types

  • DataType: string

  • Example: B

AccountTypeDesc
  • Definition: Description of the type of account the consumer has recorded with the bureau - Reference:Account Types

  • DataType: string

  • Example: Building Loan


ConsumerAccountStatus

ConsumerAccountID
  • DataType: num

  • Example: 330519746

SubscriberID
  • DataType: num

  • Example: 108

AccountNo
  • DataType: string

  • Example: 0312509243

SubAccountNo
  • DataType: string

AccountOpenedDate
  • DataType: date

  • Example: 2020/11/28

SubscriberName
  • Definition: The name of the credit provider with whom the facility is held

  • DataType: string

  • Example: Company ABC

CreditLimitAmt
  • DataType: num

  • Example: 320.0000

CurrentBalanceAmt
  • DataType: num

  • Example: 466.0000

MonthlyInstalmentAmt
  • DataType: num

  • Example: 205.0000

ArrearsAmt
  • Definition: Total value which has not been received within the agreed repayment period (monthly, weekly, annually) etc.

  • DataType: num

  • Example: 0.0000

ArrearsTypeInd
  • Definition: Description of the type of account the consumer has recorded with the bureau - Reference:Account Types

  • DataType: string

  • Example: Building Loan

AccountType
  • Definition: Indicates the type of facility, for example Credit Card, Home Loan, etc. Note: for detailed list see Reference - Account Type

  • DataType: string

  • Example: R, C, L

LastPaymentDate
  • Definition: The most recent date a payment is noted against the account

  • DataType: date

  • Example: 2021-04-26

StatusCodeDesc
  • Definition: The most recent status noted against the account. Note: for detailed list see Reference - Account Status

  • DataType: string

  • Example: Active

DeferredPaymentDate
  • DataType: date

ThirdPartyName
  • DataType: string

NoOfParticipantsInJointLoan
  • DataType: num

  • Example: 0


Consumer24MonthlyPaymentHeader

Header running by month from 24 to 1

Company
  • Definition: The name of the credit provider with whom the facility is held

  • DataType: string

  • Example: Company ABC

M24
  • Definition: The date for the retrospective 24th month

  • DataType: string

  • Example: APR 2020

M23
  • Definition: The date for the retrospective 23rd month

  • DataType: string

  • Example: MAY 2020

M02
  • Definition: The date for the retrospective 2nd month

  • DataType: string

  • Example: FEB 2022

M01
  • Definition: The date for the retrospective 1st month

  • DataType: string

  • Example: MAR 2022


Consumer24MonthlyPayment

Will return the same information for each account and for each month for the last 24 months

AccountOpenedDate
  • Definition: Date on which the account was opened

  • DataType: datetime

  • Example: 2020-11-28T00:00:00+02:00

SubscriberName
  • Definition: Name of the credit provider

  • DataType: string

  • Example: Company ABC

AccountNo
  • Definition: The consumers account number with the credit provider

  • DataType: string

  • Example: 0312509243

SubAccountNo
  • Definition: The sub account number for the client with the credit provider

M24
  • Definition: The account status of the account 24 months ago. The statuses are prescribed by SACCRA in the layout and submission rules.

  • DataType: string

  • Example: 0

M23
  • Definition: The account status of the account 23 months ago. The status's are prescribed by SACRRA in the layout and submission rules.

  • DataType: string

  • Example: 0

M02
  • Definition: The account status of the account 2 months ago. The status's are prescribed by SACRRA in the layout and submission rules.

  • DataType: string

  • Example: 1

M01
  • Definition: The account status of the account 1 months ago. The status's are prescribed by SACRRA in the layout and submission rules.

  • DataType: string

  • Example: C


ConsumerDefinition

DefinitionCode
  • Definition: This is the status code indicator

  • DataType: string

  • Example: #

DefinitionDesc
  • Definition: A description of the indicator

  • DataType: string

  • Example: No data found


ConsumerDebtSummary

TotalMonthlyInstallment
  • Definition: The sum of all monthly instalments

  • DataType: num

  • Example: 445.0000

TotalOutStandingDebt
  • Definition: Sum of all outstanding balances

  • DataType: num

  • Example: 2717.0000

NoOFActiveAccounts
  • Definition: Count of active accounts

  • DataType: num

  • Example: 2

NoOfAccountInGoodStanding
  • Definition: Count of accounts that are up to date

  • DataType: num

  • Example: 2

NoOfAccountInBadStanding
  • Definition: Count of accounts that are not up to date

  • DataType: num

TotalArrearAmount
  • Definition: Sum of amounts in arrears

  • DataType: num

  • Example: 0.0000

HighestJudgmentAmount
  • Definition: The value of the largest judgement against the consumer

  • DataType: num

  • Example: 0.0000

HighestDelinquentRating
  • Definition: Worst delinquency status on an account

  • DataType: num

  • Example: 1

AdminOrderStatus
  • Definition: Does the consumer have an administration order listed against them

  • DataType: string

  • Example: No

TotalAdverseAmount
  • Definition: Sum of accounts 3 months or more in arrears

  • DataType: num

  • Example: 0.0000

NoOfAccountsOpenedinLast45Days
  • Definition: Count of new accounts opened within the last 45 days

  • DataType: num

  • Example: 0

NoOfPaidUpOrClosedAccounts
  • Definition: Count of accounts that are closed or paid up

  • DataType: num

NoOfEnquiriesLast90DaysOWN
  • Definition: Count of enquiries by subscriber in the last 90 days

  • DataType: num

NoOfEnquiriesLast90DaysOTH
  • Definition: Count of enquires by all subscribers in the last 90 days

  • DataType: num

HighestMonthsInArrears
  • Definition: The current worst status across all active accounts

  • DataType: string

  • Example: No data found

JudgementCount
  • Definition: The number of judgements issued in the last 5 years against the consumer

  • DataType: num

  • Example: No data found

TotalJudgmentAmt
  • Definition: Sum of all judgement amounts listed against the consumer

  • DataType: num

MostRecentJudgmentDate
  • Definition: The date of the most recent judgement granted against the consumer

  • DataType: date

CourtNoticeCount
  • Definition: Number of Admin Orders and sequestrations issued in the last 5 years against the consumer

  • DataType: num

TotalCourtNoticeAmt
  • Definition: Sum of values of all court orders

  • DataType: num

MostRecentCourtNoticeDate
  • Definition: The date of the most recent court notice granted against the consumer

  • DataType: date

NoofAccountdefaults
  • Definition: Count of accounts in default i.e. 3 months or more in arrears

  • DataType: num

TotalAdverseAmt

MostRecentJudgmentDate
  • Definition: The date of the most recent court notice granted against the consumer

  • DataType: date

CourtNoticeCount
  • Definition: Number of Admin Orders and sequestrations issued in the last 5 years against the consumer

  • DataType: num

TotalCourtNoticeAmt
  • Definition: Sum of values of all court orders

  • DataType: num

MostRecentCourtNoticeDate
  • Definition: The date of the most recent court notice granted against the consumer

  • DataType: date

NoofAccountdefaults
  • Definition: Count of accounts in default i.e. 3 months or more in arrears

  • DataType: num

MostRecentAdverseDate
  • Definition: The date of the most recent adverse lsiting noted against the consumer

  • DataType: date

DefaultListingCount
  • Definition: Count of the number of adverse listing noteed against the consumer

  • DataType: num

DefaultListingAmt
  • Definition: Sum of all values of adverse listing noteed against the consumer

  • DataType: num

RecentDefaultListingDate
  • Definition: Date of most recent default listing

  • DataType: date

NoOfEnqinLast24Months
  • Definition: Count of enquiries by all subscribers in the last 24 months

  • DataType: num

MostRecentEnqDateLast24Months
  • Definition: Date of the most recent enquiry in the last 24 months

  • DataType: date

DebtReviewStatus
  • Definition: The description of the status code of the consumer’s debt review process. Aligned to the wording used by the National Credit Regulator

  • DataType: string

DisputeMessage
  • Definition: The message or comment explaining an account or judgement that is currently being disputed with the bureau.

  • DataType: string


SubscriberInputDetails

EnquiryDate
  • Definition: The date of the enquiry

  • DataType: datetime

  • Example: 2022-03-30T11:08:07.1981002+02:00

EnquiryType
  • DataType: string

  • Example: Consumer Credit Enquiry

SubscriberName
  • Definition: The name of the entity performing the enquiry

  • DataType: string

  • Example: xds Trial Tester

SubscriberUserName
  • DataType: string

  • Example: Data Quality

EnquiryInput
  • DataType: string

  • Example: 9009205777081

EnquiryReason
  • DataType: string

  • Example: Testing


ConsumerEnquiryHistory

DisplayText

EnquiryDate
  • Definition: The date of the enquiry

  • DataType: date

SubscriberName
  • Definition: The name of the entity performing the enquiry

SubscriberBusinessTypeDesc

CreditGrantorEnquiryReasonDesc

SubscriberContact

Last updated