{ "openapi": "3.0.3", "info": { "title": "Consult API v3 - Localizador e Processos", "version": "3.0.0", "description": "Localizacao e enriquecimento cadastral (Assertiva e Credlink) e processos judiciais (Netrin).\n\nContrato unico de consulta.\n\nToda resposta de sucesso tem a mesma forma: `consulta` com os metadados, `dados` com os blocos canonicos e `avisos` com o que merece atencao sem ser erro. Colecao e sempre `{total, itens: []}`, data e sempre ISO-8601, valor monetario e sempre numero decimal em reais e ausencia e sempre `null`.\n\nA v1 continua no ar e congelada: nenhum produto novo entra la e o formato das respostas dela nao muda mais.\n\n## Ambiente de homologacao\n\nDa para testar a integracao inteira antes de ter contrato. Mande o header `APITOKEN: sandbox_e3e8f1d2-39fe-407b-b85a-93651c476539` e toda consulta da v3 responde com dado estatico, no mesmo envelope da resposta paga: sem chamar fornecedor, sem conferir liberacao de produto e sem cobrar nada.\n\nA resposta depende do documento consultado:\n\n| documento | tipo | cenario | o que volta |\n|---|---|---|---|\n| `11222333000181` | CNPJ | completo | resposta cheia, com todos os blocos do produto |\n| `11444777000161` | CNPJ | limpo | documento existe e nada consta |\n| `50250250000158` | CNPJ | indisponivel | devolve 502 fornecedor_indisponivel |\n| `11144477735` | CPF | completo | resposta cheia, com todos os blocos do produto |\n| `52998224725` | CPF | limpo | documento existe e nada consta |\n| `50250250284` | CPF | indisponivel | devolve 502 fornecedor_indisponivel |\n\nQualquer outro documento **valido** responde 200 com `dados` vazio e o aviso `consulta_sem_retorno` - por exemplo `12345678000195` ou `12345678909`. Documento invalido continua devolvendo 400 `documento_invalido`, para a sua validacao ser exercitada de verdade.\n\nOs produtos que nao consultam documento (localizador por nome, telefone, e-mail e endereco) tem valores proprios; veja `_docs/v3/homologacao.md`.\n\nO token e publico e tem teto de 120 requisicoes por minuto por IP; passando disso a resposta e 429 `limite_sandbox_excedido`." }, "servers": [ { "url": "https://api.consultcenter.com.br" } ], "tags": [ { "name": "catalogo", "description": "Catalogo de produtos e features liberadas para o cliente autenticado." }, { "name": "localizador", "description": "Busca e enriquecimento cadastral: CPF, CNPJ, nome, telefone, e-mail, endereco e pessoas de referencia." }, { "name": "processos", "description": "Processos judiciais por documento." } ], "security": [ { "ApiToken": [] } ], "components": { "securitySchemes": { "ApiToken": { "type": "apiKey", "in": "header", "name": "APITOKEN" } }, "schemas": { "Consulta": { "type": "object", "required": [ "produto", "produto_id", "documento", "tipo_pessoa", "consultado_em" ], "properties": { "produto": { "type": "string" }, "produto_id": { "type": "integer" }, "documento": { "type": "string", "description": "so digitos, sem mascara" }, "tipo_pessoa": { "type": "string", "nullable": true, "enum": [ "fisica", "juridica", null ] }, "consultado_em": { "type": "string", "format": "date-time" } } }, "Aviso": { "type": "object", "required": [ "codigo", "mensagem" ], "properties": { "codigo": { "type": "string", "enum": [ "consulta_sem_retorno", "resultado_truncado", "campo_sem_revisao", "campo_sem_mapeamento", "modelo_nao_mapeado" ] }, "mensagem": { "type": "string" }, "detalhes": { "type": "object", "additionalProperties": true } } }, "Feature": { "type": "object", "required": [ "codigo", "nome", "liberada", "preco" ], "properties": { "codigo": { "type": "string", "description": "nome do parametro na query string da consulta" }, "nome": { "type": "string", "nullable": true, "description": "nome de cadastro; null quando a feature nao tem cobranca propria" }, "liberada": { "type": "boolean", "description": "se o cliente autenticado pode usar" }, "preco": { "type": "number", "format": "double", "nullable": true, "description": "preco do plano ativo, em reais; null quando nao ha cobranca" } } }, "Erro": { "type": "object", "required": [ "erro" ], "properties": { "erro": { "type": "object", "required": [ "codigo", "mensagem" ], "properties": { "codigo": { "type": "string", "enum": [ "documento_invalido", "parametro_ausente", "parametro_invalido", "nao_autenticado", "produto_sem_acesso", "limite_mensal_excedido", "limite_sandbox_excedido", "fornecedor_indisponivel", "fornecedor_sem_resposta", "credenciais_ausentes", "credenciais_invalidas", "usuario_bloqueado", "cliente_sem_token", "configuracao_ausente" ] }, "mensagem": { "type": "string" }, "detalhes": { "type": "object", "additionalProperties": true } } } } }, "Dados_localizador_pf": { "type": "object", "description": "Blocos canonicos montados pelo adaptador de AssertivaAdapter.", "additionalProperties": true }, "Dados_localizador_pj": { "type": "object", "description": "Blocos canonicos montados pelo adaptador de AssertivaAdapter.", "additionalProperties": true }, "Dados_localizador_endereco": { "type": "object", "description": "Blocos canonicos montados pelo adaptador de CredlinkEnderecoAdapter.", "additionalProperties": true }, "Dados_localizador_nome": { "type": "object", "description": "Blocos canonicos montados pelo adaptador de AssertivaBuscaAdapter.", "additionalProperties": true }, "Dados_localizador_telefone": { "type": "object", "description": "Blocos canonicos montados pelo adaptador de AssertivaBuscaAdapter.", "additionalProperties": true }, "Dados_localizador_email": { "type": "object", "description": "Blocos canonicos montados pelo adaptador de AssertivaBuscaAdapter.", "additionalProperties": true }, "Dados_localizador_pessoas_relacionadas": { "type": "object", "description": "Blocos canonicos montados pelo adaptador de AssertivaReferenciasAdapter.", "additionalProperties": true }, "Dados_processos_pf": { "type": "object", "description": "Blocos canonicos montados pelo adaptador de NetrinAdapter.", "additionalProperties": true }, "Dados_processos_pj": { "type": "object", "description": "Blocos canonicos montados pelo adaptador de NetrinAdapter.", "additionalProperties": true } } }, "paths": { "/v3/consultas": { "get": { "summary": "Lista as consultas disponiveis", "description": "So aparecem os produtos liberados para o cliente autenticado (`acessos`). Com `app=1`, apenas os habilitados no app interno (`product.appAccess`); sem o parametro, tudo que o cliente tem acesso.", "operationId": "catalogo", "tags": [ "catalogo" ], "parameters": [ { "name": "app", "in": "query", "required": false, "description": "1 = so os produtos habilitados no app interno; 0 ou ausente = todos", "schema": { "type": "string", "enum": [ "0", "1" ] } } ], "responses": { "200": { "description": "Catalogo de produtos, parametros e features" } } } }, "/v3/consultas/localizador/pf": { "get": { "summary": "Consulta localizador pf", "operationId": "consultar_localizador_pf", "tags": [ "localizador" ], "parameters": [ { "name": "cpf", "in": "query", "required": true, "description": "com ou sem mascara", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Consulta realizada. Se o documento nao tem informacao na base, `dados` vem vazio, `avisos` traz consulta_sem_retorno e a consulta nao e cobrada.", "content": { "application/json": { "schema": { "type": "object", "required": [ "consulta", "dados", "avisos" ], "properties": { "consulta": { "$ref": "#/components/schemas/Consulta" }, "dados": { "$ref": "#/components/schemas/Dados_localizador_pf" }, "avisos": { "type": "array", "items": { "$ref": "#/components/schemas/Aviso" } } } }, "example": { "consulta": { "produto": "localizador_pf", "produto_id": 4173, "documento": "11144477735", "tipo_pessoa": "fisica", "consultado_em": "2026-01-15T10:30:00-03:00" }, "dados": { "identificacao": { "documento": "11080673016", "nome": "ELISA MOURA CAMPOS", "nome_mae": "JOANA SOUZA EXEMPLO", "situacao_cadastral": "REGULAR", "sexo": "Feminino", "data_nascimento": "1988-03-15", "data_situacao_cadastral": "2024-09-02", "idade": 38, "obito_provavel": false, "pessoa_exposta_politicamente": false }, "telefones": { "total": 3, "itens": [ { "numero": "1147524510", "tipo": "fixo", "origem": "consulta", "operadora": "Outras", "relacao": "Direto", "nao_perturbe": false }, { "numero": "11908331155", "tipo": "movel", "origem": "consulta", "operadora": "Tim", "relacao": "Direto", "ultimo_contato": "DISTRIBUIDORA TESTE EPP", "nao_perturbe": false, "tem_whatsapp": true }, { "numero": "11962316434", "tipo": "movel", "origem": "consulta", "operadora": "Claro", "relacao": "Direto", "ultimo_contato": "COMERCIO EXEMPLO LTDA", "nao_perturbe": false, "tem_whatsapp": true } ] }, "enderecos": { "total": 2, "itens": [ { "tipo": "residencial", "origem": "consulta", "cep": "80255540", "tipo_logradouro": "RUA", "logradouro": "RUA DAS FLORES", "numero": "15", "bairro": "CENTRO", "cidade": "SAO PAULO", "uf": "SP", "precisao_cep": "CONFIRMADA", "latitude": "0.0", "longitude": "0.0" }, { "tipo": "comercial", "origem": "credlink", "cep": "09053570", "logradouro": "AVENIDA BRASIL", "numero": "2073", "complemento": "CONJUNTO 402", "bairro": "JARDIM AMERICA", "cidade": "SAO PAULO", "uf": "SP" } ] }, "emails": { "total": 0, "itens": [] }, "participacoes": { "total": 0, "itens": [] }, "registros_profissionais": { "total": 1, "itens": [ { "numero_inscricao": "06600925060", "sigla": "CRA", "profissao": "ADMINISTRADOR", "situacao": "ATIVO", "uf": "MG" } ] }, "consultas_anteriores": { "total": 0, "total_consultas": 0, "itens": [] }, "pessoas_relacionadas": { "total": 1, "itens": [ { "documento": "92533947067", "nome": "JOANA SOUZA EXEMPLO", "grau_parentesco": "MAE", "data_nascimento": "1961-06-18" } ] } }, "avisos": [] } } } }, "400": { "description": "documento_invalido, parametro_ausente, parametro_invalido, credenciais_ausentes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "401": { "description": "nao_autenticado, credenciais_invalidas", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "403": { "description": "produto_sem_acesso, usuario_bloqueado, cliente_sem_token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "429": { "description": "limite_mensal_excedido, limite_sandbox_excedido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "502": { "description": "fornecedor_indisponivel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "504": { "description": "fornecedor_sem_resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "503": { "description": "configuracao_ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } } } } }, "/v3/consultas/localizador/pj": { "get": { "summary": "Consulta localizador pj", "operationId": "consultar_localizador_pj", "tags": [ "localizador" ], "parameters": [ { "name": "cnpj", "in": "query", "required": true, "description": "com ou sem mascara", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Consulta realizada. Se o documento nao tem informacao na base, `dados` vem vazio, `avisos` traz consulta_sem_retorno e a consulta nao e cobrada.", "content": { "application/json": { "schema": { "type": "object", "required": [ "consulta", "dados", "avisos" ], "properties": { "consulta": { "$ref": "#/components/schemas/Consulta" }, "dados": { "$ref": "#/components/schemas/Dados_localizador_pj" }, "avisos": { "type": "array", "items": { "$ref": "#/components/schemas/Aviso" } } } }, "example": { "consulta": { "produto": "localizador_pj", "produto_id": 4174, "documento": "11222333000181", "tipo_pessoa": "juridica", "consultado_em": "2026-01-15T10:30:00-03:00" }, "dados": { "identificacao": { "documento": "36203203912474", "razao_social": "MARIA SOUZA COMERCIO LTDA", "situacao_cadastral": "ATIVA", "natureza_juridica": "SOCIEDADE EMPRESARIA LIMITADA", "porte": "MICROEMPRESA", "cnae": "5611205", "cnae_descricao": "RESTAURANTES E SIMILARES", "cnae_grupo": "ALIMENTACAO", "cnae_subgrupo": "RESTAURANTES", "data_fundacao": "2026-01-15", "data_situacao_cadastral": "2026-01-15", "idade_anos": 7, "quantidade_funcionarios": 1 }, "telefones": { "total": 2, "itens": [ { "numero": "11935287396", "tipo": "movel", "origem": "consulta", "operadora": "Tim", "relacao": "Direto", "ultimo_contato": "COMERCIO EXEMPLO LTDA", "nao_perturbe": false, "tem_whatsapp": true }, { "numero": "11944602281", "tipo": "movel", "origem": "consulta", "operadora": "Tim", "relacao": "Direto", "ultimo_contato": "COMERCIO EXEMPLO LTDA", "nao_perturbe": false, "tem_whatsapp": true } ] }, "enderecos": { "total": 2, "itens": [ { "tipo": "residencial", "origem": "consulta", "cep": "78610765", "tipo_logradouro": "RUA", "logradouro": "RUA DAS FLORES", "numero": "0", "bairro": "CENTRO", "cidade": "SAO PAULO", "uf": "PB", "precisao_cep": "CONFIRMADA" }, { "tipo": "residencial", "origem": "consulta", "cep": "78610765", "tipo_logradouro": "AVENIDA", "logradouro": "AVENIDA BRASIL", "numero": "0", "complemento": "SALA 12", "bairro": "VILA NOVA", "cidade": "CAMPINAS", "uf": "PB", "precisao_cep": "APROXIMADA" } ] }, "emails": { "total": 1, "itens": [ { "endereco": "contato845@exemplo.com.br", "origem": "consulta" } ] }, "participacoes": { "total": 0, "itens": [] }, "registros_profissionais": { "total": 0, "itens": [] }, "consultas_anteriores": { "total": 0, "total_consultas": 0, "itens": [] }, "pessoas_relacionadas": { "total": 0, "itens": [] }, "cnaes_secundarios": { "total": 14, "itens": [ { "cnae": "5841769", "descricao": "RESTAURANTES E SIMILARES", "grupo": "ALIMENTACAO" }, { "cnae": "4635294", "descricao": "COMERCIO VAREJISTA DE MERCADORIAS EM GERAL", "grupo": "COMERCIO VAREJISTA" }, { "cnae": "7303351", "descricao": "PREPARACAO DE DOCUMENTOS E SERVICOS DE APOIO ADMINISTRATIVO", "grupo": "SERVICOS ADMINISTRATIVOS" }, { "cnae": "6272243", "descricao": "FABRICACAO DE PRODUTOS DE PADARIA E CONFEITARIA", "grupo": "INDUSTRIA DE TRANSFORMACAO" }, { "cnae": "8146330", "descricao": "TRANSPORTE RODOVIARIO DE CARGA", "grupo": "TRANSPORTE E ARMAZENAGEM" }, { "cnae": "2076272", "descricao": "ATIVIDADES DE CONSULTORIA EM GESTAO EMPRESARIAL", "grupo": "ALIMENTACAO" }, { "cnae": "1271861", "descricao": "RESTAURANTES E SIMILARES", "grupo": "COMERCIO VAREJISTA" }, { "cnae": "5135354", "descricao": "COMERCIO VAREJISTA DE MERCADORIAS EM GERAL", "grupo": "SERVICOS ADMINISTRATIVOS" }, { "cnae": "8492001", "descricao": "PREPARACAO DE DOCUMENTOS E SERVICOS DE APOIO ADMINISTRATIVO", "grupo": "INDUSTRIA DE TRANSFORMACAO" }, { "cnae": "1124098", "descricao": "FABRICACAO DE PRODUTOS DE PADARIA E CONFEITARIA", "grupo": "TRANSPORTE E ARMAZENAGEM" }, { "cnae": "4243233", "descricao": "TRANSPORTE RODOVIARIO DE CARGA", "grupo": "ALIMENTACAO" }, { "cnae": "0258246", "descricao": "ATIVIDADES DE CONSULTORIA EM GESTAO EMPRESARIAL", "grupo": "COMERCIO VAREJISTA" }, { "cnae": "3152430", "descricao": "RESTAURANTES E SIMILARES", "grupo": "SERVICOS ADMINISTRATIVOS" }, { "cnae": "3386435", "descricao": "COMERCIO VAREJISTA DE MERCADORIAS EM GERAL", "grupo": "INDUSTRIA DE TRANSFORMACAO" } ] } }, "avisos": [] } } } }, "400": { "description": "documento_invalido, parametro_ausente, parametro_invalido, credenciais_ausentes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "401": { "description": "nao_autenticado, credenciais_invalidas", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "403": { "description": "produto_sem_acesso, usuario_bloqueado, cliente_sem_token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "429": { "description": "limite_mensal_excedido, limite_sandbox_excedido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "502": { "description": "fornecedor_indisponivel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "504": { "description": "fornecedor_sem_resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "503": { "description": "configuracao_ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } } } } }, "/v3/consultas/localizador/endereco": { "get": { "summary": "Consulta localizador endereco", "operationId": "consultar_localizador_endereco", "tags": [ "localizador" ], "parameters": [ { "name": "endereco", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "uf", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "cep", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "numero_inicial", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "numero_final", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "complemento", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "bairro", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cidade", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Consulta realizada. Se o documento nao tem informacao na base, `dados` vem vazio, `avisos` traz consulta_sem_retorno e a consulta nao e cobrada.", "content": { "application/json": { "schema": { "type": "object", "required": [ "consulta", "dados", "avisos" ], "properties": { "consulta": { "$ref": "#/components/schemas/Consulta" }, "dados": { "$ref": "#/components/schemas/Dados_localizador_endereco" }, "avisos": { "type": "array", "items": { "$ref": "#/components/schemas/Aviso" } } } }, "example": { "consulta": { "produto": "localizador_endereco", "produto_id": 4229, "documento": "", "tipo_pessoa": null, "consultado_em": "2026-01-15T10:30:00-03:00" }, "dados": { "moradores": { "total": 4, "itens": [ { "documento": "92533947067", "nome": "FABIO NUNES TEIXEIRA", "data_nascimento": "1988-03-15", "numero": "1015", "cidade": "SAO PAULO", "uf": "SP" }, { "documento": "54106480212", "nome": "ANA PEREIRA LIMA", "data_nascimento": "1992-05-27", "numero": "1051", "cidade": "SAO PAULO", "uf": "SP" }, { "documento": "80970493339", "nome": "DIEGO ALVES PINTO", "data_nascimento": "1979-12-09", "numero": "1087", "cidade": "SAO PAULO", "uf": "SP" }, { "documento": "01232191590", "nome": "FABIO NUNES TEIXEIRA", "data_nascimento": "1975-11-30", "numero": "1000", "cidade": "SAO PAULO", "uf": "SP" } ] } }, "avisos": [] } } } }, "400": { "description": "documento_invalido, parametro_ausente, parametro_invalido, credenciais_ausentes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "401": { "description": "nao_autenticado, credenciais_invalidas", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "403": { "description": "produto_sem_acesso, usuario_bloqueado, cliente_sem_token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "429": { "description": "limite_mensal_excedido, limite_sandbox_excedido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "502": { "description": "fornecedor_indisponivel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "504": { "description": "fornecedor_sem_resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "503": { "description": "configuracao_ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } } } } }, "/v3/consultas/localizador/nome": { "get": { "summary": "Consulta localizador nome", "operationId": "consultar_localizador_nome", "tags": [ "localizador" ], "parameters": [ { "name": "nome", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "uf", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cidade", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "bairro", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cep_ou_rua", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "numero_inicial", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "numero_final", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "complemento", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sexo", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "data_nascimento", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exata", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Consulta realizada. Se o documento nao tem informacao na base, `dados` vem vazio, `avisos` traz consulta_sem_retorno e a consulta nao e cobrada.", "content": { "application/json": { "schema": { "type": "object", "required": [ "consulta", "dados", "avisos" ], "properties": { "consulta": { "$ref": "#/components/schemas/Consulta" }, "dados": { "$ref": "#/components/schemas/Dados_localizador_nome" }, "avisos": { "type": "array", "items": { "$ref": "#/components/schemas/Aviso" } } } }, "example": { "consulta": { "produto": "localizador_nome", "produto_id": 4175, "documento": "", "tipo_pessoa": null, "consultado_em": "2026-01-15T10:30:00-03:00" }, "dados": { "candidatos": { "total": 4, "itens": [ { "documento": "52998224725", "tipo_pessoa": "fisica", "nome": "MARIA SOUZA EXEMPLO", "data_nascimento": "1988-03-15", "nome_mae": "JOANA SOUZA EXEMPLO", "telefone": "1133334444", "logradouro": "RUA DAS FLORES", "numero": "1015", "complemento": "APTO 32", "bairro": "CENTRO", "cidade": "SAO PAULO", "uf": "SP", "cep": "04436040", "origem": "assertiva" }, { "documento": "47004532577", "tipo_pessoa": "fisica", "nome": "MARIA SOUZA EXEMPLO FILHO", "data_nascimento": "2001-07-22", "numero": "88", "cidade": "CAMPINAS", "uf": "SP", "origem": "assertiva" }, { "documento": "11222333000181", "tipo_pessoa": "juridica", "nome": "MARIA SOUZA COMERCIO LTDA", "data_nascimento": "2010-09-02", "socio": "MARIA SOUZA EXEMPLO", "cidade": "SAO PAULO", "uf": "SP", "origem": "assertiva" }, { "documento": "92533947067", "tipo_pessoa": "fisica", "nome": "MARIA SOUZA DA COSTA", "data_nascimento": "1975-11-30", "telefone": "1332221100", "logradouro": "TRAVESSA DOIS", "numero": "45", "bairro": "VILA NOVA", "cidade": "SANTOS", "uf": "SP", "cep": "11015200", "origem": "credlink" } ] } }, "avisos": [] } } } }, "400": { "description": "documento_invalido, parametro_ausente, parametro_invalido, credenciais_ausentes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "401": { "description": "nao_autenticado, credenciais_invalidas", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "403": { "description": "produto_sem_acesso, usuario_bloqueado, cliente_sem_token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "429": { "description": "limite_mensal_excedido, limite_sandbox_excedido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "502": { "description": "fornecedor_indisponivel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "504": { "description": "fornecedor_sem_resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "503": { "description": "configuracao_ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } } } } }, "/v3/consultas/localizador/telefone": { "get": { "summary": "Consulta localizador telefone", "operationId": "consultar_localizador_telefone", "tags": [ "localizador" ], "parameters": [ { "name": "telefone", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Consulta realizada. Se o documento nao tem informacao na base, `dados` vem vazio, `avisos` traz consulta_sem_retorno e a consulta nao e cobrada.", "content": { "application/json": { "schema": { "type": "object", "required": [ "consulta", "dados", "avisos" ], "properties": { "consulta": { "$ref": "#/components/schemas/Consulta" }, "dados": { "$ref": "#/components/schemas/Dados_localizador_telefone" }, "avisos": { "type": "array", "items": { "$ref": "#/components/schemas/Aviso" } } } }, "example": { "consulta": { "produto": "localizador_telefone", "produto_id": 4177, "documento": "", "tipo_pessoa": null, "consultado_em": "2026-01-15T10:30:00-03:00" }, "dados": { "candidatos": { "total": 1, "itens": [ { "documento": "11144477735", "tipo_pessoa": "fisica", "nome": "CARLOS EXEMPLO ROCHA", "data_nascimento": "1979-12-09", "nome_mae": "TEREZA EXEMPLO ROCHA", "telefone": "3133332222", "logradouro": "RUA DA PAZ", "numero": "700", "complemento": "SALA 4", "bairro": "SAVASSI", "cidade": "BELO HORIZONTE", "uf": "MG", "cep": "30140071", "origem": "assertiva" } ] } }, "avisos": [] } } } }, "400": { "description": "documento_invalido, parametro_ausente, parametro_invalido, credenciais_ausentes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "401": { "description": "nao_autenticado, credenciais_invalidas", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "403": { "description": "produto_sem_acesso, usuario_bloqueado, cliente_sem_token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "429": { "description": "limite_mensal_excedido, limite_sandbox_excedido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "502": { "description": "fornecedor_indisponivel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "504": { "description": "fornecedor_sem_resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "503": { "description": "configuracao_ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } } } } }, "/v3/consultas/localizador/email": { "get": { "summary": "Consulta localizador email", "operationId": "consultar_localizador_email", "tags": [ "localizador" ], "parameters": [ { "name": "email", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Consulta realizada. Se o documento nao tem informacao na base, `dados` vem vazio, `avisos` traz consulta_sem_retorno e a consulta nao e cobrada.", "content": { "application/json": { "schema": { "type": "object", "required": [ "consulta", "dados", "avisos" ], "properties": { "consulta": { "$ref": "#/components/schemas/Consulta" }, "dados": { "$ref": "#/components/schemas/Dados_localizador_email" }, "avisos": { "type": "array", "items": { "$ref": "#/components/schemas/Aviso" } } } }, "example": { "consulta": { "produto": "localizador_email", "produto_id": 4176, "documento": "", "tipo_pessoa": null, "consultado_em": "2026-01-15T10:30:00-03:00" }, "dados": { "candidatos": { "total": 2, "itens": [ { "documento": "54106480212", "tipo_pessoa": "fisica", "nome": "ANA PEREIRA LIMA", "data_nascimento": "1992-05-27", "cidade": "CURITIBA", "uf": "PR", "origem": "assertiva" }, { "documento": "05795928000123", "tipo_pessoa": "juridica", "nome": "COMERCIO EXEMPLO LTDA", "data_nascimento": "2005-02-14", "socio": "ANA PEREIRA LIMA", "cidade": "CURITIBA", "uf": "PR", "origem": "assertiva" } ] } }, "avisos": [] } } } }, "400": { "description": "documento_invalido, parametro_ausente, parametro_invalido, credenciais_ausentes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "401": { "description": "nao_autenticado, credenciais_invalidas", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "403": { "description": "produto_sem_acesso, usuario_bloqueado, cliente_sem_token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "429": { "description": "limite_mensal_excedido, limite_sandbox_excedido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "502": { "description": "fornecedor_indisponivel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "504": { "description": "fornecedor_sem_resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "503": { "description": "configuracao_ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } } } } }, "/v3/consultas/localizador/pessoas-relacionadas": { "get": { "summary": "Consulta localizador pessoas relacionadas", "operationId": "consultar_localizador_pessoas_relacionadas", "tags": [ "localizador" ], "parameters": [ { "name": "cpf", "in": "query", "required": true, "description": "com ou sem mascara", "schema": { "type": "string" } }, { "name": "protocolo", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Consulta realizada. Se o documento nao tem informacao na base, `dados` vem vazio, `avisos` traz consulta_sem_retorno e a consulta nao e cobrada.", "content": { "application/json": { "schema": { "type": "object", "required": [ "consulta", "dados", "avisos" ], "properties": { "consulta": { "$ref": "#/components/schemas/Consulta" }, "dados": { "$ref": "#/components/schemas/Dados_localizador_pessoas_relacionadas" }, "avisos": { "type": "array", "items": { "$ref": "#/components/schemas/Aviso" } } } }, "example": { "consulta": { "produto": "localizador_pessoas_relacionadas", "produto_id": 4677, "documento": "11144477735", "tipo_pessoa": "fisica", "consultado_em": "2026-01-15T10:30:00-03:00" }, "dados": { "pessoas_relacionadas": { "total": 3, "itens": [ { "documento": "92533947067", "nome": "JOANA SOUZA EXEMPLO", "grau_parentesco": "MAE", "data_nascimento": "1961-06-18" }, { "documento": "47004532577", "nome": "PEDRO SOUZA EXEMPLO", "grau_parentesco": "IRMAO", "data_nascimento": "2001-07-22" }, { "documento": "11222333000181", "nome": "MARIA SOUZA COMERCIO LTDA", "grau_parentesco": "SOCIO" } ] } }, "avisos": [] } } } }, "400": { "description": "documento_invalido, parametro_ausente, parametro_invalido, credenciais_ausentes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "401": { "description": "nao_autenticado, credenciais_invalidas", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "403": { "description": "produto_sem_acesso, usuario_bloqueado, cliente_sem_token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "429": { "description": "limite_mensal_excedido, limite_sandbox_excedido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "502": { "description": "fornecedor_indisponivel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "504": { "description": "fornecedor_sem_resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "503": { "description": "configuracao_ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } } } } }, "/v3/consultas/processos/pf": { "get": { "summary": "Consulta processos pf", "operationId": "consultar_processos_pf", "tags": [ "processos" ], "parameters": [ { "name": "cpf", "in": "query", "required": true, "description": "com ou sem mascara", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Consulta realizada. Se o documento nao tem informacao na base, `dados` vem vazio, `avisos` traz consulta_sem_retorno e a consulta nao e cobrada.", "content": { "application/json": { "schema": { "type": "object", "required": [ "consulta", "dados", "avisos" ], "properties": { "consulta": { "$ref": "#/components/schemas/Consulta" }, "dados": { "$ref": "#/components/schemas/Dados_processos_pf" }, "avisos": { "type": "array", "items": { "$ref": "#/components/schemas/Aviso" } } } }, "example": { "consulta": { "produto": "processos_pf", "produto_id": 4814, "documento": "11144477735", "tipo_pessoa": "fisica", "consultado_em": "2026-01-15T10:30:00-03:00" }, "dados": { "processos": { "total": 2, "total_encontrado": 2, "itens": [ { "numero": "52053455143343060025", "classe": "ACAO TRABALHISTA - RITO ORDINARIO", "segmento": "JUSTICA DO TRABALHO", "tribunal": "TRIBUNAL REGIONAL DO TRABALHO DA 2A REGIAO", "orgao_julgador": "1A VARA DO TRABALHO DE SAO PAULO", "sistema": "PJE", "uf": "SP", "grau": 1, "data_distribuicao": "2026-01-15", "url": "https://exemplo.test/processo/85423628", "assuntos": { "total": 3, "itens": [ { "titulo": "VERBAS RESCISORIAS", "principal": true }, { "titulo": "HORAS EXTRAS", "principal": false }, { "titulo": "ADICIONAL DE INSALUBRIDADE", "principal": false } ] }, "partes": { "total": 2, "itens": [ { "nome": "CARLOS EXEMPLO ROCHA", "polo": "ATIVO", "tipo": "RECLAMANTE", "advogados": { "total": 1, "itens": [ { "nome": "ANA PEREIRA LIMA", "tipo": "ADVOGADO" } ] } }, { "nome": "COMERCIO EXEMPLO LTDA", "polo": "PASSIVO", "tipo": "RECLAMADO", "advogados": { "total": 1, "itens": [ { "nome": "BRUNO SOUZA MELO", "tipo": "ADVOGADO" } ] } } ] } }, { "numero": "03881532563201204525", "classe": "EXECUCAO DE TITULO EXTRAJUDICIAL", "segmento": "JUSTICA ESTADUAL", "tribunal": "TRIBUNAL DE JUSTICA DO ESTADO DE SAO PAULO", "orgao_julgador": "2A VARA CIVEL DE SANTOS", "sistema": "ESAJ", "uf": "SP", "grau": 1, "data_distribuicao": "2026-01-15", "url": "https://exemplo.test/processo/97483335", "assuntos": { "total": 3, "itens": [ { "titulo": "DANO MORAL", "codigo": "5000", "principal": true }, { "titulo": "MULTA DO ARTIGO 477 DA CLT", "codigo": "4993", "principal": false }, { "titulo": "VERBAS RESCISORIAS", "codigo": "9616", "principal": false } ] }, "partes": { "total": 3, "itens": [ { "nome": "CARLOS EXEMPLO ROCHA", "polo": "ATIVO", "tipo": "EXEQUENTE", "advogados": { "total": 2, "itens": [ { "nome": "CARLA DIAS ROCHA", "tipo": "ADVOGADA" }, { "nome": "DIEGO ALVES PINTO", "tipo": "ADVOGADO" } ] } }, { "nome": "COMERCIO EXEMPLO LTDA", "polo": "PASSIVO", "tipo": "EXECUTADO", "advogados": { "total": 1, "itens": [ { "nome": "ELISA MOURA CAMPOS", "tipo": "ADVOGADA" } ] } }, { "nome": "INDUSTRIA FICTICIA SA", "polo": "PASSIVO", "tipo": "EXECUTADO", "advogados": { "total": 1, "itens": [ { "nome": "FABIO NUNES TEIXEIRA", "tipo": "ADVOGADA" } ] } } ] } } ] } }, "avisos": [] } } } }, "400": { "description": "documento_invalido, parametro_ausente, parametro_invalido, credenciais_ausentes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "401": { "description": "nao_autenticado, credenciais_invalidas", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "403": { "description": "produto_sem_acesso, usuario_bloqueado, cliente_sem_token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "429": { "description": "limite_mensal_excedido, limite_sandbox_excedido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "502": { "description": "fornecedor_indisponivel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "504": { "description": "fornecedor_sem_resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "503": { "description": "configuracao_ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } } } } }, "/v3/consultas/processos/pj": { "get": { "summary": "Consulta processos pj", "operationId": "consultar_processos_pj", "tags": [ "processos" ], "parameters": [ { "name": "cnpj", "in": "query", "required": true, "description": "com ou sem mascara", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Consulta realizada. Se o documento nao tem informacao na base, `dados` vem vazio, `avisos` traz consulta_sem_retorno e a consulta nao e cobrada.", "content": { "application/json": { "schema": { "type": "object", "required": [ "consulta", "dados", "avisos" ], "properties": { "consulta": { "$ref": "#/components/schemas/Consulta" }, "dados": { "$ref": "#/components/schemas/Dados_processos_pj" }, "avisos": { "type": "array", "items": { "$ref": "#/components/schemas/Aviso" } } } }, "example": { "consulta": { "produto": "processos_pj", "produto_id": 4816, "documento": "11222333000181", "tipo_pessoa": "juridica", "consultado_em": "2026-01-15T10:30:00-03:00" }, "dados": { "processos": { "total": 2, "total_encontrado": 2, "itens": [ { "numero": "52053455143343060025", "classe": "ACAO TRABALHISTA - RITO ORDINARIO", "segmento": "JUSTICA DO TRABALHO", "tribunal": "TRIBUNAL REGIONAL DO TRABALHO DA 2A REGIAO", "orgao_julgador": "1A VARA DO TRABALHO DE SAO PAULO", "sistema": "PJE", "uf": "SP", "grau": 1, "data_distribuicao": "2026-01-15", "url": "https://exemplo.test/processo/85423628", "assuntos": { "total": 3, "itens": [ { "titulo": "VERBAS RESCISORIAS", "principal": true }, { "titulo": "HORAS EXTRAS", "principal": false }, { "titulo": "ADICIONAL DE INSALUBRIDADE", "principal": false } ] }, "partes": { "total": 2, "itens": [ { "nome": "MARIA SOUZA COMERCIO LTDA", "polo": "PASSIVO", "tipo": "RECLAMADO", "advogados": { "total": 1, "itens": [ { "nome": "ANA PEREIRA LIMA", "tipo": "ADVOGADO" } ] } }, { "nome": "COMERCIO EXEMPLO LTDA", "polo": "ATIVO", "tipo": "RECLAMANTE", "advogados": { "total": 1, "itens": [ { "nome": "BRUNO SOUZA MELO", "tipo": "ADVOGADO" } ] } } ] } }, { "numero": "03881532563201204525", "classe": "EXECUCAO DE TITULO EXTRAJUDICIAL", "segmento": "JUSTICA ESTADUAL", "tribunal": "TRIBUNAL DE JUSTICA DO ESTADO DE SAO PAULO", "orgao_julgador": "2A VARA CIVEL DE SANTOS", "sistema": "ESAJ", "uf": "SP", "grau": 1, "data_distribuicao": "2026-01-15", "url": "https://exemplo.test/processo/97483335", "assuntos": { "total": 3, "itens": [ { "titulo": "DANO MORAL", "codigo": "5000", "principal": true }, { "titulo": "MULTA DO ARTIGO 477 DA CLT", "codigo": "4993", "principal": false }, { "titulo": "VERBAS RESCISORIAS", "codigo": "9616", "principal": false } ] }, "partes": { "total": 3, "itens": [ { "nome": "MARIA SOUZA COMERCIO LTDA", "polo": "ATIVO", "tipo": "EXEQUENTE", "advogados": { "total": 2, "itens": [ { "nome": "CARLA DIAS ROCHA", "tipo": "ADVOGADA" }, { "nome": "DIEGO ALVES PINTO", "tipo": "ADVOGADO" } ] } }, { "nome": "COMERCIO EXEMPLO LTDA", "polo": "PASSIVO", "tipo": "EXECUTADO", "advogados": { "total": 1, "itens": [ { "nome": "ELISA MOURA CAMPOS", "tipo": "ADVOGADA" } ] } }, { "nome": "INDUSTRIA FICTICIA SA", "polo": "PASSIVO", "tipo": "EXECUTADO", "advogados": { "total": 1, "itens": [ { "nome": "FABIO NUNES TEIXEIRA", "tipo": "ADVOGADA" } ] } } ] } } ] } }, "avisos": [] } } } }, "400": { "description": "documento_invalido, parametro_ausente, parametro_invalido, credenciais_ausentes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "401": { "description": "nao_autenticado, credenciais_invalidas", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "403": { "description": "produto_sem_acesso, usuario_bloqueado, cliente_sem_token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "429": { "description": "limite_mensal_excedido, limite_sandbox_excedido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "502": { "description": "fornecedor_indisponivel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "504": { "description": "fornecedor_sem_resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "503": { "description": "configuracao_ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } } } } }, "/v3/features/{produto}": { "get": { "summary": "Lista as features de um produto, com liberacao e preco", "description": "Toda feature que o produto aceita na query string aparece aqui. `liberada` diz se o cliente autenticado pode usar; `preco` e o do plano ativo e vem null quando a feature nao e cobrada a parte.", "operationId": "features", "tags": [ "catalogo" ], "parameters": [ { "name": "produto", "in": "path", "required": true, "description": "mesmo slug da rota de consulta", "schema": { "type": "string", "enum": [ "localizador/pf", "localizador/pj", "localizador/endereco", "localizador/nome", "localizador/telefone", "localizador/email", "localizador/pessoas-relacionadas", "processos/pf", "processos/pj" ] } } ], "responses": { "200": { "description": "Features do produto", "content": { "application/json": { "schema": { "type": "object", "required": [ "produto", "produto_id", "total", "itens" ], "properties": { "produto": { "type": "string" }, "produto_id": { "type": "integer" }, "total": { "type": "integer" }, "itens": { "type": "array", "items": { "$ref": "#/components/schemas/Feature" } } } } } } }, "400": { "description": "documento_invalido, parametro_ausente, parametro_invalido, credenciais_ausentes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "401": { "description": "nao_autenticado, credenciais_invalidas", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "403": { "description": "produto_sem_acesso, usuario_bloqueado, cliente_sem_token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "429": { "description": "limite_mensal_excedido, limite_sandbox_excedido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "502": { "description": "fornecedor_indisponivel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "504": { "description": "fornecedor_sem_resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "503": { "description": "configuracao_ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } } } } } } }