API Reference
SDK IntegrationAPI ReferenceBlogDashboard

Income estimate monthly (Nigeria)

get
https://api.pngme.com/api/v1/nigeria/income/model-estimate

Predicts the monthly income in units of Ngn for a given user.

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

This model is optimized for users who primarily transact in Nigeria Naira. Use Predict Income (Kenya) for users who primarily transact in Kenyan Shillings.

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

403

Not authorized

Updated 10 months ago

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

Updated 10 months ago

Did this page help you?