v1

latestOpenAPI 3.0.22026-07-26480119.6 KB
Eligibility

Check eligibility for multiple documents

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

post/api/v1/eligibility/batch

Request body

document_numberstring required

Document number to check

document_kind'cpf' 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"
    }
  ]
}