Estrutura dos dados

Retorno do SCR

Objeto de resposta que representa os dados de uma consulta ao Sistema de Informações de Crédito (SCR) do Banco Central.

Estrutura

{
  uuid: string;          // Identificador único da consulta
  status: string;        // Status atual da consulta
  webhookType: string;   // Tipo de webhook que gerou a resposta
  data: DataVM;         // Dados da consulta ao SCR
  pdf: string;          // Documento PDF com o resultado (binary)
  createdAt: string;    // Data/hora de criação (ISO-8601)
  updatedAt: string;    // Data/hora da última atualização (ISO-8601)
}

Status Possíveis

• PENDING: Consulta pendente de processamento

• PROCESSING: Consulta em processamento no SCR

• COMPLETED: Consulta finalizada com sucesso

• ERROR: Erro durante o processamento

• EXPIRED: Consulta expirada

• CANCELED: Consulta cancelada

Tipos de Webhook

• SCR: Atualização dos dados da consulta SCR

• DOCUMENT_EXPIRED: Notificação de documento expirado

• DOCUMENT_SIGNED: Notificação de documento assinado

Informações Retornadas

Dados Principais (DataVM)

Informação	Descrição
Dados do Cliente	Nome, CPF/CNPJ e tipo de pessoa (PF/PJ)
Período Consultado	Data inicial e final do período
Termo de Consentimento	Termo fornecido para a consulta
Datas	Data da consulta e criação do registro
Identificadores	UUID da origem e chave SCR
Status SCR	Situação atual no sistema do Bacen
Documento	PDF com resultado da consulta

Dados do SCR (ScrDataVM)

Informação	Descrição
Instituições Financeiras	Quantidade de instituições que reportaram
Operações	Número total de operações encontradas
Coobrigações	Valores assumidos como avalista/fiador
Relacionamento	Data mais antiga de relacionamento com bancos
Discordâncias	Operações com registro de discordância
Operações Sub Judice	Operações com decisão judicial
Risco Indireto	Valor total como coobrigado
Detalhamento	Lista de operações com valores e tipos

Exemplo de Uso

// Exemplo de resposta de uma consulta completada
{
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "status": "COMPLETED",
  "webhookType": "SCR",
  "data": {
    "subjectName": "João da Silva",
    "subjectDocumentNumber": "123.456.789-00",
    "subjectPersonType": "Pessoa_Fisica",
    "consultedAt": "2024-03-20",
    "scrStatus": "PROCESSED",
    "scrData": [
      {
        "referenceDate": "2024-03",
        "financialInstitutionCount": "3",
        "operationCount": "5",
        "assumedCoobligation": "25000.00"
      }
    ]
  },
  "createdAt": "2024-03-20T10:00:00Z",
  "updatedAt": "2024-03-20T10:05:00Z"
}

Notas Importantes

1. O campo pdf contém o documento binário apenas quando a consulta está COMPLETED

2. Os dados SCR são atualizados progressivamente conforme o processamento

3. O webhookType indica qual evento gerou a atualização dos dados

4. As datas seguem o formato ISO-8601

5. O status da consulta e o scrStatus podem ser diferentes

6. Valores monetários são retornados como string com 2 casas decimais

7. Datas de referência seguem o formato YYYY-MM