> ## 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. # Report which operation families this deployment reaches > Reports which operation families THIS deployment reaches. The console reads it once and uses it to disable, rather than hide, a control that would otherwise answer 501. Nothing here is tenant data: the answer is a property of the running deployment and is identical for every tenant it serves. The tenant is still derived from the validated identity, as on every other operation, and is never read from the request. 'name' is the operation family, never the name of the deployment flag behind it: a flag name is operator material. 'reason' is a closed vocabulary of four values, one per mechanism. 'enabled' is the only one that appears beside available true. 'flag_off' means a boot flag made the composition skip building the family. 'portal_store_absent' means this deployment mounted no portal store. 'rail_client_absent' means no Dataprev client was wired, which takes the whole rail family with it. A family reported unavailable will answer 501 on every one of its operations. A family reported available may still answer 501 in the instant between this read and the call, so a client keeps its own 501 branch: this read tells a client what to offer, it does not replace the refusal. ## OpenAPI ````yaml /en/openapi/v3-current/consignado.yaml get /v1/consignado/capabilities 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/capabilities: get: tags: - Consignado Capabilities summary: Report which operation families this deployment reaches description: >- Reports which operation families THIS deployment reaches. The console reads it once and uses it to disable, rather than hide, a control that would otherwise answer 501. Nothing here is tenant data: the answer is a property of the running deployment and is identical for every tenant it serves. The tenant is still derived from the validated identity, as on every other operation, and is never read from the request. 'name' is the operation family, never the name of the deployment flag behind it: a flag name is operator material. 'reason' is a closed vocabulary of four values, one per mechanism. 'enabled' is the only one that appears beside available true. 'flag_off' means a boot flag made the composition skip building the family. 'portal_store_absent' means this deployment mounted no portal store. 'rail_client_absent' means no Dataprev client was wired, which takes the whole rail family with it. A family reported unavailable will answer 501 on every one of its operations. A family reported available may still answer 501 in the instant between this read and the call, so a client keeps its own 501 branch: this read tells a client what to offer, it does not replace the refusal. operationId: getConsignadoCapabilities responses: '200': content: application/json: schema: $ref: '#/components/schemas/CapabilitiesResponse' 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 '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: CapabilitiesResponse: additionalProperties: false properties: capabilities: items: $ref: '#/components/schemas/Capability' type: array required: - capabilities 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 Capability: additionalProperties: false properties: available: description: >- Whether this deployment composed the family. A console reads THIS to decide whether a control is offered. type: boolean name: description: >- The operation family. It names the family and never the deployment flag behind it. enum: - averbacao - averbacao_recovery - exclusao - correcoes - desembolso - cessao - leilao - portal - trilho type: string reason: description: >- Which mechanism decided. 'enabled' is the only value that appears beside available true; the other three each name a distinct thing an operator would have to change. enum: - enabled - flag_off - portal_store_absent - rail_client_absent type: string required: - name - available - reason 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 ````