Domínios — Consignado Privado
PrivatePayrollEmploymentRelationshipStatus
Devolvido em status de Vínculos empregatícios.
| Code | Key | Nome | Cor | Significado |
|---|---|---|---|---|
1 | success | Sucesso | Verde | O provedor devolveu ao menos um vínculo. |
2 | empty | Sem Vínculos | Cinza | O provedor respondeu, mas não há vínculos. |
3 | error | Erro | Vermelho | Falha no provedor. A consulta é gravada mesmo assim. |
4 | pending | Consultando | Amarelo | Consulta registrada, aguardando o processamento na Dataprev em segundo plano. |
PrivatePayrollEmployeeDataStatus
Devolvido em status de Dados do trabalhador.
| Code | Key | Nome | Cor | Significado |
|---|---|---|---|---|
1 | pending | Consultando | Amarelo | Consulta registrada, aguardando o processamento na Dataprev em segundo plano. |
2 | success | Sucesso | Verde | O provedor devolveu os dados do trabalhador. |
3 | error | Erro | Vermelho | Falha no provedor. note traz o motivo retornado pela Dataprev. |
PrivatePayrollFgtsBalanceStatus
Devolvido em status de Saldo FGTS.
| Code | Key | Nome | Cor | Significado |
|---|---|---|---|---|
1 | pending | Consultando | Amarelo | Consulta registrada, aguardando o processamento na Dataprev em segundo plano. |
2 | success | Sucesso | Verde | O provedor devolveu o saldo e a multa rescisória. |
3 | error | Erro | Vermelho | Falha 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
| Code | Nome | Significado |
|---|---|---|
1 | CNPJ | Empregador pessoa jurídica. employerDocumentNumber com 14 dígitos. |
2 | CPF | Empregador pessoa física (doméstico, produtor rural). employerDocumentNumber com 11 dígitos. |
loanBlockType
| Code | Nome |
|---|---|
0 | Sem Bloqueio |
Outros códigos indicam bloqueio à contratação registrado pelo trabalhador ou pelo empregador.
politicallyExposedPerson
| Code | Nome |
|---|---|
0 | Pessoa Não Exposta Politicamente |
gender (na consulta Dataprev)
| Code | Nome |
|---|---|
1 | Masculino |
2 | Feminino |
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ódigo | Significado |
|---|---|
IV | Trabalhador não autorizou a consulta ao saldo FGTS no aplicativo da Carteira de Trabalho Digital, ou a autorização (30 dias) expirou. |
TS | Vínculo encerrado. |