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

# Read the inbound-portability lineage of a contract

> Answers whether this contract ARRIVED by portability and, if so, which institution it came from, under which operation reference there, for how much, and as of when. A 404 is the ordinary answer for a contract this lender originated: the lineage row EXISTS only for transferred stock, which is what distinguishes it from new production in portfolio and regulatory reporting. The transferred balance is the principal the contract was booked with — a registered fact whose two numbers disagree is refused at ingestion rather than reconciled — and the record is immutable: a correction is a new fact elsewhere, never a rewrite of where a debt came from.



## OpenAPI

````yaml /pt/openapi/v3-current/lender.yaml get /api/v1/internal/br/consignado/contracts/{numeroContrato}/portability-inbound
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/internal/br/consignado/contracts/{numeroContrato}/portability-inbound:
    get:
      tags:
        - Consignado
      summary: Read the inbound-portability lineage of a contract
      description: >-
        Answers whether this contract ARRIVED by portability and, if so, which
        institution it came from, under which operation reference there, for how
        much, and as of when. A 404 is the ordinary answer for a contract this
        lender originated: the lineage row EXISTS only for transferred stock,
        which is what distinguishes it from new production in portfolio and
        regulatory reporting. The transferred balance is the principal the
        contract was booked with — a registered fact whose two numbers disagree
        is refused at ingestion rather than reconciled — and the record is
        immutable: a correction is a new fact elsewhere, never a rewrite of
        where a debt came from.
      operationId: getConsignadoPortabilityInboundLineage
      parameters:
        - description: The rail contract number, byte-exact.
          in: path
          name: numeroContrato
          required: true
          schema:
            description: The rail contract number, byte-exact.
            maxLength: 128
            minLength: 1
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PortabilityInboundLineageHumaBody'
          description: OK
        '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:
    PortabilityInboundLineageHumaBody:
      additionalProperties: false
      properties:
        currency:
          description: ISO 4217 currency code.
          type: string
        effectiveAt:
          description: >-
            UTC instant the portability took effect at the ORIGIN (RFC3339,
            sub-second precision preserved to the microsecond the row stores).
            Not the instant we booked.
          type: string
        externalOperationRef:
          description: >-
            The operation reference at the origin institution. Opaque, preserved
            verbatim; this is what a dispute is quoted against.
          type: string
        numeroContrato:
          description: The rail contract number.
          type: string
        originInstitution:
          description: >-
            The institution the contract came FROM. Opaque counterparty
            identifier, preserved verbatim.
          type: string
        transferredPrincipal:
          description: >-
            What the worker owed at the ORIGIN when the debt moved, cent scale.
            The booked principal equals it by construction: a fact whose two
            numbers disagree is refused at ingestion.
          type: string
      required:
        - numeroContrato
        - originInstitution
        - externalOperationRef
        - transferredPrincipal
        - currency
        - effectiveAt
      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

````