SCR — Relatório completo

Consulta ao SCR via integração Procrédito — produto relatório completo. Requer Bearer token e query planId. O plano deve ter SCR habilitado e o usuário deve pertencer à organização dona do plano.

GET /v1/scr/full/{document}

Relatório completo (SCR)

cURL

curl --request GET \
  --url https://search.tratum.com.br/v1/scr/full/{document} \
  --header 'Authorization: Bearer <token>'

200

{
  "message": "Seu plano não permite acesso a este recurso"
}

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

200

application/json

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

Option 1

Option 2

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"