> ## 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. # Read the cadastro stored with a consignado averbação > Returns the cadastro the client sent with the averbação — `dados_cadastrais` plus `nome_trabalhador` — as the exact bytes stored at averbação time. Their SHA-256 is the `dados_cadastrais_digest_sha256` that consignado.contract.registered published, so the consumer verifies the body against the fact and never parses before verifying. A contract with no cadastro, a missing contract and another tenant's contract share the same 404. The tenant comes from the validated identity; a fund credential reads only contracts of its own fund. ## OpenAPI ````yaml /pt/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/dados-cadastrais 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. 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. 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}/dados-cadastrais: get: tags: - Artifacts summary: Read the cadastro stored with a consignado averbação description: >- Returns the cadastro the client sent with the averbação — `dados_cadastrais` plus `nome_trabalhador` — as the exact bytes stored at averbação time. Their SHA-256 is the `dados_cadastrais_digest_sha256` that consignado.contract.registered published, so the consumer verifies the body against the fact and never parses before verifying. A contract with no cadastro, a missing contract and another tenant's contract share the same 404. The tenant comes from the validated identity; a fund credential reads only contracts of its own fund. operationId: getConsignadoContractDadosCadastrais parameters: - description: Client contract identity within the authenticated tenant. in: path name: numero_contrato required: true schema: description: Client contract identity within the authenticated tenant. examples: - NC-000001 minLength: 1 type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/DadosCadastraisDocument' description: The stored cadastro bytes, verbatim. headers: Cache-Control: schema: type: string Content-Type: schema: type: string X-Content-Type-Options: schema: type: string '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 '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Internal Server Error '501': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Not Implemented '503': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Service Unavailable security: - BearerAuth: [] components: schemas: DadosCadastraisDocument: additionalProperties: false properties: dados_cadastrais: $ref: '#/components/schemas/DadosCadastrais' nome_trabalhador: type: string required: - nome_trabalhador - dados_cadastrais 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; and the four IDEMPOTENCY_* terminal refusals (422), which tell the client to reconcile the original request and never retry under a new key. enum: - AVERBACAO_ARTIFACT_CONFLICT - AVERBACAO_CLAIM_CONFLICT - BID_PROPOSAL_SLOT_TAKEN - BID_SOLICITACAO_TAKEN - 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 - DATAPREV_CREDENTIAL_REQUIRED - EXCLUSION_AUTHORITY_CONFLICT - EXCLUSION_AUTHORITY_QUARANTINED - FGTS_EXECUTION_ALREADY_REFUSED - FGTS_EXECUTION_CONTRACT_TAKEN - FGTS_EXECUTION_OUTCOME_UNRESOLVED - FGTS_EXECUTION_PAYLOAD_MISMATCH - IDEMPOTENCY_OUTCOME_UNRECORDED - IDEMPOTENCY_RECORD_UNREADABLE - IDEMPOTENCY_REPLAY_UNAVAILABLE - IDEMPOTENCY_STATE_UNRECOGNISED - RAIL_COMMAND_ANSWER_NOT_RETAINED - RAIL_COMMAND_CLAIM_CONFLICT - REVERSAO_WINDOW_EXPIRED 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 DadosCadastrais: additionalProperties: false properties: dados_bancarios: $ref: '#/components/schemas/DadosCadastraisBancarios' description: >- The worker's own disbursement account. When present it carries at least one complete set: banco + agencia + conta, or chave_pix + tipo_chave_pix. empregador: $ref: '#/components/schemas/DadosCadastraisEmpregador' description: >- Employer record. Required when codigo_inscricao_empregador is 1 (CNPJ), refused when it is 2 (a person employer). The CNPJ is numero_inscricao_empregador and is not repeated here. originacao: $ref: '#/components/schemas/DadosCadastraisOriginacao' trabalhador: $ref: '#/components/schemas/DadosCadastraisTrabalhador' required: - trabalhador - originacao 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 DadosCadastraisBancarios: additionalProperties: false properties: agencia: description: Branch, without check digit. examples: - '1234' pattern: ^[0-9]{1,5}$ type: string banco: description: COMPE bank code. examples: - '341' pattern: ^[0-9]{3}$ type: string chave_pix: description: >- Pix key. A CPF key must equal the body's cpf; a TELEFONE key is E.164. examples: - '41128041308' maxLength: 77 minLength: 1 type: string conta: description: Account, without check digit. examples: - '56789' pattern: ^[0-9]{1,20}$ type: string conta_digito: description: Account check digit. examples: - '0' pattern: ^[0-9X]{1,2}$ type: string tipo_chave_pix: description: Pix key kind. enum: - CPF - EMAIL - TELEFONE - EVP examples: - CPF type: string tipo_conta: description: Account kind; absent means CORRENTE to the destination. enum: - CORRENTE - POUPANCA - PAGAMENTO examples: - CORRENTE type: string type: object DadosCadastraisEmpregador: additionalProperties: false properties: cnae_principal: description: Main CNAE code. examples: - '4743100' pattern: ^[0-9]{7}$ type: string cnae_principal_descricao: description: Official CNAE description. examples: - Comércio varejista de vidros maxLength: 178 minLength: 1 type: string data_inicio_atividade: description: Activity start date, YYYY-MM-DD. examples: - '2013-04-01' format: date type: string endereco: $ref: '#/components/schemas/DadosCadastraisEnderecoEmpregador' natureza_juridica: description: CONCLA legal-nature code. examples: - '2062' pattern: ^[0-9]{4}$ type: string natureza_juridica_descricao: description: Official CONCLA description. examples: - Sociedade Empresária Limitada maxLength: 150 minLength: 1 type: string nome_fantasia: description: >- Trade name; when Receita has none, repeat razao_social and set nome_fantasia_ausente. examples: - Vidraçaria Souza maxLength: 150 minLength: 1 type: string nome_fantasia_ausente: description: >- True when nome_fantasia repeats razao_social because Receita has no trade name. examples: - false type: boolean opcao_mei: description: Whether the employer opted into MEI. examples: - false type: boolean porte_receita: description: Receita company-size code. enum: - '00' - '01' - '03' - '05' examples: - '01' type: string qtd_empregados_clt: description: CLT headcount. examples: - 187 format: int64 minimum: 0 type: integer razao_social: description: Legal name. examples: - VIDRACARIA SOUZA LTDA maxLength: 150 minLength: 1 type: string required: - razao_social - nome_fantasia - data_inicio_atividade - natureza_juridica - natureza_juridica_descricao type: object DadosCadastraisOriginacao: additionalProperties: false properties: autorizacao_consulta_scr: description: >- Whether the worker authorized an SCR (BACEN credit registry) inquiry. examples: - true type: boolean data_solicitacao: description: Request date, YYYY-MM-DD. examples: - '2026-09-04' format: date type: string id_contrato_interno: description: The client's internal contract identifier. examples: - WNG-2026-31892162 maxLength: 64 minLength: 1 type: string id_decisao_credito: description: Stable identifier of the credit decision that approved the contract. examples: - CAI-DEC-2026-09-04-7f3a19 maxLength: 64 minLength: 1 type: string lote_id: description: Stable batch identifier, unique per batch. examples: - CAI-2026-09-17-001 pattern: ^[A-Za-z0-9_.-]{1,64}$ type: string numero_ccb: description: CCB number; absent means equal to numero_contrato. examples: - DIDI2090 maxLength: 30 minLength: 1 type: string referencias_externas: description: Identifiers owned by third-party systems. items: $ref: '#/components/schemas/DadosCadastraisReferenciaExterna' maxItems: 10 type: - array - 'null' required: - lote_id - id_contrato_interno - id_decisao_credito type: object DadosCadastraisTrabalhador: additionalProperties: false properties: categoria_esocial: description: eSocial worker category. examples: - '101' pattern: ^[0-9]{3}$ type: string cbo: description: CBO occupation code. examples: - '354815' pattern: ^[0-9]{6}$ type: string cbo_descricao: description: Official CBO description. examples: - Agente de viagem maxLength: 150 minLength: 1 type: string data_admissao: description: Admission date, YYYY-MM-DD. examples: - '2024-06-10' format: date type: string data_nascimento: description: Birth date, YYYY-MM-DD. examples: - '1970-09-04' format: date type: string email: description: E-mail address. examples: - gustavo.albuquerque@example.com format: email maxLength: 254 type: string endereco: $ref: '#/components/schemas/DadosCadastraisEndereco' estado_civil: description: Marital status. enum: - SOLTEIRO - CASADO - DIVORCIADO - VIUVO - UNIAO_ESTAVEL - SEPARADO examples: - SOLTEIRO type: string nome_mae: description: Mother's name. examples: - Helena Neves Albuquerque maxLength: 150 minLength: 1 type: string renda_base: description: Base income, BRL decimal string with at most two places. examples: - '2201.17' pattern: ^[0-9]+(\.[0-9]{1,2})?$ type: string rg: $ref: '#/components/schemas/DadosCadastraisRG' sexo: description: Sex. enum: - M - F examples: - M type: string telefone_celular: description: Mobile phone with area code, digits only. examples: - '21998765432' pattern: ^[0-9]{10,11}$ type: string vinculo_ativo: description: Whether the employment relationship is active. examples: - true type: boolean required: - data_nascimento - nome_mae - sexo - estado_civil - renda_base - cbo - vinculo_ativo - endereco type: object DadosCadastraisEnderecoEmpregador: additionalProperties: false properties: bairro: description: District. examples: - Centro maxLength: 100 minLength: 1 type: string cep: description: Postal code, eight digits, no hyphen. examples: - '20040020' pattern: ^[0-9]{8}$ type: string complemento: description: Address complement. examples: - sala 5 maxLength: 100 type: string logradouro: description: Street. examples: - Avenida Rio Branco maxLength: 150 minLength: 1 type: string municipio: description: Official municipality name. examples: - Rio de Janeiro maxLength: 100 minLength: 1 type: string municipio_ibge: description: IBGE municipality code. examples: - '3304557' pattern: ^[0-9]{7}$ type: string numero: description: Street number. examples: - '1' maxLength: 20 minLength: 1 type: string uf: description: State. examples: - RJ pattern: ^[A-Z]{2}$ type: string required: - cep - logradouro - numero - bairro - municipio_ibge - municipio - uf type: object DadosCadastraisReferenciaExterna: additionalProperties: false properties: sistema: description: Owning system. examples: - REGISTRADORA_X pattern: ^[A-Z0-9_]{1,32}$ type: string tipo: description: Identifier kind. examples: - ipoc maxLength: 64 minLength: 1 type: string valor: description: Identifier value. examples: - IPOC-000123 maxLength: 128 minLength: 1 type: string required: - sistema - tipo - valor type: object DadosCadastraisEndereco: additionalProperties: false properties: bairro: description: District. examples: - Laranjeiras maxLength: 100 minLength: 1 type: string cep: description: Postal code, eight digits, no hyphen. examples: - '22240003' pattern: ^[0-9]{8}$ type: string cidade: description: City. examples: - Rio de Janeiro maxLength: 100 minLength: 1 type: string complemento: description: Address complement. examples: - apto 41 maxLength: 100 type: string logradouro: description: Street. examples: - Rua das Laranjeiras maxLength: 150 minLength: 1 type: string numero: description: Street number; S/N is valid. examples: - '120' maxLength: 20 minLength: 1 type: string uf: description: State. examples: - RJ pattern: ^[A-Z]{2}$ type: string required: - logradouro - numero - bairro - cidade - uf - cep type: object DadosCadastraisRG: additionalProperties: false properties: data_emissao: description: Issue date, YYYY-MM-DD. examples: - '2010-03-15' format: date type: string numero: description: RG number. examples: - '12345678' maxLength: 20 minLength: 1 type: string orgao_emissor: description: Issuing body. examples: - DETRAN maxLength: 20 minLength: 1 type: string uf_emissor: description: Issuing state. examples: - RJ pattern: ^[A-Z]{2}$ type: string required: - numero - orgao_emissor - uf_emissor 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.