> ## 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. # Get one contract's averbação operation > Returns ONE contract's averbação operation, by the rail contract number. It answers from a LOCAL table and never reaches the Dataprev rail. The tenant is derived from the validated identity: a contract that does not exist and a contract belonging to another tenant are the SAME answer, 404, so this read cannot be used to probe another tenant's book. The body is the operation object itself, with no envelope, the same shape as one element of GET /v1/consignado/averbacao-operations. Every conditional instant is present and null until the step it names has happened. This is the READ half of the address whose POST creates the payroll-deduction mandate. It creates nothing and changes nothing. ## OpenAPI ````yaml /en/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/averbacao openapi: 3.1.0 info: contact: email: contact@lerian.studio name: Lerian Studio url: https://lerian.studio description: >- OpenAPI 3.1 surface for Lerian Consignado — Dataprev. The API covers tenant credentials and rail configuration, worker margin, loan auctions and bids, contract registration and lifecycle, disbursement confirmation, portability, refinancing, renegotiation, FGTS guarantees, reconciliation, funds, assignments, usage, throughput, and event subscriptions. Secret material is written to the tenant secret store and is never returned by any operation. license: name: Lerian Studio General License title: Lerian Consignado API version: v1.0.0 servers: - url: https://br-consignado-gw.sandbox.lerian.net security: - BearerAuth: [] tags: - description: >- Per-tenant Dataprev credential custody and public rail configuration (upload, status, rotation, revoke, requester code, and worker portal base URL) name: Credentials - description: >- Tenant-scoped consignado gateway usage: priced billable-unit aggregation per competência name: Consignado Usage - description: >- Per-tenant streaming-hub subscription control-plane (list, create, get, rotate, revoke, and test delivery) name: Subscriptions - description: >- Dataprev payroll-rail surface: FGTS balance and authorization reads, the FGTS guarantee execution, contract suspension, reactivation and term changes, the rail's own contract documents, and the on-demand reads of leilão solicitações, escriturações, repasses and employment terminations name: Consignado Rail - description: >- Synchronous rail command surface: the operations a bancarizador without the lender drives over HTTP. Each shares its command implementation with the equivalent lender event trigger. name: Consignado Rail Commands - description: >- Gateway-owned disbursement confirmation: a client bank recording money it has ALREADY paid to a worker. It crosses no government boundary and proxies no Dataprev operation. name: Consignado Disbursement - description: >- Per-tenant self-service outbound Dataprev rail throughput: read and set this tenant's own requests-per-second, including a deliberate pause at zero name: Consignado Throughput paths: /v1/consignado/contracts/{numero_contrato}/averbacao: get: tags: - Consignado Averbação Operations summary: Get one contract's averbação operation description: >- Returns ONE contract's averbação operation, by the rail contract number. It answers from a LOCAL table and never reaches the Dataprev rail. The tenant is derived from the validated identity: a contract that does not exist and a contract belonging to another tenant are the SAME answer, 404, so this read cannot be used to probe another tenant's book. The body is the operation object itself, with no envelope, the same shape as one element of GET /v1/consignado/averbacao-operations. Every conditional instant is present and null until the step it names has happened. This is the READ half of the address whose POST creates the payroll-deduction mandate. It creates nothing and changes nothing. operationId: getConsignadoContractAverbacaoOperation parameters: - description: >- The rail contract number, exactly as it was registered. It is never trimmed or normalized. in: path name: numero_contrato required: true schema: description: >- The rail contract number, exactly as it was registered. It is never trimmed or normalized. maxLength: 15 minLength: 2 type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AverbacaoOperationItem' 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 '404': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Not Found '422': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unprocessable Entity '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 security: - BearerAuth: [] components: schemas: AverbacaoOperationItem: additionalProperties: false properties: attachment_at: format: date-time type: - string - 'null' attachment_invocation_deadline_at: format: date-time type: - string - 'null' attachment_unknown_at: format: date-time type: - string - 'null' averbacao_at: format: date-time type: - string - 'null' averbacao_invocation_deadline_at: format: date-time type: - string - 'null' averbacao_unknown_at: format: date-time type: - string - 'null' claimed_at: format: date-time type: string contract_id: type: string fact_id: type: - string - 'null' numero_contrato: type: string outcome_at: format: date-time type: - string - 'null' response_code: description: >- The rail's return code for the averbação call. Empty until the rail answered. type: string response_message: description: >- The rail's message for the averbação call. Empty until the rail answered. type: string status: description: The situation the operation is durably parked in. enum: - claimed - averbacao_invoking - averbacao_unknown - attachment_pending - attachment_invoking - attachment_unknown - confirmed - rejected type: string required: - contract_id - numero_contrato - status - response_code - response_message - claimed_at - averbacao_at - attachment_at - outcome_at - averbacao_unknown_at - attachment_unknown_at - averbacao_invocation_deadline_at - attachment_invocation_deadline_at - fact_id type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -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 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 ````