> ## 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 registration of a loan application at a registradora

> Records the code the registradora (B3, CERC, Grafeno, Nuclea, TAG or another, named) assigned when the client registered this contract, with the registration date and the CCB number when informed. The Lender stores it and commands nothing at any registradora. An approved or disbursed direct-credit contract takes it; a payroll-gateway contract informs it at the gateway (409 LENDER-0972). It is written once: the same values, registradora and its name included, answer the stored registration with X-Idempotency-Replayed: true, and any other value, a field the first call left out included, is refused with 409 LENDER-0973 and writes nothing. A registration at B3 publishes loan_application.b3_registered; at any other registradora, loan_application.registration_recorded.



## OpenAPI

````yaml /es/openapi/v3-current/lender.yaml put /api/v1/br/loan-applications/{id}/registration
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/loan-applications/{id}/registration:
    put:
      tags:
        - Loan Applications
      summary: Record the registration of a loan application at a registradora
      description: >-
        Records the code the registradora (B3, CERC, Grafeno, Nuclea, TAG or
        another, named) assigned when the client registered this contract, with
        the registration date and the CCB number when informed. The Lender
        stores it and commands nothing at any registradora. An approved or
        disbursed direct-credit contract takes it; a payroll-gateway contract
        informs it at the gateway (409 LENDER-0972). It is written once: the
        same values, registradora and its name included, answer the stored
        registration with X-Idempotency-Replayed: true, and any other value, a
        field the first call left out included, is refused with 409 LENDER-0973
        and writes nothing. A registration at B3 publishes
        loan_application.b3_registered; at any other registradora,
        loan_application.registration_recorded.
      operationId: recordLoanApplicationRegistration
      parameters:
        - description: Loan application identifier.
          in: path
          name: id
          required: true
          schema:
            description: Loan application identifier.
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecordRegistrationBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistrationHumaBody'
          description: OK
          headers:
            X-Idempotency-Replayed:
              schema:
                description: >-
                  Set to "true" when the same values were already recorded and
                  this response replays them; absent on the first write.
                type: string
        '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:
    RecordRegistrationBody:
      additionalProperties: false
      properties:
        ccbNumber:
          description: >-
            The CCB number as registered. Optional. Not cross-checked against
            the client contract number.
          examples:
            - CCB-2026-000123
          maxLength: 64
          pattern: ^[^\s\x00-\x1F\x7F](?:[^\x00-\x1F\x7F]*[^\s\x00-\x1F\x7F])?$
          type: string
        registradora:
          description: >-
            The registradora the client registered the contract at. 'outra'
            requires registradoraName.
          enum:
            - b3
            - cerc
            - grafeno
            - nuclea
            - tag
            - outra
          type: string
        registradoraName:
          description: >-
            Name of the registradora, required when registradora is 'outra' and
            refused otherwise (LENDER-0961).
          maxLength: 60
          pattern: ^[^\s\x00-\x1F\x7F](?:[^\x00-\x1F\x7F]*[^\s\x00-\x1F\x7F])?$
          type: string
        registrationCode:
          description: >-
            The code the registradora assigned, stored exactly as sent. B3: the
            Codigo IF, 1 to 14 letters and digits (LENDER-0960).
          maxLength: 64
          pattern: ^[^\s\x00-\x1F\x7F](?:[^\x00-\x1F\x7F]*[^\s\x00-\x1F\x7F])?$
          type: string
        registrationDate:
          description: >-
            Civil day the registradora registered the contract, from the
            approval day to today in Brasilia. Optional.
          format: date
          type: string
      required:
        - registradora
        - registrationCode
      type: object
    RegistrationHumaBody:
      additionalProperties: false
      properties:
        ccbNumber:
          description: The CCB number as registered. Absent when not informed.
          type: string
        loanApplicationId:
          description: Loan application identifier (uuid).
          type: string
        recordedAt:
          description: When the Lender recorded it (RFC3339, UTC).
          type: string
        registradora:
          description: The registradora the contract was registered at.
          type: string
        registradoraName:
          description: Name of the registradora; present only for 'outra'.
          type: string
        registrationCode:
          description: The code the registradora assigned, as the client sent it.
          type: string
        registrationDate:
          description: >-
            The civil day the registradora registered the contract (YYYY-MM-DD).
            Absent when not informed.
          type: string
      required:
        - loanApplicationId
        - registradora
        - registrationCode
        - recordedAt
      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.