Features (India)

get

https://api.pngme.com/api/v1/india/features

Returns features for Indian customers.

To retrieve a subset of features, provide a list of feature names in the features query parameter. To retrieve all features, omit the features query parameter.

To retrieve average loan balances and depository balances for a specified institution provide one or a list of institution ids in the institutions query parameter. The list of institution ids for a specific user can be found in the Institutions by user id endpoint

To retrieve the features in a year set all_time parameter to True or Yes, case sensitive

The user is identified by providing one of user_uuid, phone_number, or external_id.

The features are:

average_end_of_day_depository_balance
average_end_of_day_loan_balance
count_betting_and_lottery_events
count_insufficient_funds_events
count_loan_declined_events
count_loan_defaulted_events
count_loan_missed_payment_events
count_loan_opened_events
count_loan_repayment_events
count_of_currencies
count_of_institutions
count_overdraft_events
count_transactions_depository
count_user_shared_device_ids
count_user_shared_phone_numbers
daily_average_of_stacked_loan_alerts
daily_average_of_stacked_loan_fes
difference_count_of_loans_opened_to_loans_delinquent
difference_count_of_loans_opened_to_loans_repaid
loan_sharks_alert_institutions_ratio
loan_sharks_fes_ratio
median_depository_credit
median_depository_debit
median_end_of_day_depository_balance
median_end_of_day_loan_balance
min_end_of_day_depository_balance
net_cash_flow
primary_currency
slope_end_of_day_depository_balance
slope_end_of_day_loan_balance
stdev_end_of_day_depository_balance
sum_of_atm_credits
sum_of_atm_debits
sum_of_betting_and_lottery_debits
sum_of_credits
sum_of_debits
sum_of_depository_balances_latest
sum_of_depository_transactions_between_user_accounts
sum_of_loan_debits
sum_of_loan_repayments
sum_of_non_mpesa_credits
sum_of_non_mpesa_debits
sum_of_pos_credits
sum_of_pos_debits

More features can be found in the Feature Grouping section

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

phone_number

string

Defaults to 25412345678X

Phone number including the country code. This should match the phone number passed to the mobile SDK. If given, external_id and user_uuid must not be specified.

external_id

string

Identifies the user using a key external to Pngme's systems. This should match the external_id passed to the mobile SDK. If given, phone_number and user_uuid must not be specified.

user_uuid

string

Unique identifier generated when a user is created by your mobile app. If given external_id and phone_number must not be specified.

utc_time

date-time

Defaults to 2023-11-17T00:00:00

Represents the timestamp until which all the fields of the report will be calculated. If not specified, the request instant will be used as timestamp.

features

array of strings

Optional comma delimited set of features to be included in the response.

features

institution_ids

string

Optional Institutions ids to filter features, one or more can be provided. When provided, only end of day loan balance and end of day depository balance features related to the specified institutions will be returned.

all_time

string

Boolean value, when set to True, returns all the features but in a period of one year instead of the periods 0-30, 0-90 and 31-90.

Responses

400

Invalid parameters or unable to find the user

401

Not authenticated

403

Not authorized

200Returns all (or a subset) of financial modeling features.