Get a rule

Create and manage workspace rules that guide the fraud engine.

GET /api/v1/rules/{id}/

Error

A valid request URL is required to generate request examples

200

{
  "id": "<string>",
  "created_at": "<string>",
  "title": "<string>",
  "condition": "<string>",
  "guidance": "<string>",
  "score_delta": 123,
  "document_types": [
    "<string>"
  ],
  "object": "rule",
  "document_descriptions": [
    "<string>"
  ],
  "document_subtypes": [
    "<string>"
  ]
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Paste your workspace API key from Settings. Sent as Authorization: Bearer .

Path Parameters

id · string · required

The rule id, e.g. rule_9f2c4b1e8a7d4c3fb2e1d0a9c8b7a6f5.

Response

200

application/json

The rule.

id · string · required

Prefixed id, e.g. rule_9f2c….

created_at · string · required

status · enum<string> · required

• active - active
• disabled - disabled

Available options: active, disabled

title · string · required

condition · string · required

guidance · string · required

outcome_guidance · enum<string> · required

• ACCEPTED - ACCEPTED
• REJECTED - REJECTED
• PENDING - PENDING
• ADVISORY - ADVISORY

Available options: ACCEPTED, REJECTED, PENDING, ADVISORY

score_delta · integer · required

Added to risk_score when the rule triggers.

document_types · string[] · required

object · string · default: rule

document_descriptions · string[]

document_subtypes · string[]