Skip to main content
The Employee is the link of an individual — identified by CPF (gov_id) — to an organization, in a hierarchy position (branch × sector × position). It is the aggregate that drives the occupational exam lifecycle: each relevant action on the employee generates an exam pendency.

​
Identifiers (don’t mix them up)

The SOC/eSocial-sensitive fields — e_social, e_social_category and employee_registration_number — preserve internal whitespace and are not normalized. Send them exactly as required by eSocial.

​
Main fields

The canonical list of required/optional fields is always the endpoint schema (rendered from the OpenAPI). Use this page for the meaning; use the reference page for the exact contract.

​
Lifecycle and events

Each event on the employee generates an exam pendency of the matching type:

​
PCD and disability analysis

When is_disabled = true, the employee may be associated with a PCD analysis (field disability_analysis_id), which validates the disability condition.

​
Double bond

The same CPF can exist in more than one organization when “double bond” is enabled for the client. That is: the Person (CPF) is unique, but may have distinct employees across distinct organizations.

​
Endpoints

Create employee

List employees

Update employee

Dismiss employee