Domínios

Esta seção reúne os conjuntos de valores controlados usados pelos endpoints da jornada de consignado privado. Eles se dividem em dois grupos:

1. Valores fixos da API — listas cujos valores fazem parte do contrato da API. São as tabelas listadas nesta seção. Ao enviar, use a key; ao ler, a API devolve CodeKeyName { code, key, name }.
2. Códigos vindos do provedor — campos como employerDocumentType, gender (na consulta Dataprev), cbo, cnae, loanBlockType e politicallyExposedPerson são objetos { code, name } preenchidos com o código e a descrição devolvidos pela Dataprev. Não são listas fixas da API e podem receber valores não listados aqui.

Há ainda um terceiro caso, o produto de empréstimo (product: "private_payroll"): é um cadastro por empresa, não uma lista fixa. Seus padrões estão descritos em Simulações.

Páginas

Página	Conteúdo
Termos de Autorização	Status, tipo, provedor, papel do signatário, tipo de autenticação e canal do termo.
Consignado Privado	Status das consultas de vínculos, dados do trabalhador e saldo FGTS, e códigos Dataprev mais frequentes.
Empréstimos	Status, estágio, etapa, formalização (pedido de documento), modo de simulação, tipos de produto/operação/juros/amortização, regras de atraso, métodos de pagamento/desembolso, tipo de conta, comandos de desembolso e situação da averbação/desaverbação do consignado privado.
Jornadas	Tipo e status da jornada, status das etapas, eventos da trilha, geolocalização e canais de convite.
Consultas Externas	Tipo, status e provedor das consultas externas e recursos a que podem ser vinculadas.
Pessoas	Tipo de pessoa, tipo de documento, estado civil e gênero.
Assinatura Eletrônica	Status, provedor, fluxo, tipo e papel do documento, qualificação do signatário, tipo de autenticação, rubrica, marcação e eventos.