API Reference
SDK IntegrationAPI ReferenceBlogDashboard

Discretionary Income (Kenya)

get
https://api.pngme.com/api/v1/kenya/income/discretionary-estimate

Returns a discretionary income, which is the money you have after paying all necessary living expenses and financial obligations

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

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

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.

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.

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.

Responses

400

Invalid parameters or insufficient data to estimate income

401

Not authenticated

403

Not authorized

Updated 7 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago