API Response Body
{
"meta": {
"created_at": "2021-10-31T00:00:00+00:00",
"user_uuid": "958a5ae8-f3a3-41d5-ae48-177fdc19e3f4"
},
"user": {
"first_name": "Mercy",
"last_name": "Otieno",
"phone_number": "254123456789"
},
"depository": {
"total_balances": 13404,
"total_accounts": 1,
"accounts": [
{
"institution_id": "mpesa",
"account_id": "default",
"balance": 13404,
"iso_currency_code": "KES",
"updated_at": "2021-10-18T20:27:29+00:00"
}
]
},
"loan": {
"open_accounts": 2,
"open_balances": 9300,
"nonperforming_accounts": 0,
"nonperforming_balances": 0,
"defaulted_accounts": 0,
"defaulted_balances": 0,
"closed_accounts": 2,
"accounts": [
{
"institution_id": "credithela",
"account_id": "5755581653",
"status": "open",
"principal": 500,
"balance": 500,
"iso_currency_code": "KES",
"updated_at": "2021-10-18T08:23:08+00:00"
},
{
"institution_id": "credithela",
"account_id": "default",
"status": "closed",
"principal": null,
"balance": 0,
"iso_currency_code": null,
"updated_at": "2021-10-18T08:21:21+00:00"
},
{
"institution_id": "okash",
"account_id": "default",
"status": "open",
"principal": 8800,
"balance": 8800,
"iso_currency_code": "KES",
"updated_at": "2021-10-17T19:52:41+00:00"
},
{
"institution_id": "okoajahazi",
"account_id": "default",
"status": "closed",
"principal": null,
"balance": 0,
"iso_currency_code": "KES",
"updated_at": "2021-10-18T09:28:44+00:00"
}
]
}
}
Summary
Pngme's Alternative Credit Report provides a comprehensive overview of a borrower's financial profile, offering insight into an individual's savings and debt profiles.
Fields
user.*
The mobile phone user's name and phone number, as registered by the Pngme SDK in the client's mobile app.
depository.total_balances
Sum of latest balances across all depository accounts.
depository.total_accounts
Count of total number of depository accounts.
depository.accounts[]
Depository account information, broken down on a per-account basis.
depository.accounts[].institution_id
An institution identifier for the institution with which the user has an account.
depository.accounts[].account_id
An account identifier for the account. A common value is "default", for the default account of the user with the given institutions.
depository.accounts[].balance
The latest balance value.
depository.accounts[].iso_currency_code
ISO currency code for the latest balance value. See Currency Codes ]
depository.accounts[].updated_at
ISO timestamp for the last observed balance statement on the account.
loan.*_accounts
Count of accounts in the "open", "nonperforming", "defaulted" or "closed" status.
loan.*_balances
Sum of latest balances across accounts with "open", "nonperforming" or "defaulted" status.
loan.accounts[]
loan account information, broken down on a per-account basis.
depository.loan[].institution_id
An institution identifier for the institution with which the user has an account.
loan.accounts[].account_id
An account identifier for the account. A common value is "default", for the default account of the user with the given institutions.
loan.accounts[].status
The loan status. One of ["open", "nonperforming", "defaulted", "closed].
loan.accounts[].principal
The original loan amount, if available.
loan.accounts[].balance
The latest balance value.
loan.accounts[].iso_currency_code
ISO currency code for the latest balance value. See Currency Codes ]
loan.accounts[].updated_at
ISO timestamp for the last observed balance statement on the account.