Get Employment

Provides insights into employment verification and salary consistency based on bank account, including legal employer name in Arabic and English and salary variance details. (only supported for retail accounts).

To verify the detected employer against an employer you already know (e.g. from GOSI), send employer_name_en and/or employer_name_ar.

This API is asynchronous, please read this guide for further information on how to fetch the results.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid
required

The entity_id you are querying for. The entity needs to have permissions accounts and transactions.

date

The start date in UTC (in the format YYYY-MM-DD) you want to query the employment for. Defaults to the entity consent's start date if not provided.

string
length ≤ 200

English name of the employer you received from another source (e.g. GOSI), to verify against the employer detected from the entity's salary transactions.

When employer_name_en or employer_name_ar is provided, each detected employer is compared with the provided names instead of Lean's verified employer list. The highest similarity score across the provided names is used. If it is 0.70 or more, matched_reference_employer returns the provided names, with cr_number set to null. Otherwise matched_reference_employer is null.

Matching ignores letter case, Arabic diacritics and legal forms such as "Co.", "LLC" or "شركة". A name only matches a bank employer name written in the same script, and bank transactions can describe the employer in either language, so send both names when you have them. Empty values are ignored.

string
length ≤ 200

Arabic name of the employer you received from another source (e.g. GOSI), to verify against the employer detected from the entity's salary transactions.

Can be sent on its own or together with employer_name_en. See employer_name_en for how matching works.

boolean
Defaults to true
deprecated

When true the API will return a results_id which can be fetched from the /data/v2/results endpoint when ready. Note: it''s recommended to use the sync flow (async=false) for all requests by adapting the data workflow for connected entities.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json