Bulk Consumer Credit Reporting
Share Bulk Consumer data (HTTP POST) to the DLNβ
POST https://dev.creditchek.africa/v1/dln/data/consumer/submit-bulk
This is similar to the single consumer data endpoint; this works if your reporting process is periodical or at the initial stage after getting onboarded on the network and thereβs a need to share already existing data with the network.
Request Parametersβ
| Name | Position | Required | Description |
|---|---|---|---|
| token | Headers | True | app secret key |
| BVN | Body | True | borrower BVN |
| customerId | Body | True | borrower customerId |
| lastName | Body | True | borrower last name |
| firstName | Body | True | borrower first name |
| addressLine1 | Body | True | borrower address line 1 |
| addressLine2 | Body | False | borrower address line 2 |
| city | Body | True | borrower city |
| state | Body | True | borrower state |
| country | Body | True | borrower country |
| maritalStatus | Body | True | borrower marital status |
| employmentStatus | Body | True | borrower employment status |
| occupation | Body | True | borrower occupation |
| businessSector | Body | True | borrower business sector |
| NIN | Body | False | borrower NIN |
| dateOfBirth | Body | True | borrower date of birth |
| address | Body | True | borrower address |
| phoneNumber | Body | True | borrower phone number |
| Body | True | borrower email | |
| gender | Body | True | borrower gender |
| dateOpened | Body | True | date opened |
| loanAmount | Body | True | loan amount |
| outstandingBalance | Body | True | outstanding balance |
| overdueAmount | Body | True | overdue amount |
| daysInArrears | Body | True | days in arrears |
| lastPaymentAmount | Body | True | last payment amount |
| maturityDate | Body | True | maturity date |
| minimumInstallment | Body | True | minimum installment |
| nextDueDate | Body | False | next due date |
| loanDuration | Body | True | loan duration |
| lastPaymentDate | Body | True | last payment date |
| purpose | Body | False | loan purpose |
| collateral | Body | True | collateral |
| collateralType | Body | False | collateral type |
| collateralDetails | Body | False | collateral details |
| repaymentFrequency | Body | True | repayment frequency |
| accountDescription | Body | False | account description |
| currency | Body | False | currency |
| accountName | Body | True | account name |
| accountType | Body | True | account type |
| accountStatus | Body | True | account status |
| accountNumber | Body | True | account number |
| accountStatusDate | Body | True | account status date |
| nationality | Body | True | borrower nationality |
| legalChallengeStatus | Body | True | legal challenge status |
| consentStatus | Body | True | consent status |
| guarantor | Body | True | guarantor |
| guarantorType | Body | Conditional | guarantor type |
| guarantorDOBorDateOfIncorporation | Body | Conditional | guarantor date of birth or date of incorporation |
| guarantorFirstName | Body | Conditional | guarantor first name |
| guarantorLastName | Body | Conditional | guarantor last name |
| guarantorGender | Body | Conditional | guarantor gender |
| guarantorPhoneNumber | Body | Conditional | guarantor phone number |
| guarantorAddressLine1 | Body | Conditional | guarantor address line 1 |
| guarantorCity | Body | Conditional | guarantor city |
| guarantorState | Body | Conditional | guarantor state |
| guarantorCountry | Body | Conditional | guarantor country |
| guarantorBVN | Body | Conditional | guarantor BVN |
Example Request
curl --location 'https://dev.creditchek.africa/v1/dln/data/consumer/submit-bulk' \
--header 'token: JWR6t1qp8UcHrGVFyTPhrIWyayH+8eUQFSDkLih6lA2KXGo4CzGUx/zqPc8uhksb' \
--data-raw '{
"data": [
{
"BVN": "11111111111",
"customerId": "62f1d3863518a3e04bbc6aaf",
"lastName": "Sample",
"firstName": "Test",
"dateOfBirth": "07/11/1998",
"addressLine1": "35 Adeola odeku",
"addressLine2": "off Idejo",
"city": "Ikeja",
"state": "Lagos",
"country": "Nigeria",
"maritalStatus": "single",
"employmentStatus": "employed",
"occupation": "student",
"businessSector": "Education",
"phoneNumber": "08023151310",
"email": "[email protected]",
"gender": "Male",
"accountNumber": "0128456407",
"accountName": "Isaac John",
"accountStatusDate": "03/05/2022",
"dateOpened": "13/05/2022",
"loanAmount": 95150,
"lastPaymentDate": "22/06/2022",
"outstandingBalance": 20,
"overdueAmount": 2500,
"daysInArrears": 0,
"minimumInstallment": 19000,
"lastPaymentAmount": 450,
"collateral": "Yes",
"collateralType": "Cash",
"guarantor": "Yes",
"guarantorType": "individual",
"guarantorDOBorDateOfIncorporation": "12/07/2002",
"guarantorFirstName": "Guator",
"guarantorLastName": "Testor",
"guarantorGender": "male",
"guarantorPhoneNumber": "08173902223",
"guarantorAddressLine1": "34 Kalu street",
"guarantorCity": "Algiers",
"guarantorState": "Lagos",
"guarantorCountry": "Nigeria",
"guarantorBVN": "10923874652",
"nextDueDate": "13/12/2022",
"maturityDate": "30/06/2023",
"loanDuration": "6 months",
"purpose": "Tuition",
"repaymentFrequency": "monthly",
"accountDescription": "Creditchek user account",
"currency": "NGN",
"accountStatus": "Open",
"nationality": "Nigeria",
"legalChallengeStatus": "No",
"consentStatus": "Yes"
},
{
"BVN": "11111100000",
"customerId": "62f1d3863518a3e04bbc6ac0",
"lastName": "Sample",
"firstName": "Test",
"dateOfBirth": "07/11/1998",
"addressLine1": "35 Adeola odeku",
"addressLine2": "off Idejo",
"city": "Ikeja",
"state": "Lagos",
"country": "Nigeria",
"maritalStatus": "single",
"employmentStatus": "employed",
"occupation": "student",
"businessSector": "Education",
"phoneNumber": "08023151310",
"email": "[email protected]",
"gender": "Male",
"accountNumber": "0128456407",
"accountName": "Isaac John",
"accountStatusDate": "03/05/2022",
"dateOpened": "13/05/2022",
"loanAmount": 71150,
"lastPaymentDate": "22/06/2022",
"outstandingBalance": 20,
"overdueAmount": 2500,
"daysInArrears": 0,
"minimumInstallment": 19000,
"lastPaymentAmount": 450,
"collateral": "Yes",
"collateralType": "Cash",
"guarantor": "Yes",
"guarantorType": "individual",
"guarantorDOBorDateOfIncorporation": "12/07/2002",
"guarantorFirstName": "Guator",
"guarantorLastName": "Testor",
"guarantorGender": "male",
"guarantorPhoneNumber": "08173902223",
"guarantorAddressLine1": "34 Kalu street",
"guarantorCity": "Algiers",
"guarantorState": "Lagos",
"guarantorCountry": "Nigeria",
"guarantorBVN": "10923874652",
"nextDueDate": "13/12/2022",
"maturityDate": "30/06/2023",
"loanDuration": "6 months",
"purpose": "Tuition",
"repaymentFrequency": "monthly",
"accountDescription": "Creditchek user account",
"currency": "NGN",
"accountStatus": "Open",
"nationality": "Nigeria",
"legalChallengeStatus": "No",
"consentStatus": "Yes"
}
]
}'
---
Response
{
"status": true,
"data": {},
"message": "Bulk Data submitted successfully, count: 7",
"error": false
}