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

# Lista de registros de contrato de consignado confirmados

> Devuelve una página delimitada por compromiso y con alcance tenant de evidencia de registro Dataprev confirmada.



## OpenAPI

````yaml es/openapi/v3-current/consignado.yaml get /v1/consignado/contract-registrations
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    Superficie OpenAPI 3.1 para Lerian Consignado — Dataprev. API cubre las
    credenciales y la configuración de red de tenant, el margen de los
    trabajadores, las subastas y ofertas de préstamos, el registro y el ciclo de
    vida de los contratos, la confirmación de desembolsos, la portabilidad, la
    refinanciación, la renegociación, las garantías de FGTS, la conciliación,
    los fondos, las asignaciones, el uso, el rendimiento y las suscripciones a
    eventos. El material secreto se escribe en el almacén secreto tenant y
    ninguna operación lo devuelve nunca.
  license:
    name: Lerian Studio General License
  title: Lerian Consignado API
  version: v1.0.0
servers:
  - url: https://consignado.sandbox.lerian.net
security:
  - BearerAuth: []
tags:
  - description: >-
      Custodia de credenciales de Dataprev y configuración pública del rail por
      tenant (carga, estado, rotación, revocación, código del solicitante y URL
      base del portal del trabajador)
    name: Credentials
  - description: >-
      Uso de la gateway del consignado en el ámbito del tenant: agregación de
      unidades facturables con precio por competencia
    name: Consignado Usage
  - description: >-
      Plano de control de suscripción al hub de streaming per-tenant (enumerar,
      crear, obtener, rotar, revocar y probar la entrega)
    name: Subscriptions
  - description: >-
      Superficie de rail de nómina Dataprev: lecturas de saldo y autorización
      FGTS, ejecución de garantía FGTS, suspensión de contrato, reactivación y
      cambios de términos, documentos de contrato propios de la red y lecturas
      bajo demanda de leilão solicitações, escriturações, repasses y
      terminaciones de empleo.
    name: Consignado Rail
  - description: >-
      Superficie de comando de red síncrona: las operaciones de un bancarizador
      sin que el prestamista conduzca sobre HTTP. Cada uno comparte su
      implementación de comando con el activador de evento de prestamista
      equivalente.
    name: Consignado Rail Commands
  - description: >-
      Confirmación de desembolso propiedad de la gateway: un banco cliente que
      registra el dinero que ya pagó a un trabajador. No cruza ninguna frontera
      gubernamental y no representa ninguna operación Dataprev.
    name: Consignado Disbursement
  - description: >
      Rendimiento de red Dataprev saliente de autoservicio per-tenant: lea y
      configure el requests-per-second propio de este tenant, incluida una pausa
      deliberada en cero
    name: Consignado Throughput
paths:
  /v1/consignado/contract-registrations:
    get:
      tags:
        - Contract registrations
      summary: Lista de registros de contrato de consignado confirmados
      description: >-
        Devuelve una página delimitada por compromiso y con alcance tenant de
        evidencia de registro Dataprev confirmada.
      operationId: listConsignadoContractRegistrations
      parameters:
        - description: Opaque continuation cursor from the preceding page.
          explode: false
          in: query
          name: after
          schema:
            description: Opaque continuation cursor from the preceding page.
            type: string
        - description: Opaque immutable fence returned by the first page.
          explode: false
          in: query
          name: through
          schema:
            description: Opaque immutable fence returned by the first page.
            type: string
        - description: Maximum number of registrations to return.
          explode: false
          in: query
          name: limit
          schema:
            default: 100
            description: Maximum number of registrations to return.
            maximum: 500
            minimum: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistrationInventoryPage'
          description: OK
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Bad Request
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Forbidden
        '409':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Conflict
        '410':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Gone
        '429':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Too Many Requests
        '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
      security:
        - BearerAuth: []
components:
  schemas:
    RegistrationInventoryPage:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/RegistrationInventoryItem'
          type: array
        page:
          $ref: '#/components/schemas/RegistrationInventoryPageMetadata'
      required:
        - items
        - page
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          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
    RegistrationInventoryItem:
      additionalProperties: false
      properties:
        artifacts:
          $ref: '#/components/schemas/RegistrationInventoryArtifacts'
        composition:
          $ref: '#/components/schemas/RegistrationInventoryComposition'
        event:
          anyOf:
            - $ref: '#/components/schemas/RegistrationInventoryEvent'
            - type: 'null'
        numero_contrato:
          type: string
        outbox:
          anyOf:
            - $ref: '#/components/schemas/RegistrationInventoryOutbox'
            - type: 'null'
        position:
          type: string
        registration:
          $ref: '#/components/schemas/RegistrationInventoryRegistration'
      required:
        - position
        - numero_contrato
        - registration
        - composition
        - event
        - outbox
        - artifacts
      type: object
    RegistrationInventoryPageMetadata:
      additionalProperties: false
      properties:
        after:
          type:
            - string
            - 'null'
        has_more:
          type: boolean
        next_after:
          type: string
        through:
          type: string
      required:
        - after
        - through
        - next_after
        - has_more
      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
    RegistrationInventoryArtifacts:
      additionalProperties: false
      properties:
        biometrics_documents_pack:
          anyOf:
            - $ref: '#/components/schemas/RegistrationInventoryArtifact'
            - type: 'null'
        signed_ccb:
          anyOf:
            - $ref: '#/components/schemas/RegistrationInventoryArtifact'
            - type: 'null'
      required:
        - signed_ccb
        - biometrics_documents_pack
      type: object
    RegistrationInventoryComposition:
      additionalProperties: false
      properties:
        composed_at:
          format: date-time
          type:
            - string
            - 'null'
        failure_code:
          type:
            - string
            - 'null'
        payload_sha256:
          type:
            - string
            - 'null'
        status:
          type: string
      required:
        - status
        - composed_at
        - payload_sha256
        - failure_code
      type: object
    RegistrationInventoryEvent:
      additionalProperties: false
      properties:
        event_id:
          type: string
        event_type:
          type: string
        schema_version:
          type: string
      required:
        - event_id
        - event_type
        - schema_version
      type: object
    RegistrationInventoryOutbox:
      additionalProperties: false
      properties:
        attempt_count:
          format: int64
          type: integer
        created_at:
          format: date-time
          type: string
        last_error_code:
          type:
            - string
            - 'null'
        outbox_id:
          type: string
        published_at:
          format: date-time
          type:
            - string
            - 'null'
        status:
          type: string
      required:
        - outbox_id
        - status
        - created_at
        - published_at
        - attempt_count
        - last_error_code
      type: object
    RegistrationInventoryRegistration:
      additionalProperties: false
      properties:
        attachment_hash_operacao:
          type: string
        confirmed_at:
          format: date-time
          type: string
        dataprev_success_code:
          type: string
        rail_reference:
          type: string
      required:
        - confirmed_at
        - dataprev_success_code
        - rail_reference
        - attachment_hash_operacao
      type: object
    RegistrationInventoryArtifact:
      additionalProperties: false
      properties:
        blob_ref:
          type: string
        digest_sha256:
          type: string
        retrieval_uri:
          type: string
        size_bytes:
          format: int64
          type: integer
        stored_at:
          format: date-time
          type: string
      required:
        - blob_ref
        - digest_sha256
        - size_bytes
        - stored_at
        - retrieval_uri
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````