v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Consignado

Originate a consignado privado contract (contratação ativa)

Re-checks margin, renders and signs the CCB, creates and approves the core loan application (with its BR consignado extension) and persists it, then emits consignado.averbacao.requested so the gateway performs the real averbação. The returned state reflects the core origination progress (approved on contratação); the averbação lifecycle is tracked separately.

post/api/v1/br/consignado/contracts

Request body

annualRatestring required

Annual interest rate as a fraction (RateScale, e.g. "0.2400").

averbacaoDatestring date-time

Instant the averbação is requested (RFC3339); anchors the first-deduction competência. Defaults to now when omitted.

borrowerCpfstring required

Borrower CPF, digits only (pre-normalized).

borrowerNamestring required

Borrower (emitente/devedor) full legal name (CCB Art. 23).

cetAnnualstring required

Annual CET as a fraction (RateScale).

cetMonthlystring required

Monthly CET as a fraction (RateScale).

creditorNamestring required

Financing institution issuing the credit (CCB Art. 23 credor).

eSocialCategorystring required

eSocial category code of the vínculo.

employerCnpjstring required

Employer CNPJ, digits only (pre-normalized).

employerLegalNamestring required

Employer / payroll counterparty legal name.

extendedTermEligibleboolean

True enables the 144-month cap (public-company/autarquia CLT, Art. 10 V); false keeps the 96-month cap.

fgtsGuaranteePercentstring

Optional FGTS-guarantee fraction (RateScale); omit when not applicable.

installmentAmountstring required

Monthly installment amount in major currency units.

installmentCountinteger required

Number of installments.

iofAmountstring required

IOF tax amount in major currency units.

loanProductVersionIdstring uuid required

UUID of the activated loan-product version the contract binds to.

matriculastring required

Payroll registration the margin lookup and CCB key against.

monthlyRatestring required

Monthly interest rate as a fraction (RateScale, e.g. "0.0180").

numeroContratostring required

Human-facing contract number assigned by the originating channel.

principalAmountstring required

Financed principal in major currency units.

vinculoIdstring uuid required

UUID of the borrower<->employer vínculo the contract originates against.

Example request

{
  "annualRate": "0.2400",
  "averbacaoDate": "2026-06-22T12:00:00Z",
  "borrowerCpf": "12345678909",
  "cetAnnual": "0.2610",
  "cetMonthly": "0.0195",
  "employerCnpj": "12345678000199",
  "fgtsGuaranteePercent": "0.1000",
  "installmentAmount": "450.00",
  "installmentCount": 24,
  "iofAmount": "86.84",
  "loanProductVersionId": "550e8400-e29b-41d4-a716-446655440000",
  "monthlyRate": "0.0180",
  "principalAmount": "10000.00",
  "vinculoId": "550e8400-e29b-41d4-a716-446655440010"
}

Response

Created

annualRatestring required

Annual interest rate as a fraction (RateScale).

biometricEvidenceRefstring required

Reference to the captured biometric signing evidence.

cetAnnualstring required

Annual CET as a fraction (RateScale).

cetMonthlystring required

Monthly CET as a fraction (RateScale).

createdAtstring required

RFC3339 UTC timestamp when the contract was persisted.

firstDeductionCompetenciastring required

First payroll-deduction competência as YYYYMM.

idstring required

Server-generated UUID of the persisted contract.

installmentAmountstring required

Monthly installment amount in major currency units.

installmentCountinteger required

Number of installments.

iofAmountstring required

IOF tax amount in major currency units.

loanProductVersionIdstring required

UUID of the bound loan-product version.

monthlyRatestring required

Monthly interest rate as a fraction (RateScale).

numeroContratostring required

Human-facing contract number.

principalAmountstring required

Financed principal in major currency units.

signatureSessionRefstring required

Reference to the out-of-band signature ceremony session.

statestring required

Core origination-progress state of the loan application: pending_approval, approved, disbursed, rejected, or withdrawn.

vinculoIdstring required

Identifier of the originating vínculo.

Example response

{
  "annualRate": "0.2400",
  "cetAnnual": "0.2610",
  "cetMonthly": "0.0195",
  "createdAt": "2026-06-22T12:00:00Z",
  "firstDeductionCompetencia": "202608",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "installmentAmount": "450.00",
  "installmentCount": 24,
  "iofAmount": "86.84",
  "monthlyRate": "0.0180",
  "principalAmount": "10000.00",
  "state": "approved"
}