TOtotalpass
Eligibility

Check eligibility for multiple identifiers

Changed on

Verifies eligibility for a list of identifiers in a single request. Returns the availability status for each identifier provided. Useful for validating large sets of employees at once.

post/api/v1/eligibility/batch

Request

  • Base URL
    https://company-eligibles-api.totalpass.com
  • URL
    https://company-eligibles-api.totalpass.com/api/v1/eligibility/batch
  • Auth
    HTTP bearer

Request body

document_numberstring required

Eligible identifier value (document/email/employee_number) to check

document_kind'cpf' | 'email' | 'employee_number' required

Type of the document

Example request

[
  {
    "document_number": "12345678901",
    "document_kind": "cpf"
  }
]

Response

Batch eligibility results returned

Example response

{
  "data": [
    {
      "available": true,
      "document_number": "12345678901"
    }
  ]
}

Changes

  • 309daa2abc23Revision changes
    • info

      added the new email enum value to the request property /

    • info

      added the new employee_number enum value to the request property /