Consultar o SCR da Pessoa

Esse endpoint permite a realização da consulta do SCR da Pessoa.

SCR, Sistema de Informações de Créditos, é um instrumento de registro gerido pelo BC e alimentado mensalmente pelas instituições financeiras. Permite à supervisão bancária a adoção de medidas preventivas, com o aumento da eficácia de avaliação dos riscos inerentes à atividade. Por meio dele, o BC consegue verificar operações de crédito atípicas e de alto risco, sempre preservando o sigilo bancário.

Parâmetros da URL

  • person_id (string, uuid v4): Identificador do cadastro da Pessoa a ser consultada.
  • refresh (boolean): Campo para informar se deve utilizar a última consulta realizada (cache) ou se deve ser feita uma nova consulta.

Parâmetros da Requisição

Não é necessário o envio de nenhum dado no corpo da requisição.

Resposta

Em caso de sucesso será retornado um status 200 e um arquivo JSON no seguinte formato:

  • sucesso (boolean): Campo do tipo boolean para indicar o sucesso da consulta realizada.
  • mensagem (string): Campo para retorno de uma mensagem referente a consulta realizada.
  • dados (object): Objeto contendo o detalhamento do SCR da Pessoa.
Language
URL
Click Try It! to start a request and see the response here!