DataBolsa docs
Referência da APIExtensõesCreditRegulamento

Propor um limiar extraído do regulamento

O termo nasce SEMPRE como `pending`, mesmo com confiança alta: só a revisão humana (`deskReviewRegulationTerm`) liga o alerta. Valores numéricos seguem a unidade do dado.

POST
/v1/desk/orgs/{org}/classes/{cnpj}/terms
AuthorizationBearer <token>

In: header

Path Parameters

orgstring

Id ou slug da organização (de deskGetMe).

cnpjstring

CNPJ da classe de FIDC ou do cedente, 14 dígitos.

termstring

Qual limiar do regulamento (chave do vocabulário fechado).

Value in"subordinacao_minima" | "inadimplencia_max" | "concentracao_cedente_max" | "revolvente" | "coobrigacao_cedente" | "taxa_administracao" | "taxa_performance" | "benchmark_alvo"
value_num?number | null

Valor numérico na unidade declarada (fração para razão; BRL; % a.a.).

value_text?string | null

Valor em texto quando o limiar não é numérico.

unit?string | null

Unidade do valor: ratio, brl, percent_year ou text.

Value in"ratio" | "brl" | "percent_year" | "text" | null
doc_id?string | null

Documento de onde o limiar foi lido (protocolo).

doc_page?integer | null

Página do documento.

quote?string | null

Trecho literal que sustenta o limiar.

confidence?number | null

Confiança da extração, de 0 a 1.

Range0 <= value <= 1

Response Body

curl -X POST "https://api.databolsa.com/v1/desk/orgs/string/classes/string/terms" \  -H "Content-Type: application/json" \  -d '{    "term": "subordinacao_minima"  }'
{
  "id": "string",
  "cnpj": "string",
  "term": "string",
  "label": "string",
  "value_num": 0,
  "value_text": "string",
  "unit": "string",
  "doc_id": "string",
  "doc_page": 0,
  "quote": "string",
  "confidence": 0,
  "status": "pending",
  "valid_from": "string",
  "valid_to": "string"
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string"
}