API response body

{
  "user": {
      "first_name": "Mercy",
      "last_name": "Otieno",
      "phone_number": "254123456789",
      "external_id": "f196eeb9-4d47-46a9-a90d-2e23ba8559d4",
      "user_uuid": "ass-ddsw-asdfv-awed"
  },
  "features": {
      "count_loan_defaulted_events_0_90": 1,
      "count_opened_loans_0_90": null,
      "count_transactions_depository_0_90": 284,
      "count_user_shared_device_ids_0_10": 0,
      "daily_average_of_stacked_loan_alerts_0_90": 1.48,
      "data_recency_minutes": 62370,
      "median_end_of_day_depository_balance_0_90": 2913.0,
      "net_cash_flow_0_90": 8789.76,
      "depository_balances_latest": [
            {
                "account_id": "default",
                "balance": 13404.7,
                "currency": "KES",
                "institution_id": "mpesa",
                "institution_display_name": "M-Pesa",
                "timestamp": "2021-10-18T20:27:29+00:00"
            },
            {
                "account_id": "5253***0785",
                "balance": 414.13,
                "currency": "KES",
                "institution_id": "kcb",
                "institution_display_name": "KCB Bank Kenya Limited",
                "timestamp": "2021-10-12T08:28:02+00:00"
            }
        ]
     }
}

Summary

"Features" are values derived from the user’s data, which can be used directly in a loan decisioning flow. Examples of features generated by Pngme are:

featuredefinitionresponse value
count_loan_defaulted_events_0_90count of loan defaulted events, across all of a user's accounts, over a 90 days history prior to the utc_time date.int
count_opened_loans_0_90count of institutions where loans have been opened, over a 90 days history prior to the utc_time date.int
count_transactions_depository_0_90count of depository transactions, over a 90 days history prior to the utc_time dateint
count_user_shared_device_ids_0_10Computes the number of users with same device as the provided one for the last 10 daysint
depository_balances_latestlatest balances for all depository accounts in the last 2 years{list, null}
daily_average_of_stacked_loan_alerts_0_90Average number of stacked loan alerts per day over a 90 days history prior to the utc_time datefloat
data_recency_minutescomputes the time in minutes between the utc_time date and the most recent financial event or alert{int, null}
median_end_of_day_depository_balance_0_90Median of daily of total balance held in all depository accounts{float, null}
net_cash_flow_0_90computes the net cash flow for a user, over a 90 days history prior to the utc_time date.{float, null}

Fields

user[].user_uuid

A unique identifier for the user, used as the user_uuid path parameter for other endpoints, and provided by the Android SDK.

user[].first_name

The user's first name, provided by the Android SDK.

user[].last_name

The user's last name, provided by the Android SDK.

user[].phone_number

The user's phone number, provided by the Android SDK.

user[].external_id

External identifier configured while integrating the Android SDK. Can be used to identify users in other identity systems.

features[]

Key-value pairs for the features requested by the api caller.