Fraud Check Completed

POST

Triggered when a Fraud Detection request is completed

Authorizations

• token

Request Body ^required

Media type application/json

object

id

Unique entity UUID

string

/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

api_version

Version of the notification webhook data structure

string

name

Webhook’s event name

string

created_at

Timestamp when the entity was added to the system by the user

integer

attempt_total

Total number of notification webhook delivery attempts

integer

>= 1 <= 4

attempt_number

Current webhook notification attempt number

integer

>= 1

data

Event-specific data payload

object

notification_task_id

Notification task identifier (request identifier)

string format: uuid

name

Allowed values: fraud-check.done

data

Data for fraud-check.done events

object

key

additional properties

any

Examples

Example completed

Fraud Check Done Event

Event sent when fraud detection check is completed

{
  "id": "a7bc0d53-2ab6-822c-df31-a1284b5f8ea2",
  "api_version": "2022-05-25",
  "name": "fraud-check.done",
  "created_at": 1653379003,
  "attempt_total": 1,
  "attempt_number": 1,
  "data": {
    "check_id": "fraud-check-123",
    "result": "clean",
    "confidence_score": 0.95
  },
  "notification_task_id": "7712ab27-cd00-8ef2-da5d-6f54f85ff085"
}

Responses

200

Webhook received

400

Invalid webhook request’s body structure

401

Webhook request unauthorized

403

Webhook access forbidden

404

Webhook access forbidden

500

Server error