SEON user docs logoSEON user docs logoSEON user docs logo
Search input icon

Self Exclusion API

Online gambling operators can enable self-exclusion lists using our bespoke API if required by law. The API uses the email address, phone number, full name, date of birth, user country, and user zip fields.

Good to know

  • Identify users with their email addresses or User IDs.
  • Use PUT request to exclude users, and use DELETE request to reverse the exclusion.
  • All SEON API requests are case-sensitive. Please follow the formatting below to avoid errors.

Request

Request Attributes

TypeRequired
user_ids
array No
emails
array No

HTTP Endpoint

PUT

https://api.seon.io/SeonRestService/fraud-api/exclude/v1
PHP
Generic
Generic

Response

The endpoint returns JSON structured response.

JSON Attributes

Type
created_id_rules
object map
created_email_rules
object map
failed_ids
object
failed_emails
object
Response
{
 "success": true,
 "error": {},
 "data": {
  "created_id_rules": {
   "id1": {
    "id": "1000001",
    "name": "Exclude customer [id: 123]",
    "operation": "DECLINE",
    "score": 100
   }
  },
  "created_email_rules": {
   "example1@example.com": {
    "id": "100000",
    "name": "Exclude customer [email: example1@example.com]",
    "operation": "DECLINE",
    "score": 100
   }
  },
  "failed_ids": {},
  "failed_emails": {}
 }
}

Delete request

JSON Attributes

TypeRequired
user_ids
array no
emails
array no

HTTP Endpoint

DELETE

https://api.seon.io/SeonRestService/fraud-api/exclude/v1
PHP
Generic
Generic

Delete response

The endpoint returns JSON structured response.

JSON Attributes 

Type
created_id_rules
object map
created_email_rules
object map
failed_ids
object
failed_emails
object
Response
{
  "success": true,
  "error": {},
  "data": {
    "deleted_id_rules": {
        "deleted_id_rules": [
            "1000000 - Exclude customer [id: id1]",
            "1000001 - Exclude customer [id: id2]",
        ],
        "deleted_email_rules": [
            "1000002 - Exclude customer [email: example1@example.com]",
            "1000003 - Exclude customer [email: example2@example.com]"
        ],
        "failed_ids": [],
        "failed_emails": []
    }
}