Income Pattern
This endpoint allows developers to determine if a customer is a salary earner, and to determine the amount of employer's income.
GET Lookup Income Pattern
1
{{baseUrl}}/api/v1/financial/earning_structure
Copied!
Params
Curl
Response
Parameters
Type
Description
account_id required
string
Account ID
gotten from the widget
duration
string
Can be 6_months, 12_months, 24_months only
1
curl -L -X GET '{{baseUrl}}/api/v1/financial/income_pattern' \
2
-H 'Content-Type: application/json' \
3
-H 'Authorization: SECRET_KEY'
4
-H 'AppId: APP_ID'
Copied!
1
{
2
"entity": {
3
"average_monthly_income": 1070300.0383333336,
4
"salary_earner": false,
5
"consistent": false,
6
"number_of_days": 183
7
}
8
}
Copied!
Last modified 6mo ago
Copy link