Guia Inicial
Guia do Desenvolvedor
- Guia de Integração Via API
Bureau
Consultar dados no SPC
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultarSPC \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '{
"consulta": {
"documento": "<string>",
"codigoProduto": "<string>",
"consultaCompleta": true
}
}'
{
"msg": "<string>",
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"hasError": true,
"possuiRestricao": true,
"falha": true,
"spcMixMaisPF": {
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"documentoFederal": "<string>",
"dtInclusao": "2023-11-07T05:31:56Z",
"protocolo": "<string>",
"dtNasc": "<string>",
"email": "<string>",
"estadoCivil": "<string>",
"idade": 123,
"nome": "<string>",
"nomeMae": "<string>",
"nomePai": "<string>",
"rg": "<string>",
"rguf": "<string>",
"nroTituloEleitor": "<string>",
"sexo": "<string>",
"signo": "<string>",
"situacao": "<string>",
"dtSituacao": "<string>",
"telefoneCelular": "<string>",
"telefoneResidencial": "<string>",
"telefoneComercial": "<string>",
"telefoneFax": "<string>",
"cep": "<string>",
"logradouro": "<string>",
"nroLogradouro": "<string>",
"bairro": "<string>",
"complemento": "<string>",
"cidade": "<string>",
"uf": "<string>",
"score3Meses": 123,
"score3MesesMSG": "<string>",
"score12Meses": 123,
"score12MesesMSG": "<string>",
"xmlResult": "<string>",
"spcMixMaisPFTelefone": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ddd": "<string>",
"numero": "<string>",
"qtde": 123
}
],
"spcMixMaisPFConsultaDetalhe": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nomeAssociado": "<string>",
"dtConsulta": "2023-11-07T05:31:56Z",
"entidadeOrigem": "<string>"
}
],
"spcMixMaisPFEndereco": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cep": "<string>",
"logradouro": "<string>",
"nroLogradouro": "<string>",
"bairro": "<string>",
"complemento": "<string>",
"cidade": "<string>",
"uf": "<string>"
}
],
"spcMixMaisPFConsultaRealizada": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"item": "<string>",
"qtde": 123,
"dtUltOcorrencia": "2023-11-07T05:31:56Z",
"valor": 123
}
]
},
"spcMixMaisPFConsultaRealizada": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"item": "<string>",
"qtde": 123,
"dtUltOcorrencia": "2023-11-07T05:31:56Z",
"valor": 123
}
],
"spcMixMaisPFConsultaDetalhe": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nomeAssociado": "<string>",
"dtConsulta": "2023-11-07T05:31:56Z",
"entidadeOrigem": "<string>"
}
],
"spcMixMaisPFEndereco": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cep": "<string>",
"logradouro": "<string>",
"nroLogradouro": "<string>",
"bairro": "<string>",
"complemento": "<string>",
"cidade": "<string>",
"uf": "<string>"
}
],
"spcMixMaisPFTelefone": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ddd": "<string>",
"numero": "<string>",
"qtde": 123
}
],
"spcpj": {
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"documentoFederal": "<string>",
"dtInclusao": "2023-11-07T05:31:56Z",
"protocolo": "<string>",
"dataFundacao": "<string>",
"razaoSocial": "<string>",
"razaoSocialAnterior": "<string>",
"nomeComercial": "<string>",
"homePage": "<string>",
"email": "<string>",
"inscricaoEstadual": "<string>",
"numeroNIRENIRC": "<string>",
"valorCapitalSocial": "<string>",
"situacaoRFB": "<string>",
"dtSituacaoRFB": "<string>",
"situacaoIE": "<string>",
"dtSituacaoIE": "<string>",
"naturezaJuridica": "<string>",
"atividades": "<string>",
"telefone": "<string>",
"telefoneFax": "<string>",
"cep": "<string>",
"logradouro": "<string>",
"nroLogradouro": "<string>",
"bairro": "<string>",
"complemento": "<string>",
"cidade": "<string>",
"uf": "<string>",
"score12Meses": 123,
"score12MesesMSG": "<string>",
"score3Meses": 123,
"score3MesesMSG": "<string>",
"xmlResult": "<string>",
"spcpjTelefone": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ddd": "<string>",
"numero": "<string>",
"qtde": 123
}
],
"spcpjConsultaDetalhe": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nomeAssociado": "<string>",
"dtConsulta": "2023-11-07T05:31:56Z",
"entidadeOrigem": "<string>"
}
],
"spcpjEndereco": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cep": "<string>",
"logradouro": "<string>",
"nroLogradouro": "<string>",
"bairro": "<string>",
"complemento": "<string>",
"cidade": "<string>",
"uf": "<string>"
}
],
"spcpjConsultaRealizada": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"item": "<string>",
"qtde": 123,
"dtUltOcorrencia": "2023-11-07T05:31:56Z",
"valor": 123
}
]
},
"spcpjConsultaRealizada": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"item": "<string>",
"qtde": 123,
"dtUltOcorrencia": "2023-11-07T05:31:56Z",
"valor": 123
}
],
"spcpjConsultaDetalhe": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nomeAssociado": "<string>",
"dtConsulta": "2023-11-07T05:31:56Z",
"entidadeOrigem": "<string>"
}
],
"spcpjEndereco": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cep": "<string>",
"logradouro": "<string>",
"nroLogradouro": "<string>",
"bairro": "<string>",
"complemento": "<string>",
"cidade": "<string>",
"uf": "<string>"
}
],
"spcpjTelefone": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ddd": "<string>",
"numero": "<string>",
"qtde": 123
}
]
}
Este endpoint fornece resultados detalhados sobre documentos de pessoas físicas ou jurídicas.
A resposta é retornada em formato JSON e inclui dados cadastrais, situação do documento, informações sobre sócios, participação empresarial, registros de ações, protestos, dados judiciais e análise de risco de score ao longo do tempo.
Esses dados permitem uma avaliação mais precisa do perfil consultado, auxiliando na análise de risco e na tomada de decisões estratégicas.
Authorizations
Informe o token
Headers
Body
Response
200
text/plain
Success
The response is of type object
.
Esta página foi útil?
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultarSPC \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '{
"consulta": {
"documento": "<string>",
"codigoProduto": "<string>",
"consultaCompleta": true
}
}'
{
"msg": "<string>",
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"hasError": true,
"possuiRestricao": true,
"falha": true,
"spcMixMaisPF": {
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"documentoFederal": "<string>",
"dtInclusao": "2023-11-07T05:31:56Z",
"protocolo": "<string>",
"dtNasc": "<string>",
"email": "<string>",
"estadoCivil": "<string>",
"idade": 123,
"nome": "<string>",
"nomeMae": "<string>",
"nomePai": "<string>",
"rg": "<string>",
"rguf": "<string>",
"nroTituloEleitor": "<string>",
"sexo": "<string>",
"signo": "<string>",
"situacao": "<string>",
"dtSituacao": "<string>",
"telefoneCelular": "<string>",
"telefoneResidencial": "<string>",
"telefoneComercial": "<string>",
"telefoneFax": "<string>",
"cep": "<string>",
"logradouro": "<string>",
"nroLogradouro": "<string>",
"bairro": "<string>",
"complemento": "<string>",
"cidade": "<string>",
"uf": "<string>",
"score3Meses": 123,
"score3MesesMSG": "<string>",
"score12Meses": 123,
"score12MesesMSG": "<string>",
"xmlResult": "<string>",
"spcMixMaisPFTelefone": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ddd": "<string>",
"numero": "<string>",
"qtde": 123
}
],
"spcMixMaisPFConsultaDetalhe": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nomeAssociado": "<string>",
"dtConsulta": "2023-11-07T05:31:56Z",
"entidadeOrigem": "<string>"
}
],
"spcMixMaisPFEndereco": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cep": "<string>",
"logradouro": "<string>",
"nroLogradouro": "<string>",
"bairro": "<string>",
"complemento": "<string>",
"cidade": "<string>",
"uf": "<string>"
}
],
"spcMixMaisPFConsultaRealizada": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"item": "<string>",
"qtde": 123,
"dtUltOcorrencia": "2023-11-07T05:31:56Z",
"valor": 123
}
]
},
"spcMixMaisPFConsultaRealizada": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"item": "<string>",
"qtde": 123,
"dtUltOcorrencia": "2023-11-07T05:31:56Z",
"valor": 123
}
],
"spcMixMaisPFConsultaDetalhe": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nomeAssociado": "<string>",
"dtConsulta": "2023-11-07T05:31:56Z",
"entidadeOrigem": "<string>"
}
],
"spcMixMaisPFEndereco": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cep": "<string>",
"logradouro": "<string>",
"nroLogradouro": "<string>",
"bairro": "<string>",
"complemento": "<string>",
"cidade": "<string>",
"uf": "<string>"
}
],
"spcMixMaisPFTelefone": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ddd": "<string>",
"numero": "<string>",
"qtde": 123
}
],
"spcpj": {
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"documentoFederal": "<string>",
"dtInclusao": "2023-11-07T05:31:56Z",
"protocolo": "<string>",
"dataFundacao": "<string>",
"razaoSocial": "<string>",
"razaoSocialAnterior": "<string>",
"nomeComercial": "<string>",
"homePage": "<string>",
"email": "<string>",
"inscricaoEstadual": "<string>",
"numeroNIRENIRC": "<string>",
"valorCapitalSocial": "<string>",
"situacaoRFB": "<string>",
"dtSituacaoRFB": "<string>",
"situacaoIE": "<string>",
"dtSituacaoIE": "<string>",
"naturezaJuridica": "<string>",
"atividades": "<string>",
"telefone": "<string>",
"telefoneFax": "<string>",
"cep": "<string>",
"logradouro": "<string>",
"nroLogradouro": "<string>",
"bairro": "<string>",
"complemento": "<string>",
"cidade": "<string>",
"uf": "<string>",
"score12Meses": 123,
"score12MesesMSG": "<string>",
"score3Meses": 123,
"score3MesesMSG": "<string>",
"xmlResult": "<string>",
"spcpjTelefone": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ddd": "<string>",
"numero": "<string>",
"qtde": 123
}
],
"spcpjConsultaDetalhe": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nomeAssociado": "<string>",
"dtConsulta": "2023-11-07T05:31:56Z",
"entidadeOrigem": "<string>"
}
],
"spcpjEndereco": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cep": "<string>",
"logradouro": "<string>",
"nroLogradouro": "<string>",
"bairro": "<string>",
"complemento": "<string>",
"cidade": "<string>",
"uf": "<string>"
}
],
"spcpjConsultaRealizada": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"item": "<string>",
"qtde": 123,
"dtUltOcorrencia": "2023-11-07T05:31:56Z",
"valor": 123
}
]
},
"spcpjConsultaRealizada": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"item": "<string>",
"qtde": 123,
"dtUltOcorrencia": "2023-11-07T05:31:56Z",
"valor": 123
}
],
"spcpjConsultaDetalhe": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nomeAssociado": "<string>",
"dtConsulta": "2023-11-07T05:31:56Z",
"entidadeOrigem": "<string>"
}
],
"spcpjEndereco": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cep": "<string>",
"logradouro": "<string>",
"nroLogradouro": "<string>",
"bairro": "<string>",
"complemento": "<string>",
"cidade": "<string>",
"uf": "<string>"
}
],
"spcpjTelefone": [
{
"id": 123,
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ddd": "<string>",
"numero": "<string>",
"qtde": 123
}
]
}
Assistente
Responses are generated using AI and may contain mistakes.