Request

Periculum

cURL

curl --location --request POST 'https://api.insights-periculum.io/statements/custombureaudata'
--header 'Authorization: Bearer string_encrypted_access_token'
--header 'Content-Type: application/json'
--data-raw '{
{
    "statementKey": 1,
    "bvn": "******",
    "mfCreditHasCreditFacilities": "YES",
    "mfCreditNumberOfDelinqCreditFacilities": "0",
    "mgCreditHasCreditFacilities": "NO",
    "mgCreditNumberOfDelinqCreditFacilities": "0",
    "creditHasCreditFacilities": "YES",
    "creditNumberOfDelinqCreditFacilities": "0",
    "creditLastReportedDate": "28-OCT-2021",
    "citizenship": "NG",
    "dateOfBirth": "15-JAN-1993",
    "firstName": "John",
    "lastName": "Doe",
    "gender": "001",
    "mailTo": "[email protected]",
    "productName": "Insights",
    "reportDate": "05-Nov-2021",
    "providerSource": "Custom",
    "statementBureauAccountData": [{
            "accountName": "John Doe",
            "accountNo": "0198********53",
            "balance": "52000",
            "type": "Open",
            "payStatus": "paid",
            "paymentTerms": "monthly",
            "dateOpened": "1/1/2020",
            "responsibility": "none",
            "addressIdentificationNumber": "A-25",
            "creditLimit": "500000",
            "highBalance": "300000",
            "monthlyPayment": "10000",
            "recentPaymentAmount": "20000",
            "statementBureauAccountPaymentHistory": [
				{
                    "month": "July",
                    "year": "2022",
                    "status": "OK"
                },
				{
                    "month": "June",
                    "year": "2022",
                    "status": "OK"
                }				
            ],
			"statementBureauAccountAddressHistory": [
				{
                    "address": "L-23",
                    "addressType": "Residential",
                    "dateReported": "1/JAN/2020"
                },
				{
                    "address": "L-24",
                    "addressType": "Residential",
                    "dateReported": "1/FEB/2020"
                }				
            ],
			"statementBureauAccountContactHistory": [
				{
                    "contactType": "3484600",
                    "details": "dummy details",
                    "dateReported": "1/1/2020"
                },
				{
                    "contactType": "2493268",
                    "details": "dummy details 2",
                    "dateReported": "1/1/2020"
                }				
            ],
            "statementBureauAccountHeaderReasons": [
				{
                    "reason": "Reason1"
                },
				{
                    "reason": "Reason2"
                }				
            ]
        },
        {
            "accountName": "John",
            "accountNo": "5160********53",
            "balance": "24000",
            "type": "Open",
            "payStatus": "unpaid",
            "paymentTerms": "bi-weekly",
            "dateOpened": "1/5/2020",
            "responsibility": "none",
            "addressIdentificationNumber": "K9",
            "creditLimit": "100000",
            "highBalance": "20000",
            "monthlyPayment": "5000",
            "recentPaymentAmount": "10000",
            "statementBureauAccountPaymentHistory": [
				{
                    "month": "March",
                    "year": "2022",
                    "status": "OK"
                },
				{
                    "month": "April",
                    "year": "2022",
                    "status": "OK"
                }				
            ],
			"statementBureauAccountAddressHistory": [
				{
                    "address": "L-25",
                    "addressType": "Residential",
                    "dateReported": "1/MAR/2020"
                },
				{
                    "address": "L-26",
                    "addressType": "Residential",
                    "dateReported": "1/APR/2020"
                }				
            ],
			"statementBureauAccountContactHistory": [
				{
                    "contactType": "3358066",
                    "details": "dummy details1 second account",
                    "dateReported": "1/1/2020"
                },
				{
                    "contactType": "2327048",
                    "details": "dummy details2 second account",
                    "dateReported": "1/1/2020"
                }				
            ],
            "statementBureauAccountHeaderReasons": [
				{
                    "reason": "Reason1 second account"
                },
				{
                    "reason": "Reason2 second account"
                }				
            ]
        }
    ]}

Request Parameters

Name	Description	Type	Required
statementKey	The key of the statement to get the credit bureau data for.	int	Yes
bvn		string	No
mfCreditHasCreditFacilities		string	No
mfCreditNumberOfDelinqCreditFacilities		string	No
mgCreditHasCreditFacilities		string	No
mgCreditNumberOfDelinqCreditFacilities		string	No
creditHasCreditFacilities		string	No
creditNumberOfDelinqCreditFacilities		string	No
creditLastReportedDate		string	No
citizenship		string	No
dateOfBirth		string	No
firstName		string	No
lastName		string	No
gender		string	No
mailTo		string	No
productName		string	No
reportDate		string	No
providerSource		string	Yes
statementBureauAccountData		array	No
statementBureauAccountData[i].accountName		string	No
statementBureauAccountData[i].accountNo		string	No
statementBureauAccountData[i].balance		string	No
statementBureauAccountData[i].type		string	No
statementBureauAccountData[i].payStatus		string	No
statementBureauAccountData[i].paymentTerms		string	No
statementBureauAccountData[i].payStatus		string	No
statementBureauAccountData[i].dateOpened		string	No
statementBureauAccountData[i].responsibility		string	No
statementBureauAccountData[i].addressIdentificationNumber		string	No
statementBureauAccountData[i].creditLimit		string	No
statementBureauAccountData[i].highBalance		string	No
statementBureauAccountData[i].recentPaymentAmount		string	No
statementBureauAccountData[i].statementBureauAccountPaymentHistory		array	No
statementBureauAccountData[i].statementBureauAccountPaymentHistory[x].month		string	No
statementBureauAccountData[i].statementBureauAccountPaymentHistory[x].year		string	No
statementBureauAccountData[i].statementBureauAccountPaymentHistory[x].status		string	No
statementBureauAccountData[i].statementBureauAccountAddressHistory		array	No
statementBureauAccountData[i].statementBureauAccountAddressHistory[x].address		string	No
statementBureauAccountData[i].statementBureauAccountAddressHistory[x].addressType		string	No
statementBureauAccountData[i].statementBureauAccountAddressHistory[x].dateReported		string	No
statementBureauAccountData[i].statementBureauAccountContactHistory		array	No
statementBureauAccountData[i].statementBureauAccountContactHistory[x].contactType		string	No
statementBureauAccountData[i].statementBureauAccountContactHistory[x].details		string	No
statementBureauAccountData[i].statementBureauAccountContactHistory[x].dateReported		string	No
statementBureauAccountData[i].statementBureauAccountHeaderReasons		array	No
statementBureauAccountData[i].statementBureauAccountHeaderReasons[x].Reason		string	No