Skip to main content

Dados do trabalhador (private-payroll-employee-data)

Rota base v5/private-payroll-employee-data. Ver visão geral do módulo.

Para um vínculo específico, consulta na Dataprev (consultar-dados-trabalhador) os dados cadastrais, a remuneração, a margem consignável disponível, alertas e empréstimos já existentes. O resultado é gravado como uma consulta persistida, com os dados principais na raiz e as listas filhas alerts e legacyLoans.

Processamento assíncrono

O POST não aguarda a Dataprev. A API valida o que não depende do provedor, grava a consulta com status pending ("Consultando") e responde imediatamente com esse registro. Em segundo plano, a consulta é feita na Dataprev e o mesmo registro é atualizado para success ou error. Acompanhe o resultado assinando os eventos private_payroll_employee_data.completed e private_payroll_employee_data.failed, cujo payload é a própria consulta, no mesmo formato da resposta do POST. Esta API não expõe GET /{id} para este recurso: o webhook é a forma de receber o resultado.

Autenticação​

API Key. Exige a permissão "Consultar dados do trabalhador".

Rotas implementadas​

RotaVerboResumo
/v5/private-payroll-employee-dataPOSTRegistra a consulta dos dados do trabalhador para um vínculo e processa em segundo plano.

Leitura por id, busca e filtros deste recurso ficam no portal da Semear e não são expostos na API de integração.

Campos da entidade​

Identificação da consulta​

CampoTipoDescrição
id / codestring (uuid) / integerIdentificadores da consulta gravada.
authorizationTermIdstring (uuid)Termo usado.
employmentRelationshipIdstring (uuid)Vínculo consultado (items[].id da consulta de vínculos).
providerobject (code/key/name)Sempre dataprev.
statusobject (Status)pending (1, Consultando), success (2, Sucesso) ou error (3, Erro). Em erro, note traz o motivo retornado pela Dataprev. Ver PrivatePayrollEmployeeDataStatus.
queriedAtstring (date-time)Momento em que a consulta foi registrada.
documentNumberstringCPF do trabalhador (do termo).
registrationNumber, employerDocumentType, employerDocumentNumberstring / CodeName / stringChave do vínculo, copiada do item de vínculo.

Dados cadastrais​

CampoTipoDescrição
name, birthDate, motherNamestring / date / stringDados civis conforme o cadastro do empregador.
genderobject (code/name)Gênero, código Dataprev.
nationalityCountryobject (code/name)País de nacionalidade (código numérico).
politicallyExposedPersonobject (code/name)Indicador de pessoa politicamente exposta.
workerCategoryCodeintegerCategoria do trabalhador (eSocial).
cboobject (code/name)Ocupação (Classificação Brasileira de Ocupações).

Análise de crédito​

CampoTipoDescrição
isEligible / ineligibilityReasonboolean / string | nullElegibilidade final e motivo, se negativo.
totalEarningsAmountdecimalRemuneração total.
marginBaseAmountdecimalBase sobre a qual a margem é calculada.
availableMarginAmountdecimalMargem consignável disponível. A parcela do novo contrato não pode ultrapassar este valor.
activeSuspendedLoansCountintegerEmpréstimos ativos ou suspensos no vínculo.
loanBlockTypeobject (code/name)Tipo de bloqueio para empréstimo. 0 = sem bloqueio.
availableSeveranceRatedecimalPercentual da multa rescisória disponível para garantia.

Vínculo e empregador​

CampoTipoDescrição
admissionDate, terminationDate, terminationReasonCodedate / date | null / integer | nullAdmissão e, se houver, desligamento e motivo.
employerNamestringRazão social do empregador.
cnaeobject (code/name)Atividade econômica do empregador.
employerActivityStartDatedateInício da atividade do empregador.

Listas filhas​

CampoTipoDescrição
alerts[]arrayAlertas cadastrais devolvidos pelo provedor.
legacyLoans[]arrayEmpréstimos já existentes no vínculo. Cada item traz ao menos contractNumber e outstandingBalanceAmount.

Os dados cadastrais, de análise de crédito, de vínculo e as listas filhas só são preenchidos quando a consulta termina com success.

POST /v5/private-payroll-employee-data​

Registra a consulta dos dados do trabalhador para um vínculo e processa em segundo plano.

Autenticação: API Key. Exige permissão de consulta de dados do trabalhador.

Comportamento​

  1. Carrega o termo e valida active + token (4051003–4051005).
  2. Carrega o vínculo (4051008) e valida que o CPF dele é o do subject do termo (4051009) e que tem matrícula e inscrição do empregador (4051010).
  3. Grava a consulta com status pending e responde 201 com o registro, sem aguardar a Dataprev.
  4. Em segundo plano, chama a Dataprev com CPF, matrícula, tipo e número de inscrição do empregador e o token do termo. Falhas temporárias do provedor (tempo esgotado, indisponibilidade) são repetidas automaticamente algumas vezes, com espera crescente; quando a cota da Dataprev é excedida, o processamento é adiado até o horário indicado pelo provedor. Erros de negócio encerram a consulta na hora.
  5. Atualiza o mesmo registro: success com os dados devolvidos, ou error com o motivo da Dataprev em status.note. O evento correspondente (private_payroll_employee_data.completed ou .failed) é publicado.

Payload de entrada​

Campos enviados pela requisição Consulta dados do trabalhador da collection, na mesma ordem.

Visualizar parâmetros
CampoTipoObrigatórioDescrição
authorizationTermIdstring (uuid)SimTermo active com token. O CPF consultado vem do subject. Ausente → 4051002.
employmentRelationshipIdstring (uuid)Simitems[].id de um vínculo devolvido em Vínculos. Ausente → 4051007. Não confundir com o id da consulta de vínculos (→ 4051008).

Exemplo de Requisição e Resposta​

Visualizar Body
{
  "authorizationTermId": "{{termId}}",
  "employmentRelationshipId": "{{employmentRelationshipId}}"
}