Web-service para busca de Pessoa Física e Pessoa

Juridica (SPC Busca)

From SPC Brasil - Wiki Pages

Web-service para busca de Pessoa Física e Pessoa Juridica (SPC Busca) > Web-service para busca de Pessoa Física e
Pessoa Juridica (SPC Busca)

O propósito deste documento é apresentar o web-service disponível no SPC Brasil para busca de número de
CPF ou CNPJ de pessoas físicas e pessoas jurídicas. Não é objetivo deste documento descrever as
tecnologias e especificações envolvidas no acesso a Web-Services. Outros detalhes, como tipos de dados,
devem ser obtidos a partir do documento descritor “WSDL”, disponível nos endereços abaixo.

Contents
 1 Acesso
 2 Autenticação
 3 Operação "buscarPF"
 4 Operação "buscarPJ"
 5 Regras de uso
 6 Exceções
 7 Entidades Replicadas
o 7.1 Observações:

Acesso
Produção:

Entidades Migradas: https://servicos.spc.org.br/spc/remoting/ws/consulta/buscaWebService

Entidades Replicadas:
https://servicos.spc.org.br/spc/remoting/ws/consulta/buscaEntidadeReplicadaWebService

Homologação:

Entidades Migradas: https://homologacao.spc.org.br/spc/remoting/ws/consulta/buscaWebService

Entidades Replicadas:
https://homologacao.spc.org.br/spc/remoting/ws/consulta/buscaEntidadeReplicadaWebService

Treinamento:

Entidades Migradas: https://treina.spc.org.br/spc/remoting/ws/consulta/buscaWebService

Entidades Replicadas:
https://treina.spc.org.br/spc/remoting/ws/consulta/buscaEntidadeReplicadaWebService

WSDL:
Adicionar ao final da URL "?wsdl"

Deve ser utilizado o charset UTF-8 no envio das informações.

Autenticação
A autenticação desse serviço segue a forma padrão Http basic (ver documento "Forma padrão de
autenticação dos web-services da aplicação Java").

Operação "buscarPF"
Descrição: Executa uma busca de pessoa física utilizando os parâmetros da requisição.

Exemplo de requisição:

Cookie: $Version=0; JSESSIONID=1v3qqpbrwmzm2_dev01; $Path=/spc

Authorization: Basic d3N0ZXN0ZTp3c3Rlc3RlMzMz
Host: localhost:8080
Content-Length: 337
SOAPAction: ""
User-Agent: Jakarta Commons-HttpClient/3.0.1
Content-Type: text/xml;charset=UTF-8
Connection: close
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.consulta.spcjava.spcbrasil.org/">
<soapenv:Header/>
<soapenv:Body>
<web:filtroBuscaPF>
<nome-consumidor>NOME DA PESSOA A BUSCAR</nome-consumidor>
<nome-mae-consumidor>NOME DA MAE DA PESSOA</nome-mae-consumidor>
<data-nascimento-consumidor>1949-08-31T00:00:00-03:00</data-nascimento-
consumidor>
<nome-cidade-consumidor>SÃO PAULO</nome-cidade-consumidor>
<sigla-uf-consumidor>SP</sigla-uf-consumidor>
</web:filtroBuscaPF>
</soapenv:Body>
</soapenv:Envelope>

Exemplos de retorno:

Exemplo de retorno quando não são encontradas ocorrências:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:resultadoBuscaPF quantidade-encontrada="0" data="2011-03-11T14:54:12.168-
03:00" xmlns:ns2="http://webservice.consulta.spcjava.spcbrasil.org/">
<protocolo digito="9" numero="369510974"/>
<operador nome="GLEDE" codigo="OPTESTE"/>
</ns2:resultadoBuscaPF>
</S:Body>
</S:Envelope>
Exemplo de retorno com uma ocorrência encontrada:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:resultadoBuscaPF quantidade-encontrada="1" data="2011-03-11T14:46:57.202-03:00"
xmlns:ns2="http://webservice.consulta.spcjava.spcbrasil.org/">
<protocolo digito="4" numero="369510971"/>
<operador nome="GLEDE" codigo="OPTESTE"/>
<detalhe-busca-fonetica-pf>
<cpf numero="11111111111" regiao-origem="SÃO PAULO"/>
<nome>NOME DA PESSOA</nome>
<nome-mae>MAE DA PESSOA</nome-mae>
<data-nascimento>1949-08-31T00:00:00-03:00</data-nascimento>
<nome-cidade>SAO PAULO</nome-cidade>
<sigla-uf>SP</sigla-uf>
</detalhe-busca-fonetica-pf>
</ns2:resultadoBuscaPF>
</S:Body>
</S:Envelope>

Exemplo de retorno com duas ocorrências encontradas:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:resultadoBuscaPF quantidade-encontrada="2" data="2011-03-11T14:46:57.202-
03:00" xmlns:ns2="http://webservice.consulta.spcjava.spcbrasil.org/">
<protocolo digito="4" numero="369510971"/>
<operador nome="GLEDE" codigo="OPTESTE"/>
<detalhe-busca-fonetica-pf>
<cpf numero="11111111111" regiao-origem="SÃO PAULO"/>
<nome>NOME DA PESSOA</nome>
<nome-mae>MAE DA PESSOA</nome-mae>
<data-nascimento>1949-08-31T00:00:00-03:00</data-nascimento>
<nome-cidade>SAO PAULO</nome-cidade>
<sigla-uf>SP</sigla-uf>
</detalhe-busca-fonetica-pf>
<detalhe-busca-fonetica-pf>
<cpf numero="2222222222" regiao-origem="SÃO PAULO"/>
<nome>NOME DA PESSOA</nome>
<nome-mae>MAE DA PESSOA</nome-mae>
<data-nascimento>1949-08-31T00:00:00-03:00</data-nascimento>
<nome-cidade>SAO PAULO</nome-cidade>
<sigla-uf>SP</sigla-uf>
</detalhe-busca-fonetica-pf>
</ns2:resultadoBuscaPF>
</S:Body>
</S:Envelope>

Exemplo de retorno quando uma quantidade muito grande de ocorrências são encontradas, e
a busca precisa ser refinada:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<S:Fault xmlns:ns4="http://www.w3.org/2003/05/soap-envelope">
<faultcode>49</faultcode>
<faultstring>Atenção! 2.696.327 nomes encontrados. Refine sua pesquisa
preenchendo os dados complementares. [CN_WEB005.E6.1]</faultstring>
</S:Fault>
</S:Body>
</S:Envelope>
Operação "buscarPJ"
Descrição: Executa uma busca de pessoa jurídica utilizando os parâmetros da requisição.

Exemplo de requisição:

Cookie: $Version=0; JSESSIONID=x3hhht2y776q_dev01; $Path=/spc

Authorization: Basic d3N0ZXN0ZTp3c3Rlc3RlMzMz
Host: localhost:8080
Content-Length: 314
SOAPAction: ""
User-Agent: Jakarta Commons-HttpClient/3.0.1
Content-Type: text/xml;charset=UTF-8
Connection: close
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.consulta.spcjava.spcbrasil.org/">
<soapenv:Header/>
<soapenv:Body>
<web:filtroBuscaPJ>
<nome-empresa>NOME DA EMPRESA</nome-empresa>
<data-fundacao-empresa>1949-08-31T00:00:00-03:00</data-fundacao-empresa>
<nome-cidade-empresa>SÃO PAULO</nome-cidade-empresa>
<sigla-uf-empresa>SP</sigla-uf-empresa>
</web:filtroBuscaPJ>
</soapenv:Body>
</soapenv:Envelope>

Exemplos de retorno:

Exemplo de retorno quando não são encontradas ocorrências:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:resultadoBuscaPJ quantidade-encontrada="0" data="2011-03-11T15:06:49.847-
03:00" xmlns:ns2="http://webservice.consulta.spcjava.spcbrasil.org/">
<protocolo digito="7" numero="369510975"/>
<operador nome="GLEDE" codigo="OPTESTE"/>
</ns2:resultadoBuscaPJ>
</S:Body>
</S:Envelope>

Exemplo de retorno com uma ocorrência encontrada:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:resultadoBuscaPJ quantidade-encontrada="1" data="2011-03-11T15:08:27.353-
03:00" xmlns:ns2="http://webservice.consulta.spcjava.spcbrasil.org/">
<protocolo digito="3" numero="369510977"/>
<operador nome="GLEDE" codigo="OPTESTE"/>
<detalhe-busca-fonetica-pj>
<cnpj numero="11111111111111"/>
<razao-social>NOME DA EMPRESA LTDA</razao-social>
<nome-comercial>EMPRESA LTDA</nome-comercial>
<nome-cidade>SAO PAULO</nome-cidade>
<sigla-uf>SP</sigla-uf>
</detalhe-busca-fonetica-pj>
</ns2:resultadoBuscaPJ>
</S:Body>
</S:Envelope>
Exemplo de retorno com duas ocorrências encontradas:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:resultadoBuscaPJ quantidade-encontrada="2" data="2011-03-11T15:08:27.353-
03:00" xmlns:ns2="http://webservice.consulta.spcjava.spcbrasil.org/">
<protocolo digito="3" numero="369510977"/>
<operador nome="GLEDE" codigo="OPTESTE"/>
<detalhe-busca-fonetica-pj>
<cnpj numero="11111111111111"/>
<razao-social>NOME DA EMPRESA LTDA</razao-social>
<nome-comercial>NOME DA EMPRESA</nome-comercial>
<nome-cidade>SAO PAULO</nome-cidade>
<sigla-uf>SP</sigla-uf>
</detalhe-busca-fonetica-pj>
<detalhe-busca-fonetica-pj>
<cnpj numero="22222222222222"/>
<razao-social>OUTRA EMPRESA LTDA</razao-social>
<nome-comercial>EMPRESA 2 LTDA</nome-comercial>
<data-fundacao>2004-11-25T00:00:00-02:00</data-fundacao>
<nome-cidade>RIBEIRÃO PRETO</nome-cidade>
<sigla-uf>SP</sigla-uf>
</detalhe-busca-fonetica-pj>
</ns2:resultadoBuscaPJ>
</S:Body>
</S:Envelope>

Exemplo de retorno quando uma quantidade muito grande de ocorrências são encontradas, e
a busca precisa ser refinada:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<S:Fault xmlns:ns4="http://www.w3.org/2003/05/soap-envelope">
<faultcode>49</faultcode>
<faultstring>Atenção! 6.728.057 nomes encontrados. Refine sua pesquisa
preenchendo os dados complementares. [CN_WEB005.E6.1]</faultstring>
</S:Fault>
</S:Body>
</S:Envelope>
Regras de uso
1. Os parâmetros de entrada compõem a chave de busca. Ao executar as operações de busca, é obrigatório o
envio do parâmetro "nome-consumidor" ou "nome-empresa". Os demais parâmetros não são obrigatórios,
entretanto, se o sistema encontrar mais de 60 ocorrências para o nome informado, o sistema devolve o
código de erro 49, e será necessário refinar a busca, re-executando a operação informando os demais
parâmetros.
2. A entidade/associado do operador deve possuir acesso ao produto SPC Busca para que a busca funcione
corretamente; o perfil do operador utilizado também deve possuir a role de acesso ao produto.
3. A requisição possui dois atributos opcionais que podem ser enviados para identificação da estação
consultante: cep-origem, onde deve ser enviado o CEP do local de onde parte a consulta (numérico de 8
posições) e codigo-estacao-consultante, onde deve ser enviado um código de identificação da estação
(alfanumérico de até 16 posições). Essas informações ficam guardadas no sistema do SPC Brasil.
4. Deve-se respeitar os limites mínimo e máximo de tamanho para envio dos parâmetros:

Parâmetro Tamanho

nome-consumidor Mínimo 3, máximo 100 caracteres.

nome-mae-consumidor Mínimo 3, máximo 100 caracteres.

nome-cidade-consumidor Mínimo 3, máximo 40 caracteres.

sigla-uf-consumidor Máximo 2 caracteres.

nome-empresa Mínimo 3, máximo 100 caracteres.

nome-cidade-empresa Mínimo 3, máximo 40 caracteres.

sigla-uf-empresa Máximo 2 caracteres.

Exceções

Código Retorno Descrição

0 Erro interno.

O produto a ser consultado não existe ou está inativo. Ocorre quando a liberação do serviço não
1
foi executada corretamente.

2 CEP de origem inválido.

3 Código da estação consultante inválido (suporta até 16 caracteres).

39 O operador não possui acesso ao produto.

40 O operador informou nome do consumidor/empresa com menos de 3 caracteres.

41 O operador informou nome do consumidor/empresa com mais de 100 caracteres.

O operador informou caracteres especiais no nome do consumidor/empresa, no nome da mãe ou

42
no nome da cidade.

43 O operador informou nome da mãe com menos de 3 caracteres.

44 O operador informou nome da mãe com mais de 100 caracteres.

45 O operador informou data de nascimento/fundação inválida.

46 O operador informou nome da cidade com menos de 3 caracteres.

47 O operador informou nome da cidade com mais de 40 caracteres.

48 O operador informou sigla do estado com mais de 2 caracteres.

A quantidade de nomes encontrados a partir da busca do nome do consumidor ou do nome da

49
empresa é muito alta; necessário refinar o filtro e re-executar a busca.

Acesso apenas para entidades migradas (quando um operador de entidade replicada tenta
52
consultar via web-service de consulta para entidades migradas).

Obrigatorio informar códigos da entidade e associado replicados e o documento consultante (para

53
web-service de entidades replicadas, quando uma das informações não é enviada).

Associado replicado informado nao cadastrado (o código do associado replicado passado por
54
parâmetro não existe no cadastro do SPC Brasil).

55 Documento do consultante informado inválido.

 Documento do consultante informado nao corresponde ao cadastro do associado (apenas para
56
web-service de entidades replicadas).

Entidades Replicadas
Entidades replicadas devem enviar dados adicionais para a identificação do associado e da entidade
consultante. Por isso, existem diferenças na requisição do serviço utilizado para entidades deste tipo (vide
URL's acima e respectivos documentos WSDL's).

Os campos adicionais que devem ser enviados são:

documento-consultante: número do CPF ou CNPJ do associado consultante.

tipo-pessoa-consultante: tipo da pessoa referente ao documento informado no campo anterior; pode ser "F"
ou "J".

codigo-entidade-origem: código da entidade que está executando a consulta. Mesmo código de entidade
enviado no processo de replicação.

codigo-associado-origem: código do associado que está executando a consulta. Mesmo código de associado
enviado no processo de replicação.

É obrigatória a informação de todos os campos.

Observações:

Os dados enviados serão cruzados com o cadastro de associado, replicado para o SPC Brasil. Serão
executadas as seguintes validações:

 o código de associado enviado de deve corresponder à um associado da entidade informada;

 o número de documento consultante deve possuir o número do documento cadastrado para o associado, via
processo de replicação.

Se uma das validações falhar, a consulta não será executada.

Entidades replicadas não conseguirão utilizar o web-service destinado à entidades migradas, e vice-versa.

Retrieved from "http://wiki/index.php/Web-

service_para_busca_de_Pessoa_F%C3%ADsica_e_Pessoa_Juridica_(SPC%C2%A0Busca)"

 This page was last modified on 18 February 2013, at 18:58.