Sobre o produto
O E-Consignado é a camada de API modular via DATAPREV do portfólio Zipdin: em vez de uma plataforma pronta, você integra só os módulos que faltam na sua operação de crédito consignado privado — da consulta de elegibilidade do trabalhador até a averbação do contrato junto à DATAPREV. Para quem é: empresas, correspondentes bancários ou fintechs que já operam (ou estão estruturando) uma originação de crédito consignado e querem plugar via API só as etapas que ainda não têm — sem depender de uma plataforma completa como o Zipconsig. Como funciona: por trás da API está o Dataprev Controller, a camada da Zipdin que integra o originador à DATAPREV. Cada chamada da jornada abaixo é independente e pode ser opcional, condicional ou obrigatória dependendo do que a sua operação já resolve por conta própria.Todos os endpoints requerem autenticação via Bearer token no header
Authorization.
Consulte o guia de autenticação para obter suas credenciais e gerar um token.URL Base e Versão
Todas as chamadas do Dataprev Controller ficam sob o prefixo/dataprev-controller:
- Homologação
Algumas rotas (ex.:
simulation/calculate, relatórios de gestão) são sempre síncronas,
independente do header X-Version — isso está sinalizado em cada etapa abaixo.Jornada de Integração
A documentação está organizada em duas categorias: o fluxo de contratação ativa (o caminho que leva um contrato a ser averbado) e as APIs de apoio (consultas de risco e relatórios de gestão). O contratante entra só onde precisa — o restante continua com quem já opera a etapa hoje.Contratação Ativa
1
Consulta de vínculo empregatício · opcional
POST /worker-relationshipsDetalha o vínculo empregatício do trabalhador (empregador, cargo e admissão) para iniciar a análise de
elegibilidade. Use quando ainda não conhece o vínculo.
2
Dados do trabalhador · opcional
POST /worker-dataConsulta os dados do trabalhador na DATAPREV, com a coleta do termo de autorização (LGPD). Se já conhece
o vínculo, pode consultar direto.
3
Saldo FGTS · opcional
POST /worker-fgtsConsulta o saldo/multa do FGTS, necessária apenas quando o trabalhador usa o FGTS como garantia.
4
Simulação · opcional
POST /simulation/calculateCalcula parcelas, CET e IOF quando o contratante não tem cálculo próprio.
5
Upload de documentos · condicional
POST /contract/documentsEnvio da CCB assinada, documento e biometria — obrigatório quando a formalização é conduzida pelo
contratante.
6
Averbação · obrigatória
POST /contract/averbacaoEnvio dos dados do contrato à DATAPREV para inclusão da averbação.
7
Resultado da averbação · obrigatória
GET /request/:requestIdAcompanhe o processamento assíncrono por webhook, com consulta de status como fallback.
Refinanciamento
1
Refinanciamento (REFIN) · opcional
POST /contract/refinancingAlternativa à averbação de um novo contrato: quita um ou mais contratos ativos do trabalhador.
Relatório de gestão
Condicional — quando a gestão da carteira é do próprio contratante.1
Novos vínculos elegíveis
GET /workers/new-relationshipsRelatório paginado de novos vínculos elegíveis num período.
2
Contratos encerrados
GET /contracts/relationship-endedRelatório de empréstimos encerrados por vínculo.
3
Escriturações e remunerações
GET /contracts/accounting-and-remunerationRelatório de escriturações e remunerações num período.
4
Repasses de pagamentos
GET /emprestimos/consultar-repasse-pagamentosRelatório de repasses de pagamentos num período.
Mapa de Chamadas
Paths relativos à URL base/dataprev-controller. A versão (síncrono/assíncrono) é definida pelo header
x-version, não pela URL — não há prefixo /v1/ nos caminhos.
Etapas fora do Dataprev Controller. O acompanhamento de pagamento/reapresentação roda no
Zipban (serviço separado) e será detalhado adiante. O histórico de solicitações CTPS e o
cancelamento de REFIN ainda estão em construção e não têm endpoint no controller.
Formato de Erros
Dois formatos coexistem, dependendo do endpoint:- Endpoints worker-* (proxy genérico)
- Endpoints /contract/* (averbação, refin, documentos)
Formato achatado — usado por
worker-relationships, worker-data, worker-fgts,
simulation/calculate e pelos relatórios de gestão:Eventos (Webhooks)
O evento de resultado da averbação (POST /webhooks/dataprev) e o webhook de liquidação/devolução do
pagamento são específicos do Dataprev Controller — o formato difere do catálogo genérico em
guias/webhooks, que ainda não foi atualizado para este fluxo.