--- updatedAt: 2026-08-19T07:44:15.000Z agentTools: projectIndex: https://docs.tarabut.com/llms.txt --- # Get Salary Check 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. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Income Insights", "description": "APIs for the Tarabut Gateway sandbox environment. Before you begin, please create the 'clientId' and 'clientSecret' from Tarabut Gateway Dev Portal.", "version": "1.0.0" }, "servers": [ { "url": "https://api.sau.sandbox.tarabutgateway.io" } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "Your access token generated from the [Create Access Token](https://docs.tarabut.com/v2.0/reference/createaccesstokenv2) endpoint, the access token will contain `X-TG-CustomerUserId` that was added when the token was generated" } } }, "security": [ { "bearerAuth": [] } ], "paths": { "/insights/v1/income/salary": { "get": { "tags": [ "Income Insights" ], "summary": "Get Salary Check", "description": "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.", "operationId": "getIncomeInsightsSalary", "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string", "description": "Specify the body format to JSON format", "default": "application/json" }, "required": true }, { "name": "months", "in": "query", "schema": { "type": "integer", "format": "int32", "maximum": 12, "minimum": 1, "description": "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", "default": 3 } }, { "name": "purposeStatement", "in": "query", "schema": { "type": "string", "description": "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" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "accounts": { "type": "array", "description": "Array of objects contains list of the accounts as well as their income insights", "items": { "type": "object", "properties": { "accountId": { "type": "string", "description": "Unique `accountId` that has been returned on the [Get Accounts](https://docs.tarabut.com/v2.0/reference/getaccountsv2) endpoint" }, "accountCurrency": { "type": "string", "description": "Currency code associated with account. Supports all ISO 4217 currency codes" }, "providerId": { "type": "string", "description": "Unique identifier of the financial institution (see [providers](https://docs.tarabut.com/v2.0/reference/getproviders) endpoint) to which the account belongs" }, "source": { "type": "string", "description": "The source of the account insights, e.g. `Bank API`" }, "lastUpdated": { "type": "string", "format": "date-time", "description": "Timestamp of the account's last update in DateTime format (ISO-8601)" }, "accountHasSalary": { "type": "boolean", "description": "Salary insight indicator, if the salary is found the value will be `true` otherwise, will be `false`" }, "startDate": { "type": "string", "format": "date", "description": "Start date of the income insight result" }, "endDate": { "type": "string", "format": "date", "description": "End date of the income insight result" }, "salarySummary": { "type": "array", "description": "Array of objects contains details of salary stream along with transactions details", "items": { "type": "object", "properties": { "streamType": { "type": "string", "description": "The type of the income stream, e.g. `Salary`" }, "frequency": { "type": "string", "description": "The frequency of the salary stream, e.g. `Monthly`" }, "count": { "type": "integer", "format": "int32", "description": "The total number of transactions matches the stream type" }, "transactions": { "type": "array", "description": "Array of objects containing transaction details for the salary stream.", "items": { "type": "object", "properties": { "transactionId": { "type": "string", "description": "Unique transaction ID (generated by Tarabut) for every transaction" }, "description": { "type": "string", "description": "Description of the transaction provided by the financial institution" }, "monthIndicator": { "type": "integer", "format": "int32", "description": "Month of the transaction. The value for this field starts from 1(01 = January) to 12 (12 = December)" }, "amount": { "type": "string", "description": "Actual amount value, which is always rounded to up to 3 decimal places" }, "date": { "type": "string", "description": "Timestamp of when the transaction was booked in DateTime format (ISO-8601)" } } } } } } } } }, "example": [ { "accountId": "7eeec027-16d2-41bf-abad-70a81aabb2b3", "accountCurrency": "SAR", "providerId": "BLUE", "source": "Bank API", "lastUpdated": "2024-11-04T00:00:00.123Z", "accountHasSalary": true, "startDate": "2024-09-01", "endDate": "2024-11-30", "salarySummary": [ { "streamType": "Salary", "frequency": "Monthly", "count": 2, "transactions": [ { "transactionId": "8e3a5f5a-a24a-45a6-ba4c-c28ffff0794c", "description": "PAYROLL/ JAN salary 2024 ABC company", "monthIndicator": "10", "amount": "14000.00", "date": "2024-10-27T08:31:02.907Z" }, { "transactionId": "55090e5d-17a5-4555-8fe9-4a6713101bec", "description": "PAYROLL/ DEC salary 2023 ABC company", "monthIndicator": "09", "amount": "14000.00", "date": "2024-09-27T08:31:02.907Z" } ] } ] } ] } } } } } }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "error name", "example": "UNAUTHORIZED_ACCESS" }, "errorMessage": { "type": "string", "description": "error message", "example": "Access token used is expired" }, "traceId": { "type": "string", "description": "Tracing Id used when you contact support", "example": "278827398026513417" }, "details": { "type": "array", "description": "The array contains details of the error", "items": { "type": "object", "properties": { "fieldName": { "type": "string", "description": "Field name that has invalid input", "example": "Authorization" }, "message": { "type": "string", "description": "Error message of the invalid input", "example": "Expired bearer token" } } } } } } } } } } } } } } ```