v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
CAAS

Consult score and SCR, Restriction, QSA

Consult score, SCR, Restriction and QSA

  • Consult score, SCR (Sistema de Informações de Crédito do Banco Central), Restriction and QSA
  • Consulta score, SCR (Sistema de Informações de Crédito do Banco Central), Restriction e QSA
post/bureau/v1/consult_score_scr

Request body

documentstring required

CPF

referencestring

Data da pesquisa/consulta do SCR

tagTagConsultScoresAndSCD[] required

Pesquisa a ser realizada (podendo ser 1 ou todas)

Example request

{
  "document": "01796128163",
  "reference": "2023-07",
  "tag": [
    "SCR",
    "SCORE",
    "RESTRICTION",
    "QSA"
  ],
  "logData": {
    "latitude": -16.6982283,
    "longitude": -49.2581201,
    "occurrenceDate": "2024-03-12T14:41:17.459Z",
    "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.169 Safari/537.36",
    "ip": "0.0.0.0",
    "mac": "00:00:00:00:00:00"
  }
}

Response

Success

scoreinteger

Score

Example response

{
  "scr": {
    "QuantidadeDeOperacoes": "44",
    "DataInicioRelacionamento": "2004-03-01",
    "CodigoDoCliente": "01796128163",
    "CoobrigacaoRecebida": "0.00",
    "CnpjDaIFSolicitante": "13203354",
    "PercentualDocumentosProcessados": "99.59",
    "TipoDoCliente": "1",
    "QuantidadeOperacoesSubJudice": "0",
    "ResponsabilidadeTotalSubJudice": "0",
    "QuantidadeOperacoesDiscordancia": "0",
    "ResponsabilidadeTotalDiscordancia": "0",
    "CoobrigacaoAssumida": "0.00",
    "DataBaseConsultada": "2023-07",
    "QuantidadeDeInstituicoes": "9",
    "PercentualVolumeProcessado": "99.99",
    "RiscoIndiretoVendor": "0.00",
    "ListaDeResumoDasOperacoes": [
      {
        "ListaDeVencimentos": [
          {
            "CodigoVencimento": "v140",
            "ValorVencimento": "59848.11"
          },
          {
            "CodigoVencimento": "v150",
            "ValorVencimento": "83640.36"
          },
          {
            "CodigoVencimento": "v160",
            "ValorVencimento": "87547.36"
          },
          {
            "CodigoVencimento": "v110",
            "ValorVencimento": "72101.57"
          },
          {
            "CodigoVencimento": "v120",
            "ValorVencimento": "18626.78"
          },
          {
            "CodigoVencimento": "v130",
            "ValorVencimento": "19057.68"
          },
          {
            "CodigoVencimento": "v165",
            "ValorVencimento": "31392.44"
          }
        ],
        "VariacaoCambial": "N",
        "Modalidade": "0210"
      },
      {
        "ListaDeVencimentos": [
          {
            "CodigoVencimento": "v20",
            "ValorVencimento": "12500.00",
            "VariacaoCambial": "N",
            "Modalidade": "1901"
          }
        ]
      },
      {
        "ListaDeVencimentos": [
          {
            "CodigoVencimento": "v140",
            "ValorVencimento": "0.92"
          },
          {
            "CodigoVencimento": "v150",
            "ValorVencimento": "14.40"
          },
          {
            "CodigoVencimento": "v130",
            "ValorVencimento": "53.17"
          }
        ],
        "VariacaoCambial": "N",
        "Modalidade": "0213"
      },
      {
        "ListaDeVencimentos": [
          {
            "CodigoVencimento": "v140",
            "ValorVencimento": "21706.15"
          },
          {
            "CodigoVencimento": "v150",
            "ValorVencimento": "2820.50"
          },
          {
            "CodigoVencimento": "v110",
            "ValorVencimento": "91626.85"
          },
          {
            "CodigoVencimento": "v120",
            "ValorVencimento": "17835.36"
          },
          {
            "CodigoVencimento": "v130",
            "ValorVencimento": "11379.73"
          }
        ],
        "VariacaoCambial": "N",
        "Modalidade": "1304"
      },
      {
        "ListaDeVencimentos": [
          {
            "CodigoVencimento": "v40",
            "ValorVencimento": "402006.03"
          },
          {
            "CodigoVencimento": "v20",
            "ValorVencimento": "42294.64"
          }
        ],
        "VariacaoCambial": "N",
        "Modalidade": "1904"
      },
      {
        "ListaDeVencimentos": [
          {
            "CodigoVencimento": "v20",
            "ValorVencimento": "36500.01"
          }
        ],
        "VariacaoCambial": "N",
        "Modalidade": "1902"
      },
      {
        "ListaDeVencimentos": [
          {
            "CodigoVencimento": "v140",
            "ValorVencimento": "1775.07"
          },
          {
            "CodigoVencimento": "v110",
            "ValorVencimento": "2504.62"
          },
          {
            "CodigoVencimento": "v120",
            "ValorVencimento": "597.80"
          },
          {
            "CodigoVencimento": "v130",
            "ValorVencimento": "595.70"
          }
        ],
        "VariacaoCambial": "N",
        "Modalidade": "0204"
      },
      {
        "ListaDeVencimentos": [
          {
            "CodigoVencimento": "v130",
            "ValorVencimento": "1934.95"
          },
          {
            "CodigoVencimento": "v180",
            "ValorVencimento": "107070.31"
          },
          {
            "CodigoVencimento": "v150",
            "ValorVencimento": "11092.68"
          },
          {
            "CodigoVencimento": "v120",
            "ValorVencimento": "1948.60"
          },
          {
            "CodigoVencimento": "v175",
            "ValorVencimento": "16241.01"
          },
          {
            "CodigoVencimento": "v170",
            "ValorVencimento": "17638.82"
          },
          {
            "CodigoVencimento": "v140",
            "ValorVencimento": "5723.94"
          },
          {
            "CodigoVencimento": "v110",
            "ValorVencimento": "2174.03"
          },
          {
            "CodigoVencimento": "v165",
            "ValorVencimento": "19166.47"
          },
          {
            "CodigoVencimento": "v190",
            "ValorVencimento": "16012.36"
          },
          {
            "CodigoVencimento": "v160",
            "ValorVencimento": "20836.39"
          }
        ],
        "VariacaoCambial": "N",
        "Modalidade": "0901"
      },
      {
        "ListaDeVencimentos": [
          {
            "CodigoVencimento": "v140",
            "ValorVencimento": "7890.23"
          },
          {
            "CodigoVencimento": "v150",
            "ValorVencimento": "12431.41"
          },
          {
            "CodigoVencimento": "v160",
            "ValorVencimento": "26488.55"
          },
          {
            "CodigoVencimento": "v110",
            "ValorVencimento": "2783.22"
          },
          {
            "CodigoVencimento": "v170",
            "ValorVencimento": "6654.64"
          },
          {
            "CodigoVencimento": "v120",
            "ValorVencimento": "2743.55"
          },
          {
            "CodigoVencimento": "v130",
            "ValorVencimento": "2705.69"
          },
          {
            "CodigoVencimento": "v165",
            "ValorVencimento": "22368.40"
          }
        ],
        "VariacaoCambial": "N",
        "Modalidade": "0401"
      },
      {
        "ListaDeVencimentos": [
          {
            "CodigoVencimento": "v20",
            "ValorVencimento": "65000.00"
          }
        ],
        "VariacaoCambial": "N",
        "Modalidade": "1903"
      }
    ]
  },
  "score": 610,
  "restriction": {
    "texto": "Não possui débito.",
    "nome_core": "Flag Restritivos PF",
    "descricao_natureza": "SINISTRO",
    "modelo_score": "55",
    "texto2": "",
    "codigo_natureza_modelo": "104"
  },
  "qsa": {
    "_id": "0a0000b00000c0000d00e00f",
    "type": "",
    "status": "APROVADO",
    "report": "000000000000000000000000",
    "data": {},
    "images": {},
    "parameters": {
      "cnpj": "0123456789123"
    },
    "validations": [],
    "fraud": false,
    "createdAt": "2024-05-06T19:09:19.139Z",
    "updatedAt": "2024-05-06T19:09:23.147Z",
    "sections": {
      "pjData": {
        "statusCode": "01",
        "data": {
          "registrationNumber": "0123456789123",
          "openingDate": "01/01/2001",
          "officialName": "NOME DA EMPRESA",
          "fantasyName": "NOME FANTASIA",
          "companySize": "Demais empresas",
          "mainActivity": "000000 - Atividade Principal",
          "secondaryActivities": [
            {
              "code": "0123456",
              "description": "Descrição"
            }
          ],
          "companyEmail": "NOME@EMAIL.COM.BR",
          "phoneNumber": "(00) 0000000",
          "address": {
            "street": "ENDEREÇO",
            "number": "0",
            "complement": "COMPLEMENTO",
            "neighborhood": "SETOR",
            "zipCode": "00.000-000",
            "state": "UF",
            "city": "CIDADE"
          },
          "status": "ATIVA",
          "statusOrigin": "Receita Federal",
          "statusDate": "2016-01-28T00:00:00.000Z",
          "isMei": false,
          "legalNature": "0000 - NATUREZA LEGAL",
          "jointStock": "R$ 000.000,00",
          "QSA": [
            {
              "name": "NOME DA EMPRESA",
              "cpf": "",
              "function": "Sócio",
              "functionCode": "00",
              "isLegalRepresentative": true
            }
          ]
        }
      },
      "pjCompanyOwnersPercentage": {
        "statusCode": "01",
        "data": {
          "message": "Consulta realizada com sucesso",
          "companyShares": [
            {
              "cnpj": "0123456789123",
              "cpf": "01234567898",
              "corporateName": "NOME CORPORATIVO",
              "totalShare": ".00"
            }
          ]
        },
        "available": true
      }
    }
  }
}