💳TU - Credit Report
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.
Please note that the Credit Report will be generated based off of the Customers details that were provided in the POST Create New Customer endpoint. A Credit Report can only be generated for a Customer with a valid RSA ID Number.
Get Customer Credit Report
GET {{baseUrl}}/customers/:customer_id/credit-report
Retrieve a customers credit report, excluding credit score.
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. |
{
// See "Success" Response below
}```postman_json
{
"data": {
"id": "a692f0e1-87e9-49b6-8941-4f9b81766974",
"xml_response_full": {
"RawData": [],
"ResponseStatus": "Success",
"ProcessingStartDate": "2023-04-25T14:45:07.5245586+02:00",
"ProcessingTimeSecs": "0.8280949",
"UniqueRefGuid": "7deb5402-6931-4b47-b6c7-a7433b74ded3",
"ConsEnqTransInfo0102": {
"DefiniteMatchCount": "0",
"PossibleMatchCount": "00",
"MatchedConsumerNo": "170330832",
"PossibleConsumerNo": [],
"PossibleAdverseIndicator": []
},
"ConsumerInfoNO05": {
"RecordSeq": "01",
"Part": "001",
"PartSeq": "01",
"ConsumerNo": "170330832",
"Surname": "LASTNAME",
"Forename1": "FIRSTNAME",
"Forename2": [],
"Forename3": [],
"Title": [],
"Gender": [],
"NameInfoDate": "20230425",
"DateOfBirth": "20021124",
"IdentityNo1": "0211243531087",
"IdentityNo2": [],
"MaritalStatusCode": [],
"MaritalStatusDesc": [],
"Dependants": "00",
"SpouseName1": [],
"SpouseName2": [],
"TelephoneNumbers": [],
"DeceasedDate": "00000000",
"CellNumber": "000000000000000",
"EMail": []
},
"EvolutionEN01": {
"EvolutionEN01": {
"ConsumerNo": "170330832",
"date_of_enquiry": "20230425",
"enq_subscriber_name": "FINCH TECHNOLOGIES",
"enq_subscriber_contact": "FINCHECK 0726031227",
"enq_type_cd": "45",
"enq_type_desc": "OTHER",
"own_account": "Y",
"loan_reason_cd": [],
"loan_reason_desc": [],
"enq_ref_no": "00000000000",
"industry_cd": "FL",
"industry_desc": "Non-Bank Personal Loans",
"message": []
}
},
"EchoData0001": {
"SubscriberCode": "99889",
"ClientReference": [],
"BranchNumber": [],
"BatchNumber": []
},
"EmpiricaEM07": {
"ConsumerNo": "170330832",
"EmpiricaScore": "00000",
"ExclusionCode": "N",
"ExclusionCodeDescription": "Insufficient data to be scored",
"ReasonCode": {
"string": [
"00",
"00",
"00",
"00"
]
},
"ReasonDescription": {
"string": [
[],
[],
[],
[]
]
},
"ExpansionScore": [],
"ExpansionScoreDescription": [],
"EmpiricaVersion": "AOV5.0"
},
"EnquiriesNE50": {
"EnquiryNE50": {
"ConsumerNo": "170330832",
"DateOfEnquiry": "20230425",
"Subscriber": "FINCH TECHNOLOGIE",
"Contact": "FINCHECK 0726031227",
"EnquiryTypeCode": "45",
"EnquiryTypeDescription": "OTHER",
"OwnAccount": "Y"
}
},
"IdvNI01": {
"IDVerifiedCode": "V3",
"IDVerifiedDesc": "ID Not Yet Verified",
"IDWarning": [],
"IDDesc": [],
"VerifiedSurname": "LASTNAME",
"VerifiedForename1": "FIRSTNAME",
"VerifiedForename2": [],
"DeceasedDate": []
},
"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": null,
"source": null,
"verified": false
}
}
``````postman_json
{
"data": {
"id": "d2c41ccb-bad4-4ee6-b679-a70eb6248327",
"xml_response_full": {
"RawData": [],
"ResponseStatus": "Failure",
"ErrorCode": "R0028",
"ErrorMessage": " THE DATE OF BIRTH FORMAT MUST BE CCYYMMDD. CORRECT AND RESUBMIT. ",
"ProcessingStartDate": "2023-04-25T14:40:00.9465835+02:00",
"ProcessingTimeSecs": "0.343709",
"UniqueRefGuid": "32967237-f485-4fb8-bbd0-e1cd2431b5f9"
},
"credit_score": null,
"source": null,
"verified": false
}
}
``````postman_json
{
"data": {
"id": "838045b8-9b6e-4910-9487-ae50b3593770",
"xml_response_full": {
"RawData": [],
"ResponseStatus": "Failure",
"ErrorCode": "R0040",
"ErrorMessage": " THE DATE OF BIRTH ON THIS ENQUIRY SHOWS THAT THE PERSON BEING ENQUIRED ON IS YOUNGER THAN 16 YEARS OLD. CHECK ",
"ProcessingStartDate": "2023-04-25T14:42:19.435422+02:00",
"ProcessingTimeSecs": "0.4531516",
"UniqueRefGuid": "bf6cbf55-0c9d-4148-8b80-2e5944ea211c"
},
"credit_score": null,
"source": null,
"verified": false
}
}
```{
"data": {
"id": "c5a6beab-727c-4019-a654-cd5ceaf2f543",
"xml_response_full": {
"RawData": [],
"ResponseStatus": "Failure",
"ErrorCode": "R0109",
"ErrorMessage": " The id, name/surname combination does not match our home affairs verified data ",
"ProcessingStartDate": "2023-07-10T15:11:28.556287+02:00",
"ProcessingTimeSecs": "0.14502969999999998",
"UniqueRefGuid": "97d1f65b-12c2-4266-b02a-0dac26248d7b"
},
"credit_score": null,
"source": null,
"verified": false
}
}```postman_json
{
"errors": {
"code": "entity_not_found",
"message": "Record not found in customers"
}
}
```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": []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
}
}Last updated