Consult data in SPC

cURL

cURL

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
  }
}
'

import requests

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

payload = { "consulta": {
        "documento": "<string>",
        "codigoProduto": "<string>",
        "consultaCompleta": True
    } }
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>', codigoProduto: '<string>', consultaCompleta: true}
  })
};

fetch('https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultarSPC', 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/ConsultarSPC",
  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>',
        'codigoProduto' => '<string>',
        'consultaCompleta' => true
    ]
  ]),
  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/ConsultarSPC"

	payload := strings.NewReader("{\n  \"consulta\": {\n    \"documento\": \"<string>\",\n    \"codigoProduto\": \"<string>\",\n    \"consultaCompleta\": true\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/ConsultarSPC")
  .header("IdempotencyKey", "<idempotencykey>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"consulta\": {\n    \"documento\": \"<string>\",\n    \"codigoProduto\": \"<string>\",\n    \"consultaCompleta\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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    \"codigoProduto\": \"<string>\",\n    \"consultaCompleta\": true\n  }\n}"

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

200

{
  "msg": "<string>",
  "messages": [
    {
      "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
    }
  ]
}

{
  "msg": "<string>",
  "messages": [
    {
      "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
    }
  ]
}

This endpoint provides detailed results on documents of individuals or legal entities.

The response is returned in JSON format and includes registration data, document status, information on partners, business participation, stock records, protests, legal data and risk score analysis over time.

This data allows for a more accurate assessment of the profile consulted, assisting in risk analysis and strategic decision-making.

Authorizations

Authorization · string · header · required

Informe o token

Headers

IdempotencyKey · string · required

Body

application/jsontext/jsonapplication/*+json

consulta · object

Show child attributes

Response

200

text/plain

Success

msg · string | null

messages · object[] | null

Show child attributes

hasError · boolean

possuiRestricao · boolean

falha · boolean

spcMixMaisPF · object

Show child attributes

spcMixMaisPFConsultaRealizada · object[] | null

Show child attributes

spcMixMaisPFConsultaDetalhe · object[] | null

Show child attributes

spcMixMaisPFEndereco · object[] | null

Show child attributes

spcMixMaisPFTelefone · object[] | null

Show child attributes

spcpj · object

Show child attributes

spcpjConsultaRealizada · object[] | null

Show child attributes

spcpjConsultaDetalhe · object[] | null

Show child attributes

spcpjEndereco · object[] | null

Show child attributes

spcpjTelefone · object[] | null

Show child attributes