Configuration
Streams and Fields
companies
companies
Company information linked to the authenticated user.Key Fields
id- Company IDcompanyName- Legal company name (razao social)fantasyName- Trade name (nome fantasia)cnpj- Company CNPJ numberresponsibleName- Responsible person name
establishment_documents
establishment_documents
Document compliance status for each establishment, including worker qualifications within each establishment.Key Fields
id- Establishment IDname- Establishment namestatus- Current statusactivated- Whether the establishment is activeamountOfRegular- Count of documents with regular statusamountOfIrregular- Count of documents with irregular statusworkers- Array of workers with their qualification documents (fileName, description, situation, realizationDate, active)
supplier_documents
supplier_documents
Document compliance status for registered suppliers.Key Fields
id- Supplier IDcorporateName- Supplier legal namefantasyName- Supplier trade namecnpj- Supplier CNPJqualifications- Array of qualification documents (fileName, description, situation, realizationDate, active)
worker_documents
worker_documents
Document compliance status for registered workers.Key Fields
id- Worker IDcontractType- Contract type (e.g., Tempo Indeterminado)name- Worker namecompany- Company namegender- GenderfunctionDescription- Job functionstatus- Active statusqualifications- Array of qualification documents (fileName, description, situation, realizationDate, active)
workers
workers
Complete worker information including personal data, contact, and employment details. From the Catraca (access control) API.Key Fields
id- Worker IDname- Worker namecpf- CPF numberhiringType- Hiring type (e.g., CLT)contractType- Contract typecompany- Company namegender- Gendercbo/cboSynonyms- CBO code and descriptionbirthDate- Date of birthdegree- Education leveladmissionAt- Admission dateaccessCardNumber- Access card numbercontact- Contact object (email, phone, cep, address, number, complement, district, city, uf)specialNeeds- Special needs flagoriginRecord- Record originstatus- Active status
worker_entrance_permissions
worker_entrance_permissions
Entrance permissions for workers at each establishment. Only workers with “Regular” document situation have access allowed.Key Fields
name- Worker namecpf- Worker CPFsituation- Document situation (Regular, Pendente, Irregular, Em Vencimento)accessAllowed- Whether entrance is allowed (true/false)establishment_id- ID of the establishment
This stream is a child of
establishment_documents. It fetches permissions for each establishment automatically.