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

# Register a receivable's credit instrument at the registradora

> Commands the registration of the receivable's credit instrument at the registradora the named fund is configured with, through the CLIENT's own participation. The command is idempotent by a deterministic reference that names the instrument alone: a second call returns the same protocol, and a registration the registry already accepted is refused rather than issued twice. A fund configured with no registradora is refused by name — registration is legally dispensable in the general case, and its absence never blocks a cession, but a caller who asked for one is never answered with silence.



## OpenAPI

````yaml /es/openapi/v3-current/lender.yaml post /api/v1/assignment/receivables/{receivableRef}/registry-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). See
    docs/contracts/money-route-idempotency.md.
  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.
    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.
    name: Consignado
  - description: >-
      Credit-instrument document template registry: versioned drafting and
      publication of CCB clausulado.
    name: DocumentTemplates
paths:
  /api/v1/assignment/receivables/{receivableRef}/registry-registration:
    post:
      tags:
        - AssignmentRegistry
      summary: Register a receivable's credit instrument at the registradora
      description: >-
        Commands the registration of the receivable's credit instrument at the
        registradora the named fund is configured with, through the CLIENT's own
        participation. The command is idempotent by a deterministic reference
        that names the instrument alone: a second call returns the same
        protocol, and a registration the registry already accepted is refused
        rather than issued twice. A fund configured with no registradora is
        refused by name — registration is legally dispensable in the general
        case, and its absence never blocks a cession, but a caller who asked for
        one is never answered with silence.
      operationId: registerReceivableInstrumentAtRegistry
      parameters:
        - description: >-
            The receivable this call is about, as an opaque identifier. Which
            format it carries belongs to the jurisdiction that booked it;
            nothing here parses it.
          in: path
          name: receivableRef
          required: true
          schema:
            description: >-
              The receivable this call is about, as an opaque identifier. Which
              format it carries belongs to the jurisdiction that booked it;
              nothing here parses it.
            maxLength: 128
            minLength: 1
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterReceivableInstrumentHumaInputBody'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssignmentRegistryCommandHumaBody'
          description: Accepted
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Forbidden
        '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
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    RegisterReceivableInstrumentHumaInputBody:
      additionalProperties: false
      properties:
        fundId:
          description: The fund whose registry configuration governs this registration.
          format: uuid
          type: string
      required:
        - fundId
      type: object
    AssignmentRegistryCommandHumaBody:
      additionalProperties: false
      properties:
        commandReference:
          description: >-
            Our deterministic idempotency key for this command. Quoting it back
            reaches the same command, never a second one.
          type: string
        providerReference:
          description: The registry's own protocol number for this command.
          type: string
        receivableRef:
          description: The receivable the command is about.
          type: string
        replayed:
          description: >-
            True when the registry was NOT reached because this exact command
            had already been acknowledged.
          type: boolean
        state:
          description: >-
            requested (issued and acknowledged, waiting on the registry's
            acceptance), confirmed, or failed.
          type: string
      required:
        - receivableRef
        - commandReference
        - providerReference
        - state
        - replayed
      type: object
    Detail:
      additionalProperties: false
      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

````