15 - Consultar Dados no SPC - Sem Receita

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaSPCSemReceita \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "consulta": {
    "documento": "<string>"
  }
}
'

import requests

url = "https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaSPCSemReceita"

payload = { "consulta": { "documento": "<string>" } }
headers = {
    "IdempotencyKey": "<idempotencykey>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    IdempotencyKey: '<idempotencykey>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({consulta: {documento: '<string>'}})
};

fetch('https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaSPCSemReceita', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaSPCSemReceita",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'consulta' => [
        'documento' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "IdempotencyKey: <idempotencykey>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaSPCSemReceita"

	payload := strings.NewReader("{\n  \"consulta\": {\n    \"documento\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("IdempotencyKey", "<idempotencykey>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaSPCSemReceita")
  .header("IdempotencyKey", "<idempotencykey>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"consulta\": {\n    \"documento\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaSPCSemReceita")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["IdempotencyKey"] = '<idempotencykey>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"consulta\": {\n    \"documento\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "msg": "<string>",
  "messages": [
    {
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "hasError": true,
  "falha": true,
  "json": "<string>"
}

{
  "msg": "<string>",
  "messages": [
    {
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "hasError": true,
  "falha": true,
  "json": "<string>"
}

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaSPCSemReceita \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "consulta": {
    "documento": "<string>"
  }
}
'

import requests

url = "https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaSPCSemReceita"

payload = { "consulta": { "documento": "<string>" } }
headers = {
    "IdempotencyKey": "<idempotencykey>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    IdempotencyKey: '<idempotencykey>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({consulta: {documento: '<string>'}})
};

fetch('https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaSPCSemReceita', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaSPCSemReceita",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'consulta' => [
        'documento' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "IdempotencyKey: <idempotencykey>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaSPCSemReceita"

	payload := strings.NewReader("{\n  \"consulta\": {\n    \"documento\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("IdempotencyKey", "<idempotencykey>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaSPCSemReceita")
  .header("IdempotencyKey", "<idempotencykey>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"consulta\": {\n    \"documento\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaSPCSemReceita")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["IdempotencyKey"] = '<idempotencykey>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"consulta\": {\n    \"documento\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "msg": "<string>",
  "messages": [
    {
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "hasError": true,
  "falha": true,
  "json": "<string>"
}

{
  "msg": "<string>",
  "messages": [
    {
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "hasError": true,
  "falha": true,
  "json": "<string>"
}

Este endpoint fornece resultados detalhados sobre documentos de pessoa física ou jurídica. A resposta é retornada em formato JSON serializado e contempla informações de dados cadastrados, score 12 meses, crédito concedido, CCF, cheque lojista, cheque sustado quando informado no ato da consulta, consumação da alínea 21, contravenções, alerta de documentos e protesto nacional. Esses dados permitem uma avaliação mais precisa do perfil consultado, auxiliando na análise de risco e na tomada de decisão estratégica.

Exemplo de Retorno Completo

Mostrar Exemplo de Retorno Completo

{
    "Erro": "boolean",
    "MensagemOperador": "String",
    "ResultadoConsulta": {
        "Protocolo": {
            "Numero": "int",
            "Digito": "int",
            "ProtocoloFormatado": "String"
        },
        "Restricao": "boolean",
        "DataAtTimestamp": "long",
        "Data": "datetime",
        "MensagemBaseExterna": [
			{
				"OrigemBaseExterna" : enum BaseExternaAgenteEnum,
				"MensagemBaseExterna" : "String",
				"CodigoRede" : "String"
			}
		],
        "BaseInoperante": [
			{
				"String"
			}
		],
        "Consumidor": {
            "ConsumidorPessoaFisica": {
                "CPF": {
                    "RegiaoOrigem": "String",
                    "Numero": "String"
                },
                "SituacaoCPF": {
                    "DescricaoSituacao": "String",
                    "DataSituacaoAtTimestamp": "long",
                    "DataSituacao": "datetime",
                    "UF": "String"
                },
                "Endereco": {
                    "Cidade": {
                        "Estado": {
                            "SiglaUF": "String"
                        },
                        "Nome": "String"
                    },
                    "Logradouro": "String",
                    "Numero": "int",
                    "Complemento": "String",
                    "Bairro": "String",
                    "CEP": "int"
                },
                "TelefoneResidencial": {
                    "NumeroDDD": "int",
                    "Numero": "int"
                },
                "TelefoneCelular": {
                    "NumeroDDD": "int",
                    "Numero": "int"
                },
                "TelefoneComercial": {
                    "NumeroDDD": "int",
                    "Numero": "int"
                },
                "Fax": {
                    "NumeroDDD": "int",
                    "Numero": "int"
                },
                "DataNascimentoAtTimestamp": "long",
                "DataNascimento": "datetime",
                "Email": "String",
                "NumeroRG": "String",
                "EstadoRG": "String",
                "Idade": "int",
                "Nome": "String",
                "NomePai": "String",
                "NomeMae": "String",
                "NumeroTituloEleitor": "String",
                "Sexo": "String",
                "Signo": "String",
                "EstadoCivil": "String"
            },
            "ConsumidorPessoaJuridica": {
				"CNPJ" : {
					"Numero" : "String"
				},
				"NomeComercial" : "String",
				"RazaoSocial" : "String",
				"DataFundacaoAtTimestamp" : "long",
				"DataFundacao" : "datetime",
				"InscricaoEstadual" : "string",
				"ValorCapitalSocial" : "float(10,2)",
				"NumeroNIRENIRC" : "String",
				"RazaoSocialAnterior" : "String",
				"SituacaoCNPJ" : {
					"DescricaoSituacao" : "String",
					"DataSituacaoAtTimestamp" : "long",
					"DataSituacao" : "datetime",
					"UF" : "String"
				},
				"SituacaoInscricaoEstadual" : {
					"DescricaoSituacao" : "String",
					"DataSituacaoAtTimestamp" : "long",
					"DataSituacao" : "datetime",
					"UF" : "String"
				},
				"NaturezaJuridica" : {
					"Codigo" : "long",
					"Descricao" : "String"
				},
				"AtividadeEconomicaPrincipal" : {
					"Codigo" : "long",
					"Descricao" : "String"
				},
				"AtividadeEconomicaSecundaria" : [
					{
						"Codigo" : "long",
						"Descricao" : "String"
					},
					{
						"Codigo" : "long",
						"Descricao" : "String"
					}
				],
				"Email" : "String",
				"Endereco" : {
					"Cidade": {
						"Estado": {
							"SiglaUF": "String"
						},
						"Nome": "String"
					},
					"Logradouro": "String",
					"Numero": "String",
					"Complemento": "String",
					"Bairro": "String",
					"CEP": "int"
				},
				"Telefone" : {
					"NumeroDDD" : "int",
					"Numero" : "int"
				},
				"Fax" : {
					"NumeroDDD" : "int",
					"Numero" : "int"
				}
			}
        },
        "GrafiaPJ": {
            "DetalheGrafiaPJ": [
				{
					"RazaoSocial" : "String"
				},
				{
					"RazaoSocial" : "String"
				}
			]
        },
        "EnderecoCepConsultado": {
            "DetalheEnderecoCepConsultado": [
				{
					"Endereco": {
						"Cidade": {
							"Estado": {
								"SiglaUF": "String"
							},
							"Nome": "String"
						},
						"Logradouro": "String",
						"Numero": "String",
						"Complemento": "String",
						"Bairro": "String",
						"CEP": "int"
					}
				},
				{
					"Endereco": {
						"Cidade": {
							"Estado": {
								"SiglaUF": "String"
							},
							"Nome": "String"
						},
						"Logradouro": "String",
						"Numero": "String",
						"Complemento": "String",
						"Bairro": "String",
						"CEP": "int"
					}
				}
			]
        },
        "TelefoneConsultado": {
            "Resumo": {
                "QuantidadeTotal": "int",
                "MesAnoPrimeiraOcorrencia": "int",
                "DataPrimeiraOcorrenciaAtTimestamp": "long",
                "DataPrimeiraOcorrencia": "datetime",
                "MesAnoUltimaOcorrencia": "String",
                "DataUltimaOcorrenciaAtTimestamp": "long",
                "DataUltimaOcorrencia": "datetime",
                "ValorTotal": "decimal",
                "ValorUltimaOcorrencia": "decimal"
            },
            "DetalheTelefoneConsultado": [
				{
					"Assinante": {
						"Telefone": {
							"NumeroDDD": "int",
							"Numero": "int"
						},
						"Endereco": {
							"Cidade": {
								"Estado": {
									"SiglaUF": "String"
								},
								"Nome": "String"
							},
							"Logradouro": "String",
							"Numero": "String",
							"Complemento": "String",
							"Bairro": "String",
							"CEP": "int"
						},
						"Nome": "String",
						"TipoTelefone": "String"
					}
				}
			]
        },
        "TelefoneVinculadoAssinanteConsultado": {
            "Resumo": {
                "QuantidadeTotal": "int",
                "MesAnoPrimeiraOcorrencia": "int",
                "DataPrimeiraOcorrenciaAtTimestamp": "long",
                "DataPrimeiraOcorrencia": "datetime",
                "MesAnoUltimaOcorrencia": "String",
                "DataUltimaOcorrenciaAtTimestamp": "long",
                "DataUltimaOcorrencia": "datetime",
                "ValorTotal": "decimal",
                "ValorUltimaOcorrencia": "decimal"
            },
            "DetalheTelefoneVinculadoAssinanteConsultado": [
                {
                  "Assinante": {
						"Telefone": {
							"NumeroDDD": "int",
							"Numero": "int"
						},
						"Endereco": {
							"Cidade": {
								"Estado": {
									"SiglaUF": "String"
								},
								"Nome": "String"
							},
							"Logradouro": "String",
							"Numero": "String",
							"Complemento": "String",
							"Bairro": "String",
							"CEP": "int"
						},
						"Nome": "String",
						"TipoTelefone": "String"
					}
				}
            ] 
        },
        "UltimoTelefoneInformado": {
            "DetalheUltimoTelefoneInformado": [  
                {
                  "Assinante": {
						"Telefone": {
							"NumeroDDD": "int",
							"Numero": "int"
						},
						"Endereco": {
							"Cidade": {
								"Estado": {
									"SiglaUF": "String"
								},
								"Nome": "String"
							},
							"Logradouro": "String",
							"Numero": "String",
							"Complemento": "String",
							"Bairro": "String",
							"CEP": "int"
						},
						"Nome": "String",
						"TipoTelefone": "String"
					}
				}
            ] 
        },
        "UltimoEnderecoInformado": {
            "DetalheUltimoEnderecoInformado": [
                {
                    "Endereco": {
                        "Cidade": {
                            "Estado": {
                                "SiglaUF": "String"
                            },
                            "Nome": "String"
                        },
                        "Logradouro": "String",
                        "Numero": "String",
                        "Complemento": "String",
                        "Bairro": "String",
                        "CEP": "int"
                    }
                }
            ]
        },
        "AlertaDocumento": {
            "Resumo": {
                "QuantidadeTotal": "int",
                "MesAnoPrimeiraOcorrencia": "String",
                "DataPrimeiraOcorrenciaAtTimestamp": "long",
                "DataPrimeiraOcorrencia": "datetime",
                "MesAnoUltimaOcorrencia": "String",
                "DataUltimaOcorrenciaAtTimestamp": "long",
                "DataUltimaOcorrencia": "datetime",
                "ValorTotal": "decimal",
                "ValorUltimaOcorrencia": "decimal"
            },
            "DetalheAlertaDocumento": [
				{
					"TipoDocumentoAlerta": [
						{
							"Nome": "String",
							"DataEmissaoNovoDocumentoAtTimestamp" : "long",
							"DataEmissaoNovoDocumento" : "datetime"
							
						},
						{
							"Nome": "String",
							"DataEmissaoNovoDocumentoAtTimestamp" : "long",
							"DataEmissaoNovoDocumento" : "datetime"
						}
					],
					"DataInclusaoAtTimestamp" : "long",
					"DataInclusao": "datetime",
					"DataOcorrenciaAtTimestamp" : "long",
					"DataOcorrencia": "datetime",
					"EntidadeOrigem": "String",
					"Motivo": "String",
					"Observacao": "String"
				}

            ]
        },
        "SPC": {
            "Resumo": {
                "QuantidadeTotal": "int",
                "MesAnoPrimeiraOcorrencia": "String",
                "DataPrimeiraOcorrenciaAtTimestamp": "long",
                "DataPrimeiraOcorrencia": "datetime",
                "MesAnoUltimaOcorrencia": "String",
                "DataUltimaOcorrenciaAtTimestamp": "long",
                "DataUltimaOcorrencia": "datetime",
                "ValorTotal": "decimal",
                "ValorUltimaOcorrencia": "decimal"
            },
            "DetalheSPC": [
				{
					"CidadeAssociado": {
						"Estado": {
							"SiglaUF": "String"
						},
						"Nome": "String"
					},
					"TelefoneAssociado" : {
						"NumeroDDD": "int",
                        "Numero": "int"
					},
					"NomeAssociado" : "String",
					"CodigoEntidade" : "long",
					"ContaContrato": "String",
					"DataInclusaoAtTimestamp" : "long",
					"DataInclusao" : "datetime",
					"DataVencimentoAtTimestamp" : "long",
					"DataVencimento" : "datetime",
					"Reservado" : "String",
					"NomeEntidade" : "String",
					"Contrato": "String",
					"RegistroInstituicaoFinanceira" : "enum" SimNaoEnum,
					"RegistroRelevante" : "enum" SimNaoEnum,
					"CompradorFiadorAvalista" : "String",
					"Valor" : "decimal"
				}
			]
        },
        "ChequeLojista": {
            "Resumo": {
                "QuantidadeTotal": "int",
                "MesAnoPrimeiraOcorrencia": "String",
                "DataPrimeiraOcorrenciaAtTimestamp": "long",
                "DataPrimeiraOcorrencia": "datetime",
                "MesAnoUltimaOcorrencia": "String",
                "DataUltimaOcorrenciaAtTimestamp": "long",
                "DataUltimaOcorrencia": "datetime",
                "ValorTotal": "decimal",
                "ValorUltimaOcorrencia": "decimal"
            },
            "DetalheChequeLojista": [
				{
					"Alinea": {
						"Codigo": "long",
						"Descricao": "String"
					},
					"ChequeInicial": {
						"DadosBancarios": {
							"Endereco": {
								"Cidade": {
									"Estado": {
										"SiglaUF": "String"
									},
									"Nome": "String"
								},
								"Logradouro": "String",
								"Numero": "String",
								"Complemento": "String",
								"Bairro": "String",
								"CEP": "int"
							},
							"Banco": {
								"Codigo": "int",
								"Nome": "String"
							},
							"Telefone" : {
								"NumeroDDD" : "int",
								"Numero" : "long"
							},
							"Fax" : {
								"NumeroDDD" : "int",
								"Numero" : "long"
							},
							"NumeroAgencia": "int",
							"NomeAgencia" : "String",
							"NumeroContaCorrente" : "String",
							"DigitoContaCorrente" : "String"
						},
						"Numero": "int",
						"Digito": "int",
						"Valor": "decimal"
					},
					"ChequeFinal": {
						"DadosBancarios": {
							"Endereco": {
								"Cidade": {
									"Estado": {
										"SiglaUF": "String"
									},
									"Nome": "String"
								},
								"Logradouro": "String",
								"Numero": "String",
								"Complemento": "String",
								"Bairro": "String",
								"CEP": "int"
							},
							"Banco": {
								"Codigo": "int",
								"Nome": "String"
							},
							"Telefone" : {
								"NumeroDDD" : "int",
								"Numero" : "long"
							},
							"Fax" : {
								"NumeroDDD" : "int",
								"Numero" : "long"
							},
							"NumeroAgencia": "int",
							"NomeAgencia" : "String",
							"NumeroContaCorrente" : "String",
							"DigitoContaCorrente" : "String"
						},
						"Numero": "int",
						"Digito": "int",
						"Valor": "decimal"
					},
					"CidadeAssociado": {
						"Estado": {
							"SiglaUF": "String"
						},
						"Nome": "String"
					},
					"TelefoneAssociado": {
						"NumeroDDD": "int",
						"Numero": "long"
					},
					"NomeAssociado": "String",
					"CodigoEntidade": "long",
					"DataInclusaoAtTimestamp" : "long",
					"DataInclusao": "datetime",
					"NomeEntidade": "String",
					"Informante" : "String",
					"Origem" : "String"
				}

            ]
        },
        "CCF": {
            "Resumo": {
                "QuantidadeTotal": "int",
                "MesAnoPrimeiraOcorrencia": "String",
                "DataPrimeiraOcorrenciaAtTimestamp": "long",
                "DataPrimeiraOcorrencia": "datetime",
                "MesAnoUltimaOcorrencia": "String",
                "DataUltimaOcorrenciaAtTimestamp": "long",
                "DataUltimaOcorrencia": "datetime",
                "ValorTotal": "decimal",
                "ValorUltimaOcorrencia": "decimal"
            },
            "DetalheCCF": [
                {
					"Motivo": {
						"Codigo": "long",
						"Descricao": "String"
					},
					"UltimoCheque": {
						"DadosBancarios": {
							"Endereco": {
								"Cidade": {
									"Estado": {
										"SiglaUF": "String"
									},
									"Nome": "String"
								},
								"Logradouro": "String",
								"Numero": "String",
								"Complemento": "String",
								"Bairro": "String",
								"CEP": "int"
							},
							"Banco": {
								"Codigo": "int",
								"Nome": "String"
							},
							"Telefone" : {
								"NumeroDDD" : "int",
								"Numero" : "long"
							},
							"Fax" : {
								"NumeroDDD" : "int",
								"Numero" : "long"
							},
							"NumeroAgencia": "int",
							"NomeAgencia" : "String",
							"NumeroContaCorrente" : "String",
							"DigitoContaCorrente" : "String"
						},
						"Numero": "int",
						"Digito": "int",
						"Valor": "decimal"
					},
					"DataUltimoChequeAtTimestamp" : "long",
					"DataUltimoCheque": "datetime",
					"Origem": "String",
					"Quantidade": "int"
				}
            ]
        },
        "ContraOrdem": {
            "Resumo": {
                "QuantidadeTotal": "int",
                "MesAnoPrimeiraOcorrencia": "String",
                "DataPrimeiraOcorrenciaAtTimestamp": "long",
                "DataPrimeiraOcorrencia": "datetime",
                "MesAnoUltimaOcorrencia": "String",
                "DataUltimaOcorrenciaAtTimestamp": "long",
                "DataUltimaOcorrencia": "datetime",
                "ValorTotal": "decimal",
                "ValorUltimaOcorrencia": "decimal"
            },
            "DetalheContraOrdem": [
                {
					"Motivo": {
						"Codigo": "long",
						"Descricao": "String"
					},
					"ChequeInicial": {
						"DadosBancarios": {
							"Endereco": {
								"Cidade": {
									"Estado": {
										"SiglaUF": "String"
									},
									"Nome": "String"
								},
								"Logradouro": "String",
								"Numero": "String",
								"Complemento": "String",
								"Bairro": "String",
								"CEP": "int"
							},
							"Banco": {
								"Codigo": "int",
								"Nome": "String"
							},
							"Telefone" : {
								"NumeroDDD" : "int",
								"Numero" : "long"
							},
							"Fax" : {
								"NumeroDDD" : "int",
								"Numero" : "long"
							},
							"NumeroAgencia": "int",
							"NomeAgencia" : "String",
							"NumeroContaCorrente" : "String",
							"DigitoContaCorrente" : "String"
						},
						"Numero": "int",
						"Digito": "int",
						"Valor": "decimal"
					},
					"ChequeFinal": {
						"DadosBancarios": {
							"Endereco": {
								"Cidade": {
									"Estado": {
										"SiglaUF": "String"
									},
									"Nome": "String"
								},
								"Logradouro": "String",
								"Numero": "String",
								"Complemento": "String",
								"Bairro": "String",
								"CEP": "int"
							},
							"Banco": {
								"Codigo": "int",
								"Nome": "String"
							},
							"Telefone" : {
								"NumeroDDD" : "int",
								"Numero" : "long"
							},
							"Fax" : {
								"NumeroDDD" : "int",
								"Numero" : "long"
							},
							"NumeroAgencia": "int",
							"NomeAgencia" : "String",
							"NumeroContaCorrente" : "String",
							"DigitoContaCorrente" : "String"
						},
						"Numero": "int",
						"Digito": "int",
						"Valor": "decimal"
					},
					"DataInclusaoAtTimestamp" : "long",
					"DataInclusao" : "datetime",
					"DataOcorrenciaAtTimestamp" : "long",
					"DataOcorrencia" : "datetime",
					"Origem" : "String",
					"Informante" : "String"
				}
            ]
        },
        "Protesto": {
            "Resumo": {
                "QuantidadeTotal": "int",
                "MesAnoPrimeiraOcorrencia": "String",
                "DataPrimeiraOcorrenciaAtTimestamp": "long",
                "DataPrimeiraOcorrencia": "datetime",
                "MesAnoUltimaOcorrencia": "String",
                "DataUltimaOcorrenciaAtTimestamp": "long",
                "DataUltimaOcorrencia": "datetime",
                "ValorTotal": "decimal",
                "ValorUltimaOcorrencia": "decimal"
            },
            "DetalheProtesto": [
                {
					"Cartorio": {
						"Cidade": {
							"Estado": {
								"SiglaUF": "String"
							},
							"Nome": "String"
						},
						"Nome": "String"
					},
					"NaturezaAnotacao" : {
						"DescricaoNaturezaAnotacao" : "String",
						"DescricaoComplementarNaturezaAnotacao" : "String"
					},
					"Subjudice" : {
						"PracaSubjudice" : "String",
						"DistritoSubjudice" : "String",
						"VaraSubjudice" : "String",
						"DataSubjudiceAtTimestamp" : "long",
						"DataSubjudice" : "datetime",
						"ProcessoSubjudice" : "String",
						"MensagemSubjudice" : "String"
					},
					"Moeda" : {
						"Simbolo" : "String"
					},
					"CartaAnuencia" : enum CartaAnuenciaEnum,
					"DataCartaAnuenciaAtTimestamp" : "long",
					"DataCartaAnuencia" : "datetime",
					"DataInclusaoAtTimestamp" : "long",
					"DataInclusao" : "datetime",
					"DataProtestoAtTimestamp" : "long",
					"DataProtesto": "datetime",
					"RequerenteCredor" : "String",
					"NumeroProtesto" : "String",
					"Valor": "decimal"
                }
            ]
        },
        "Contumacia": {
            "Resumo": {
                "QuantidadeTotal": "int",
                "MesAnoPrimeiraOcorrencia": "String",
                "DataPrimeiraOcorrenciaAtTimestamp": "long",
                "DataPrimeiraOcorrencia": "datetime",
                "MesAnoUltimaOcorrencia": "String",
                "DataUltimaOcorrenciaAtTimestamp": "long",
                "DataUltimaOcorrencia": "datetime",
                "ValorTotal": "decimal",
                "ValorUltimaOcorrencia": "decimal"
            },
            "DetalheContumacia": [
                {
					"Motivo": {
						"Codigo": "long",
						"Descricao": "String"
					},
					"ChequeInicial": {
						"DadosBancarios": {
							"Endereco": {
								"Cidade": {
									"Estado": {
										"SiglaUF": "String"
									},
									"Nome": "String"
								},
								"Logradouro": "String",
								"Numero": "String",
								"Complemento": "String",
								"Bairro": "String",
								"CEP": "int"
							},
							"Banco": {
								"Codigo": "int",
								"Nome": "String"
							},
							"Telefone" : {
								"NumeroDDD" : "int",
								"Numero" : "long"
							},
							"Fax" : {
								"NumeroDDD" : "int",
								"Numero" : "long"
							},
							"NumeroAgencia": "int",
							"NomeAgencia" : "String",
							"NumeroContaCorrente" : "String",
							"DigitoContaCorrente" : "String"
						},
						"Numero": "int",
						"Digito": "int",
						"Valor": "decimal"
					},
					"ChequeFinal": {
						"DadosBancarios": {
							"Endereco": {
								"Cidade": {
									"Estado": {
										"SiglaUF": "String"
									},
									"Nome": "String"
								},
								"Logradouro": "String",
								"Numero": "String",
								"Complemento": "String",
								"Bairro": "String",
								"CEP": "int"
							},
							"Banco": {
								"Codigo": "int",
								"Nome": "String"
							},
							"Telefone" : {
								"NumeroDDD" : "int",
								"Numero" : "long"
							},
							"Fax" : {
								"NumeroDDD" : "int",
								"Numero" : "long"
							},
							"NumeroAgencia": "int",
							"NomeAgencia" : "String",
							"NumeroContaCorrente" : "String",
							"DigitoContaCorrente" : "String"
						},
						"Numero": "int",
						"Digito": "int",
						"Valor": "decimal"
					},
					"DataInclusaoAtTimestamp" : "long",
					"DataInclusao" : "datetime",
					"DataOcorrenciaAtTimestamp" : "long",
					"DataOcorrencia" : "datetime",
					"Origem" : "String",
					"Informante" : "String"
				}

            ],
            "DataFinalPeriodoConsultadoAtTimestamp": "long",
            "DataFinalPeriodoConsultado": "datetime",
            "DataInicialPeriodoConsultadoAtTimestamp": "long",
            "DataInicialPeriodoConsultado": "datetime"
        },
        "CreditoConcedido": {
            "Resumo": {
                "QuantidadeTotal": "int",
                "MesAnoPrimeiraOcorrencia": "String",
                "DataPrimeiraOcorrenciaAtTimestamp": "long",
                "DataPrimeiraOcorrencia": "datetime",
                "MesAnoUltimaOcorrencia": "String",
                "DataUltimaOcorrenciaAtTimestamp": "long",
                "DataUltimaOcorrencia": "datetime",
                "ValorTotal": "decimal",
                "ValorUltimaOcorrencia": "decimal"
            },
            "DetalheCreditoConcedido": [
                {
					"NumeroContrato" : "String",
					"AnoVencimento": "int",
					"MesVencimento": "int",
					"QuantidadeCredito": "int",
					"Valor": "decimal"
                }
            ]
        },
        "ConsultaRealizada": {
            "Resumo": {
                "QuantidadeTotal": "int",
                "MesAnoPrimeiraOcorrencia": "String",
                "DataPrimeiraOcorrenciaAtTimestamp": "long",
                "DataPrimeiraOcorrencia": "datetime",
                "MesAnoUltimaOcorrencia": "String",
                "DataUltimaOcorrenciaAtTimestamp": "long",
                "DataUltimaOcorrencia": "datetime",
                "ValorTotal": "decimal",
                "ValorUltimaOcorrencia": "decimal"
            },
            "DetalheConsultaRealizada": [
                {
                    "OrigemAssociado": {
                        "Estado": {
                            "SiglaUF": "String"
                        },
                        "Nome": "String"
                    },
                    "NomeAssociado": "String",
                    "DataConsultaAtTimestamp": "long",
                    "DataConsulta": "datetime",
                    "NomeEntidadeOrigem": "String"
                }
            ],
            "QuantidadeDiasConsultados": "int"
        },
        "ChequeConsultaOnlineSRS": {
            "Resumo": {
                "QuantidadeTotal": "int",
                "MesAnoPrimeiraOcorrencia": "String",
               "DataPrimeiraOcorrenciaAtTimestamp": "int",
                "DataPrimeiraOcorrencia": "date",
                "MesAnoUltimaOcorrencia": "String",
                "DataUltimaOcorrenciaAtTimestamp": "int",
                "DataUltimaOcorrencia": "date",
                "ValorTotal": "decimal",
                "ValorUltimaOcorrencia": "decimal"
            },
            "DetalheChequeConsultaOnlineSRS": [
				{
					"OcorrenciaRechequeOnline" : {
						"BancoParticipacaoRechequeOnline" : "String",
						"MensagemIndisponibilidade" : "String"
					},
					"DataSituacaoContaCorrenteAtTimestamp" : "long",
					"DataSituacaoContaCorrente" : "datetime",
					"MensagemSituacaoContaCorrente" : "String",
					"TipoDocumentoIdentificacao" : "String",
					"TipoPessoaRechequeOnline" : "String"
				}
			]
        },
        "AtividadeEmpresa": {
			"DetalheAtividadeEmpresa": [
				{
					"RamoAtividade" : {
						"Codigo" : "long", 
						"Descricao" : "String"
					},
					"AtividadesEconomicasSecundarias" : [
						{
							"Codigo" : "long", 
							"Descricao" : "String"
						},
						{
							"Codigo" : "long", 
							"Descricao" : "String"
						}
					],
					"NumeroCNAE": "String",
					"PercentualCompra" : "decimal",
					"PercentualVendas" : "decimal",
					"QuantidadeEmpregados" : "int",
					"QuantidadeFiliais" : "int"
				}
			]
		},
        "MensagemComplementar": [
			{
				"Mensagem": [
					"String",
					"String"
				],
				"Origem" : "String"
			}
		],
        "SpcScore12Meses": {
            "DetalheSpcScore12Meses": [
                {
                    "Horizonte": "int",
                    "Classe": "String",
                    "MensageminterpretativaScore": "String",
                    "MensageminterpretativaProbabilidade": "String",
                    "MesagemSemaforo": "String",
                    "Probabilidade": "decimal",
                    "Score": "int",
                    "TipoClienteScore": enum TipoClienteScoreEnum
                }
            ]
        },
        "DadosAdicionaisDeContato": {
            "Resumo": {
                "QuantidadeTotal": "int",
                "MesAnoPrimeiraOcorrencia": "string",
				"DataPrimeiraOcorrenciaAtTimestamp": "long",
                "DataPrimeiraOcorrencia": "datetime",
                "MesAnoUltimaOcorrencia": "string",
                "DataUltimaOcorrenciaAtTimestamp": "long",
                "DataUltimaOcorrencia": "datetime",
                "ValorTotal": "decimal",
                "ValorUltimaOcorrencia": "decimal"
			},
            "DetalheDadosAdicionaisDeContato": [
                {
                    "Celulares": [
                        "String",
						"String"
                    ],
                    "Emails": [
                        "String",
						"String"
                    ],
                    "EnderecosPF": [
                        "String",
						"String"
                    ],
                    "EnderecosPJ": [
                        "String",
						"String"
                    ],
                    "Telefones": [
                       "String",
						"String"
                    ]
                },
                {
                    "Celulares": [
                        "String",
						"String"
                    ],
                    "Emails": [
                        "String",
						"String"
                    ],
                    "EnderecosPF": [
                        "String",
						"String"
                    ],
                    "EnderecosPJ": [
                        "String",
						"String"
                    ],
                    "Telefones": [
                        "String",
						"String"
                    ]
                }
            ]
        }
	}
}

Informações sobre campos do retorno

Mostrar enum BaseExternaAgenteEnum

No objeto MensagemBaseExterna, presente no retorno da requisição, o campo OrigemBaseExterna, pode vir com os seguintes valores:

SRF
RENIC
USEFN
ACSP
EQUIF
SRASA_TRADUTOR_CONCENTRE
SRASA_RELATO
SRASA_CHEQUENET
SRASA_CONCTR
FORNECEDOR_INTEGRACAO
FORNECEDOR_INTEGRACAO_CHEQUE
SSPDSCE
SSPGO
SSPMT
CHECKAUTO
SRASA_CREDNET
SRASA_CREDIT_BUREAU
ASSECC_FONE
FIBER_RENDA_PRESUMIDA
IBOPE
RENDA_PRESUMIDA
CARFACTS
CADPS
CADPS_PONTUALIDADE_PAGAMENTO
CADPS_COMPORTAMENTO_GASTOS
CADPS_MOVIMENTACAO
UNICHECK
SPCADOS
CADPS_SCORE
SALES_BOX
INSUMOS_HOT

Mostrar enum SimNaoEnum

No objeto DetalheSPC, presente no retorno da requisição, os campos RegistroInstituicaoFinanceira e RegistroRelevante, podem vir com os seguintes valores:

Código	Descrição
0	Não
1	Sim

Mostrar enum TipoPessoaEnum

No objeto DetalheParticipacaoMercadoCapitais, presente no retorno da requisição, o campo TipoPessoa, pode vir com os seguintes valores:

Código	Descrição
F	Física
J	Jurídica

Mostrar enum IdentificacaoPeriodoPagamentoCadastroPositivoEnum

No objeto DetalheInsumoIndicePontualidadePagamentoCadastroPositivo, presente no retorno da requisição, o campo Descricao, pode vir com os seguintes valores:

PAGAMENTO_EM_DIA;
PAGAMENTO_ATE_15_DIAS;
PAGAMENTO_ENTRE_15_E_30_DIAS_APOS_VENCIMENTO;
PAGAMENTO_ENTRE_30_E_90_DIAS_APOS_VENCIMENTO;
PAGAMENTO_ACIMA_DE_90_DIAS_APOS_VENCIMENTO;
SEM_INFORMACOES_PAGAMENTO_ATE_30_DIAS_APOS_VENCIMENTO;
SEM_INFORMACOES_PAGAMENTO_ACIMA_DE_30_DIAS_APOS_VENCIMENTO.

Autorizações

Authorization

string

header

obrigatório

Informe o token

Cabeçalhos

IdempotencyKey

string

obrigatório

Corpo

consulta

object

Show child attributes

Resposta

Success

msg

string | null

messages

object[] | null

Show child attributes

hasError

boolean

falha

boolean

json

string | null

14 - Consultar Dados no SPC - Descontinuado 16 - Consultar Dados no QUOD

Guia Inicial

Guia do Desenvolvedor

Referências de API

15 - Consultar Dados no SPC - Sem Receita

Exemplo de Retorno Completo

Informações sobre campos do retorno

Autorizações

Cabeçalhos

Corpo

Resposta

​Exemplo de Retorno Completo

​Informações sobre campos do retorno

Autorizações

Cabeçalhos

Corpo

Resposta

Exemplo de Retorno Completo

Informações sobre campos do retorno