Fluxo de Consulta por Documento
Consulta por Dados Cadastrais
Comece a usar
Essenciais
Fluxo de Consulta por Documento
Fluxo de Consulta por Documento
Consulta por Dados Cadastrais
Esta página tem como objetivo mostrar o fluxo de Consulta por dados cadastrais.
1
Criação de Request
Para consultar dados cadastrais via CPF ou CNPJ, a requisição deve ser feita utilizando o endpoint /requests/create
da API de lawsuits.
Exemplo de Consulta por CPF:
curl --location 'https://lawsuits.prod.judit.io/requests/create' \
--header 'Content-Type: application/json' \
--header 'api-key: <API-KEY>' \
--data '{
"search": {
"search_type": "cpf",
"search_key": "999.999.999-99",
"response_type": "entity"
}
}'
Exemplo de Consulta por CNPJ:
curl --location 'https://lawsuits.prod.judit.io/requests/create' \
--header 'Content-Type: application/json' \
--header 'api-key: <API-KEY>' \
--data '{
"search": {
"search_type": "CNPJ",
"search_key": "99.999.999/9999-99",
"response_type": "entity"
}
}'
Na consulta por dados cadastrais, o search_type deve ser ‘CPF’ ou ‘CNPJ’, já o campo response_type deverá sempre ser ‘entity’.
Abaixo está um exemplo de resposta JSON para uma consulta por CPF/CNPJ, onde as informações detalhadas do portador serão retornadas conforme solicitado.
Resposta por CPF
{
"has_lawsuits": false,
"request_id": "5c618521-2ecc-4176-a573-431d2e0edeb2",
"response_data": [
{
"entity_id": "",
"entity_type": "person",
"main_document": "999.999.999-99",
"name": "JOÃO TESTE",
"addresses": [
{
"street": "RUA RAMOS DE CARVALHO",
"number": "999",
"complement": "",
"neighborhood": "CENTRO",
"city": "RIO DE JANEIRO",
"state": "RJ",
"country": "Brasil",
"zip_code": "99999999",
"ibge_code": 9999999
}
],
"aka_names": [],
"contacts": [
{
"description": "21999999999",
"contact_type": "phone"
}
],
"documents": [],
"parents": [
{
"name": "JANAINA DA SILVA",
"kinship": "mother"
}
],
"partners": [],
"associated_people": [],
"tags": {
"revenue_update_date": "2022-05-30T00:00:00.000Z"
},
"created_at": "2024-10-12T13:28:59.051Z",
"updated_at": "2024-10-12T13:28:59.051Z",
"nationality": "BRASILEIRA",
"birth_date": "1981-08-07T00:00:00.000Z",
"gender": "male",
"revenue_service_active": true
}
]
}
Resposta por CNPJ
{
"has_lawsuits": false,
"request_id": "6e5a24f7-f874-4234-8acc-419142e2b066",
"response_data": [
{
"entity_id": "",
"entity_type": "company",
"main_document": "99.999.999/0009-99",
"name": "FINGI - EM RECUPERACAO JUDICIAL",
"social_name": "FING",
"addresses": [
{
"street": "RUA DO JOÃO CIRILO",
"number": "99",
"complement": "ANDAR 9",
"neighborhood": "CENTRO",
"city": "RIO DE JANEIRO",
"state": "RJ",
"country": "BRASIL",
"zip_code": "99999999",
"ibge_code": 999999
}
],
"aka_names": [],
"contacts": [
{
"description": "999999999",
"contact_type": "phone"
},
{
"description": "999999999",
"contact_type": "phone"
},
{
"description": "ouvidoria@fing.com.br",
"contact_type": "email"
}
],
"documents": [],
"parents": [],
"partners": [
{
"entity_id": "",
"entity_type": "company",
"main_document": "***999999**",
"name": "JOÃO DE OLIVEIRA SOUZA",
"position": "CONSELHEIRO DE ADMINISTRAÇÃO",
"addresses": [],
"aka_names": [],
"contacts": [],
"documents": [],
"parents": [],
"partners": [],
"branch_activities": [],
"associated_people": [],
"tags": {
"age_group": "Entre 61 a 70 anos",
"start_date": "2018-09-25T00:00:00.000Z"
},
"created_at": "2024-10-12T13:32:25.135Z",
"updated_at": "2024-10-12T13:32:25.135Z"
}
],
"branch_activities": [
{
"code": "9999999",
"name": "SERVIÇOS DE ATENDIMENTO AO CLIENTE - SAC",
"active": true,
"main_activity": true,
"tree_history": ""
},
{
"code": "9999999",
"name": "CONSTRUÇÃO DE ESTAÇÕES E REDES",
"active": true,
"main_activity": false,
"tree_history": ""
}
],
"associated_people": [],
"tags": {
"revenue_update_date": "2005-11-03T00:00:00.000Z"
},
"created_at": "2024-10-12T13:32:25.134Z",
"updated_at": "2024-10-12T13:32:25.134Z",
"nationality": "BRASILEIRA",
"birth_date": "1966-09-26T00:00:00.000Z",
"size": "DEMAIS",
"legal_nature": {
"code": "2046",
"name": "SOCIEDADE ANÔNIMA ABERTA",
"active": true
},
"head_office": true,
"revenue_service_active": true,
"special_status": "RECUPERACAO JUDICIAL",
"special_status_date": "2016-06-29T00:00:00.000Z",
"share_capital": 99999999999
}
]
}
O significado de cada campo pode ser encontrado no glossário: