O que é#
Na consulta Junta Comercial do Estado de São Paulo - Busca por Sócio você obtém a lista de empresas registradas na JUCESP em que uma pessoa ou empresa consta como titular, sócio ou membro da diretoria, pesquisando por nome ou por CPF/CNPJ.
Esta consulta só está disponível via API.
Sobre a requisição#
Método: POST
Endereço: https://api.plexi.com.br/api/maestro/jucesp/busca-socio
Parâmetros do header#
| Nome | Tipo | Obrigatório? | Descrição |
|---|---|---|---|
| Authorization | String | Sim | Chave de API gerada no cadastro no Plexi, prefixada com Bearer |
| Callback | String | Não | URL para onde o resultado da requisição será enviado via HTTP POST. |
Parâmetros do body#
| Nome | Tipo | Obrigatório? | Descrição |
|---|---|---|---|
| certificate | string | Sim | Identificador (UUID) do certificado digital a ser utilizado para autenticação Gov.br. |
| nome | string | Apenas se não for passado valor em cpfCnpj |
Nome da pessoa ou empresa que consta como titular, sócio ou diretor. Máximo de 255 caracteres. |
| cpfCnpj | string | Apenas se não for passado valor em nome |
CPF ou CNPJ da pessoa ou empresa que consta como titular, sócio ou diretor. Deve ser um CPF ou CNPJ válido (com ou sem máscara). |
| somenteAtivas | boolean | Não | Quando true, retorna somente empresas ativas. Padrão: false. |
Estrutura da resposta#
| Status | Significado | Descrição | Informações retornadas |
|---|---|---|---|
| 201 | Created | Solicitação criada | Campo requestId, com o ID da requisição criada. |
| 422 | Unprocessable Entity | A solicitação contém erro | Em quais campos houve erro. |
Exemplos de retornos quando você faz a requisição#
Status 201
A consulta recebida com sucesso e será processada. Com o ID retornado você pode consultar se já houve resposta.
JSON
{
"requestId": "1fdd4247-4f98-4113-887a-b182117b0e42"
}Status 422
Significa que ocorreu um erro de validação dos dados enviados.
JSON
{
"message": "The given data was invalid.",
"errors": {
"cpf": [
"O campo cpf é obrigatório."
],
"nome": [
"O campo nome é obrigatório."
]
}
}Exemplos de retornos do resultado da pesquisa#
Valores possíveis do campo "status"
| Status | Significado |
|---|---|
| positivo | Foram encontradas empresas em que a pessoa ou empresa pesquisada consta como titular, sócio ou diretor. |
| negativo | Nenhuma empresa foi encontrada para a pesquisa. O campo mensagem traz a mensagem exibida pela JUCESP. |
| erro | Não foi possível realizar a consulta com o certificado informado (certificado inválido, incompleto, fora do prazo de validade ou recusado pelo gov.br). O campo mensagem informa o motivo. |
Campos do resultado
| Campo | Tipo | Descrição |
|---|---|---|
| status | string | positivo, negativo ou erro. |
| mensagem | string ou null | Mensagem exibida pela JUCESP quando nenhuma empresa é encontrada, ou o motivo do erro. null quando há empresas no resultado. |
| totalResultados | number | Total de resultados informado pela JUCESP para a pesquisa. |
| resultadosExibidos | number | Quantidade de empresas retornadas em empresas. Apenas a primeira página de resultados da JUCESP é retornada, portanto este valor pode ser menor que totalResultados. |
| empresas | array ou null | Empresas encontradas. null quando nenhuma empresa é encontrada. |
| empresas[].nire | string | NIRE da empresa. |
| empresas[].empresa | string | Nome empresarial. |
| empresas[].municipio | string ou null | Município da empresa. |
| empresas[].socios | array ou null | Titular, sócios e diretoria exibidos pela JUCESP para a empresa. null quando a JUCESP não exibe nenhum. |
| empresas[].socios[].nome | string | Nome do titular, sócio ou diretor. |
| empresas[].socios[].documento | string ou null | Documento exibido pela JUCESP: o CPF, ou, quando o sócio é uma empresa, o identificador exibido pela JUCESP (por exemplo, o NIRE). |
| string | Comprovante da consulta em PDF, codificado em base64, reproduzindo o resultado exibido na tela. Retornado nos status positivo e negativo. |
Resposta com empresas encontradas
JSON
{
"status": "positivo",
"mensagem": null,
"totalResultados": 2,
"resultadosExibidos": 2,
"empresas": [
{
"nire": "99999999999",
"empresa": "EMPRESA EXEMPLO LTDA",
"municipio": "CIDADE EXEMPLO",
"socios": [
{
"nome": "FULANO DE TAL",
"documento": "999.999.999-99"
}
]
},
{
"nire": "88888888888",
"empresa": "OUTRA EMPRESA EXEMPLO LTDA",
"municipio": "CIDADE EXEMPLO",
"socios": null
}
],
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}Resposta sem empresas encontradas
JSON
{
"status": "negativo",
"mensagem": "Sua pesquisa não encontrou nenhuma empresa correspondente.",
"totalResultados": 0,
"resultadosExibidos": 0,
"empresas": null,
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}Resposta com erro
JSON
{
"status": "erro",
"mensagem": "Certificado inválido, incompleto ou fora do prazo de validade."
}
