Skip to main content

Domínios — Consignado Privado

PrivatePayrollEmploymentRelationshipStatus​

Devolvido em status de Vínculos empregatícios.

CodeKeyNomeCorSignificado
1successSucessoVerdeO provedor devolveu ao menos um vínculo.
2emptySem VínculosCinzaO provedor respondeu, mas não há vínculos.
3errorErroVermelhoFalha no provedor. A consulta é gravada mesmo assim.
4pendingConsultandoAmareloConsulta registrada, aguardando o processamento na Dataprev em segundo plano.

PrivatePayrollEmployeeDataStatus​

Devolvido em status de Dados do trabalhador.

CodeKeyNomeCorSignificado
1pendingConsultandoAmareloConsulta registrada, aguardando o processamento na Dataprev em segundo plano.
2successSucessoVerdeO provedor devolveu os dados do trabalhador.
3errorErroVermelhoFalha no provedor. note traz o motivo retornado pela Dataprev.

PrivatePayrollFgtsBalanceStatus​

Devolvido em status de Saldo FGTS.

CodeKeyNomeCorSignificado
1pendingConsultandoAmareloConsulta registrada, aguardando o processamento na Dataprev em segundo plano.
2successSucessoVerdeO provedor devolveu o saldo e a multa rescisória.
3errorErroVermelhoFalha no provedor. note traz o motivo retornado pela Dataprev.

Nos três tipos de consulta, só as consultas com success são consideradas quando outro fluxo da API procura a última consulta válida de um trabalhador ou vínculo.

Provider​

Todas as consultas deste módulo devolvem provider = { 100, "dataprev", "Dataprev" } — o mesmo valor de AuthorizationTermProvider.

Códigos vindos da Dataprev (CodeName)​

Os campos abaixo não são listas fixas da API: code e name são repassados da resposta da Dataprev. Os valores listados são os observados nos exemplos da collection; outros podem ocorrer.

employerDocumentType​

CodeNomeSignificado
1CNPJEmpregador pessoa jurídica. employerDocumentNumber com 14 dígitos.
2CPFEmpregador pessoa física (doméstico, produtor rural). employerDocumentNumber com 11 dígitos.

loanBlockType​

CodeNome
0Sem Bloqueio

Outros códigos indicam bloqueio à contratação registrado pelo trabalhador ou pelo empregador.

politicallyExposedPerson​

CodeNome
0Pessoa Não Exposta Politicamente

gender (na consulta Dataprev)​

CodeNome
1Masculino
2Feminino

Difere de Gender usado no borrower do empréstimo, que tem key.

nationalityCountry, cbo, cnae​

Códigos numéricos padrão (país ISO 3166 numérico, Classificação Brasileira de Ocupações e CNAE) com a descrição devolvida pelo provedor.

Códigos de erro da Dataprev na consulta de FGTS​

Repassados em status.note da consulta de saldo FGTS que termina com error:

CódigoSignificado
IVTrabalhador não autorizou a consulta ao saldo FGTS no aplicativo da Carteira de Trabalho Digital, ou a autorização (30 dias) expirou.
TSVínculo encerrado.