Fraud Defender API

Version 1

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

Télécharger la spécification OpenAPI

Traffic Rules

Operations to manage traffic rules.

Opérations disponibles

Create rule

Create a new fraud rule based on phone number prefixes.

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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Corps de la demande
Type de contenu
application/json

product
string
Exigée
exemplesms
Il doit s'agir de l'un d'entre eux :voicesms
prefix
string
Exigée
Max15
exemple44

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
Exigée
exempleMy custom prefix rule

Human readable reason

action
string
Exigée
exempleblock
Il doit s'agir de l'un d'entre eux :blockallow
status
string
exempleactive
Il doit s'agir de l'un d'entre eux :activearchivedall

Exemple Demande

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

Réponses
Type de contenu
application/json

rule operation success

En-tête Paramètres
X-Request-Id
string(uuid)
exemplef94b4e56-604e-07e5-e5ad-5a7228618f81
A unique identifier for the request, used for tracking and debugging
id
string
exempletest-id
product
string
exemplesms
Il doit s'agir de l'un d'entre eux :voicesms
prefix
string
Max15
exemple44

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
exemplefrom
Il doit s'agir de l'un d'entre eux :fromto
traffic_direction
string
Défautoutbound
exempleoutbound

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

action
string
exempleblock
Il doit s'agir de l'un d'entre eux :blockallow
reason
string
exempleMy custom prefix rule

Human readable reason

permission
string
exempleedit
Il doit s'agir de l'un d'entre eux :viewedit
status
string
exempleactive
Il doit s'agir de l'un d'entre eux :activearchivedall
created_timestamp
string
exemple2022-12-09T18:19:26
updated_timestamp
string
exemple2022-11-09T18:19:26
archived_timestamp
string
exemple2022-10-09T18:19:26
_links
object

HAL Links object

self
object
Exigée

A single HAL link object

href
string
Exigée
exemplehttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated
boolean

Indicates if the href is a URI template

type
string
exempleapplication/json

Media type hint for the target resource

name
string
exempleresource-name

Secondary key for selecting link objects

title
string
exempleResource Title

Human-readable title for the link

Exemple Réponse

{
   "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/v1/fraud-defender/rules/test-id"
      }
   }
}

Listing rules

List all existing fraud rules with support for filtering by prefix, action, and status.

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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Demande de renseignements Paramètres

product
string
exemplesms

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

Il doit s'agir de l'un d'entre eux :voicesms
prefix
string
Max15
exemple44

phone prefix filter

reason
string
exempleMy custom prefix rule

reason filter

action
string
exempleblock

action filter

Il doit s'agir de l'un d'entre eux :blockallow
rule_type
string

rule type filter (allow, block)

Il doit s'agir de l'un d'entre eux :allowblock
status
string
exempleactive

filter rules by status (active, archived, all)

Il doit s'agir de l'un d'entre eux :activearchivedall
show_default_rules
boolean
Défauttrue

defines whether to display default rules or not

show_custom_rules
boolean
Défauttrue

show custom rules flag

page_size
integer
exemple10

Page size in Integer format

page
integer
Min1
exemple2

Page number in Integer format

sort
string

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

Il doit s'agir de l'un d'entre eux :productprefixtraffic
order
string
Défautdesc

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

Il doit s'agir de l'un d'entre eux :ascdesc

Réponses
Type de contenu
application/json

rule listing success

En-tête Paramètres
X-Request-Id
string(uuid)
exemplef94b4e56-604e-07e5-e5ad-5a7228618f81
A unique identifier for the request, used for tracking and debugging
links
object

HAL Links object

self
object
Exigée

A single HAL link object

href
string
Exigée
exemplehttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated
boolean

Indicates if the href is a URI template

type
string
exempleapplication/json

Media type hint for the target resource

name
string
exempleresource-name

Secondary key for selecting link objects

title
string
exempleResource Title

Human-readable title for the link

page
object
page_size
integer
exemple10

Items per page

page
integer
Min1
exemple2

Page Offset

total_pages
integer
Min1
exemple100

Number of pages in the entire result set

total_items
integer
exemple100

Number of items in the entire result set

_embedded
object
rules
array
id
string
exempletest-id
product
string
exemplesms
Il doit s'agir de l'un d'entre eux :voicesms
prefix
string
Max15
exemple44

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
exemplefrom
Il doit s'agir de l'un d'entre eux :fromto
traffic_direction
string
Défautoutbound
exempleoutbound

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

action
string
exempleblock
Il doit s'agir de l'un d'entre eux :blockallow
reason
string
exempleMy custom prefix rule

Human readable reason

permission
string
exempleedit
Il doit s'agir de l'un d'entre eux :viewedit
status
string
exempleactive
Il doit s'agir de l'un d'entre eux :activearchivedall
created_timestamp
string
exemple2022-12-09T18:19:26
updated_timestamp
string
exemple2022-11-09T18:19:26
archived_timestamp
string
exemple2022-10-09T18:19:26
_links
object

HAL Links object

self
object
Exigée

A single HAL link object

href
string
Exigée
exemplehttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated
boolean

Indicates if the href is a URI template

type
string
exempleapplication/json

Media type hint for the target resource

name
string
exempleresource-name

Secondary key for selecting link objects

title
string
exempleResource Title

Human-readable title for the link

Exemple Réponse

{
   "links": {
      "first": {
         "href": "https://api.nexmo.com/v1/fraud-defender/rules?order=asc&page=1&page_size=3"
      },
      "last": {
         "href": "https://api.nexmo.com/v1/fraud-defender/rules?order=asc&page=4&page_size=3"
      },
      "next": {
         "href": "https://api.nexmo.com/v1/fraud-defender/rules?order=asc&page=3&page_size=3"
      },
      "prev": {
         "href": "https://api.nexmo.com/v1/fraud-defender/rules?order=asc&page=1&page_size=3"
      },
      "self": {
         "href": "https://api.nexmo.com/v1/fraud-defender/rules?order=asc&page=2&page_size=3"
      }
   },
   "page": {
      "page_size": 10,
      "page": 2,
      "total_pages": 100,
      "total_items": 100
   },
   "_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/v1/fraud-defender/rules/test-id"
               }
            }
         }
      ]
   }
}

Get rule by id

Retrieve a specific fraud rule by its unique ID.

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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Trajectoire Paramètres

id
string
Exigée
exempleabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Réponses
Type de contenu
application/json

rule operation success

En-tête Paramètres
X-Request-Id
string(uuid)
exemplef94b4e56-604e-07e5-e5ad-5a7228618f81
A unique identifier for the request, used for tracking and debugging
id
string
exempletest-id
product
string
exemplesms
Il doit s'agir de l'un d'entre eux :voicesms
prefix
string
Max15
exemple44

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
exemplefrom
Il doit s'agir de l'un d'entre eux :fromto
traffic_direction
string
Défautoutbound
exempleoutbound

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

action
string
exempleblock
Il doit s'agir de l'un d'entre eux :blockallow
reason
string
exempleMy custom prefix rule

Human readable reason

permission
string
exempleedit
Il doit s'agir de l'un d'entre eux :viewedit
status
string
exempleactive
Il doit s'agir de l'un d'entre eux :activearchivedall
created_timestamp
string
exemple2022-12-09T18:19:26
updated_timestamp
string
exemple2022-11-09T18:19:26
archived_timestamp
string
exemple2022-10-09T18:19:26
_links
object

HAL Links object

self
object
Exigée

A single HAL link object

href
string
Exigée
exemplehttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated
boolean

Indicates if the href is a URI template

type
string
exempleapplication/json

Media type hint for the target resource

name
string
exempleresource-name

Secondary key for selecting link objects

title
string
exempleResource Title

Human-readable title for the link

Exemple Réponse

{
   "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/v1/fraud-defender/rules/test-id"
      }
   }
}

Archive rule by id

Mark a rule as archived. Archived rules are no longer active in the fraud detection flow.

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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Trajectoire Paramètres

id
string
Exigée
exempleabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Réponses

No Content - Resource successfully deleted

En-tête Paramètres
X-Request-Id
string(uuid)
exemplef94b4e56-604e-07e5-e5ad-5a7228618f81
A unique identifier for the request, used for tracking and debugging

Update rule by id

Update specific fields of an existing fraud rule.

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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Trajectoire Paramètres

id
string
Exigée
exempleabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Corps de la demande
Type de contenu
application/json

reason
string
Exigée
exempleMy custom prefix rule

Human readable reason

Exemple Demande

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

Réponses
Type de contenu
application/json

rule operation success

En-tête Paramètres
X-Request-Id
string(uuid)
exemplef94b4e56-604e-07e5-e5ad-5a7228618f81
A unique identifier for the request, used for tracking and debugging
id
string
exempletest-id
product
string
exemplesms
Il doit s'agir de l'un d'entre eux :voicesms
prefix
string
Max15
exemple44

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
exemplefrom
Il doit s'agir de l'un d'entre eux :fromto
traffic_direction
string
Défautoutbound
exempleoutbound

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

action
string
exempleblock
Il doit s'agir de l'un d'entre eux :blockallow
reason
string
exempleMy custom prefix rule

Human readable reason

permission
string
exempleedit
Il doit s'agir de l'un d'entre eux :viewedit
status
string
exempleactive
Il doit s'agir de l'un d'entre eux :activearchivedall
created_timestamp
string
exemple2022-12-09T18:19:26
updated_timestamp
string
exemple2022-11-09T18:19:26
archived_timestamp
string
exemple2022-10-09T18:19:26
_links
object

HAL Links object

self
object
Exigée

A single HAL link object

href
string
Exigée
exemplehttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated
boolean

Indicates if the href is a URI template

type
string
exempleapplication/json

Media type hint for the target resource

name
string
exempleresource-name

Secondary key for selecting link objects

title
string
exempleResource Title

Human-readable title for the link

Exemple Réponse

{
   "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/v1/fraud-defender/rules/test-id"
      }
   }
}

AIT Protection

Operations to manage AIT Protection.

Opérations disponibles

Get AIT configuration

Retrieve the current AIT protection configuration for a given product.

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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Trajectoire Paramètres

product
string
Exigée
Défautsms

product type

Il doit s'agir de l'un d'entre eux :sms

Réponses
Type de contenu
application/json

AIT protection config response

En-tête Paramètres
X-Request-Id
string(uuid)
exemplef94b4e56-604e-07e5-e5ad-5a7228618f81
A unique identifier for the request, used for tracking and debugging
data
object
protection_enabled
boolean
exempletrue

used to turn on/off AIT protection

default_protection_level
string
exemplestandard

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

Il doit s'agir de l'un d'entre eux :highstandardnone
protection_level_per_country
array

array of specific per-country AIT protection level configurations

country
string
Exigée
exempleUS

country code in ISO 3166-1 Alpha-2 standard

protection_level
string
Exigée
exemplehigh

AIT protection level

Il doit s'agir de l'un d'entre eux :highstandardnone
_links
object

HAL Links object

self
object
Exigée

A single HAL link object

href
string
Exigée
exemplehttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated
boolean

Indicates if the href is a URI template

type
string
exempleapplication/json

Media type hint for the target resource

name
string
exempleresource-name

Secondary key for selecting link objects

title
string
exempleResource Title

Human-readable title for the link

Exemple Réponse

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

Create or update AIT configuration

Enable or modify AIT protection settings globally or per country.

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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Trajectoire Paramètres

product
string
Exigée
Défautsms

product type

Il doit s'agir de l'un d'entre eux :sms

Corps de la demande
Type de contenu
application/json

data
object
protection_enabled
boolean
exempletrue

used to turn on/off AIT protection

default_protection_level
string
exemplestandard

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

Il doit s'agir de l'un d'entre eux :highstandardnone
protection_level_per_country
array

array of specific per-country AIT protection level configurations

country
string
Exigée
exempleUS

country code in ISO 3166-1 Alpha-2 standard

protection_level
string
Exigée
exemplehigh

AIT protection level

Il doit s'agir de l'un d'entre eux :highstandardnone

Exemple Demande

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

Réponses
Type de contenu
application/json

AIT protection config response

En-tête Paramètres
X-Request-Id
string(uuid)
exemplef94b4e56-604e-07e5-e5ad-5a7228618f81
A unique identifier for the request, used for tracking and debugging
data
object
protection_enabled
boolean
exempletrue

used to turn on/off AIT protection

default_protection_level
string
exemplestandard

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

Il doit s'agir de l'un d'entre eux :highstandardnone
protection_level_per_country
array

array of specific per-country AIT protection level configurations

country
string
Exigée
exempleUS

country code in ISO 3166-1 Alpha-2 standard

protection_level
string
Exigée
exemplehigh

AIT protection level

Il doit s'agir de l'un d'entre eux :highstandardnone
_links
object

HAL Links object

self
object
Exigée

A single HAL link object

href
string
Exigée
exemplehttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated
boolean

Indicates if the href is a URI template

type
string
exempleapplication/json

Media type hint for the target resource

name
string
exempleresource-name

Secondary key for selecting link objects

title
string
exempleResource Title

Human-readable title for the link

Exemple Réponse

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

SMS Burst Protection

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

Opérations disponibles

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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Demande de renseignements Paramètres

page
integer
Min1
exemple2

Page number in Integer format

page_size
integer
exemple10

Page size in Integer format

Réponses
Type de contenu
application/json

Successful operation

En-tête Paramètres
X-Request-Id
string(uuid)
exemplef94b4e56-604e-07e5-e5ad-5a7228618f81
A unique identifier for the request, used for tracking and debugging
page
object
page_size
integer
exemple10

Items per page

page
integer
Min1
exemple2

Page Offset

total_pages
integer
Min1
exemple100

Number of pages in the entire result set

total_items
integer
exemple100

Number of items in the entire result set

_embedded
object
entries
array
id
string
exempleabcdef01-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

Valeurs disponibles :
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
exemple1

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

_links
object

HAL Links object

self
object
Exigée

A single HAL link object

href
string
Exigée
exemplehttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated
boolean

Indicates if the href is a URI template

type
string
exempleapplication/json

Media type hint for the target resource

name
string
exempleresource-name

Secondary key for selecting link objects

title
string
exempleResource Title

Human-readable title for the link

links
object

HAL Links object

self
object
Exigée

A single HAL link object

href
string
Exigée
exemplehttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated
boolean

Indicates if the href is a URI template

type
string
exempleapplication/json

Media type hint for the target resource

name
string
exempleresource-name

Secondary key for selecting link objects

title
string
exempleResource Title

Human-readable title for the link

Exemple Réponse

{
   "page": {
      "page_size": 10,
      "page": 2,
      "total_pages": 100,
      "total_items": 100
   },
   "_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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Corps de la demande
Type de contenu
application/json

destination_countries
array
Exigée
Valeurs disponibles :
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
Exigée
exemple1

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

Exemple Demande

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

Réponses
Type de contenu
application/json

Successful operation

En-tête Paramètres
X-Request-Id
string(uuid)
exemplef94b4e56-604e-07e5-e5ad-5a7228618f81
A unique identifier for the request, used for tracking and debugging
id
string
exempleabcdef01-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

Valeurs disponibles :
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
exemple1

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

_links
object

HAL Links object

self
object
Exigée

A single HAL link object

href
string
Exigée
exemplehttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated
boolean

Indicates if the href is a URI template

type
string
exempleapplication/json

Media type hint for the target resource

name
string
exempleresource-name

Secondary key for selecting link objects

title
string
exempleResource Title

Human-readable title for the link

Exemple Réponse

{
   "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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Trajectoire Paramètres

id
string
Exigée
exempleabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Réponses
Type de contenu
application/json

Successful operation

En-tête Paramètres
X-Request-Id
string(uuid)
exemplef94b4e56-604e-07e5-e5ad-5a7228618f81
A unique identifier for the request, used for tracking and debugging
id
string
exempleabcdef01-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

Valeurs disponibles :
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
exemple1

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

_links
object

HAL Links object

self
object
Exigée

A single HAL link object

href
string
Exigée
exemplehttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated
boolean

Indicates if the href is a URI template

type
string
exempleapplication/json

Media type hint for the target resource

name
string
exempleresource-name

Secondary key for selecting link objects

title
string
exempleResource Title

Human-readable title for the link

Exemple Réponse

{
   "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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Trajectoire Paramètres

id
string
Exigée
exempleabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Corps de la demande
Type de contenu
application/json

destination_countries
array
Exigée
Valeurs disponibles :
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
Exigée
exemple1

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

Exemple Demande

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

Réponses
Type de contenu
application/json

Successful operation

En-tête Paramètres
X-Request-Id
string(uuid)
exemplef94b4e56-604e-07e5-e5ad-5a7228618f81
A unique identifier for the request, used for tracking and debugging
id
string
exempleabcdef01-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

Valeurs disponibles :
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
exemple1

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

_links
object

HAL Links object

self
object
Exigée

A single HAL link object

href
string
Exigée
exemplehttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated
boolean

Indicates if the href is a URI template

type
string
exempleapplication/json

Media type hint for the target resource

name
string
exempleresource-name

Secondary key for selecting link objects

title
string
exempleResource Title

Human-readable title for the link

Exemple Réponse

{
   "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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Trajectoire Paramètres

id
string
Exigée
exempleabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Réponses

No Content - Resource successfully deleted

En-tête Paramètres
X-Request-Id
string(uuid)
exemplef94b4e56-604e-07e5-e5ad-5a7228618f81
A unique identifier for the request, used for tracking and debugging

Custom Fraud Alerts

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

Opérations disponibles

List custom fraud alerts

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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Trajectoire Paramètres

identifier
string
Exigée
Il doit s'agir de l'un d'entre eux :SMSVOICE

Demande de renseignements Paramètres

page_size
integer
exemple10

Page size in Integer format

page
integer
Min1
exemple2

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

Réponses
Type de contenu
application/json

OK

En-tête Paramètres
X-Request-Id
string(uuid)
exemplef94b4e56-604e-07e5-e5ad-5a7228618f81
A unique identifier for the request, used for tracking and debugging
page
object
page_size
integer
exemple10

Items per page

page
integer
Min1
exemple2

Page Offset

total_pages
integer
Min1
exemple100

Number of pages in the entire result set

total_items
integer
exemple100

Number of items in the entire result set

_embedded
object
entries
array
country
string
exempleGB
interval
integer(int32)
exemple60
threshold
integer(int32)
exemple100
product
string
exemplesms
Il doit s'agir de l'un d'entre eux :voicesms
id
string
exempleabcdef01-2345-6789-abcd-ef0123456789
_links
object

HAL Links object

self
object
Exigée

A single HAL link object

href
string
Exigée
exemplehttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated
boolean

Indicates if the href is a URI template

type
string
exempleapplication/json

Media type hint for the target resource

name
string
exempleresource-name

Secondary key for selecting link objects

title
string
exempleResource Title

Human-readable title for the link

links
object

HAL Links object

self
object
Exigée

A single HAL link object

href
string
Exigée
exemplehttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated
boolean

Indicates if the href is a URI template

type
string
exempleapplication/json

Media type hint for the target resource

name
string
exempleresource-name

Secondary key for selecting link objects

title
string
exempleResource Title

Human-readable title for the link

Exemple Réponse

{
   "page": {
      "page_size": 10,
      "page": 2,
      "total_pages": 100,
      "total_items": 100
   },
   "_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 alert by ID

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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Trajectoire Paramètres

identifier
string
Exigée

Corps de la demande
Type de contenu
application/json

product
string
exemplesms
Il doit s'agir de l'un d'entre eux :voicesms
country
string
exempleGB

ISO country code

interval
integer(int32)
exemple360

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
Il doit s'agir de l'un d'entre eux :1510153045603607201440
threshold
integer(int32)
exemple100

Exemple Demande

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

Réponses
Type de contenu
application/json

OK

En-tête Paramètres
X-Request-Id
string(uuid)
exemplef94b4e56-604e-07e5-e5ad-5a7228618f81
A unique identifier for the request, used for tracking and debugging
country
string
exempleGB
interval
integer(int32)
exemple60
threshold
integer(int32)
exemple100
product
string
exemplesms
Il doit s'agir de l'un d'entre eux :voicesms
id
string
exempleabcdef01-2345-6789-abcd-ef0123456789
_links
object

HAL Links object

self
object
Exigée

A single HAL link object

href
string
Exigée
exemplehttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated
boolean

Indicates if the href is a URI template

type
string
exempleapplication/json

Media type hint for the target resource

name
string
exempleresource-name

Secondary key for selecting link objects

title
string
exempleResource Title

Human-readable title for the link

Exemple Réponse

{
   "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 alert

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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Corps de la demande
Type de contenu
application/json

product
string
exemplesms
Il doit s'agir de l'un d'entre eux :voicesms
country
string
exempleGB

ISO country code

interval
integer(int32)
exemple360

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
Il doit s'agir de l'un d'entre eux :1510153045603607201440
threshold
integer(int32)
exemple100

Exemple Demande

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

Réponses
Type de contenu
application/json

OK

En-tête Paramètres
X-Request-Id
string(uuid)
exemplef94b4e56-604e-07e5-e5ad-5a7228618f81
A unique identifier for the request, used for tracking and debugging
country
string
exempleGB
interval
integer(int32)
exemple60
threshold
integer(int32)
exemple100
product
string
exemplesms
Il doit s'agir de l'un d'entre eux :voicesms
id
string
exempleabcdef01-2345-6789-abcd-ef0123456789
_links
object

HAL Links object

self
object
Exigée

A single HAL link object

href
string
Exigée
exemplehttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated
boolean

Indicates if the href is a URI template

type
string
exempleapplication/json

Media type hint for the target resource

name
string
exempleresource-name

Secondary key for selecting link objects

title
string
exempleResource Title

Human-readable title for the link

Exemple Réponse

{
   "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 alert by product and id

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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Trajectoire Paramètres

product
string
Exigée
exemplesms
Il doit s'agir de l'un d'entre eux :voicesms
id
string
Exigée
exempleabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Réponses
Type de contenu
application/json

OK

En-tête Paramètres
X-Request-Id
string(uuid)
exemplef94b4e56-604e-07e5-e5ad-5a7228618f81
A unique identifier for the request, used for tracking and debugging
country
string
exempleGB
interval
integer(int32)
exemple60
threshold
integer(int32)
exemple100
product
string
exemplesms
Il doit s'agir de l'un d'entre eux :voicesms
id
string
exempleabcdef01-2345-6789-abcd-ef0123456789
_links
object

HAL Links object

self
object
Exigée

A single HAL link object

href
string
Exigée
exemplehttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated
boolean

Indicates if the href is a URI template

type
string
exempleapplication/json

Media type hint for the target resource

name
string
exempleresource-name

Secondary key for selecting link objects

title
string
exempleResource Title

Human-readable title for the link

Exemple Réponse

{
   "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 alert by ID

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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Trajectoire Paramètres

product
string
Exigée
exemplesms
Il doit s'agir de l'un d'entre eux :voicesms
id
string
Exigée
exempleabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Réponses

No Content - Resource successfully deleted

En-tête Paramètres
X-Request-Id
string(uuid)
exemplef94b4e56-604e-07e5-e5ad-5a7228618f81
A unique identifier for the request, used for tracking and debugging

Erreurs

Voici une liste non exhaustive des codes d'erreur susceptibles de se produire lors de l'utilisation de cette API.

Ces codes s'ajoutent à ceux de notre site codes d'erreur génériques.

CodeInformations
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