Links
✴️

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.
Please note that the Credit Report and Score will be generated based off of the Customer details that were provided in the POST Create New Customer endpoint. A Credit Report and Score can only be generated for a Customer with a valid RSA ID Number.
get
{{baseUrl}}/customers/:customer_id/credit-report-and-score
Get Credit Report and Score

Response Status - Success

Response data
The below extract shows data relating to the actual response from the bureau after the request was made by Gathr. In general, you as the Tenant do not need to worry about this data, except to see whether you got a successful response back in the "ResponseStatus" field. If the timing of the request to the bureau matters to you, you may also consider the "ProcessingStartDate" field.
{
"data": {
"id": "c5a6beab-727c-4019-a654-cd5ceaf2f543",
"xml_response_full": {
"RawData": [],
"ResponseStatus": "Success",
"ProcessingStartDate": "2023-03-07T13:41:27.4177831+02:00",
"ProcessingTimeSecs": "1.0625145",
"UniqueRefGuid": "d1362daf-35ae-4329-9767-dd7611367bd8",
AddressNA08
As you can see from the extract below, the Bureau returns an array of Addresses that belong to the Customer.
"AddressNA08": {
"AddressNA08": [
{
"ConsumerNo": "068741106",
"InformationDate": "20230223",
"Line1": “Example”,
"Line2": [],
"Suburb": [],
"City": [],
"PostalCode": "2196",
"ProvinceCode": [],
"Province": [],
"AddressPeriod": "00",
"OwnerTenant": [],
"AddressChanged": "Y"
},
{
"ConsumerNo": "Example",
"InformationDate": "Example",
"Line1": “Example”,
"Line2": "Example",
"Suburb": "SANDHURST",
"City": "JOHANNESBURG",
"PostalCode": "2196",
"ProvinceCode": "GP",
"Province": "GAUTENG",
"AddressPeriod": "00",
"OwnerTenant": [],
"AddressChanged": "Y"
},
{
"ConsumerNo": "Example",
"InformationDate": "Example",
"Line1": "Example",
"Line2": [],
"Suburb": "SANDHURST",
"City": "JOHANNESBURG",
"PostalCode": "2001",
"ProvinceCode": "GP",
"Province": "GAUTENG",
"AddressPeriod": "00",
"OwnerTenant": [],
"AddressChanged": "Y"
},
{
"ConsumerNo": "Example",
"InformationDate": "20170607",
"Line1": "Example",
"Line2": [],
"Suburb": "SANDHURST",
"City": "SANDHURST",
"PostalCode": "2196",
"ProvinceCode": "GP",
"Province": "GAUTENG",
"AddressPeriod": "00",
"OwnerTenant": "T",
"AddressChanged": "Y"
}
]
},
AKANamesNK04
This section of the Report shows an array of names that are on record at the Bureau for the Customer.
"AKANamesNK04": {
"AKANamesNK04": [
{
"RecordSeq": "01",
"Part": "001",
"PartSeq": "01",
"ConsumerNo": "068741106",
"InformationDate": "20221020",
"AKAName": "John"
},
{
"RecordSeq": "02",
"Part": "001",
"PartSeq": "01",
"ConsumerNo": "Example",
"InformationDate": "20220912",
"AKAName": "John Wick"
},
{
"RecordSeq": "03",
"Part": "001",
"PartSeq": "01",
"ConsumerNo": "Example",
"InformationDate": "20210202",
"AKAName": "Jovonovich"
}
]
},
ConsEnqTransInfo0102
This looks like high-level/snapshot information about the Credit Report that has been generated.
"ConsEnqTransInfo0102": {
"DefiniteMatchCount": "1",
"PossibleMatchCount": "00",
"MatchedConsumerNo": "Example",
"PossibleConsumerNo": [],
"PossibleAdverseIndicator": []
ConsumerInfoNO05
Personal information on the Customer including contact details and information about their spouses.
},
"ConsumerInfoNO05": {
"RecordSeq": "01",
"Part": "001",
"PartSeq": "01",
"ConsumerNo": "Example",
"Surname": "Example",
"Forename1": "Example",
"Forename2": "J",
"Forename3": "P",
"Title": "MR",
"Gender": "M",
"NameInfoDate": "20170728",
"DateOfBirth": "19900114",
"IdentityNo1": "Example",
"IdentityNo2": [],
"MaritalStatusCode": "S",
"MaritalStatusDesc": "SINGLE",
"Dependants": "00",
"SpouseName1": [],
"SpouseName2": [],
"TelephoneNumbers": "H(011)Example B(010)7531700",
"DeceasedDate": "00000000",
"CellNumber": “Example,
"EMail": "Example"
},
EvolutionPO01
"EvolutionPO01": {
"EvolutionPO01": [
{
"ConsumerNo": "068741106",
"Lastupdatedate": "20230211",
"SupplierName": [],
"NLRSACRRAAccount": "CPA",
"IndustryCode": "OT",
"Industry": "Other",
"AccountTypeCode": "C",
"AccountType": "Credit Card",
"AccountNumber": "Example",
"SubAccountNumber": [],
"BranchCode": [],
"SupplierReferencenumber": "00000000",
"DateOpened": "20210518",
"OpeningBalance": "000040000",
"Instalment": "000000100",
"CurrentBalance": "000001641",
"Terms": "0000",
"OverdueAmount": "000000000",
"OwnershipType": "00",
"NumberParticipantsJointLoan": "00",
"PaymentType": "0",
"RepaymentFrequency": "03",
"LoanReasonCode": [],
"LoanReasonCodeDescription": [],
"DeferredPaymentDate": "00000000",
"AccSoldTo3rdParty": "00",
"ThirdPartyName": [],
EvolutionPaymentHistory
Up-to-date monthly payment history in reverse chronological order.
"EvolutionPaymentHistory": {
"EvolutionPaymentHistory": [
{
"PaymentHistoryDate": "202303",
"StatusCode": "=",
"LastPayDate": "20230131"
},
{
"PaymentHistoryDate": "202302",
"StatusCode": "=",
"LastPayDate": "20221220"
},
{
"PaymentHistoryDate": "202301",
"StatusCode": "0",
"LastPayDate": "20221130"
},
{
"PaymentHistoryDate": "202212",
"StatusCode": "0",
"LastPayDate": "20221027"
},
{
"PaymentHistoryDate": "202211",
"StatusCode": "0",
"LastPayDate": "20220930"
},
{
"PaymentHistoryDate": "202210",
"StatusCode": "0",
"LastPayDate": "20220831"
},
{
"PaymentHistoryDate": "202209",
"StatusCode": "0",
"LastPayDate": "20220730"
},
{
"PaymentHistoryDate": "202208",
"StatusCode": "0",
"LastPayDate": "20220630"
},
{
"PaymentHistoryDate": "202207",
"StatusCode": "0",
"LastPayDate": "20220430"
},
{
"PaymentHistoryDate": "202206",
"StatusCode": "0",
"LastPayDate": "20220430"
},
{
"PaymentHistoryDate": "202205",
"StatusCode": "0",
"LastPayDate": "20220331"
},
{
"PaymentHistoryDate": "202204",
"StatusCode": "0",
"LastPayDate": "20220228"
},
{
"PaymentHistoryDate": "202203",
"StatusCode": "0",
"LastPayDate": "20220127"
},
{
"PaymentHistoryDate": "202202",
"StatusCode": "0",
"LastPayDate": "20211231"
},
{
"PaymentHistoryDate": "202201",
"StatusCode": "0",
"LastPayDate": "20211122"
},
{
"PaymentHistoryDate": "202112",
"StatusCode": "0",
"LastPayDate": "20211030"
},
{
"PaymentHistoryDate": "202111",
"StatusCode": "0",
"LastPayDate": "20210928"
},
{
"PaymentHistoryDate": "202110",
"StatusCode": "0",
"LastPayDate": "20210701"
},
{
"PaymentHistoryDate": "202109",
"StatusCode": "0",
"LastPayDate": "20210701"
},
{
"PaymentHistoryDate": "202108",
"StatusCode": "P",
"LastPayDate": "20210630"
},
{
"PaymentHistoryDate": "202107",
"StatusCode": "P",
"LastPayDate": []
},
{
"PaymentHistoryDate": "202106",
"StatusCode": "0",
"LastPayDate": []
},
{
"PaymentHistoryDate": "202105",
"StatusCode": "=",
"LastPayDate": []
},
{
"PaymentHistoryDate": "202104",
"StatusCode": "=",
"LastPayDate": []
}
]
}
},
An example credit facility
{
"ConsumerNo": "Example",
"Lastupdatedate": "20230223",
"SupplierName": [],
"NLRSACRRAAccount": "CPA",
"IndustryCode": "OT",
"Industry": "Other",
"AccountTypeCode": "E",
"AccountType": "Single Credit Facility",
"AccountNumber": "Example",
"SubAccountNumber": "Q6",
"BranchCode": "824",
"SupplierReferencenumber": "00000000",
"DateOpened": "20210518",
"OpeningBalance": "000001000",
"Instalment": "000000000",
"CurrentBalance": "000000000",
"Terms": "0000",
"OverdueAmount": "000000000",
"OwnershipType": "00",
"NumberParticipantsJointLoan": "00",
"PaymentType": "00",
"RepaymentFrequency": "03",
"LoanReasonCode": "O",
"LoanReasonCodeDescription": "OTHER",
"DeferredPaymentDate": "00000000",
"AccSoldTo3rdParty": "00",
"ThirdPartyName": [],
"EvolutionPaymentHistory": {
"EvolutionPaymentHistory": [
{
"PaymentHistoryDate": "202303",
"StatusCode": "=",
"LastPayDate": "20210528"
},
{
"PaymentHistoryDate": "202302",
"StatusCode": "=",
"LastPayDate": "20210528"
},
{
"PaymentHistoryDate": "202301",
"StatusCode": "P",
"LastPayDate": "20210528"
},
{
"PaymentHistoryDate": "202212",
"StatusCode": "0",
"LastPayDate": "20210528"
},
{
"PaymentHistoryDate": "202211",
"StatusCode": "P",
"LastPayDate": "20210528"
},
{
"PaymentHistoryDate": "202210",
"StatusCode": "P",
"LastPayDate": "20210528"
},
{
"PaymentHistoryDate": "202209",
"StatusCode": "P",
"LastPayDate": "20210528"
},
{
"PaymentHistoryDate": "202208",
"StatusCode": "P",
"LastPayDate": "20210528"
},
{
"PaymentHistoryDate": "202207",
"StatusCode": "=",
"LastPayDate": "20210528"
},
{
"PaymentHistoryDate": "202206",
"StatusCode": "P",
"LastPayDate": "20210528"
},
{
"PaymentHistoryDate": "202205",
"StatusCode": "P",
"LastPayDate": "20210528"
},
{
"PaymentHistoryDate": "202204",
"StatusCode": "P",
"LastPayDate": "20210528"
},
{
"PaymentHistoryDate": "202203",
"StatusCode": "P",
"LastPayDate": "20210528"
},
{
"PaymentHistoryDate": "202202",
"StatusCode": "=",
"LastPayDate": "20210528"
},
{
"PaymentHistoryDate": "202201",
"StatusCode": "P",
"LastPayDate": "20210528"
},
{
"PaymentHistoryDate": "202112",
"StatusCode": "P",
"LastPayDate": "20210528"
},
{
"PaymentHistoryDate": "202111",
"StatusCode": "P",
"LastPayDate": "20210528"
},
{
"PaymentHistoryDate": "202110",
"StatusCode": "P",
"LastPayDate": "20210528"
},
{
"PaymentHistoryDate": "202109",
"StatusCode": "P",
"LastPayDate": "20210528"
},
{
"PaymentHistoryDate": "202108",
"StatusCode": "P",
"LastPayDate": []
},
{
"PaymentHistoryDate": "202107",
"StatusCode": "P",
"LastPayDate": []
},
{
"PaymentHistoryDate": "202106",
"StatusCode": "P",
"LastPayDate": []
},
{
"PaymentHistoryDate": "202105",
"StatusCode": "P",
"LastPayDate": []
},
{
"PaymentHistoryDate": "202104",
"StatusCode": "=",
"LastPayDate": []
}
]
}
},
EchoData0001
"EchoData0001": {
"SubscriberCode": "99889",
"ClientReference": [],
"BranchNumber": [],
"BatchNumber": []
},
EmpiricaEM07
This section contains information regarding the individual's empirica credit score.
"EmpiricaEM07": {
"ConsumerNo": "Example",
"EmpiricaScore": "00738",
"ExclusionCode": [],
"ExclusionCodeDescription": [],
"ReasonCode": {
"string": [
"79",
"32",
"61",
"31"
]
},
"ReasonDescription": {
"string": [
"Lack of usable auto loan information",
"Length of time revolve account established",
"Lack of usable instalment account information",
"Time accounts established"
]
},
"ExpansionScore": [],
"ExpansionScoreDescription": [],
"EmpiricaVersion": "AOV5.0"
},
EmploymentNM04
This section contains information about
"EmploymentNM04": {
"EmploymentNM04": [
{
"RecordSeq": "01",
"Part": "001",
"PartSeq": "01",
"ConsumerNo": "Example",
"InformationDate": "20210605",
"Occupation": [],
"EmployerName": "AFRICA INTERNET GROUP",
"EmploymentPeriod": "02"
},
{
"RecordSeq": "02",
"Part": "001",
"PartSeq": "01",
"ConsumerNo": "Example",
"InformationDate": "20230223",
"Occupation": "OTHER",
"EmployerName": "FINCH TECHNOLOGIES",
"EmploymentPeriod": "02"
},
{
"RecordSeq": "03",
"Part": "001",
"PartSeq": "01",
"ConsumerNo": "Example",
"InformationDate": "20220509",
"Occupation": "NA",
"EmployerName": [],
"EmploymentPeriod": "05"
}
]
},
IdvNI01
This section of the credit report contains information about the extent to which the person's identity and name could be verified by the bureau.
"IdvNI01": {
"IDVerifiedCode": "V0",
"IDVerifiedDesc": "ID and Surname Verified",
"IDWarning": [],
"IDDesc": [],
"VerifiedSurname": "Example",
"VerifiedForename1": "Example",
"VerifiedForename2": "J",
"DeceasedDate": []
},
V1Segment
This section contains the empirica credit score of the individual.
"V1Segment": {
"v1Segs": {
"v1Seg": [
{
"Code": "V1",
"Value": "01"
},
{
"Code": "00",
"Value": "01"
},
{
"Code": "01",
"Value": "02"
},
{
"Code": "D7",
"Value": "01"
},
{
"Code": "DC",
"Value": "01"
},
{
"Code": "DI",
"Value": "01"
},
{
"Code": "EM",
"Value": "07"
},
{
"Code": "EN",
"Value": "01"
},
{
"Code": "NA",
"Value": "08"
},
{
"Code": "NE",
"Value": "50"
},
{
"Code": "NI",
"Value": "01"
},
{
"Code": "NJ",
"Value": "07"
},
{
"Code": "NK",
"Value": "04"
},
{
"Code": "NM",
"Value": "04"
},
{
"Code": "NN",
"Value": "08"
},
{
"Code": "NO",
"Value": "05"
},
{
"Code": "NT",
"Value": "07"
},
{
"Code": "PM",
"Value": "01"
},
{
"Code": "PO",
"Value": "01"
}
]
}
}
},
"credit_score": 738,
"source": null,
"verified": false
}
}

Looking for more?

If you would like a more detailed explanation of the data points in the credit report, please reach out via email to [email protected].

More for you and your customers

If you or your Customers are interested in understanding more about your Credit Report or personal finance in general, please visit https://academy.fincheck.co.za. Here you can find in-depth and informative courses about money and financial matters in a format that is easy to read and understand.
Last modified 7mo ago