> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Originar um contrato de consignado privado (contratação ativa) > Reverifica a margem, renderiza e assina a CCB, cria e aprova a solicitação de empréstimo central (com sua extensão de consignado BR) e a persiste, e então emite consignado.averbacao.requested para que o gateway execute a averbação real. O estado retornado reflete o progresso da originação central (aprovada na contratação); o ciclo de vida da averbação é rastreado separadamente. ## OpenAPI ````yaml pt/openapi/v3-current/lender.yaml post /api/v1/br/consignado/contracts openapi: 3.1.0 info: contact: email: contact@lerian.studio name: Lerian Studio url: https://lerian.studio description: Superfície OpenAPI 3.1 code-first do serviço Lender. license: name: Lerian Studio General License title: Lender API version: 1.0.0 servers: - url: https://lender.sandbox.lerian.net security: - BearerAuth: [] tags: - description: >- Operações de contabilidade do ledger: entradas de journal e lançamentos de accrual para contas de empréstimo. name: Accounting - description: >- Recepção e ciclo de vida da solicitação de empréstimo: submissão, decisão e status. name: LoanApplications - description: >- Catálogo de produtos de empréstimo: definição, versionamento e ativação de produtos de crédito. name: LoanProducts - description: >- Operações de servicing de contas de empréstimo: saldos, cronogramas e ações em nível de conta. name: Loan Accounts - description: >- Operações de leitura de servicing: cronogramas de pagamento e estado de servicing para contas de empréstimo. name: Servicings - description: >- Operações de leitura do painel de carteira: visões agregadas de carteira e de desempenho. name: Dashboard - description: >- Registro de jurisdições: perfis de jurisdição suportados e suas capacidades. name: Jurisdictions - description: >- Operações de solicitação de empréstimo específicas por jurisdição (superfície de originação do Brasil). name: Loan Applications - description: >- Operações de cálculo de impostos para crédito específico por jurisdição (por exemplo, IOF do Brasil). name: Tax - description: >- Operações de consignado privado do Brasil: originação de contrato (contratação ativa) e ciclo de vida. name: Consignado paths: /api/v1/br/consignado/contracts: post: tags: - Consignado summary: Originar um contrato de consignado privado (contratação ativa) description: >- Reverifica a margem, renderiza e assina a CCB, cria e aprova a solicitação de empréstimo central (com sua extensão de consignado BR) e a persiste, e então emite consignado.averbacao.requested para que o gateway execute a averbação real. O estado retornado reflete o progresso da originação central (aprovada na contratação); o ciclo de vida da averbação é rastreado separadamente. operationId: createConsignadoContract requestBody: content: application/json: schema: $ref: '#/components/schemas/ContratacaoAtivaRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/ContratacaoAtivaResponse' description: Created default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error components: schemas: ContratacaoAtivaRequest: additionalProperties: false properties: annualRate: description: Annual interest rate as a fraction (RateScale, e.g. "0.2400"). examples: - '0.2400' type: string averbacaoDate: description: >- Instant the averbação is requested (RFC3339); anchors the first-deduction competência. Defaults to now when omitted. examples: - '2026-06-22T12:00:00Z' format: date-time type: string borrowerCpf: description: Borrower CPF, digits only (pre-normalized). examples: - '12345678909' type: string borrowerName: description: Borrower (emitente/devedor) full legal name (CCB Art. 23). type: string cetAnnual: description: Annual CET as a fraction (RateScale). examples: - '0.2610' type: string cetMonthly: description: Monthly CET as a fraction (RateScale). examples: - '0.0195' type: string creditorName: description: Financing institution issuing the credit (CCB Art. 23 credor). type: string eSocialCategory: description: eSocial category code of the vínculo. type: string employerCnpj: description: Employer CNPJ, digits only (pre-normalized). examples: - '12345678000199' type: string employerLegalName: description: Employer / payroll counterparty legal name. type: string extendedTermEligible: description: >- True enables the 144-month cap (public-company/autarquia CLT, Art. 10 V); false keeps the 96-month cap. type: boolean fgtsGuaranteePercent: description: >- Optional FGTS-guarantee fraction (RateScale); omit when not applicable. examples: - '0.1000' type: string installmentAmount: description: Monthly installment amount in major currency units. examples: - '450.00' type: string installmentCount: description: Number of installments. examples: - 24 format: int64 minimum: 1 type: integer iofAmount: description: IOF tax amount in major currency units. examples: - '86.84' type: string loanProductVersionId: description: UUID of the activated loan-product version the contract binds to. examples: - 550e8400-e29b-41d4-a716-446655440000 format: uuid type: string matricula: description: Payroll registration the margin lookup and CCB key against. type: string monthlyRate: description: Monthly interest rate as a fraction (RateScale, e.g. "0.0180"). examples: - '0.0180' type: string numeroContrato: description: Human-facing contract number assigned by the originating channel. type: string principalAmount: description: Financed principal in major currency units. examples: - '10000.00' type: string vinculoId: description: >- UUID of the borrower<->employer vínculo the contract originates against. examples: - 550e8400-e29b-41d4-a716-446655440010 format: uuid type: string required: - vinculoId - loanProductVersionId - numeroContrato - borrowerName - borrowerCpf - employerLegalName - employerCnpj - matricula - eSocialCategory - principalAmount - installmentAmount - installmentCount - monthlyRate - annualRate - cetMonthly - cetAnnual - iofAmount - creditorName type: object ContratacaoAtivaResponse: additionalProperties: false properties: annualRate: description: Annual interest rate as a fraction (RateScale). examples: - '0.2400' type: string biometricEvidenceRef: description: Reference to the captured biometric signing evidence. type: string cetAnnual: description: Annual CET as a fraction (RateScale). examples: - '0.2610' type: string cetMonthly: description: Monthly CET as a fraction (RateScale). examples: - '0.0195' type: string createdAt: description: RFC3339 UTC timestamp when the contract was persisted. examples: - '2026-06-22T12:00:00Z' type: string firstDeductionCompetencia: description: First payroll-deduction competência as YYYYMM. examples: - '202608' type: string id: description: Server-generated UUID of the persisted contract. examples: - 550e8400-e29b-41d4-a716-446655440000 type: string installmentAmount: description: Monthly installment amount in major currency units. examples: - '450.00' type: string installmentCount: description: Number of installments. examples: - 24 format: int64 type: integer iofAmount: description: IOF tax amount in major currency units. examples: - '86.84' type: string loanProductVersionId: description: UUID of the bound loan-product version. type: string monthlyRate: description: Monthly interest rate as a fraction (RateScale). examples: - '0.0180' type: string numeroContrato: description: Human-facing contract number. type: string principalAmount: description: Financed principal in major currency units. examples: - '10000.00' type: string signatureSessionRef: description: Reference to the out-of-band signature ceremony session. type: string state: description: >- Core origination-progress state of the loan application: pending_approval, approved, disbursed, rejected, or withdrawn. examples: - approved type: string vinculoId: description: Identifier of the originating vínculo. type: string required: - id - numeroContrato - vinculoId - loanProductVersionId - state - principalAmount - installmentAmount - installmentCount - monthlyRate - annualRate - cetMonthly - cetAnnual - iofAmount - firstDeductionCompetencia - signatureSessionRef - biometricEvidenceRef - createdAt type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). examples: - ERR-0001 type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ````