Listar as Consultas de SCRs da Empresa

Esse endpoint é responsável por retornar uma lista com as consultas do SCR de uma Pessoa previamente cadastrada na plataforma da Celcoin.

Parâmetros da URL

  • person_id (string, uuid v4): Identificador do cadastro da Pessoa a ser consultada.

  • page (integer): Campo para informar um número de página para consulta paginada do resultado da busca.

  • size (integer): Campo para informar a quantidade de registros a serem retornados quando for feita uma consulta paginada.

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:

  • content (array object): Objeto do tipo array com uma lista cotendo os resultados de SCRs encontrados para aquela pessoa.

  • content -> id (string, uuid v4): Identificador do item do resultado.

  • total_pages (integer): Número total de páginas do resultado.

  • total_elements (integer): Número total de itens do resultado.

  • has_next (boolean): Campo para indicar se tem ou não uma próxima página de resultados.

  • result (object): Objeto contendo os detalhes do resultado do SCR.

Objeto "result"
  • sucesso (boolean): Campo do tipo boolean para indicar o sucesso ou falha da consulta.

  • mensagem (string): Mensagem retornada em caso de erro.

  • dados (object): Objeto contendo o detalhamento do SCR da Pessoa.

Objeto "dados"
  • cnpjDaIFSolicitante (string): Número do CNPJ da IF (Instituição Financeira) solicitante para o SCR.

  • codigoDoCliente (string): Código de identificação do cliente.

  • coobrigacaoAssumida (integer): Campo para indicar se a pessoa consultada assumiu uma coobrigação. Possíveis valores: 0 ou 1.

  • coobrigacaoRecebida (integer): Campo para indicar se a pessoa consultada recebeu uma coobrigação. Possíveis valores: 0 ou 1.

  • dataBaseConsultada (date): Data de referência utilizada na consulta no formato "AAAA-MM".

  • dataInicioRelacionamento (date): Data de inicio do relacionamento do cliente com a IF solicitante. Formato "AAAA-MM-DD".

  • listaDeResumoDasOperacoes (array): Objeto contendo uma lista de objetos com os dados das operações contratadas.

  • percentualDocumentosProcessados (string): Valor que representa a porcentagem da quantidade de documentos que foram processadas na análise realizada.

  • percentualVolumeProcessado (string): Valor que representa a porcentagem do volume de transações da análise.

  • quantidadeDeInstituicoes (string): Quantidade de instituições financeiras consideradas na análise.

  • quantidadeDeOperacoes (string): Quantidade de operações consideradas para a análise.

  • quantidadeOperacoesDiscordancia (string):

  • quantidadeOperacoesSubJudice (string):

  • responsabilidadeTotalDiscordancia (string):

  • responsabilidadeTotalSubJudice (string):

  • riscoIndiretoVendor (string):

  • tipoDoCliente (string):

  • analise (object): Objeto contendo os detalhes da anáilse.

Objeto "listaDeResumoDasOperacoes"
  • listaDeVencimentos (array): Objeto contendo uma lista dos vencimentários.

  • modalidade (string): Código da modalidade do crédito contratado.

  • variacaoCambial (string): Indica se tem aplicação de variação cambial. Possíveis valores: "N", "S"

Objeto "listaDeVencimentos"
  • codigoVencimento (string): Código de identificação do vencimento.

  • valorVencimento (string): Valor do vencimentário da operação de crédito para a data em questão.

Objeto "analise"
  • limiteDeCreditoEmDias -> ate360 (float): Valor disponibilizado para limite de crédito no período de até 360 dias.

  • limiteDeCreditoEmDias -> acimaDe360 (float): Valor disponibilizado para limite de crédito no período acima de 360 dias.

  • creditoALiberarEmDias -> ate360 (float): Valor de crédito a ser liberado em até 360 dias.

  • creditoALiberarEmDias -> acima360 (float): Valor de crédito a ser liberado em até 360 dias.

  • total -> aVencer (float): Valor total a vencer.

  • total -> vencido (float): Valor total vencido.

  • prejuizoEmMeses -> ate12 (float): Valor total do considerado prejuizo calculado em até 12 meses.

  • prejuizoEmMeses -> acimaDe12Ate48 (float): Valor total do considerado prejuizo calculado no período de 12 até 48 meses.

  • prejuizoEmMeses -> acimaDe48 (float): Valor total do considerado prejuizo calculado no período de 12 até 48 meses.

  • vencidoEmDias -> de1a14 (float): Valor total vencido considerando a faixa de 1 à 14 dias de atraso.

  • vencidoEmDias -> acimaDe15Ate30 (float): Valor total vencido considerando a faixa de 15 à 30 dias de atraso.

  • vencidoEmDias -> acimaDe31Ate60 (float): Valor total vencido considerando a faixa de 31 à 60 dias de atraso.

  • vencidoEmDias -> acimaDe61Ate90 (float): Valor total vencido considerando a faixa de 61 à 90 dias de atraso.

  • vencidoEmDias -> acimaDe91Ate120 (float): Valor total vencido considerando a faixa de 91 à 120 dias de atraso.

  • vencidoEmDias -> acimaDe121Ate150 (float): Valor total vencido considerando a faixa de 121 à 150 dias de atraso.

  • vencidoEmDias -> acimaDe151Ate180 (float): Valor total vencido considerando a faixa de 151 à 180 dias de atraso.

  • vencidoEmDias -> acimaDe181Ate240 (float): Valor total vencido considerando a faixa de 181 à 240 dias de atraso.

  • vencidoEmDias -> acimaDe241Ate300 (float): Valor total vencido considerando a faixa de 241 à 300 dias de atraso.

  • vencidoEmDias -> acimaDe301Ate360 (float): Valor total vencido considerando a faixa de 301 à 360 dias de atraso.

  • vencidoEmDias -> acimaDe361Ate540 (float): Valor total vencido considerando a faixa de 361 à 540 dias de atraso.

  • vencidoEmDias -> acimaDe540 (float): Valor total vencido considerando a faixa acima dos 540 dias de atraso.

  • detalhamento (array): Objeto contendo uma lista com o detalhamento das operações consideradas na análise.

Objeto "detalhamento"
  • modalidade -> titulo (string): Titulo da modalidade. Possíveis valores: Empréstimos, Limites, Financiamentos, Outros créditos.

  • modalidade -> subtitulo (string): Sub titulo, detalhamento da modalidade.

  • variacaoCambial (string): Indica se tem aplicação de variação cambial. Possíveis valores: "Não", "Sim".

  • vencimentos (array): Objeto do tipo lista contendo os detalhes dos vencimentários.

  • vencimentos -> categoria (string): Campo para identificar a categoria do vencimento. Possíveis valores: "avencer", "vencidos", "prejuizo".

  • vencimentos -> descricao (string): Descrição para detalhar a faixa de de dias da categoria.

  • vencimentos -> valor (string): Valor referente ao vencimento.

  • valor (float): Valor total de todos os vencimentários daquela modalidade.

Language
Credentials
OAuth2
Required Scopes
URL
Click Try It! to start a request and see the response here!