Fraud Prevention API

Version 1

The Fraud Prevention API is a set of APIs supporting Fraud detection including managing own fraud rules. For more details, please visit the Vonage Developer Center.

OpenAPI-Spezifikation herunterladen

SMS Burst Protection

Operations to manage limits on SMS traffic bursts to prevent fraud.

Verfügbare Operationen

List SMS Burst Protection entries

Retrieve a paginated list of all SMS Burst Protection configurations.

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

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Abfrage Parameter

page

integer

Standard1

page offset parameter, starts from 1

page_size

integer

Standard150

page size parameter, starts from 1

Antworten
Inhalt Typ
application/json

Successful operation

page

object

number

Beispiel2

Page number

size

number

Beispiel3

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

totalElements

number

Beispiel11

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

totalPages

number

Beispiel4

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

_embedded

object

entries

array

string

Beispielabcdef01-2345-6789-abcd-ef0123456789

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

destination_countries

array

List of destination countries

Verfügbare Werte:

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

block_value

integer

Beispiel1

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

_links

object

self

object

href

string

Beispielhttps://api.nexmo.com/v1/fraud-defender/protection-configuration/absolute-burst/abcdef01-2345-6789-abcd-ef0123456789

link to fetch this individual entity directly

_links

object

first

object

href

string

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

first link of the paginated result set

last

object

href

string

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

last link of the paginated result set

object

href

string

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

previous link of the paginated result set

self

object

href

string

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

Beispiel Antwort

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

Create new SMS Burst Protection entity

Defines a new burst protection limit for a specific set of destination countries.

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

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Anfrage Körper
Inhalt Typ
application/json

destination_countries

array

Erforderlich

Verfügbare Werte:

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

block_value

integer

Erforderlich

Beispiel1

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

Beispiel Anfrage

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

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

Antworten
Inhalt Typ
application/json

Successful operation

string

Beispielabcdef01-2345-6789-abcd-ef0123456789

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

destination_countries

array

List of destination countries

Verfügbare Werte:

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

block_value

integer

Beispiel1

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

_links

object

self

object

href

string

Beispielhttps://api.nexmo.com/v1/fraud-defender/protection-configuration/absolute-burst/abcdef01-2345-6789-abcd-ef0123456789

link to fetch this individual entity directly

Beispiel Antwort

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

Get SMS Burst Protection rule by ID

Fetch a specific burst protection entry using its unique identifier.

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

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Pfad Parameter

string

Erforderlich

Beispielabcdef01-2345-6789-abcd-ef0123456789

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

Antworten
Inhalt Typ
application/json

Successful operation

string

Beispielabcdef01-2345-6789-abcd-ef0123456789

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

destination_countries

array

List of destination countries

Verfügbare Werte:

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

block_value

integer

Beispiel1

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

_links

object

self

object

href

string

Beispielhttps://api.nexmo.com/v1/fraud-defender/protection-configuration/absolute-burst/abcdef01-2345-6789-abcd-ef0123456789

link to fetch this individual entity directly

Beispiel Antwort

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

Edit an existing SMS Burst Protection rule

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

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Pfad Parameter

string

Erforderlich

Beispielabcdef01-2345-6789-abcd-ef0123456789

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

Anfrage Körper
Inhalt Typ
application/json

destination_countries

array

Erforderlich

Verfügbare Werte:

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

block_value

integer

Erforderlich

Beispiel1

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

Beispiel Anfrage

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

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

Antworten
Inhalt Typ
application/json

Successful operation

string

Beispielabcdef01-2345-6789-abcd-ef0123456789

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

destination_countries

array

List of destination countries

Verfügbare Werte:

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

block_value

integer

Beispiel1

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

_links

object

self

object

href

string

Beispielhttps://api.nexmo.com/v1/fraud-defender/protection-configuration/absolute-burst/abcdef01-2345-6789-abcd-ef0123456789

link to fetch this individual entity directly

Beispiel Antwort

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

Delete SMS Burst Protection entity by id

Remove an SMS burst protection entry from the system.

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

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Pfad Parameter

string

Erforderlich

Beispielabcdef01-2345-6789-abcd-ef0123456789

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

Antworten

No Content

Custom Fraud Rules

Operations to manage thresholds and intervals for custom fraud detection logic.

Verfügbare Operationen

List custom fraud rules

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

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Pfad Parameter

product

string

Erforderlich

Muss eines der folgenden sein:SMSVOICE

Abfrage Parameter

page_size

integer(int32)

Standard100

Page size in Integer format

page

integer(int32)

Standard1

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

Antworten
Inhalt Typ
application/json

page

integer(int32)

Beispiel1

page_size

integer(int32)

Beispiel100

total_pages

integer(int32)

Beispiel5

total_items

integer(int32)

Beispiel450

_embedded

object

entries

array

country

string

BeispielGB

interval

integer(int32)

Beispiel60

threshold

integer(int32)

Beispiel100

product

string

BeispielSMS

string

Beispielabcdef01-2345-6789-abcd-ef0123456789

_links

object

self

object

href

string

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

self link

_links

object

first

object

href

string

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

first link of the paginated result set

last

object

href

string

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

last link of the paginated result set

object

href

string

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

previous link of the paginated result set

self

object

href

string

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

self link

Beispiel Antwort

{
   "page": 1,
   "page_size": 100,
   "total_pages": 5,
   "total_items": 450,
   "_embedded": {
      "entries": [
         {
            "country": "GB",
            "interval": 60,
            "threshold": 100,
            "product": "SMS",
            "id": "abcdef01-2345-6789-abcd-ef0123456789",
            "_links": {
               "self": {
                  "href": "https://api.nexmo.com/v1/fraud-defender/configuration/custom-rules/SMS/e21ace94-54fa-4365-a824-38033dc06779"
               }
            }
         }
      ]
   },
   "_links": {
      "first": {
         "href": "https://api.nexmo.com/v1/fraud-defender/configuration/custom-rules/SMS?page=1&size=100"
      },
      "last": {
         "href": "https://api.nexmo.com/v1/fraud-defender/configuration/custom-rules/SMS?page=4&size=100"
      },
      "prev": {
         "href": "https://api.nexmo.com/v1/fraud-defender/configuration/custom-rules/SMS?page=1&size=100"
      },
      "self": {
         "href": "https://api.nexmo.com/v1/fraud-defender/configuration/custom-rules/SMS?page=1&size=100"
      }
   }
}

Edit custom fraud rule by ID

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

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Pfad Parameter

string

Erforderlich

Beispielabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Anfrage Körper
Inhalt Typ
application/json

product

string

Product type (SMS or VOICE)

Muss eines der folgenden sein:SMSVOICE

country

string

BeispielGB

ISO country code

interval

integer(int32)

Beispiel360

Interval in minutes. Supported values:

1 min: 1
5 min: 5
10 min: 10
15 min: 15
30 min: 30
45 min: 45
1 hour: 60
6 hour: 360
12 hour: 720
One day: 1440

Muss eines der folgenden sein:1510153045603607201440

threshold

integer(int32)

Beispiel100

Beispiel Anfrage

{
   "product": "SMS",
   "country": "GB",
   "interval": 360,
   "threshold": 100
}

{
   "product": "SMS",
   "country": "GB",
   "interval": 360,
   "threshold": 100
}

Antworten
Inhalt Typ
application/json

country

string

BeispielGB

interval

integer(int32)

Beispiel60

threshold

integer(int32)

Beispiel100

product

string

BeispielSMS

string

Beispielabcdef01-2345-6789-abcd-ef0123456789

_links

object

self

object

href

string

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

self link

Beispiel Antwort

{
   "country": "GB",
   "interval": 60,
   "threshold": 100,
   "product": "SMS",
   "id": "abcdef01-2345-6789-abcd-ef0123456789",
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v1/fraud-defender/configuration/custom-rules/SMS/e21ace94-54fa-4365-a824-38033dc06779"
      }
   }
}

Create custom fraud rule

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

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Anfrage Körper
Inhalt Typ
application/json

product

string

Product type (SMS or VOICE)

Muss eines der folgenden sein:SMSVOICE

country

string

BeispielGB

ISO country code

interval

integer(int32)

Beispiel360

Interval in minutes. Supported values:

1 min: 1
5 min: 5
10 min: 10
15 min: 15
30 min: 30
45 min: 45
1 hour: 60
6 hour: 360
12 hour: 720
One day: 1440

Muss eines der folgenden sein:1510153045603607201440

threshold

integer(int32)

Beispiel100

Beispiel Anfrage

{
   "product": "SMS",
   "country": "GB",
   "interval": 360,
   "threshold": 100
}

{
   "product": "SMS",
   "country": "GB",
   "interval": 360,
   "threshold": 100
}

Antworten
Inhalt Typ
application/json

country

string

BeispielGB

interval

integer(int32)

Beispiel60

threshold

integer(int32)

Beispiel100

product

string

BeispielSMS

string

Beispielabcdef01-2345-6789-abcd-ef0123456789

_links

object

self

object

href

string

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

self link

Beispiel Antwort

{
   "country": "GB",
   "interval": 60,
   "threshold": 100,
   "product": "SMS",
   "id": "abcdef01-2345-6789-abcd-ef0123456789",
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v1/fraud-defender/configuration/custom-rules/SMS/e21ace94-54fa-4365-a824-38033dc06779"
      }
   }
}

Get custom fraud rule by product and id

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

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Pfad Parameter

product

string

Erforderlich

Muss eines der folgenden sein:SMSVOICE

string

Erforderlich

Beispielabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Antworten
Inhalt Typ
application/json

country

string

BeispielGB

interval

integer(int32)

Beispiel60

threshold

integer(int32)

Beispiel100

product

string

BeispielSMS

string

Beispielabcdef01-2345-6789-abcd-ef0123456789

_links

object

self

object

href

string

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

self link

Beispiel Antwort

{
   "country": "GB",
   "interval": 60,
   "threshold": 100,
   "product": "SMS",
   "id": "abcdef01-2345-6789-abcd-ef0123456789",
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v1/fraud-defender/configuration/custom-rules/SMS/e21ace94-54fa-4365-a824-38033dc06779"
      }
   }
}

Delete custom fraud rule by ID

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

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Pfad Parameter

product

string

Erforderlich

Muss eines der folgenden sein:SMSVOICE

string

Erforderlich

Beispielabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Antworten

No Content

Fehler

Im Folgenden finden Sie eine nicht erschöpfende Liste von Fehlercodes, die bei der Verwendung dieser API auftreten können.

Diese Codes gelten zusätzlich zu unseren generische Fehlercodes.

Code	Informationen
http:error:conflict	Rule couldn't be added as conflicts with currently existing rules
system:error:internal-error	Something went wrong.
http:error:validation-fail	There was an issue when validating fields. Please refer to the API specs
http:error:bad-request	Bad Request. Please refer to the API specs

Fraud Prevention API

SMS Burst Protection

Verfügbare Operationen

List SMS Burst Protection entries

Authentifizierung

Abfrage Parameter

Antworten Inhalt Typapplication/json

Beispiel Antwort

Create new SMS Burst Protection entity

Authentifizierung

Anfrage Körper Inhalt Typapplication/json

Beispiel Anfrage

Antworten Inhalt Typapplication/json

Beispiel Antwort

Get SMS Burst Protection rule by ID

Authentifizierung

Pfad Parameter

Antworten Inhalt Typapplication/json

Beispiel Antwort

Edit an existing SMS Burst Protection rule

Authentifizierung

Pfad Parameter

Anfrage Körper Inhalt Typapplication/json

Beispiel Anfrage

Antworten Inhalt Typapplication/json

Beispiel Antwort

Delete SMS Burst Protection entity by id

Authentifizierung

Pfad Parameter

Antworten

Custom Fraud Rules

Verfügbare Operationen

List custom fraud rules

Authentifizierung

Pfad Parameter

Abfrage Parameter

Antworten Inhalt Typapplication/json

Beispiel Antwort

Edit custom fraud rule by ID

Authentifizierung

Pfad Parameter

Anfrage Körper Inhalt Typapplication/json

Beispiel Anfrage

Antworten Inhalt Typapplication/json

Beispiel Antwort

Create custom fraud rule

Authentifizierung

Anfrage Körper Inhalt Typapplication/json

Beispiel Anfrage

Antworten Inhalt Typapplication/json

Beispiel Antwort

Get custom fraud rule by product and id

Authentifizierung

Pfad Parameter

Antworten Inhalt Typapplication/json

Beispiel Antwort

Delete custom fraud rule by ID

Authentifizierung

Pfad Parameter

Antworten

Fehler

Antworten
Inhalt Typ
application/json

Anfrage Körper
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json

Anfrage Körper
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json

Anfrage Körper
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json

Anfrage Körper
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json