> ## 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. # Listar os pedidos de empréstimo trabalhista abertos para o leilão > Lê uma página de solicitacoes-trabalhador-paginado (Manual 001 v1.9 §3.2.1/§3.2.2): solicitações de empréstimo abertas para um leilão de 24 horas, cada uma com a margem consignável livre. A janela de inclusão é obrigatória e a rede recusa a leitura sem ela. Esta operação apenas consulta o trilho e não avança o estado do job de descoberta; portanto, pode retornar uma solicitação que o job já processou. Use o fluxo de eventos para saber o que o gateway processou. ## OpenAPI ````yaml pt/openapi/v3-current/consignado.yaml get /v1/consignado/leilao/solicitacoes openapi: 3.1.0 info: contact: email: contact@lerian.studio name: Lerian Studio url: https://lerian.studio description: >- Superfície OpenAPI 3.1 para Lerian Consignado — Dataprev. o API cobre credenciais tenant e configuração de rede, margem do trabalhador, leilões e licitações de empréstimos, registro e ciclo de vida do contrato, confirmação de desembolso, portabilidade, refinanciamento, renegociação, garantias FGTS, reconciliação, fundos, atribuições, uso, rendimento e assinaturas de eventos. o material secreto é gravado no armazenamento secreto tenant e nunca é devolvido por nenhuma operação. 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: >- Custódia de credenciais do Dataprev e configuração pública do rail por tenant (upload, status, rotação, revogação, código do solicitante e URL base do portal do trabalhador) name: Credentials - description: >- Uso do gateway consignado no escopo do tenant: agregação de unidades faturáveis ​​com preço por competência name: Consignado Usage - description: >- Per-tenant plano de controle de assinatura do streaming-hub (listar, criar, obter, girar, revogar e testar a entrega) name: Subscriptions - description: >- Superfície folha de pagamento da rail Dataprev: leituras de saldo e autorização FGTS, execução de garantias FGTS, suspensão de contrato, reativação e alteração de prazo, documentos contratuais próprios da rede e leituras sob demanda de transações, escriturações, repasses e rescisões trabalhistas name: Consignado Rail - description: >- Superfície de comando da rede síncrona: as operações que um bancarizador sem o credor realizam sobre HTTP. cada um compartilha sua implementação de comando com o gatilho de evento de credor equivalente. name: Consignado Rail Commands - description: >- Confirmação de desembolso de propriedade do gateway: um banco cliente registrando o dinheiro que ALREADY pagou a um trabalhador. ele não cruza nenhuma fronteira governamental e não representa nenhuma operação Dataprev. name: Consignado Disbursement - description: > Taxa de transferência da rail Dataprev de saída de autoatendimento per-tenant: leia e defina o próprio requests-per-second deste tenant, incluindo uma pausa deliberada em zero name: Consignado Throughput paths: /v1/consignado/leilao/solicitacoes: get: tags: - Consignado Rail summary: Listar os pedidos de empréstimo trabalhista abertos para o leilão description: >- Lê uma página de solicitacoes-trabalhador-paginado (Manual 001 v1.9 §3.2.1/§3.2.2): solicitações de empréstimo abertas para um leilão de 24 horas, cada uma com a margem consignável livre. A janela de inclusão é obrigatória e a rede recusa a leitura sem ela. Esta operação apenas consulta o trilho e não avança o estado do job de descoberta; portanto, pode retornar uma solicitação que o job já processou. Use o fluxo de eventos para saber o que o gateway processou. operationId: listConsignadoSolicitacoes parameters: - description: >- Listing window start, RFC 3339 (rail dataHoraInicio, Obrigatório Sim — Manual 001 v1.9 §3.2.2 p.16). explode: false in: query name: data_hora_inicio required: true schema: description: >- Listing window start, RFC 3339 (rail dataHoraInicio, Obrigatório Sim — Manual 001 v1.9 §3.2.2 p.16). examples: - '2026-08-17T00:00:00Z' format: date-time type: string - description: >- Listing window end, RFC 3339 (rail dataHoraFim, Obrigatório Sim). It must follow data_hora_inicio and lie in the PAST — the rail refuses an end ahead of its own clock with code GR (Manual 001 v1.9 §3.2.1 p.15), so leave a margin of a minute or so for clock drift between the two organizations. The span is capped at 365 days by this gateway. explode: false in: query name: data_hora_fim required: true schema: description: >- Listing window end, RFC 3339 (rail dataHoraFim, Obrigatório Sim). It must follow data_hora_inicio and lie in the PAST — the rail refuses an end ahead of its own clock with code GR (Manual 001 v1.9 §3.2.1 p.15), so leave a margin of a minute or so for clock drift between the two organizations. The span is capped at 365 days by this gateway. examples: - '2026-08-18T00:00:00Z' format: date-time type: string - description: >- 1-based page number, relayed to the rail's nroPagina. The rail owns the page size (Manual 001 v1.9 §3.2.1 p.15: a system parameter, 250 results per page); this surface serves exactly one page per call. explode: false in: query name: page schema: default: 1 description: >- 1-based page number, relayed to the rail's nroPagina. The rail owns the page size (Manual 001 v1.9 §3.2.1 p.15: a system parameter, 250 results per page); this surface serves exactly one page per call. examples: - 1 format: int64 minimum: 1 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/DataprevListSolicitacoesResponse' description: OK default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error security: - BearerAuth: [] components: schemas: DataprevListSolicitacoesResponse: additionalProperties: false properties: has_more: description: >- Whether at least one further page exists. Derived from the rail's total-pages / total-elements metadata, so a caller never has to re-derive pagination arithmetic. examples: - true type: boolean page: description: >- The 1-based page index this response represents, echoing the requested page. examples: - 1 format: int64 type: integer size: description: >- The page size this response represents. The RAIL owns it — Manual 001 v1.9 §3.2.1 p.15 publishes it as a system parameter of 250 results per page. examples: - 250 format: int64 type: integer solicitacoes: description: >- The worker loan requests on this page. An empty list is the rail's answer, not an error. items: $ref: '#/components/schemas/DataprevSolicitacao' type: - array - 'null' required: - solicitacoes - page - size - has_more 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 DataprevSolicitacao: additionalProperties: false properties: codigo_solicitante: description: >- The instituição financeira code whose credential produced this read, echoed so a consumer bids under the same code (Manual 001 §3.1.2 p.10). Verbatim: it carries no shape or domain guarantee. examples: - '999' type: string cpf: description: >- The worker the request belongs to, 11 digits. Re-padded from the rail's JSON Número, which drops a leading zero. examples: - '99971699990' type: string data_admissao: description: >- The worker's admission date at the employer (Manual 001 §3.2.2 p.17, a ddMMyyyy Texto on the wire). Absent when the rail did not publish it. examples: - '2004-09-25T00:00:00Z' format: date-time type: string data_nascimento: description: >- The worker's date of birth (Manual 001 §3.2.2 p.17, a ddMMyyyy Texto on the wire). Absent when the rail did not publish it. examples: - '1981-09-25T00:00:00Z' format: date-time type: string elegivel_emprestimo: description: >- Whether the rail flags the worker eligible for the leilão loan. false is a signal a bid manager can decline on. Absent when the rail element carried no verdict — absence is NOT a refusal. examples: - true type: boolean garantia: $ref: '#/components/schemas/DataprevSolicitacaoGarantia' description: >- The solicitação's FGTS-collateral eligibility block. This is the SOURCE view — the collateral the worker HAS — distinct from the collateral a proposta OFFERS. id_solicitacao: description: >- The rail's identifier for the worker loan request — the subject a bid is submitted against. examples: - '9876543210' type: string inscricao_empregador: $ref: '#/components/schemas/DataprevCodigoDescricao' description: >- The employer-inscription TYPE pair. Manual 001 §3.2.2 p.17 Obs.1 allows the employer inscription to be a CPF or a CNPJ, so the discriminator is not derivable from the number. Absent when the rail published no readable code — never a synthesised codigo 0. margem_disponivel: description: >- The FREE consignable margin the rail reports for this request (decimal string, BRL) — the ceiling an instalment must fit under. It arrives without a consent step, unlike the worker-margin read. examples: - '1500.00' type: string matricula: description: >- The worker's payroll registration at the employer (Manual 001 §3.2.2 p.17, Texto; bounded 1..30 by Manual 003 §3.1.1). Together with cpf and numero_inscricao_empregador it IS the worker's employment link on this rail — there is no separate vínculo identifier. examples: - MATCEN716 type: string nome_trabalhador: description: The worker's name (Manual 001 v1.9 element). examples: - MARIA DA SILVA type: string numero_inscricao_empregador: description: >- The employer inscription the solicitação belongs to (Texto — CNPJ, CEI or CAEPF). examples: - '42422253000101' type: string pessoa_exposta_politicamente: $ref: '#/components/schemas/DataprevCodigoDescricao' description: >- The politically-exposed-person pair, relayed verbatim and never interpreted: Manual 001 §3.2.2 p.17 types it "Código e Descrição" and does not enumerate the codes. prazo_meses: description: The number of instalments the worker requested. examples: - 24 format: int64 type: integer validadeLeilao: description: >- The instant this request's leilão window closes, RFC 3339 UTC. The rail's leilão is valid 24h — a bid after this instant is not considered. examples: - '2026-07-31T12:00:00Z' format: date-time type: string valor_solicitado: description: The principal the worker requested (decimal string, BRL). examples: - '20000.00' type: string required: - id_solicitacao - cpf - margem_disponivel - valor_solicitado - prazo_meses - validadeLeilao 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 DataprevSolicitacaoGarantia: additionalProperties: false properties: perc_verba_rescisoria_garantia: description: >- Percentage of the rescission verbas pledged as collateral (decimal string, PERCENT). It rides the SEPARATE employer verba-rescisória track, not the FGTS-guarantee execution API. examples: - '10.00' type: string tem_garantias: description: >- Whether the worker has FGTS guarantees available. CAUTION: false is an authoritative rail statement of "no collateral" and is INDISTINGUISHABLE from the zero value of an absent block — on the contract read, gate on garantia_present instead, never on this flag alone. examples: - true type: boolean valor_multa_rescisoria_garantia_fgts: description: >- The rescission-penalty portion available as collateral (decimal string, BRL). examples: - '400.25' type: string valor_saldo_disponivel_garantia_fgts: description: The FGTS balance available as collateral (decimal string, BRL). examples: - '1000.50' type: string required: - tem_garantias type: object DataprevCodigoDescricao: additionalProperties: false properties: codigo: description: The rail's code, relayed verbatim. examples: - 1 format: int64 type: integer descricao: description: >- The rail's own label for the code, relayed verbatim so an unmapped code stays diagnosable. examples: - CNPJ type: string required: - codigo - descricao type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ````