eConsignado Trabalhador (CLT)

A API de Contas (/api/v2) permite operar o Crédito do Trabalhador / CTPS Digital (eConsignado Trabalhador): consultar leads, enviar propostas, registrar o desfecho e, quando necessário, consultar saldo FGTS com autorização do trabalhador.

Não confundir com consignado INSS. Este módulo é exclusivo do crédito do trabalhador CLT (Dataprev / CTPS Digital).

Operação	Método e path	Scope
Listar leads CLT	`POST /econsigado/employee/clt-leads/list`	`econsignado.read`
Enviar proposta a partir do lead	`POST /econsigado/employee/clt-leads/{id}/proposal`	`econsignado.write`
Registrar desfecho da proposta	`POST /econsigado/employee/clt-leads/{id}/outcome`	`econsignado.write`
Enviar autorização FGTS (e-mail)	`POST /econsigado/employee/authorization-request-email`	`econsignado.write`
Consultar status da autorização	`POST /econsigado/employee/authorization-status`	`econsignado.read`
Consultar saldo FGTS	`POST /econsigado/employee/fgts-balance-inquiries`	`econsignado.read`

Todas as requisições abaixo usam:

Authorization: Bearer <access_token>
Content-Type: application/json

Base URL: https://secureapi.onz.finance/api/v2

Pré-requisitos

Conta habilitada para o eConsignado Trabalhador
Credencial com scopes econsignado.read e/ou econsignado.write

Visão geral do fluxo

POST .../clt-leads/list          → lista leads disponíveis
(Opcional) Autorização FGTS     → e-mail + aceite do trabalhador + saldo
POST .../clt-leads/{id}/proposal → envia a proposta
POST .../clt-leads/{id}/outcome  → registra se o trabalhador aceitou ou recusou

Status do lead

Status	Significado
`NEW`	Disponível para proposta
`PROPOSAL_SENT`	Proposta enviada (aguardando desfecho)
`PROPOSAL_ACCEPTED`	Trabalhador aceitou
`PROPOSAL_REJECTED`	Trabalhador recusou
`EXPIRED`	Solicitação vencida

1. Listar leads

curl --location 'https://secureapi.onz.finance/api/v2/econsigado/employee/clt-leads/list' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "page": 1,
    "per_page": 25,
    "status": "NEW"
  }'

Campo	Obrigatório	Descrição
`page`	Não	Página (default `1`)
`per_page`	Não	Itens por página (1–100, default `25`)
`status`	Não	Filtro por status do lead

Resposta (exemplo):

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "dataprev_request_id": 123456789,
      "worker_cpf": "12345678901",
      "worker_name": "Maria Silva",
      "employee_registration": "12345",
      "employer_registration_number": "12345678000199",
      "employer_registration_type": 1,
      "requested_amount": 500000,
      "installments_count": 24,
      "available_margin": 35000,
      "loan_eligible": true,
      "admission_date": "01012020",
      "request_valid_until": "2026-07-23T20:00:00.000Z",
      "status": "NEW",
      "proposal_sent_by_me": false,
      "proposal_sent_at": null,
      "synced_at": "2026-07-23T15:00:00.000Z",
      "created_at": "2026-07-23T14:00:00.000Z"
    }
  ],
  "page": 1,
  "per_page": 25,
  "total": 1
}

proposal_sent_by_me indica se você já enviou proposta neste lead.

2. Consulta de saldo FGTS (opcional, para proposta com garantias)

Fluxo em 2 passos: consentimento do trabalhador + consulta de saldo.

2.1 Enviar e-mail de autorização

curl --location 'https://secureapi.onz.finance/api/v2/econsigado/employee/authorization-request-email' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "cpf": "12345678901",
    "email": "[email protected]",
    "name": "Maria Silva"
  }'

Resposta:

{
  "data": {
    "mensagem": "E-mail de autorização enviado.",
    "authorization_url": "https://.../econsignado/authorization/...",
    "expires_at": "2026-07-24T15:00:00.000Z"
  }
}

O trabalhador acessa o link, aceita ou recusa o termo.

2.2 Polling do status

curl --location 'https://secureapi.onz.finance/api/v2/econsigado/employee/authorization-status' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{ "cpf": "12345678901" }'

Status possíveis: PENDING | ACCEPTED | REJECTED | EXPIRED.

2.3 Consultar saldo

Exige autorização ACCEPTED para o CPF. Use os dados do empregador e da matrícula retornados no lead (employer_registration_type: 1=CNPJ, 2=CPF, 3=CAEPF, 4=CNO).

curl --location 'https://secureapi.onz.finance/api/v2/econsigado/employee/fgts-balance-inquiries' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "cpf": "12345678901",
    "employer_registration_type": 1,
    "employer_registration_number": "12345678000199",
    "employee_id": "12345"
  }'

A resposta inclui campos como valor_saldo_disponivel_consignado e valor_multa_rescisoria_consignado, úteis para montar a proposta com garantias.

3. Enviar proposta a partir do lead

O proposal_request_id não deve ser enviado no body — ele é obtido automaticamente a partir do lead.

proposal_valid_until no formato ddMMyyyyHHmmss (horário de Brasília).

curl --location 'https://secureapi.onz.finance/api/v2/econsigado/employee/clt-leads/550e8400-e29b-41d4-a716-446655440000/proposal' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "proposal_number": "PROP0001",
    "proposal_valid_until": "23072026235959",
    "installments_count": 24,
    "installment_amount": 25000,
    "released_amount": 500000,
    "loan_amount": 520000,
    "iof_amount": 1500,
    "annual_rate": 1800,
    "annual_cet": 2100,
    "monthly_rate": 150,
    "monthly_cet": 175,
    "contacts": [
      { "type": 1, "contact": "[email protected]" }
    ],
    "has_guarantees": true,
    "fgts_guarantee_balance": 100000,
    "severance_penalty_guarantee_amount": 5000,
    "severance_guarantee_percentage": 40
  }'

Resposta:

{
  "lead": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "PROPOSAL_SENT",
    "proposal_sent_by_me": true
  },
  "dataprev_response": [{}]
}

Erros relevantes:

HTTP	Situação
`403`	Conta não habilitada para o eConsignado
`404`	Lead não encontrado
`409`	Já existe proposta para este lead
`422`	Lead expirado

4. Registrar desfecho

Após acompanhar se o trabalhador aceitou ou recusou a proposta na CTPS Digital, registre o desfecho:

curl --location 'https://secureapi.onz.finance/api/v2/econsigado/employee/clt-leads/550e8400-e29b-41d4-a716-446655440000/outcome' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{ "accepted": true }'

Disponível apenas quando o lead está em PROPOSAL_SENT.

Referência

Consulte a referência da API de Contas (categoria eConsignado Trabalhador) para schemas e códigos de erro detalhados dos endpoints /econsigado/employee/*.

Pré-requisitos​

Visão geral do fluxo​

Status do lead​

1. Listar leads​

2. Consulta de saldo FGTS (opcional, para proposta com garantias)​

2.1 Enviar e-mail de autorização​

2.2 Polling do status​

2.3 Consultar saldo​

3. Enviar proposta a partir do lead​

4. Registrar desfecho​

Referência​