Skip to main content

Leilão CTPS e empréstimo

Siga esta ordem na API de Contas. Prefixo: https://secureapi.onz.finance/api/v2.

Não envie accountId.

Não chame​

RequestMotivo
Proposta com garantias (has_guarantees: true)Neste teste, só a proposta sem garantias
Autorização e saldo FGTSOutro produto
POST /econsigado/loans/endorsementsA averbação ocorre depois da assinatura da CCB
POST /econsigado/loans/contract-informationA CCB é assinada no link de formalização

Scopes​

ChamadaScope
Listar leadseconsignado.read
Proposta e desfechoeconsignado.write
Cadastro e empréstimocredit.consignado.write
Consultar cadastro, empréstimos e linkcredit.consignado.read

Ordem​

1. Listar o lead​

POST /econsigado/employee/clt-leads/list

Use o lead da conta da credencial. Guarde id, worker_cpf, worker_name, employee_registration, employer_registration_type, employer_registration_number, requested_amount e installments_count.

2. Enviar a proposta​

POST /econsigado/employee/clt-leads/{id}/proposal

Uma proposta, com has_guarantees: false. A resposta fica em PROPOSAL_SENT.

3. Registrar o aceite​

POST /econsigado/employee/clt-leads/{id}/outcome

Depois que o trabalhador aceitar na CTPS Digital:

{ "accepted": true }

A resposta fica em PROPOSAL_ACCEPTED.

4. Abrir o cadastro​

POST /credit/consignado/registrations

document e prefill.fullName vêm do lead (worker_cpf, worker_name). prefill.address é obrigatório. phone e email são opcionais e não vêm no lead; e-mail, se enviado, precisa ser válido. CEP aceita máscara. UF tem 2 letras.

curl --location 'https://secureapi.onz.finance/api/v2/credit/consignado/registrations' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data '{
"document": "12345678901",
"source": "CREDIT_CONSIGNADO_WORKER",
"prefill": {
"fullName": "Maria Silva",
"email": "[email protected]",
"phone": "11988887777",
"address": {
"zipCode": "01001000",
"street": "Praça da Sé",
"number": "1",
"district": "Sé",
"city": "São Paulo",
"state": "SP"
}
}
}'

A resposta traz id e status (PERSONAL_DATA), sem personId. resumed: true quando já existe cadastro aberto para o CPF.

5. Consultar o cadastro​

GET /credit/consignado/registrations/{id}

Repita até vir personId. Em homologação ele aparece na primeira consulta. Sem personId, o cadastro ainda não concluiu ou foi recusado. A resposta não inclui score, limite nem aprovação de crédito. Outro id responde 404.

GET /credit/consignado/products

Use o creditProductId da resposta no passo seguinte.

7. Criar o empréstimo​

POST /credit/consignado/loans

Sem dataprev a API responde 400. O empréstimo nasce em REGISTRATION, com dataprevOutcome PENDING. Este POST não averba.

LeadCampo
employee_registrationdataprev.employeeId (1–30 caracteres)
employer_registration_typedataprev.employerRegistrationType (1–9)
employer_registration_numberdataprev.employerRegistrationNumber (8, 11 ou 14 dígitos)
requested_amountamount
installments_countterm

personId vem do passo 5. O destino da conta é informado por vocês.

curl --location 'https://secureapi.onz.finance/api/v2/credit/consignado/loans' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data '{
"creditProductId": 3,
"personId": 77,
"term": 24,
"period": "MONTHLY",
"amount": 4000,
"lateFine": 2,
"lateRate": 1,
"firstDueDate": "2099-12-15",
"destination": {
"ispb": "18236120",
"agency": "0001",
"account": "123456",
"accountType": "CACC",
"document": "12345678901"
},
"dataprev": {
"employeeId": "12345",
"employerRegistrationType": 1,
"employerRegistrationNumber": "12345678000199"
}
}'

GET /credit/consignado/loans/{loanId}/formalization-url

É GET. PENDING não impede o link. formalizationUrl só falta se dataprevOutcome for RECUSADO, se o destino foi recusado ou se o destino não foi informado. Abra a URL para o trabalhador assinar a CCB.

9. Averbação​

Depois da assinatura, repita um destes até dataprevOutcome igual a AVERBADO:

  • GET /credit/consignado/loans (page, limit; default 1 e 25, máximo 50). Só os empréstimos da conta da credencial.
  • GET /credit/consignado/loans/{loanId} — os mesmos campos do link, mais id, personId e creditProductId.