v1

latestOpenAPI 3.1.02026-08-043620.4 KB

Crédito

Detalhes de crédito - Quod

post/queries

Headers

Authorizationstring required

Access token do usuário com prefixo 'Bearer '

Request body

type'companies' required

Tipo da busca

key_type'cnpj' required

Tipo da chave de busca

key_valuestring required

Valor da chave de busca

datasetsstring[] (credit_details_quod) required

Lista de conjuntos de dados desejados

Example request

{
  "type": "companies",
  "key_type": "cnpj",
  "key_value": "**************",
  "datasets": [
    "credit_details_quod"
  ]
}

Response

Example response

{
  "status": {
    "code": 4000,
    "message": "Success"
  },
  "data": {
    "credit_details_quod": {
      "has_negative_debt_records": true,
      "has_notary_protests": true,
      "has_lawsuits": true,
      "has_credit_inquiries": true,
      "negative_debt_records": {
        "total_value": 12750.45,
        "total_active": 2,
        "total_inactive": 1,
        "last_record_date": "2026-06-15T00:00:00",
        "total_by_type": [
          {
            "type": "Operações com Cartão de Crédito",
            "total": 1
          }
        ],
        "items": [
          {
            "type": "Operações com Cartão de Crédito",
            "amount": 8250.45,
            "status": "active",
            "reference_date": "2026-06-15T00:00:00"
          }
        ]
      },
      "notary_protests": {
        "total": 1,
        "total_amount": 3200.75
      },
      "lawsuits": {
        "total": 1,
        "total_amount": 15000.5,
        "total_by_type": [
          {
            "type": "EXECUCAO DE TITULO EXTRAJUDICIAL",
            "total": 1
          }
        ],
        "items": [
          {
            "type": "EXECUCAO DE TITULO EXTRAJUDICIAL",
            "author": "BANCO EXEMPLO S/A",
            "justice_type": "ESTADUAL",
            "amount": 15000.5,
            "reference_date": "2025-09-20T00:00:00"
          }
        ]
      },
      "credit_inquiries": {
        "total_last_30_days": 1,
        "total_last_60_days": 2,
        "total_last_90_days": 3,
        "total_more_90_days": 5,
        "total_by_type": [
          {
            "type": "Instituições Financeiras",
            "total": 4
          }
        ],
        "conglomerate_companies": [
          {
            "tax_id": {
              "number": "**************"
            },
            "total_last_30_days": 1,
            "total_last_60_days": 2,
            "total_last_90_days": 3,
            "total_more_90_days": 5,
            "total_by_type": [
              {
                "type": "Instituições Financeiras",
                "total": 4
              }
            ]
          }
        ]
      }
    }
  }
}