Income Pattern

This endpoint allows developers to determine if a customer is a salary earner, and to determine the amount of employer's income.

Request

{{baseUrl}}/api/v1/financial/earning_structure

Headers

Parameter

Type

Description

AppId

string

you would need to create an app to get your app ID

Authorization

string

public secret key e.g prod_sk_1T1eSavlZxy02OT3OWlvbxK4G

Query Parameters

Parameter Type Description
account_id * string account ID gotten from the widget required
duration string can be 6_months, 12_months, 24_months only optional

Response Sample

{
  "entity": {
    "average_monthly_income": 1070300.0383333336,
    "salary_earner": false,
    "consistent": false,
    "number_of_days": 183
  }
}
curl -L -X GET '{{baseUrl}}/api/v1/financial/income_pattern ' \
-H 'Content-Type: application/json' \
-H 'Authorization: SECRET_KEY'
-H 'AppId: APP_ID'

Did this page help you?