Assess API catalog (pay-in) - Clausum

GET

/

api

/

v1

/

assess

Assess API catalog (pay-in)

curl --request GET \
  --url https://sandbox.clausum.ai/api/v1/assess

{
  "status": "ok",
  "version": "1.3.0",
  "amount": {},
  "field_requirements_by_segment": {},
  "resilience": {}
}

Response

200 - application/json

Catalog metadata

status

string

Example:

"ok"

version

string

Example:

"1.3.0"

amount

object

field_requirements_by_segment

object

resilience

object

Assess transaction riskScores a transaction or session in real time and returns a decision (`approve`, `review`, `challenge`, or `decline`). Call this before you capture a payment or complete a sensitive action. Authenticate with a secret API key (`clm_sk_...`); a publishable key (`clm_pub_...`) may be used from the browser SDK. **Field requirements by organization segment** (`comercio`, `psp`, `banco`): always `amount` + `currency`; PSP requires explicit `submerchant_id`; merchant recommends `order_id`, `device.ip` (server), payer identity. See `GET /api/v1/assess` → `field_requirements_by_segment` and docs `MERCHANT_INTEGRATION.md#assess-fields-by-segment`. Missing recommended fields may appear in `field_warnings` without failing the request. **Payment gateways:** Clausum does not POST decisions to Stripe or other PSPs. Your backend calls assess, then your backend calls the PSP capture API.

Assess API catalog (pay-in)

curl --request GET \
  --url https://sandbox.clausum.ai/api/v1/assess

{
  "status": "ok",
  "version": "1.3.0",
  "amount": {},
  "field_requirements_by_segment": {},
  "resilience": {}
}