2.1. Enumerações¶
Esta seção descreve os valores estáveis usados na consulta ao SCR. Todos os enumerados chegam no formato { "id": N, "nome": "..." } ou, nos motivos de falha, { "codigo": "...", "descricao": "..." }.
Ramifique pelo
idou pelocodigo, nunca pelo texto. Onomee adescricaosão para exibição e podem ter a redação ajustada sem aviso de versão da API.
Bureau (id em /bureaus/habilitados)¶
id | nome | Descrição |
|---|---|---|
1 | SCR | Sistema de Informações de Crédito do Banco Central do Brasil |
Status da consulta (status)¶
id | nome | Terminal | Descrição |
|---|---|---|---|
1 | Pendente | Não | Registrada, aguardando o envio ao provedor do SCR |
2 | Processando | Não | Em consulta no provedor do SCR |
3 | Concluída | Sim | O provedor do SCR respondeu com sucesso para pelo menos um mês. Confira o status de cada período: um mês pode vir em falha, inclusive com RESULTADO_ILEGIVEL |
4 | Falha | Sim | Nenhum mês tem resultado. O motivo vem em motivoFalha |
Nenhum outro valor é devolvido. A transição entre os estados está em 1.3. Operações Assíncronas.
Status do período (periodos[].status)¶
Cada mês da consulta só aparece com um dos dois estados terminais:
id | nome | Descrição |
|---|---|---|
3 | Concluída | O mês tem resultado: indicadores, modalidades e mensagens |
4 | Falha | O mês não tem resultado. O motivo vem em periodos[].motivoFalha |
Motivo de falha da consulta (motivoFalha.codigo)¶
Preenchido quando o status da consulta é 4 Falha. Nos demais casos vem null.
codigo | descricao | O que fazer |
|---|---|---|
PARAMETROS_RECUSADOS | O provedor do SCR recusou os parâmetros da consulta. Revise o período e o aceite do titular e faça uma nova consulta. | Corrija os dados antes de refazer. Repetir a mesma solicitação tende a ter o mesmo resultado |
PERIODOS_SEM_RESULTADO | Nenhum mês do período teve resultado. Veja o motivo de cada mês em periodos. | Leia periodos[].motivoFalha e decida, mês a mês, se refaz |
NAO_PROCESSADA | A consulta não foi processada pelo provedor do SCR. Faça uma nova consulta; se o problema se repetir, acione o suporte. | Refaça a consulta. Se repetir, acione o suporte |
NAO_DESPACHADA | A consulta não chegou a ser enviada ao provedor do SCR e não gerou custo. Faça uma nova consulta. | Refaça, se ainda precisar. Não houve custo |
ERRO_INTERNO | Não foi possível concluir a consulta. Acione o suporte informando o idConsulta. | Acione o suporte com o idConsulta. Não refaça em laço |
Motivo de falha do período (periodos[].motivoFalha.codigo)¶
Preenchido quando o status do período é 4 Falha. Nos meses com resultado vem null.
codigo | descricao | O que fazer |
|---|---|---|
SEM_RESULTADO_NO_PROVEDOR | O provedor do SCR não retornou resultado para este mês. | Confira o período: o mês pode não ter informação para o titular. Refazer tende a ter o mesmo resultado |
PROVEDOR_INDISPONIVEL | O provedor do SCR não respondeu para este mês. Refaça a consulta deste mês. | Refaça a consulta só deste mês mais tarde |
REQUISICAO_RECUSADA | O provedor do SCR recusou a consulta deste mês. | Revise o período e o aceite antes de refazer |
RESULTADO_ILEGIVEL | O resultado deste mês não pôde ser interpretado. | Refaça a consulta deste mês. Se repetir, acione o suporte |
PERIODO_NAO_PROCESSADO | Este mês não foi processado. | Refaça a consulta deste mês |
ERRO_INTERNO | Não foi possível obter o resultado deste mês. Acione o suporte informando o idConsulta. | Acione o suporte com o idConsulta |
Refazer um mês é uma consulta nova, com custo próprio — ver 1.2. Conceitos.
Tipos de evento de webhook (tipoEvento)¶
| Slug | Quando é enviado |
|---|---|
bureau.scr.concluida | A consulta terminou Concluída |
bureau.scr.falhou | A consulta terminou em Falha, por qualquer motivo |