> ## 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.

# Issue the CCB of a durable CLT quote

> Renders the product's active consignado_quote_ccb template from the stored quote and the caller-declared parties, and custodies the PDF. Idempotent by caller key. Creates no loan application.



## OpenAPI

````yaml /es/openapi/v3-current/lender.yaml post /api/v1/br/consignado/quotes/{quoteId}/credit-instruments
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    Code-first OpenAPI 3.1 surface for the Lender service. Routes that move
    money are at-most-once per X-Idempotency: when one answers 5xx, the
    X-Idempotency-Fenced response header says whether that key is now refusing
    resends (true) or free to retry (false or absent).
  license:
    name: Lerian Studio General License
  title: Lender API
  version: 1.0.0
servers:
  - url: https://lender.sandbox.lerian.net
security:
  - BearerAuth: []
tags:
  - description: >-
      Caller session projection: validated subject and effective permissions for
      the presented token.
    name: Session
  - description: >-
      Ledger accounting operations: journal entries and accrual postings for
      loan accounts. Operations under /api/v1/internal are back-office
      operations for the client's operators: they require a person's login, and
      a service credential gets 403.
    name: Accounting
  - description: >-
      Loan application intake and lifecycle: submission, decisioning, and
      status.
    name: LoanApplications
  - description: >-
      Loan product catalog: definition, versioning, and activation of lending
      products.
    name: LoanProducts
  - description: >-
      Loan account servicing operations: balances, schedules, and account-level
      actions.
    name: Loan Accounts
  - description: >-
      Portfolio dashboard read operations: aggregated portfolio and performance
      views.
    name: Dashboard
  - description: >-
      Jurisdiction registry: supported jurisdiction profiles and their
      capabilities.
    name: Jurisdictions
  - description: >-
      Jurisdiction-specific loan application operations (Brazil origination
      surface).
    name: Loan Applications
  - description: >-
      Tax computation operations for jurisdiction-specific lending (e.g. Brazil
      IOF).
    name: Tax
  - description: >-
      Brazil consignado privado operations: contract lifecycle, exclusion
      repair, and compensating adjustments. Operations under /api/v1/internal
      are back-office operations for the client's operators: they require a
      person's login, and a service credential gets 403.
    name: Consignado
  - description: >-
      Inbound record quarantine. Operations under /api/v1/internal are
      back-office operations for the client's operators: they require a person's
      login, and a service credential gets 403.
    name: Streaming
  - description: >-
      Credit-instrument document template registry: versioned drafting and
      publication of CCB clausulado.
    name: DocumentTemplates
paths:
  /api/v1/br/consignado/quotes/{quoteId}/credit-instruments:
    post:
      tags:
        - CreditInstruments
      summary: Issue the CCB of a durable CLT quote
      description: >-
        Renders the product's active consignado_quote_ccb template from the
        stored quote and the caller-declared parties, and custodies the PDF.
        Idempotent by caller key. Creates no loan application.
      operationId: issueConsignadoQuoteCreditInstrument
      parameters:
        - description: Durable quote identifier.
          in: path
          name: quoteId
          required: true
          schema:
            description: Durable quote identifier.
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/IssueConsignadoQuoteCreditInstrumentHumaInputBody
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsignadoQuoteCreditInstrumentHumaBody'
          description: Created
          headers:
            X-Idempotency-Replayed:
              schema:
                description: >-
                  true when this response replays an instrument already created
                  under the same idempotency key.
                type: boolean
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Forbidden
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Not Found
        '409':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Conflict
        '413':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Request Entity Too Large
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Service Unavailable
        '504':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Gateway Timeout
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: >-
            Any other status this operation may carry, rendered as a problem
            document — including a refusal produced ahead of the service, such
            as a gateway or ingress answering on its behalf.
components:
  schemas:
    IssueConsignadoQuoteCreditInstrumentHumaInputBody:
      additionalProperties: false
      properties:
        idempotencyKey:
          description: >-
            Caller idempotency key. The same key and parties replay the same
            instrument; the same key with different parties is refused.
          minLength: 1
          type: string
        parties:
          additionalProperties:
            type: string
          description: >-
            Caller-declared parties: BorrowerName, BorrowerDocument,
            CreditorName, IssuePlace and PaymentPlace. Financial values come
            only from the stored quote.
          type: object
      required:
        - idempotencyKey
        - parties
      type: object
    ConsignadoQuoteCreditInstrumentHumaBody:
      additionalProperties: false
      properties:
        contentDigest:
          description: sha-256 hex digest of the rendered PDF bytes.
          type: string
        createdAt:
          description: Row creation timestamp (RFC3339, UTC).
          type: string
        documentTemplateVersionId:
          description: Exact template version rendered (uuid).
          type: string
        emittedAt:
          description: Emission instant (RFC3339, UTC).
          type: string
        emittedBy:
          description: Validated actor identity that requested emission.
          type: string
        id:
          description: Instrument identifier (uuid).
          type: string
        idempotencyKey:
          description: Caller's idempotency key.
          type: string
        quoteId:
          description: Owning durable quote identifier (uuid).
          type: string
        sizeBytes:
          description: Size of the rendered document in bytes.
          format: int64
          type: integer
      required:
        - id
        - quoteId
        - documentTemplateVersionId
        - idempotencyKey
        - contentDigest
        - sizeBytes
        - emittedAt
        - emittedBy
        - createdAt
      type: object
    Detail:
      additionalProperties: true
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          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
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      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
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.