Credit History
See the credit history of a person in the credit bureaus of Nigeria based on their BVN and returns the holder's credit profile, including the loan summary and their performance.
Endpoint
POST /kyc/nga/credit-history/{provider}Authentication
API Key
Header
x-api-key
Path parameters
provider
string
Yes
Credit bureau to query. Possible values: crc, xds, all (query both bureaus).
Request body
Content-Type: application/json
Parameters
bvn
string
Yes
Bank Verification Number of 11 digits of the holder.
Request example
POST /kyc/nga/credit-history/all{
"bvn": "12345678901"
}Responses
200 Success
Response parameters
serviceResultCode
integer
Code that indicates the overall result of the service execution. See Service Result Code
serviceTime
string
Processing time (milliseconds).
serviceResultLog
string
Descriptive field for the result of the service execution. Includes details when there is an error or exception in the module.
serviceTransactionId
string
Transaction identifier associated with the request processed by the API.
data
object
Object with the holder's credit profile. See the table below.
Response parameters — data
Note: the object data is returned without field mapping or normalization. The holder's profile and credit history are unique (consolidated), not one block per bureau.
providers
array
List of bureaus that returned information, as an array of strings. Possible values: crc, xds. When querying a single bureau, it contains only that value.
profile
object
Holder profile (unique). See the table below.
credit_history
array
Credit history grouped by financial institution. See the table below.
Response parameters — profile
full_name
string
Holder's full name.
date_of_birth
string
Date of birth.
gender
string
Gender, in lowercase. E.g.: male, female
address_history
array
Reported addresses. Each element contains address, type and date_reported.
email_address
array
Registered email addresses (array of strings).
phone_number
array
Registered phone numbers (array of strings).
identifications
array
Holder's identifications. Each element contains do (number) and type (e.g.: BVN, NIN, PENCOM).
Response parameters — credit_history[]
institution
string
Financial institution that reported the loans.
history
array
List of loans reported by the institution. See the table below.
Response parameters — history[]
date_opened
string
Loan opening date.
closed_date
string
Loan closing date.
currency
string
Loan currency. E.g.: NGN
institution
string
Financial institution (repeated within each loan).
loan_status
string
Loan status. E.g.: open, closed
opening_balance
number
Loan opening amount.
performance_status
string
Loan performance. E.g.: performing
repayment_amount
number
Repayment installment amount.
repayment_frequency
string
Repayment frequency. E.g.: monthly
repayment_schedule
array
Repayment schedule. Each element contains date and status.
tenor
number
Loan term (in months).
Service Result Code
The serviceResultCode indicates the overall result of the service execution and reflects the HTTP status code of the response:
200
The service execution was successful, the module processed the request correctly.
200
Response example
400 Bad Request
Returned when the provider specified is not valid. In this case the response uses the format application/problem+json, since validation occurs before before processing the request:
When the request contains incorrect data for the query, the error is returned with the service envelope (serviceResultCode reflects the HTTP code of the response):
502 Bad Gateway
Returned when the service is temporarily unavailable or its response could not be interpreted. The body uses the service envelope with serviceResultCode: 500:
504 Gateway Timeout
Timeout error, returned with the service envelope:
Last updated