> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# O que é o Lerian SCR?

> O Lerian SCR é uma fachada REST sobre o canal de consulta wsscr2n SCR3 do BACEN. Ele retorna a posição de crédito consolidada de um cliente e audita cada consulta.

O **Lerian SCR** é uma fachada REST sobre o web service **wsscr2n** do BACEN, o canal de consulta SCR3. SCR é o *Sistema de Informações de Crédito*, o sistema de informações de crédito do BACEN.

Um consumidor se autentica com um token machine-to-machine e pede ao Lerian SCR a posição de crédito consolidada de um cliente. O serviço consulta o wsscr2n em nome da instituição, decodifica o resultado, audita a consulta e a retorna.

Cada consulta grava uma linha de auditoria. A gravação de auditoria falha de forma fechada: uma gravação de auditoria malsucedida falha a consulta, e o consumidor não recebe nenhum resultado.

Um cache de resultado, um limite de concorrência por instituição, a consolidação de single-flight de consultas idênticas, e um circuit breaker por instituição protegem o canal.

## O que o Lerian SCR faz e não faz

***

**O Lerian SCR faz:**

* **Chama o canal wsscr2n.** Ele emite um `GET` HTTPS para a operação `/wsscr2n/cliente/resumo` do BACEN com autenticação HTTP Basic, sobre TLS 1.2 ou posterior.
* **Decodifica os campos codificados.** O BACEN responde com códigos. O Lerian SCR resolve cada código em relação às tabelas de anexo do SCR e retorna um par `{ code, description }`.
* **Audita cada consulta.** Uma consulta grava uma linha de auditoria. Seus dados pessoais carregam criptografia AES-256-GCM em repouso e um índice cego HMAC-SHA256 para busca.
* **Deriva a instituição a partir do token.** Um corpo de requisição, header ou parâmetro de path nunca a define.
* **Protege o canal tarifado.** Um cache de resultado, um limite de duas conexões por instituição, a consolidação de single-flight, e um circuit breaker por instituição ficam na frente do BACEN.

**O Lerian SCR não faz:**

* **Usa mTLS.** O canal autentica apenas o servidor e coloca HTTP Basic por cima. O Lerian SCR não envia nenhum certificado de cliente.
* **Registra o documento do tomador em log.** Nenhuma linha de log, span ou mensagem de erro o carrega.
* **Mantém a trilha de consentimento.** A requisição declara a autorização do titular sob a LC 105/2001. O próprio registro de consentimento fica com a instituição.
* **Cria seu esquema de banco de dados.** Um operador aplica o esquema fora de banda antes que o serviço inicie.

## A quem atende

***

O Lerian SCR atende os consumidores internos de uma instituição financeira, como um consumidor de scoring que precisa da posição de crédito consolidada de um tomador. Um deployment atende uma única instituição, ou muitas instituições ao mesmo tempo quando a multi-tenancy está ativada.

## Glossário

***

| Termo                             | Significado                                                                                                                                                                  |
| --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **SCR**                           | *Sistema de Informações de Crédito*, o sistema de informações de crédito do BACEN.                                                                                           |
| **SCR3**                          | O contrato de consulta do SCR que o web service wsscr2n atende.                                                                                                              |
| **wsscr2n**                       | O web service do BACEN para a consulta SCR3. O Lerian SCR é a fachada sobre ele.                                                                                             |
| **WSCR0001**                      | A transação do Sisbacen que concede a uma instituição acesso ao web service de consulta. A credencial do canal é o usuário de serviço virtual da instituição, não esse nome. |
| **IF**                            | *Instituição financeira*, a instituição financeira. Um tenant do Lerian SCR.                                                                                                 |
| **Data de referência (`AAAAMM`)** | Um mês do SCR, como um inteiro de ano e mês de seis dígitos. O BACEN também a chama de *data-base*.                                                                          |
| **Posição**                       | O panorama de crédito consolidado de um tomador para uma data de referência. Um resultado vazio significa nenhuma posição, não um erro.                                      |
| **Tarifa**                        | A cobrança do BACEN por uma consulta, por cliente e por data de referência. Um cache hit não carrega nenhuma tarifa.                                                         |
| **Índice cego**                   | O HMAC determinístico de um documento de tomador. Ele torna uma linha pesquisável e mantém o documento fora do texto claro.                                                  |
| **Single-flight**                 | A consolidação de consultas concorrentes idênticas em uma única chamada ao BACEN.                                                                                            |
| **Circuit breaker**               | A guarda por instituição que interrompe as chamadas ao BACEN após falhas repetidas do canal.                                                                                 |

Para saber como o Lerian SCR se posiciona ao lado dos outros trilhos nativos e das interfaces de parceiros, veja [Mensageria nativa e interfaces de parceiros](/pt/rails/native-messaging).