Sign in

v1

latestOpenAPI 3.0.22026-07-26480119.6 KB
Eligibility

Check eligibility for a single document

Verifies whether a given employee document 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

Query parameters

document_numberstring required

Document number to check (digits only, no punctuation)

document_kind'cpf' required

Type of the document

Response

Eligibility result returned

availableboolean required

Whether the document 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"
}