API Reference
Tarabut Portal

Get Salary Check

get
https://api.sandbox.tarabutgateway.io/insights/v1/income/salary

Enables you to fetch salary information for a given user for the past 12 months. This API should be called from your backend/server and it returns a list of identified salaries for your customer account.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
1 to 12
Defaults to 3

You can specify the period for which you want to retrieve transactions, which can be any number of months from 1 to 12. If you don't specify a period, it will automatically be set to 3 months by default

string

To filter account responses based on the purpose statement, pass one of the following values PFM, ACCOUNT_AGGREGATION, CREDIT_ASSESSMENT, E_STATEMENT, ELECTRONIC_VERIFICATION, ENTERPRISE_FINANCIAL_MANAGEMENT, LETTER_OF_GUARANTEE, TAX_FILING, OTHER. By default, all accounts will be included regardless of the purpose statement

Headers
string
required
Defaults to application/json

Specify the body format to JSON format

Responses

Updated 10 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 10 months ago