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

# Record the endorsed credit instrument

> Records the endorsed credit instrument (endorsed_credit_instrument) of a direct-credit contract a fund took: it goes under the newest lot whose remessa was ingested and that holds the contract, and is the proof the fund's acceptance reads. The same file again replays (X-Idempotency-Replayed); another file for the same lot refuses with LENDER-0637. A contract no lot took yet refuses with LENDER-0636, and a consignado contract (gateway_clt) with LENDER-0610: its endorsed credit instrument goes to the gateway.



## OpenAPI

````yaml /es/openapi/v3-current/lender.yaml patch /api/v1/loan-applications/{applicationId}/signed-credit-instrument
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/loan-applications/{applicationId}/signed-credit-instrument:
    patch:
      tags:
        - CreditInstruments
      summary: Record the endorsed credit instrument
      description: >-
        Records the endorsed credit instrument (endorsed_credit_instrument) of a
        direct-credit contract a fund took: it goes under the newest lot whose
        remessa was ingested and that holds the contract, and is the proof the
        fund's acceptance reads. The same file again replays
        (X-Idempotency-Replayed); another file for the same lot refuses with
        LENDER-0637. A contract no lot took yet refuses with LENDER-0636, and a
        consignado contract (gateway_clt) with LENDER-0610: its endorsed credit
        instrument goes to the gateway.
      operationId: recordSignedCreditInstrumentCessionDocuments
      parameters:
        - description: Loan application identifier.
          in: path
          name: applicationId
          required: true
          schema:
            description: Loan application identifier.
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CessionDocumentsHumaInputBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CessionDocumentsHumaBody'
          description: OK
          headers:
            X-Idempotency-Replayed:
              schema:
                description: >-
                  true when the same file was already recorded under this lot
                  and this response replays it.
                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:
    CessionDocumentsHumaInputBody:
      additionalProperties: false
      properties:
        documents:
          description: >-
            The endorsed credit instrument (endorsed_credit_instrument, pdf, at
            most 5 MiB decoded).
          items:
            $ref: '#/components/schemas/SignedDocumentHumaInput'
          maxItems: 1
          minItems: 1
          type:
            - array
            - 'null'
      required:
        - documents
      type: object
    CessionDocumentsHumaBody:
      additionalProperties: false
      properties:
        assignmentSetId:
          description: >-
            The assignment lot that took the contract and now holds its endorsed
            credit instrument (uuid).
          type: string
        documents:
          description: >-
            The document stored or replayed by this request: one item, the
            endorsed credit instrument.
          items:
            $ref: '#/components/schemas/SignedDocumentHumaBody'
          type:
            - array
            - 'null'
        loanApplicationId:
          description: Loan application identifier (uuid).
          type: string
      required:
        - loanApplicationId
        - assignmentSetId
        - documents
      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
    SignedDocumentHumaInput:
      additionalProperties: false
      properties:
        bytesBase64:
          description: >-
            The file, canonical base64 (standard alphabet). At most 5 MiB
            decoded, 15 MiB for liveness_video; 30 MiB for all documents of the
            request.
          minLength: 4
          type: string
        contentType:
          description: >-
            The media type. selfie and liveness_photo take jpeg or png,
            liveness_video takes mp4, the others pdf, jpeg or png.
          enum:
            - application/pdf
            - image/jpeg
            - image/png
            - video/mp4
          type: string
        documentType:
          description: >-
            The document's type. POST takes the twelve origination types; PATCH
            takes endorsed_credit_instrument, the cession document. The other
            route refuses with LENDER-0632.
          enum:
            - selfie
            - liveness_photo
            - liveness_video
            - id_document_front
            - id_document_back
            - drivers_license_front
            - drivers_license_back
            - drivers_license
            - proof_of_address
            - proof_of_income
            - payslip
            - other
            - endorsed_credit_instrument
          type: string
        fileName:
          description: >-
            The file's name. Validated, never stored: downloads are named
            <documentType>.<ext>.
          maxLength: 255
          minLength: 1
          type: string
      required:
        - documentType
        - fileName
        - contentType
        - bytesBase64
      type: object
    SignedDocumentHumaBody:
      additionalProperties: false
      properties:
        assignmentSetId:
          description: >-
            The assignment lot a cession document belongs to (uuid). Absent on
            an origination document.
          type: string
        contentLength:
          description: Size of the stored file in bytes.
          format: int64
          type: integer
        contentType:
          description: The stored media type.
          type: string
        digest:
          description: sha-256 hex of the stored file.
          type: string
        documentType:
          description: The document's type.
          type: string
        recordedAt:
          description: When the Lender recorded it (RFC3339, UTC).
          type: string
      required:
        - documentType
        - contentType
        - contentLength
        - digest
        - recordedAt
      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.