Skip to main content
GET
Relatório completo (SCR)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Authorization
string | null

Path Parameters

document
string
required

CPF (11 dígitos) ou CNPJ (14), com ou sem máscara

Query Parameters

planId
integer<int64>
required

ID do plano (obtido pelas APIs de plano/saldo)

Response

Cache, plano sem permissão SCR, ou corpo de sucesso

HTTP 200: ou bloqueio por plano (PLAN_NOT_ALLOWED), ou sucesso a partir do cache (SUCCESS + source: cache).

status
enum<string>
required
Available options:
PLAN_NOT_ALLOWED
message
string
required
Example:

"Seu plano não permite acesso a este recurso"