TOtotalpass
Eligibility

Check eligibility for a single identifier

Changed on

Verifies whether a given employee identifier is eligible within the authenticated company group. Returns availability status and, when eligible, details about the associated store and holder.

get/api/v1/eligibility/single

Request

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

Query parameters

document_numberstring required

Identifier value (document/email/employee_number) to check

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

Type of the identifier

Response

Eligibility result returned

availableboolean required

Whether the identifier is eligible in this company group

kindstring required

Role of the eligible person (holder or dependent)

store_document_kindstring nullable

Identifier type of the matched company (store)

store_document_numberstring nullable

Identifier of the matched company (store)

holder_document_kindstring nullable

Identifier type of the holder (when kind is dependent)

holder_document_numberstring nullable

Identifier of the holder (when kind is dependent)

Example response

{
  "available": true,
  "kind": "holder",
  "store_document_kind": "cnpj",
  "store_document_number": "12345678000195",
  "holder_document_kind": "cpf",
  "holder_document_number": "98765432100"
}

Changes

  • 309daa2abc23Revision changes
    • info

      added the new enum value email to the query request parameter document_kind

    • info

      added the new enum value employee_number to the query request parameter document_kind