Fraud Prevention API

Version 0.1

The Fraud Prevention API is a set of APIs supporting Fraud detection including managing own fraud rules.

Download OpenAPI Specification

Available Operations

List SMS Burst Protection entries

gethttps://api.nexmo.com/v0.1/fraud-defender/protection-configuration/absolute-burst

Authentication

Key	Description	Where	Example
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Query Parameters

page

string

Default1

page offset parameter, starts from 1

page_size

string

Default150

page size parameter, starts from 1

Responses
Content Type
application/json

Successful operation

page

object

number

example2

Page number

size

number

example3

Page size number or 0 if no entries found. Default is 150.

totalElements

number

example11

Total entries for the result set or 0 if no entries found

totalPages

number

example4

Total pages for the paginated result set or 1 if no entries found

_embedded

object

entries

array

integer

example1

Internal ID, to be used as the ID when updating or deleting a record

destination_countries

array

List of destination countries

Available Values:

DZ,AZ,BD,BB,BY,BJ,BG,EG,SV,GH,KZ,KG,LA,MV,MM,NG,PH,PK,PS,RU,LK,SD,SY,TJ,AE,UZ,BH,IR,IQ,IL,JO,KW,LB,OM,QA,SA,YE,AM,KM,GE,ID,IT,TT

block_value

integer

example1

Number of messages allowed in the 10 minutes time period, after which messages will be blocked.

_links

object

self

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/protection-configuration/absolute-burst/1

link to fetch this individual entity directly

_links

object

first

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/protection-configuration/absolute-burst?page=0&size=100

first link of the paginated result set

last

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/protection-configuration/absolute-burst?page=4&size=100

last link of the paginated result set

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/protection-configuration/absolute-burst?page=0&size=100

previous link of the paginated result set

self

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/protection-configuration/absolute-burst?page=0&size=100

Example Response

{
   "page": {
      "number": 2,
      "size": 3,
      "totalElements": 11,
      "totalPages": 4
   },
   "_embedded": {
      "entries": [
         {
            "id": 1,
            "destination_countries": [
               "DZ"
            ],
            "block_value": 1,
            "_links": {
               "self": {
                  "href": "https://api.nexmo.com/v0.1/fraud-defender/protection-configuration/absolute-burst/1"
               }
            }
         }
      ]
   },
   "_links": {
      "first": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/protection-configuration/absolute-burst?page=0&size=100"
      },
      "last": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/protection-configuration/absolute-burst?page=4&size=100"
      },
      "prev": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/protection-configuration/absolute-burst?page=0&size=100"
      },
      "self": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/protection-configuration/absolute-burst?page=0&size=100"
      }
   }
}

Create new SMS Burst Protection entity

posthttps://api.nexmo.com/v0.1/fraud-defender/protection-configuration/absolute-burst

Authentication

Key	Description	Where	Example
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Request Body
Content Type
application/json

destination_countries

array

Required

Available Values:

block_value

integer

Required

example1

Number of messages allowed in the 10 minutes time period, after which messages will be blocked.

Example Request

{
   "destination_countries": [
      "DZ"
   ],
   "block_value": 1
}

{
   "destination_countries": [
      "DZ"
   ],
   "block_value": 1
}

Responses
Content Type
application/json

Successful operation

integer

example1

Internal ID, to be used as the ID when updating or deleting a record

destination_countries

array

List of destination countries

Available Values:

block_value

integer

example1

Number of messages allowed in the 10 minutes time period, after which messages will be blocked.

_links

object

self

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/protection-configuration/absolute-burst/1

link to fetch this individual entity directly

Example Response

{
   "id": 1,
   "destination_countries": [
      "DZ"
   ],
   "block_value": 1,
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/protection-configuration/absolute-burst/1"
      }
   }
}

Get SMS Burst Protection rule by ID

gethttps://api.nexmo.com/v0.1/fraud-defender/protection-configuration/absolute-burst/:id

Authentication

Key	Description	Where	Example
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Path Parameters

integer(int64)

Required

The ID of the entry to be fetched, this id can be retrieved from the list of entries and use the field called id.

Responses
Content Type
application/json

Successful operation

integer

example1

Internal ID, to be used as the ID when updating or deleting a record

destination_countries

array

List of destination countries

Available Values:

block_value

integer

example1

Number of messages allowed in the 10 minutes time period, after which messages will be blocked.

_links

object

self

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/protection-configuration/absolute-burst/1

link to fetch this individual entity directly

Example Response

{
   "id": 1,
   "destination_countries": [
      "DZ"
   ],
   "block_value": 1,
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/protection-configuration/absolute-burst/1"
      }
   }
}

Delete SMS Burst Protection entity by id

deletehttps://api.nexmo.com/v0.1/fraud-defender/protection-configuration/absolute-burst/:id

Authentication

Key	Description	Where	Example
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Path Parameters

integer(int64)

Required

The ID of the entry to be deleted.

Responses

Entry deleted

Edit an existing SMS Burst Protection rule

puthttps://api.nexmo.com/v0.1/fraud-defender/protection-configuration/absolute-burst/:id

Authentication

Key	Description	Where	Example
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Path Parameters

integer(int64)

Required

The ID of the entry to be modified.

Request Body
Content Type
application/json

destination_countries

array

Required

Available Values:

block_value

integer

Required

example1

Number of messages allowed in the 10 minutes time period, after which messages will be blocked.

Example Request

{
   "destination_countries": [
      "DZ"
   ],
   "block_value": 1
}

{
   "destination_countries": [
      "DZ"
   ],
   "block_value": 1
}

Responses
Content Type
application/json

Successful operation

integer

example1

Internal ID, to be used as the ID when updating or deleting a record

destination_countries

array

List of destination countries

Available Values:

block_value

integer

example1

Number of messages allowed in the 10 minutes time period, after which messages will be blocked.

_links

object

self

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/protection-configuration/absolute-burst/1

link to fetch this individual entity directly

Example Response

{
   "id": 1,
   "destination_countries": [
      "DZ"
   ],
   "block_value": 1,
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/protection-configuration/absolute-burst/1"
      }
   }
}

List custom fraud rules

gethttps://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/:product

Authentication

Key	Description	Where	Example
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Path Parameters

product

string

Required

Must be one of:SMSVOICE

Query Parameters

page_size

integer(int32)

Default100

Page size in Integer format

page

integer(int32)

Default1

Page number in Integer format

threshold

integer(int32)

Threshold value in Integer format

interval

integer(int32)

Interval value in Integer format it will be presented in minutes

countries

array

Array of ISO countries codes

Responses
Content Type
application/json

page

integer(int32)

page_size

integer(int32)

total_pages

integer(int32)

total_items

integer(int32)

_embedded

object

entries

array

country

string

interval

integer(int32)

threshold

integer(int32)

product

string

_links

object

self

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/SMS/e21ace94-54fa-4365-a824-38033dc06779

self link

_links

object

first

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/SMS?page=0&size=100

first link of the paginated result set

last

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/SMS?page=4&size=100

last link of the paginated result set

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/SMS?page=0&size=100

previous link of the paginated result set

self

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/SMS?page=0&size=100

Example Response

{
   "page": 0,
   "page_size": 0,
   "total_pages": 0,
   "total_items": 0,
   "_embedded": {
      "entries": [
         {
            "country": "string",
            "interval": 0,
            "threshold": 0,
            "product": "string",
            "id": "string",
            "_links": {
               "self": {
                  "href": "https://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/SMS/e21ace94-54fa-4365-a824-38033dc06779"
               }
            }
         }
      ]
   },
   "_links": {
      "first": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/SMS?page=0&size=100"
      },
      "last": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/SMS?page=4&size=100"
      },
      "prev": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/SMS?page=0&size=100"
      },
      "self": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/SMS?page=0&size=100"
      }
   }
}

Edit custom fraud rule by ID

puthttps://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/:id

Authentication

Key	Description	Where	Example
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Path Parameters

Request Body
Content Type
application/json

product

Product type (SMS or VOICE)

country

string

ISO country code

interval

integer(int32)

threshold

integer(int32)

Example Request

{
   "product": null,
   "country": "string",
   "interval": 0,
   "threshold": 0
}

{
   "product": null,
   "country": "string",
   "interval": 0,
   "threshold": 0
}

Responses
Content Type
application/json

country

string

interval

integer(int32)

threshold

integer(int32)

product

string

_links

object

self

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/SMS/e21ace94-54fa-4365-a824-38033dc06779

self link

Example Response

{
   "country": "string",
   "interval": 0,
   "threshold": 0,
   "product": "string",
   "id": "string",
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/SMS/e21ace94-54fa-4365-a824-38033dc06779"
      }
   }
}

Create custom fraud rule

posthttps://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules

Authentication

Key	Description	Where	Example
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Request Body
Content Type
application/json

product

Product type (SMS or VOICE)

country

string

ISO country code

interval

integer(int32)

threshold

integer(int32)

Example Request

{
   "product": null,
   "country": "string",
   "interval": 0,
   "threshold": 0
}

{
   "product": null,
   "country": "string",
   "interval": 0,
   "threshold": 0
}

Responses
Content Type
application/json

Created

country

string

interval

integer(int32)

threshold

integer(int32)

product

string

_links

object

self

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/SMS/e21ace94-54fa-4365-a824-38033dc06779

self link

Example Response

{
   "country": "string",
   "interval": 0,
   "threshold": 0,
   "product": "string",
   "id": "string",
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/SMS/e21ace94-54fa-4365-a824-38033dc06779"
      }
   }
}

Get custom fraud rule by product and id

gethttps://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/:product/:id

Authentication

Key	Description	Where	Example
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Path Parameters

product

string

Required

Must be one of:SMSVOICE

string

Required

Rule ID in UUID format

Responses
Content Type
application/json

country

string

interval

integer(int32)

threshold

integer(int32)

product

string

_links

object

self

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/SMS/e21ace94-54fa-4365-a824-38033dc06779

self link

Example Response

{
   "country": "string",
   "interval": 0,
   "threshold": 0,
   "product": "string",
   "id": "string",
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/SMS/e21ace94-54fa-4365-a824-38033dc06779"
      }
   }
}

Delete custom fraud rule by ID

deletehttps://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/:product/:id

Authentication

Key	Description	Where	Example
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Path Parameters

product

string

Required

Must be one of:SMSVOICE

string

Required

Rule ID in UUID format

Responses

No Content

Get AIT configuration

gethttps://api.nexmo.com/v0.1/fraud-defender/configurations/protections/ait/:product

Authentication

Key	Description	Where	Example
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Path Parameters

product

string

Required

Defaultsms

product type

Must be one of:sms

Responses
Content Type
application/json

AIT protection config response

data

object

protection_enabled

boolean

Required

exampletrue

used to turn on/off AIT protection

default_protection_level

string

examplestandard

Required if protection_enabled is set to true. Default AIT protection level will be used for countries where no specific per-country configuration exists.

Must be one of:highstandardnone

protection_level_per_country

array

array of specific per-country AIT protection level configurations

country

string

Required

exampleUS

country code in ISO 3166-1 Alpha-2 standard

protection_level

string

Required

examplehigh

AIT protection level

Must be one of:highstandardnone

_links

object

self

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/configurations/protections/ait/SMS

Example Response

{
   "data": {
      "protection_enabled": true,
      "default_protection_level": "standard",
      "protection_level_per_country": [
         {
            "country": "US",
            "protection_level": "standard"
         }
      ],
      "_links": {
         "self": {
            "href": "https://api.nexmo.com/v0.1/fraud-defender/configurations/protections/ait/SMS"
         }
      }
   }
}

Create or update AIT configuration

puthttps://api.nexmo.com/v0.1/fraud-defender/configurations/protections/ait/:product

Authentication

Key	Description	Where	Example
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Path Parameters

product

string

Required

Defaultsms

product type

Must be one of:sms

Request Body
Content Type
application/json

data

object

protection_enabled

boolean

Required

exampletrue

used to turn on/off AIT protection

default_protection_level

string

examplestandard

Required if protection_enabled is set to true. Default AIT protection level will be used for countries where no specific per-country configuration exists.

Must be one of:highstandardnone

protection_level_per_country

array

array of specific per-country AIT protection level configurations

country

string

Required

exampleUS

country code in ISO 3166-1 Alpha-2 standard

protection_level

string

Required

examplehigh

AIT protection level

Must be one of:highstandardnone

Example Request

{
   "data": {
      "protection_enabled": true,
      "default_protection_level": "standard",
      "protection_level_per_country": [
         {
            "country": "US",
            "protection_level": "high"
         }
      ]
   }
}

{
   "data": {
      "protection_enabled": true,
      "default_protection_level": "standard",
      "protection_level_per_country": [
         {
            "country": "US",
            "protection_level": "high"
         }
      ]
   }
}

Responses
Content Type
application/json

AIT protection config response

data

object

protection_enabled

boolean

Required

exampletrue

used to turn on/off AIT protection

default_protection_level

string

examplestandard

Required if protection_enabled is set to true. Default AIT protection level will be used for countries where no specific per-country configuration exists.

Must be one of:highstandardnone

protection_level_per_country

array

array of specific per-country AIT protection level configurations

country

string

Required

exampleUS

country code in ISO 3166-1 Alpha-2 standard

protection_level

string

Required

examplehigh

AIT protection level

Must be one of:highstandardnone

_links

object

self

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/configurations/protections/ait/SMS

Example Response

{
   "data": {
      "protection_enabled": true,
      "default_protection_level": "standard",
      "protection_level_per_country": [
         {
            "country": "US",
            "protection_level": "standard"
         }
      ],
      "_links": {
         "self": {
            "href": "https://api.nexmo.com/v0.1/fraud-defender/configurations/protections/ait/SMS"
         }
      }
   }
}

Create rule

posthttps://api.nexmo.com/v0.1/fraud-defender/rules

Authentication

Key	Description	Where	Example
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Request Body
Content Type
application/json

product

string

Required

examplesms

Must be one of:voicesms

prefix

string

Required

Max15

example44

The prefix attribute is used to check whether a phone number begins with a particular sequence of digits. It's not related to phone number prefixes.

reason

string

Required

exampleMy custom prefix rule

Human readable reason

action

string

Required

Must be one of:blockallow

status

string

Must be one of:activearchived

Example Request

{
   "product": "sms",
   "prefix": "44",
   "reason": "My custom prefix rule",
   "action": "block",
   "status": "active"
}

{
   "product": "sms",
   "prefix": "44",
   "reason": "My custom prefix rule",
   "action": "block",
   "status": "active"
}

Responses
Content Type
application/json

rule creation success

string

exampletest-id

product

string

examplesms

Must be one of:voicesms

prefix

string

example44

The prefix attribute is used to check whether a phone number begins with a particular sequence of digits. It's not related to phone number prefixes.

direction

string

examplefrom

Must be one of:fromto

traffic_direction

string

Defaultoutbound

Outbound rules apply to traffic generated from you API Key. Inbound rules apply to traffic sent to your phone numbers.

action

string

exampleblock

Must be one of:blockallow

reason

string

exampleMy custom prefix rule

Human readable reason

permission

string

exampleedit

Must be one of:viewedit

status

string

exampleactive

Must be one of:activearchived

created_timestamp

string

example2022-12-09T18:19:26

updated_timestamp

string

example2022-11-09T18:19:26

archived_timestamp

string

example2022-10-09T18:19:26

_links

object

self

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/rules/test-id

Example Response

{
   "id": "test-id",
   "product": "sms",
   "prefix": "44",
   "direction": "from",
   "traffic_direction": "outbound",
   "action": "block",
   "reason": "My custom prefix rule",
   "permission": "edit",
   "status": "active",
   "created_timestamp": "2022-12-09T18:19:26",
   "updated_timestamp": "2022-11-09T18:19:26",
   "archived_timestamp": "2022-10-09T18:19:26",
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/rules/test-id"
      }
   }
}

Listing rules

gethttps://api.nexmo.com/v0.1/fraud-defender/rules

Authentication

Key	Description	Where	Example
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Query Parameters

product

string

if passed, lists rules for that product. if not, gives such for all product types

Must be one of:voicesms

prefix

string

phone prefix filter

reason

string

reason filter

action

string

action filter

rule_type

string

rule type filter (allow, block)

status

string

filter rules by status (active, archived, all)

show_default_rules

boolean

Defaulttrue

defines whether to display default rules or not

show_custom_rules

boolean

Defaulttrue

show custom rules flag

page_size

string

Default150

page size parameter, starts from 1

page

string

Default1

page offset parameter, starts from 1

sort

string

sort by product, prefix or traffic and it's case-insensitive

Must be one of:productprefixtraffic

order

string

Defaultdesc

sort order either asc or desc and it's case-insensitive

Must be one of:ascdesc

Responses
Content Type
application/json

rule listing success

_links

object

first

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/rules?order=asc&page=1&page_size=3

first link of the paginated result set

last

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/rules?order=asc&page=4&page_size=3

last link of the paginated result set

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/rules?order=asc&page=3&page_size=3

next link of the paginated result set

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/rules?order=asc&page=1&page_size=3

previous link of the paginated result set

self

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/rules?order=asc&page=2&page_size=3

page

object

number

example2

Page number

size

number

example3

Page size number or 0 if no entries found. Default is 150.

totalElements

number

example11

Total entries for the result set or 0 if no entries found

totalPages

number

example4

Total pages for the paginated result set or 1 if no entries found

_embedded

object

rules

array

string

exampletest-id

product

string

examplesms

Must be one of:voicesms

prefix

string

example44

The prefix attribute is used to check whether a phone number begins with a particular sequence of digits. It's not related to phone number prefixes.

direction

string

examplefrom

Must be one of:fromto

traffic_direction

string

Defaultoutbound

Outbound rules apply to traffic generated from you API Key. Inbound rules apply to traffic sent to your phone numbers.

action

string

exampleblock

Must be one of:blockallow

reason

string

exampleMy custom prefix rule

Human readable reason

permission

string

exampleedit

Must be one of:viewedit

status

string

exampleactive

Must be one of:activearchived

created_timestamp

string

example2022-12-09T18:19:26

updated_timestamp

string

example2022-11-09T18:19:26

archived_timestamp

string

example2022-10-09T18:19:26

_links

object

self

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/rules/test-id

Example Response

{
   "_links": {
      "first": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/rules?order=asc&page=1&page_size=3"
      },
      "last": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/rules?order=asc&page=4&page_size=3"
      },
      "next": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/rules?order=asc&page=3&page_size=3"
      },
      "prev": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/rules?order=asc&page=1&page_size=3"
      },
      "self": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/rules?order=asc&page=2&page_size=3"
      }
   },
   "page": {
      "number": 2,
      "size": 3,
      "totalElements": 11,
      "totalPages": 4
   },
   "_embedded": {
      "rules": [
         {
            "id": "test-id",
            "product": "sms",
            "prefix": "44",
            "direction": "from",
            "traffic_direction": "outbound",
            "action": "block",
            "reason": "My custom prefix rule",
            "permission": "edit",
            "status": "active",
            "created_timestamp": "2022-12-09T18:19:26",
            "updated_timestamp": "2022-11-09T18:19:26",
            "archived_timestamp": "2022-10-09T18:19:26",
            "_links": {
               "self": {
                  "href": "https://api.nexmo.com/v0.1/fraud-defender/rules/test-id"
               }
            }
         }
      ]
   }
}

Get rule by id

gethttps://api.nexmo.com/v0.1/fraud-defender/rules/:id

Authentication

Key	Description	Where	Example
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Path Parameters

string

Required

Responses
Content Type
application/json

rule obtained

string

exampletest-id

product

string

examplesms

Must be one of:voicesms

prefix

string

example44

The prefix attribute is used to check whether a phone number begins with a particular sequence of digits. It's not related to phone number prefixes.

direction

string

examplefrom

Must be one of:fromto

traffic_direction

string

Defaultoutbound

Outbound rules apply to traffic generated from you API Key. Inbound rules apply to traffic sent to your phone numbers.

action

string

exampleblock

Must be one of:blockallow

reason

string

exampleMy custom prefix rule

Human readable reason

permission

string

exampleedit

Must be one of:viewedit

status

string

exampleactive

Must be one of:activearchived

created_timestamp

string

example2022-12-09T18:19:26

updated_timestamp

string

example2022-11-09T18:19:26

archived_timestamp

string

example2022-10-09T18:19:26

_links

object

self

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/rules/test-id

Example Response

{
   "id": "test-id",
   "product": "sms",
   "prefix": "44",
   "direction": "from",
   "traffic_direction": "outbound",
   "action": "block",
   "reason": "My custom prefix rule",
   "permission": "edit",
   "status": "active",
   "created_timestamp": "2022-12-09T18:19:26",
   "updated_timestamp": "2022-11-09T18:19:26",
   "archived_timestamp": "2022-10-09T18:19:26",
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/rules/test-id"
      }
   }
}

Archive rule by id

deletehttps://api.nexmo.com/v0.1/fraud-defender/rules/:id

Authentication

Key	Description	Where	Example
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Path Parameters

string

Required

Responses

rule archived

Update rule by id

patchhttps://api.nexmo.com/v0.1/fraud-defender/rules/:id

Authentication

Key	Description	Where	Example
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Path Parameters

string

Required

Request Body
Content Type
application/json

reason

string

Required

exampleMy custom prefix rule

Human readable reason

Example Request

{
   "reason": "My custom prefix rule"
}

{
   "reason": "My custom prefix rule"
}

Responses
Content Type
application/json

rule updated

string

exampletest-id

product

string

examplesms

Must be one of:voicesms

prefix

string

example44

The prefix attribute is used to check whether a phone number begins with a particular sequence of digits. It's not related to phone number prefixes.

direction

string

examplefrom

Must be one of:fromto

traffic_direction

string

Defaultoutbound

Outbound rules apply to traffic generated from you API Key. Inbound rules apply to traffic sent to your phone numbers.

action

string

exampleblock

Must be one of:blockallow

reason

string

exampleMy custom prefix rule

Human readable reason

permission

string

exampleedit

Must be one of:viewedit

status

string

exampleactive

Must be one of:activearchived

created_timestamp

string

example2022-12-09T18:19:26

updated_timestamp

string

example2022-11-09T18:19:26

archived_timestamp

string

example2022-10-09T18:19:26

_links

object

self

object

href

string

examplehttps://api.nexmo.com/v0.1/fraud-defender/rules/test-id

Example Response

{
   "id": "test-id",
   "product": "sms",
   "prefix": "44",
   "direction": "from",
   "traffic_direction": "outbound",
   "action": "block",
   "reason": "My custom prefix rule",
   "permission": "edit",
   "status": "active",
   "created_timestamp": "2022-12-09T18:19:26",
   "updated_timestamp": "2022-11-09T18:19:26",
   "archived_timestamp": "2022-10-09T18:19:26",
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/rules/test-id"
      }
   }
}

Errors

The following is a non-exhaustive list of error codes that may occur while using this API.

These codes are in addition to any of our generic error codes.

Code	Information
http:error:conflict	Rule couldn't be added as conflicts with currently existing rules
system:error:internal-error	Something went wrong.

Fraud Prevention API

Available Operations

List SMS Burst Protection entries

Authentication

Query Parameters

Responses Content Typeapplication/json

Example Response

Create new SMS Burst Protection entity

Authentication

Request Body Content Typeapplication/json

Example Request

Responses Content Typeapplication/json

Example Response

Get SMS Burst Protection rule by ID

Authentication

Path Parameters

Responses Content Typeapplication/json

Example Response

Delete SMS Burst Protection entity by id

Authentication

Path Parameters

Responses

Edit an existing SMS Burst Protection rule

Authentication

Path Parameters

Request Body Content Typeapplication/json

Example Request

Responses Content Typeapplication/json

Example Response

List custom fraud rules

Authentication

Path Parameters

Query Parameters

Responses Content Typeapplication/json

Example Response

Edit custom fraud rule by ID

Authentication

Path Parameters

Request Body Content Typeapplication/json

Example Request

Responses Content Typeapplication/json

Example Response

Create custom fraud rule

Authentication

Request Body Content Typeapplication/json

Example Request

Responses Content Typeapplication/json

Example Response

Get custom fraud rule by product and id

Authentication

Path Parameters

Responses Content Typeapplication/json

Example Response

Delete custom fraud rule by ID

Authentication

Path Parameters

Responses

Get AIT configuration

Authentication

Path Parameters

Responses Content Typeapplication/json

Example Response

Create or update AIT configuration

Authentication

Path Parameters

Request Body Content Typeapplication/json

Example Request

Responses Content Typeapplication/json

Example Response

Create rule

Authentication

Request Body Content Typeapplication/json

Example Request

Responses Content Typeapplication/json

Example Response

Listing rules

Authentication

Query Parameters

Responses Content Typeapplication/json

Example Response

Responses
Content Type
application/json

Request Body
Content Type
application/json

Responses
Content Type
application/json

Responses
Content Type
application/json

Request Body
Content Type
application/json

Responses
Content Type
application/json

Responses
Content Type
application/json

Request Body
Content Type
application/json

Responses
Content Type
application/json

Request Body
Content Type
application/json

Responses
Content Type
application/json

Responses
Content Type
application/json

Responses
Content Type
application/json

Request Body
Content Type
application/json

Responses
Content Type
application/json

Request Body
Content Type
application/json

Responses
Content Type
application/json

Responses
Content Type
application/json

Responses
Content Type
application/json

Request Body
Content Type
application/json

Responses
Content Type
application/json