1.2. Conceitos¶

SCR¶

O SCR (Sistema de Informações de Crédito) é mantido pelo Banco Central do Brasil e reúne as operações de crédito que as instituições financeiras informam sobre cada cliente: carteira a vencer e vencida, prejuízo, limites, coobrigações e outras responsabilidades.

A consulta é feita por documento do titular — CPF ou CNPJ — e por período. O resultado é o retrato do titular em cada mês consultado, organizado em indicadores, modalidades de operação e mensagens. Ver 2.2. Dicionário de Indicadores SCR.

Período: a unidade é o mês¶

Cada consulta cobre um intervalo de meses, de mesInicial a mesFinal, no formato yyyy-MM:

até 12 meses por consulta;
o mês final não pode ser posterior ao mês corrente, contado no horário de Brasília;
o mês inicial não pode ser anterior a 24 meses antes do mês corrente.

O SCR é processado mês a mês. O mês corrente pode ainda não ter informação consolidada e voltar sem resultado.

Aceite do titular¶

A consulta ao SCR só pode ser feita com a autorização do titular do documento. Essa autorização é coletada por você, no seu canal de atendimento, antes da solicitação. Na solicitação, você:

Campo	O que significa
`declaracaoAceiteTitular`	A sua declaração de que o titular autorizou a consulta. Precisa ser `true`
`dataAceiteTitular`	O momento real em que o titular deu o aceite, com fuso horário
`referenciaAceite`	Opcional. O identificador da evidência do aceite no seu sistema (ex.: versão do termo e número do registro)

Regras da data do aceite:

é um fato passado: não pode ser posterior ao momento da requisição — sem tolerância, então mantenha o relógio do seu servidor sincronizado (NTP);
precisa estar dentro da janela de validade do aceite: até 30 dias antes da requisição;
precisa vir com o fuso horário (2026-10-23T09:58:00-03:00 ou 2026-10-23T12:58:00Z). Sem o fuso não há como saber o instante exato, e a requisição é recusada.

A guarda da evidência é sua

A API registra a declaração, a data e a referência informadas, mas não recebe o termo assinado pelo titular. Guarde no seu sistema a evidência do aceite (texto apresentado, data, canal e identificação do titular) pelo prazo que o seu contrato e a legislação exigirem, e apresente-a quando solicitada. A referenciaAceite é o elo entre a consulta e essa evidência.

Consulta e período¶

Uma consulta tem um status próprio e um período para cada mês do intervalo, também com status próprio:

Status da consulta	Significado
`Concluída`	Pelo menos um mês foi consultado com sucesso
`Falha`	Nenhum mês teve resultado, ou a consulta nem chegou ao provedor do SCR

Uma consulta Concluída pode ter meses em Falha: o provedor do SCR respondeu para alguns meses e não para outros. Leia sempre resumo.quantidadePeriodosComFalha e o status de cada período — ver 3.3. Consultar Resultado.

Para obter um mês que falhou, faça uma nova consulta só com aquele mês. Não há "reprocessar" de uma consulta existente.

Cobrança¶

A cobrança considera os meses consultados com sucesso, conforme as condições do seu contrato.

Um mês em Falha não traz resultado.
Uma consulta encerrada com o motivo NAO_DESPACHADA nunca chegou ao provedor do SCR e não gera custo.
Ler o resultado (GET) não custa. Leia quantas vezes precisar, em vez de solicitar de novo.

Sem deduplicação¶

Cada solicitação aceita é uma consulta nova, mesmo que repita o documento e o período de uma consulta anterior — e pode gerar custo novo. A API não reaproveita resultados entre consultas.

O que protege contra a duplicidade acidental é a Idempotency-Key: repetir a mesma chave com o mesmo corpo, dentro de 24 horas, devolve a consulta já criada. Ver 1.1.7 Idempotência.

Quem vê cada consulta¶

Uma consulta solicitada pela API só é visível para a credencial que a criou:

a leitura e a listagem mostram apenas as consultas da sua credencial;
uma consulta de outra credencial — ainda que do mesmo grupo —, de outro grupo econômico ou inexistente responde o mesmo 404, sem indicar qual é o caso;
as consultas feitas pela tela da plataforma não aparecem na API.

Se a sua credencial está vinculada a mais de um grupo econômico, cada grupo é separado: a consulta pertence ao grupo informado no header GrupoEconomico da solicitação e só aparece quando esse mesmo grupo é informado na leitura. A Idempotency-Key e a configuração de webhook também valem por grupo.

A visibilidade é ligada ao clientId. Para renovar a credencial, troque o segredo (clientSecret) e mantenha o clientId: com um clientId novo, as consultas antigas deixam de ser visíveis pela API.

O que a API não faz¶

Cancelar uma consulta: depois de aceita, ela segue até o fim.
Gerar PDF ou planilha do resultado: a API devolve os dados em JSON.
Buscar por documento: a listagem filtra por status, data de criação e referenciaExterna — ver 3.4. Listar Consultas.

Dados pessoais¶

O resultado do SCR é dado pessoal sob sigilo bancário. Trate-o no seu lado com o mesmo cuidado: acesso restrito, sem gravação em log e sem exibição a quem não precisa.

Nunca coloque dado pessoal em referenciaExterna nem em referenciaAceite — nem o documento, nem nome, nem e-mail. A API recusa uma referência que contenha o documento consultado. Use identificadores do seu sistema, como analise-2026-000123.
O documento nunca vai na URL: ele só trafega no corpo da solicitação e na resposta da leitura.
As notificações por webhook levam apenas o idConsulta e o status — nada do titular.