Validates 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.

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

Employee's document number

string
required
Headers
string
required

The api-key used for authentication

Responses

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