API reference

Verify API

POST /credibility/verify: request and response reference.

POST https://api.iscredible.com/v1/credibility/verify

Checks one user or event and returns a decision.

Headers#

Header	Required	Value
`x-api-key`	Yes	Your API key
`content-type`	Yes	`application/json`

Body#

Field	Type	Description
`userData`	object, or array of up to 25 objects	The data to check. See Request fields. With an array, the response describes the first item.
`scenarioId`	string, optional	Run only this scenario, e.g. `SYS_DISPOSABLE_EMAIL_001`
`scenarioIds`	string[], optional	Run only these scenarios

Without scenarioId, every active scenario on your account runs; if you have none of your own, the built-in scenarios run. Add ?profileId=default to always use the built-in scenarios.

Example#

curl https://api.iscredible.com/v1/credibility/verify \
  -H "x-api-key: $ISCREDIBLE_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "userData": { "email": "jane@example.com", "ip": "203.0.113.7", "deviceId": "dev_8c1e2f", "accountCreation": true }
  }'

Response#

See Response for every field.

{
  "requestId": "6f3c8a6e-2b8e-4b6b-9b0e-7c1a5d2f9e10",
  "timestamp": "2026-06-01T12:00:00.000Z",
  "overallRecommendation": "APPROVE",
  "overallRiskScore": 0,
  "summary": "Approved. All 4 applicable scenarios passed.",
  "scenarioResults": [ ... ],
  "metadata": { "processedScenarios": 20, "applicableScenarios": 4, "dataItems": 1, "profileId": "user#..." }
}