Read the cadastro stored with a consignado averbação
curl --request GET \
--url https://br-consignado-gw.sandbox.lerian.net/v1/consignado/fundos/{fundo_id}/contracts/{numero_contrato}/dados-cadastrais \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://br-consignado-gw.sandbox.lerian.net/v1/consignado/fundos/{fundo_id}/contracts/{numero_contrato}/dados-cadastrais"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://br-consignado-gw.sandbox.lerian.net/v1/consignado/fundos/{fundo_id}/contracts/{numero_contrato}/dados-cadastrais', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://br-consignado-gw.sandbox.lerian.net/v1/consignado/fundos/{fundo_id}/contracts/{numero_contrato}/dados-cadastrais"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"nome_trabalhador": "<string>",
"dados_cadastrais": {
"originacao": {
"id_contrato_interno": "WNG-2026-31892162",
"id_decisao_credito": "CAI-DEC-2026-09-04-7f3a19",
"lote_id": "CAI-2026-09-17-001",
"autorizacao_consulta_scr": true,
"data_solicitacao": "2026-09-04",
"numero_ccb": "DIDI2090",
"referencias_externas": [
{
"sistema": "REGISTRADORA_X",
"tipo": "ipoc",
"valor": "IPOC-000123"
}
]
},
"trabalhador": {
"cbo": "354815",
"data_nascimento": "1970-09-04",
"endereco": {
"bairro": "Laranjeiras",
"cep": "22240003",
"cidade": "Rio de Janeiro",
"logradouro": "Rua das Laranjeiras",
"numero": "120",
"uf": "RJ",
"complemento": "apto 41"
},
"estado_civil": "SOLTEIRO",
"nome_mae": "Beltrana de Tal",
"renda_base": "2201.17",
"sexo": "M",
"vinculo_ativo": true,
"categoria_esocial": "101",
"cbo_descricao": "Agente de viagem",
"data_admissao": "2024-06-10",
"email": "fulano.de.tal@example.com",
"rg": {
"numero": "12345678",
"orgao_emissor": "DETRAN",
"uf_emissor": "RJ",
"data_emissao": "2010-03-15"
},
"telefone_celular": "21900000000"
},
"dados_bancarios": {
"agencia": "1234",
"banco": "341",
"chave_pix": "12345678901",
"conta": "56789",
"conta_digito": "0",
"tipo_chave_pix": "CPF",
"tipo_conta": "CORRENTE"
},
"empregador": {
"data_inicio_atividade": "2013-04-01",
"natureza_juridica": "2062",
"natureza_juridica_descricao": "Sociedade Empresária Limitada",
"nome_fantasia": "Vidraçaria Exemplo",
"razao_social": "VIDRACARIA EXEMPLO LTDA",
"cnae_principal": "4743100",
"cnae_principal_descricao": "Comércio varejista de vidros",
"endereco": {
"bairro": "Centro",
"cep": "20040020",
"logradouro": "Avenida Rio Branco",
"municipio": "Rio de Janeiro",
"municipio_ibge": "3304557",
"numero": "1",
"uf": "RJ",
"complemento": "sala 5"
},
"nome_fantasia_ausente": false,
"opcao_mei": false,
"porte_receita": "01",
"qtd_empregados_clt": 187
}
}
}{
"code": "AUT-0033",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"code": "AUT-0033",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"code": "AUT-0033",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"code": "AUT-0033",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"code": "AUT-0033",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"code": "AUT-0033",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"code": "AUT-0033",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}Read the cadastro stored with a consignado averbação
Returns the contract’s cadastro — the averbação’s nome_trabalhador, plus the dados_cadastrais block the documentation sent, else the averbação’s — as the exact bytes stored when that block arrived. Until the contract confirms, it is the client’s provisional statement. 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. The bancarizador reads every contract of its tenant. A fund or originador credential reads a contract’s signed CCB, biometrics pack and cadastro only when the fund or originador it acts for sent the averbação or one of its documentation attempts, and a fund credential also reads them once the contract is ceded to its fund. Any other contract answers the same 404 as a missing one.
Partner route: the text above describes the party’s own route. Here the register id in the path names the party: it must be in the partner credential’s scope and registered under the caller’s tenant, and the call runs as that party, exactly as the party’s own credential would.
GET
/
v1
/
consignado
/
fundos
/
{fundo_id}
/
contracts
/
{numero_contrato}
/
dados-cadastrais
Read the cadastro stored with a consignado averbação
curl --request GET \
--url https://br-consignado-gw.sandbox.lerian.net/v1/consignado/fundos/{fundo_id}/contracts/{numero_contrato}/dados-cadastrais \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://br-consignado-gw.sandbox.lerian.net/v1/consignado/fundos/{fundo_id}/contracts/{numero_contrato}/dados-cadastrais"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://br-consignado-gw.sandbox.lerian.net/v1/consignado/fundos/{fundo_id}/contracts/{numero_contrato}/dados-cadastrais', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://br-consignado-gw.sandbox.lerian.net/v1/consignado/fundos/{fundo_id}/contracts/{numero_contrato}/dados-cadastrais"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"nome_trabalhador": "<string>",
"dados_cadastrais": {
"originacao": {
"id_contrato_interno": "WNG-2026-31892162",
"id_decisao_credito": "CAI-DEC-2026-09-04-7f3a19",
"lote_id": "CAI-2026-09-17-001",
"autorizacao_consulta_scr": true,
"data_solicitacao": "2026-09-04",
"numero_ccb": "DIDI2090",
"referencias_externas": [
{
"sistema": "REGISTRADORA_X",
"tipo": "ipoc",
"valor": "IPOC-000123"
}
]
},
"trabalhador": {
"cbo": "354815",
"data_nascimento": "1970-09-04",
"endereco": {
"bairro": "Laranjeiras",
"cep": "22240003",
"cidade": "Rio de Janeiro",
"logradouro": "Rua das Laranjeiras",
"numero": "120",
"uf": "RJ",
"complemento": "apto 41"
},
"estado_civil": "SOLTEIRO",
"nome_mae": "Beltrana de Tal",
"renda_base": "2201.17",
"sexo": "M",
"vinculo_ativo": true,
"categoria_esocial": "101",
"cbo_descricao": "Agente de viagem",
"data_admissao": "2024-06-10",
"email": "fulano.de.tal@example.com",
"rg": {
"numero": "12345678",
"orgao_emissor": "DETRAN",
"uf_emissor": "RJ",
"data_emissao": "2010-03-15"
},
"telefone_celular": "21900000000"
},
"dados_bancarios": {
"agencia": "1234",
"banco": "341",
"chave_pix": "12345678901",
"conta": "56789",
"conta_digito": "0",
"tipo_chave_pix": "CPF",
"tipo_conta": "CORRENTE"
},
"empregador": {
"data_inicio_atividade": "2013-04-01",
"natureza_juridica": "2062",
"natureza_juridica_descricao": "Sociedade Empresária Limitada",
"nome_fantasia": "Vidraçaria Exemplo",
"razao_social": "VIDRACARIA EXEMPLO LTDA",
"cnae_principal": "4743100",
"cnae_principal_descricao": "Comércio varejista de vidros",
"endereco": {
"bairro": "Centro",
"cep": "20040020",
"logradouro": "Avenida Rio Branco",
"municipio": "Rio de Janeiro",
"municipio_ibge": "3304557",
"numero": "1",
"uf": "RJ",
"complemento": "sala 5"
},
"nome_fantasia_ausente": false,
"opcao_mei": false,
"porte_receita": "01",
"qtd_empregados_clt": 187
}
}
}{
"code": "AUT-0033",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"code": "AUT-0033",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"code": "AUT-0033",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"code": "AUT-0033",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"code": "AUT-0033",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"code": "AUT-0033",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"code": "AUT-0033",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}Authorizations
JWT bearer token issued by the identity provider.
Path Parameters
The fund's register id, as returned in the id field of GET /v1/consignado/fundos. It must be in the partner credential's scope.
Example:
"3f2504e0-4f89-41d3-9a0c-0305e82c3301"
Client contract identity within the authenticated tenant.
Minimum string length:
1Example:
"99999999999AN1"
Was this page helpful?