Pular para o conteúdo principal
POST
SCR

Autorizações

Authorization
string
header
obrigatório

Credencial OAuth da Base39 com os escopos profile e user:org:read, ou chave de API pertencente à organização. A organização e o autor são obtidos da autenticação.

Corpo

application/json
document
string
obrigatório

CPF ou CNPJ completo, com ou sem pontuação.

Pattern: ^(?:\d{11}|\d{3}\.\d{3}\.\d{3}-\d{2}|[0-9A-Za-z]{12}\d{2}|[0-9A-Za-z]{2}\.[0-9A-Za-z]{3}\.[0-9A-Za-z]{3}\/[0-9A-Za-z]{4}-\d{2})$

Resposta

Objeto ou página de dados Base39; next_cursor ausente indica o fim da coleção.

object
string
obrigatório

Crédito em bancos informado no SCR.

Allowed value: "scr_report"
document
string
obrigatório

CPF ou CNPJ informado pela fonte; pode estar mascarado.

Minimum string length: 1
portfolio
object
obrigatório

Saldos da carteira de crédito.

institutions
integer

Quantidade de instituições.

Intervalo obrigatório: 0 <= x <= 9007199254740991
operations
integer

Quantidade de operações.

Intervalo obrigatório: 0 <= x <= 9007199254740991
relationships
string

Informação de relacionamentos bancários fornecida na consulta.

volume
string

Volume informado na consulta; preserve a unidade fornecida.

status
string

Situação da consulta informada pela fonte.

profile
string

Perfil de crédito bancário informado pela fonte.

score
string

Pontuação informada na consulta; não representa aprovação de crédito.

risk_class
string

Classe de risco informada pela fonte.

indices
object

Indicadores por modalidade; valores conforme informados.

category_percentages
object

Distribuição da carteira por categoria, conforme informada.

overdue_percentages
object

Distribuição dos vencidos por categoria, conforme informada.

maturity_percentages
object

Distribuição por prazo, conforme informada.

commitment_evolution
object

Evolução do compromisso por modalidade, conforme informada.