> ## 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. # Set a pre-auction fund policy > Writes the policy of a fund known to the validated tenant; a deactivated fund is accepted. An identical PUT changes nothing. X-Idempotency is required. There is no DELETE: participa false takes the fund out of the pre-auction. Counters derive from the reservation ledger in the America/Sao_Paulo day. ## OpenAPI ````yaml /es/openapi/v3-current/consignado.yaml put /v1/consignado/preleilao/fundos/{fundo_ref} 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, B3 instrument codes, disbursement confirmation, portability, refinancing, renegotiation, FGTS guarantees, reconciliation, funds, assignments, throughput, and event subscriptions. 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: >- 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. 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 - description: Tenant pre-auction configuration, fund policies, auctions and quotes name: Consignado Pré-leilão - description: >- The B3 instrument code (Código IF) of an averbado contract: informed once by the bancarizador after B3 registers the CCB, and read back name: Consignado Registro B3 paths: /v1/consignado/preleilao/fundos/{fundo_ref}: put: tags: - Consignado Pré-leilão summary: Set a pre-auction fund policy description: >- Writes the policy of a fund known to the validated tenant; a deactivated fund is accepted. An identical PUT changes nothing. X-Idempotency is required. There is no DELETE: participa false takes the fund out of the pre-auction. Counters derive from the reservation ledger in the America/Sao_Paulo day. operationId: setConsignadoPreleilaoFundo parameters: - description: Registered fund, percent-encoded. in: path name: fundo_ref required: true schema: description: Registered fund, percent-encoded. examples: - fundo-a minLength: 1 type: string - description: Required key; the same body replays, a different body is refused. in: header name: X-Idempotency required: true schema: description: Required key; the same body replays, a different body is refused. examples: - idem-fundo-0001 maxLength: 128 minLength: 1 type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PreleilaoFundoPolicyRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PreleilaoFundoPolicyResponse' 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 '413': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Request Entity Too Large '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 '503': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Service Unavailable security: - BearerAuth: [] components: schemas: PreleilaoFundoPolicyRequest: additionalProperties: false properties: horario: $ref: '#/components/schemas/PreleilaoFundoHorarioBody' description: Daily window; absent or null is all day. limites: $ref: '#/components/schemas/PreleilaoFundoLimitesBody' description: Financial limits. participa: description: false refuses the fund's quotes and takes it out of the rodizio. examples: - true type: boolean peso: description: >- Desired share of the day's value, normalized among the funds that compete; need not sum to 100; unused without the rodizio. examples: - 50 format: int64 maximum: 1000 minimum: 1 type: integer restricoes: $ref: '#/components/schemas/PreleilaoFundoRestricoesBody' description: Typed restrictions on quote and averbação terms. required: - participa - peso type: object PreleilaoFundoPolicyResponse: additionalProperties: false properties: configurada: description: Whether a policy was written; false shows the defaults. examples: - true type: boolean createdAt: description: First write. examples: - '2026-11-03T15:00:00Z' format: date-time type: string fundoRef: description: The fund. examples: - fundo-a type: string horario: $ref: '#/components/schemas/PreleilaoFundoHorarioBody' description: Daily window; null is all day. limites: $ref: '#/components/schemas/PreleilaoFundoLimitesBody' description: Financial limits. participa: description: Whether the fund takes part in the pre-auction. examples: - true type: boolean peso: description: Weight of the fund in the rodizio. examples: - 50 format: int64 type: integer restricoes: $ref: '#/components/schemas/PreleilaoFundoRestricoesBody' description: Typed restrictions on quote and averbação terms. updatedAt: description: Last change. examples: - '2026-11-03T15:00:00Z' format: date-time type: string updatedBy: description: Actor of the last change. examples: - user-123 type: string uso: $ref: '#/components/schemas/PreleilaoFundoUsoBody' description: Counters derived from the reservation ledger. required: - fundoRef - configurada - participa - peso - horario - limites - restricoes - uso type: object Detail: additionalProperties: true properties: code: description: >- Stable, machine-readable product error code. One of the enumerated values: the CLT-NNNN catalog codes for the general refusal classes; the named command conflicts, which a client branches on to tell one conflict from another; the four terminal refusals IDEMPOTENCY_STATE_UNRECOGNISED, IDEMPOTENCY_RECORD_UNREADABLE, IDEMPOTENCY_OUTCOME_UNRECORDED and IDEMPOTENCY_REPLAY_UNAVAILABLE (422), which tell the client to reconcile the original request and never retry under a new key; IDEMPOTENCY_KEY_REUSE (422): the key is spent on a different request, so send a new key; the codes a single surface answers, named after it (FUNDO_*, REGISTRO_B3_*, ...); and the 5xx codes naming an upstream (DATAPREV_*, STREAMING_HUB_*, TENANT_MANAGER_*, the Access Manager's AUT-0033 and AUT-1021) or an unknown outcome, whose detail is client-readable; the Access Manager's AUT-1022 (403): the partner credential holds more than one originador, so name it in the path; ORIGINADOR_DEACTIVATED and FUNDO_PARTNER_DEACTIVATED (403): the originador or fundo the partner credential acts for is deactivated, so the bancarizador must reactivate it. enum: - AUT-0033 - AUT-1021 - AUT-1022 - AVERBACAO_ARTIFACT_CONFLICT - AVERBACAO_CLAIM_CONFLICT - AVERBACAO_DOCUMENTATION_CONFLICT - AVERBACAO_EXCLUDED - AVERBACAO_HELD_BY_ANOTHER_SENDER - AVERBACAO_NOT_ACCEPTED - AVERBACAO_OPERATIONS_INTERNAL - AVERBACAO_OPERATIONS_INVALID_CURSOR - AVERBACAO_OPERATIONS_INVALID_QUERY - AVERBACAO_OPERATIONS_UNKNOWN_STATUS - AVERBACAO_OPERATION_NOT_FOUND - BID_FUND_NOT_ACCEPTED - BID_FUND_NOT_IN_PRELEILAO - BID_FUND_OUTSIDE_HOURS - BID_FUND_OUTSIDE_MANDATE - BID_FUND_POLICY_VIOLATION - BID_FUND_REQUIRED - BID_NO_PROPOSTA_LEFT - BID_ORIGINADOR_INACTIVE - BID_ORIGINADOR_UNKNOWN - BID_PROPOSAL_SLOT_TAKEN - BID_QUOTE_NOT_IN_PRELEILAO - BID_QUOTE_REVISION_LIMIT - BID_QUOTE_UNSECURED_REQUIRED - BID_QUOTE_WINDOW_CLOSED - BID_SOLICITACAO_TAKEN - BID_SOLICITACAO_UNKNOWN - BID_SUBMISSIONS_INTERNAL - BID_SUBMISSIONS_INVALID_CURSOR - BID_SUBMISSIONS_UNKNOWN_SITUATION - BOOKING_FIELD_INVALID - CEDED_CREDIT_INTERNAL - CEDED_CREDIT_NO_FUND_ENTITLEMENT - CEDED_CREDIT_UNAVAILABLE - CLT-0001 - CLT-0002 - CLT-0003 - CLT-0004 - CLT-0005 - CLT-0006 - CLT-0007 - CLT-0008 - CLT-0009 - CLT-0010 - CLT-0011 - CONTRACT_ALREADY_REGISTERED - CONTRACT_NOT_BOOKABLE - CURSOR_EXPIRED - CURSOR_FENCE_MISMATCH - DATAPREV_CREDENTIAL_REJECTED - DATAPREV_CREDENTIAL_REQUIRED - DATAPREV_CREDENTIAL_REVOKED - DATAPREV_INVALID_RESPONSE - DATAPREV_TIMEOUT - DATAPREV_UNAVAILABLE - DECLARED_DATES_OUT_OF_ORDER - DECLARED_TERMS_INCONSISTENT - DISBURSEMENT_CONFIRMATIONS_INTERNAL - DISBURSEMENT_CONFIRMATIONS_INVALID_CURSOR - DISBURSEMENT_PAYMENT_CONFLICT - EVENT_DELIVERY_INTERNAL - EXCLUSION_AUTHORITY_CONFLICT - EXCLUSION_BOOKING_IDENTITY_INCOMPLETE - EXCLUSION_DOCUMENTATION_UNDERWAY - EXCLUSION_OPERATIONS_INTERNAL - EXCLUSION_OPERATIONS_INVALID_CURSOR - EXCLUSION_OPERATIONS_INVALID_QUERY - EXCLUSION_OPERATIONS_UNKNOWN_STATUS - EXCLUSION_OPERATION_NOT_FOUND - EXCLUSION_RENEGOTIATION_UNDERWAY - FGTS_EXECUTION_ALREADY_REFUSED - FGTS_EXECUTION_CONTRACT_TAKEN - FGTS_EXECUTION_OUTCOME_UNRESOLVED - FGTS_EXECUTION_PAYLOAD_MISMATCH - FIRST_DEDUCTION_BEFORE_COMPETENCIA - FORMALIZATION_DEADLINE_EXCEEDED - FUNDO_CNPJ_CONFLICT - FUNDO_DEACTIVATED - FUNDO_DIFFERS_FROM_QUOTE - FUNDO_INTERNAL - FUNDO_INVALID_ID - FUNDO_INVALID_INPUT - FUNDO_NOT_FOUND - FUNDO_NOT_REGISTERED - FUNDO_PARTNER_DEACTIVATED - FUNDO_POLICY_VIOLATION - FUNDO_REF_CONFLICT - FUNDO_UNAVAILABLE - HELD_REPASSE_MONTH_CLOSED - HELD_REPASSE_MONTH_MISMATCH - HELD_REPASSE_NOT_FOUND - HELD_REPASSE_UNATTRIBUTABLE - IDEMPOTENCY_KEY_REUSE - IDEMPOTENCY_OUTCOME_UNRECORDED - IDEMPOTENCY_RECORD_UNREADABLE - IDEMPOTENCY_REPLAY_UNAVAILABLE - IDEMPOTENCY_STATE_UNRECOGNISED - INVALID_CONTRACT_NUMBER - INVALID_CURSOR - INVALID_EVENTS_INVALID_CURSOR - INVALID_EVENT_NOT_FOUND - INVALID_EVENT_NOT_REQUEUEABLE - INVALID_PAGE_LIMIT - INVENTORY_UNAVAILABLE - LOAN_PRODUCT_VERSION_UNKNOWN - MARGIN_SNAPSHOT_INCONSISTENT - MATRICULA_DIFFERS_FROM_PROPOSAL - ORIGINADOR_DEACTIVATED - ORIGINADOR_INTERNAL - ORIGINADOR_INVALID_ID - ORIGINADOR_INVALID_INPUT - ORIGINADOR_NOT_FOUND - ORIGINADOR_REF_CONFLICT - ORIGINADOR_UNAVAILABLE - OUTCOME_UNKNOWN - PORTABILIDADE_WINDOW_EXPIRED - PRELEILAO_POLICY_INVALID - PRELEILAO_WORKER_UNAVAILABLE - RAIL_COMMANDS_INTERNAL - RAIL_COMMANDS_INVALID_CURSOR - RAIL_COMMANDS_TENANT_REQUIRED - RAIL_COMMANDS_UNKNOWN_FILTER - RAIL_COMMAND_ALREADY_REFUSED - RAIL_COMMAND_ANSWER_NOT_RETAINED - RAIL_COMMAND_CLAIM_CONFLICT - RAIL_COMMAND_CLOSE_CONTRADICTED - RAIL_COMMAND_NOT_CLOSEABLE - RAIL_COMMAND_OUTCOME_UNRESOLVED - RAIL_COMMAND_PAYLOAD_MISMATCH - RATE_OUTSIDE_PRODUCT_RANGE - REGISTRATION_NOT_FOUND - REGISTRO_B3_AVERBACAO_NAO_CONFIRMADA - REGISTRO_B3_CONTRATO_NAO_ENCONTRADO - REGISTRO_B3_DATA_REGISTRO_INVALIDA - REGISTRO_B3_INTERNAL - REGISTRO_B3_JA_INFORMADO - REGISTRO_B3_NAO_INFORMADO - REGISTRO_B3_UNAVAILABLE - REGISTRO_B3_UNWIRED - RENEGOTIATION_EXCLUSION_UNDERWAY - REPASSE_EXPECTATIONS_INTERNAL - REPASSE_EXPECTATIONS_INVALID_CURSOR - REPASSE_EXPECTATIONS_UNKNOWN_SITUATION - REVERSAO_WINDOW_EXPIRED - SALDO_DEVEDOR_INTERNAL - SALDO_DEVEDOR_INVALID_CURSOR - SALDO_DEVEDOR_NOT_FOUND - SALDO_DEVEDOR_TENANT_REQUIRED - SALDO_DEVEDOR_UNAVAILABLE - STREAMING_HUB_TIMEOUT - STREAMING_HUB_UNAVAILABLE - TENANT_MANAGER_TIMEOUT - TENANT_MANAGER_UNAVAILABLE - THROUGHPUT_HISTORY_INTERNAL - THROUGHPUT_HISTORY_INVALID_CURSOR - THROUGHPUT_HISTORY_TENANT_REQUIRED - THROUGHPUT_HISTORY_UNAVAILABLE - THROUGH_REQUIRED - UNKNOWN_QUERY_PARAMETER - VERSION_ADMITS_NO_PESSOA_FISICA 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 PreleilaoFundoHorarioBody: additionalProperties: false properties: fim: description: First minute no longer admitted, HH:MM; later than inicio. examples: - '22:00' pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]$ type: string inicio: description: First admitted minute, HH:MM. examples: - '08:00' pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]$ type: string required: - inicio - fim type: - object - 'null' PreleilaoFundoLimitesBody: additionalProperties: false properties: capital: description: Capital the fund commits, two decimals above zero; null is no limit. examples: - '10000000.00' pattern: ^([1-9][0-9]{0,14}\.[0-9]{2}|0\.(0[1-9]|[1-9][0-9]))$ type: - string - 'null' quantidadeDiaria: description: Quotes per local day; null is no limit. examples: - 800 format: int64 maximum: 2147483647 minimum: 1 type: - integer - 'null' valorDiario: description: >- Released value per local day, two decimals above zero; null is no limit. examples: - '4000000.00' pattern: ^([1-9][0-9]{0,14}\.[0-9]{2}|0\.(0[1-9]|[1-9][0-9]))$ type: - string - 'null' type: object PreleilaoFundoRestricoesBody: additionalProperties: false properties: garantiaFgts: default: aceita description: recusa refuses quotes and averbações that carry an FGTS guarantee. enum: - aceita - recusa examples: - recusa type: string parcelasMax: description: Maximum installment count. examples: - 48 format: int64 maximum: 96 minimum: 1 type: - integer - 'null' parcelasMin: description: Minimum installment count. examples: - 6 format: int64 maximum: 96 minimum: 1 type: - integer - 'null' taxaMensalMax: description: Maximum monthly rate, percent. examples: - '3.50' pattern: ^(0|[1-9][0-9]{0,4})\.[0-9]{2}$ type: - string - 'null' taxaMensalMin: description: Minimum monthly rate, percent. examples: - '1.80' pattern: ^(0|[1-9][0-9]{0,4})\.[0-9]{2}$ type: - string - 'null' valorLiberadoMax: description: Maximum released amount in reais. examples: - '50000.00' pattern: ^(0|[1-9][0-9]{0,12})\.[0-9]{2}$ type: - string - 'null' valorLiberadoMin: description: Minimum released amount in reais. examples: - '1000.00' pattern: ^(0|[1-9][0-9]{0,12})\.[0-9]{2}$ type: - string - 'null' valorParcelaMax: description: Maximum installment amount in reais. examples: - '2000.00' pattern: ^(0|[1-9][0-9]{0,12})\.[0-9]{2}$ type: - string - 'null' type: object PreleilaoFundoUsoBody: additionalProperties: false properties: capitalDisponivel: description: >- capital minus reservado minus confirmado; present only with a capital, and may be negative. examples: - '8668000.00' type: string confirmado: description: Value confirmed by an averbação. examples: - '1240000.00' type: string dia: description: Local day (America/Sao_Paulo) the counters cover. examples: - '2026-11-03' type: string quantidadeHoje: description: Reservations made today that are not released. examples: - 12 format: int64 type: integer reservado: description: Value currently reserved. examples: - '92000.00' type: string valorHoje: description: Released value reserved or confirmed today. examples: - '184000.00' type: string required: - dia - quantidadeHoje - valorHoje - reservado - confirmado 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 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.