v1
latestOpenAPI 3.0.22026-07-26480119.6 KBValidates user eligibility to partner app
The TotalPass Partner App API enables partner applications to determine user eligibility for app access. By sending a POST request, the API validates user eligibility based on the provided employee document number. The request must include a JSON payload containing the "employee_document_number" parameter. The API response will indicate whether the specified employee is eligible to use the partner app. Access is determined by the validation process, allowing the partner app to make informed decisions on user access privileges. Obs: The "x-api-key" header is essential for authentication and authorization, ensuring secure communication between the partner app and the TotalPass API.
Headers
The api-key used for authentication
Request body
Example request
{
"employee_document_number": 62422254098
}Response
When the http status is success, the API response will include detailed information about the employee and their access to the partner app. Employee data, such as name, email, date of birth, and phone number, will be provided on "employee_data" section. Additionally, the "app_data" section will contain information about the app, specifying the features or functionalities accessible to the user, allowing the partner app to determine the user's available options or restrictions within the application.