Fraud Prevention API

Versão 0.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.

Baixar a especificação OpenAPI

Custom Fraud Rules

Operations for managing specific fraud rules per product.

Operações disponíveis

List custom fraud rules

Returns a paginated list of custom fraud rules filtered by product type.

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Caminho Parâmetros

product

string

Obrigatório

Deve ser uma das seguintes opções:SMSVOICE

Consulta Parâmetros

page_size

integer(int32)

Padrão100

Page size in Integer format

page

integer(int32)

Padrão1

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

Respostas
Tipo de conteúdo
application/json

page

integer(int32)

exemplo1

page_size

integer(int32)

exemplo100

total_pages

integer(int32)

exemplo5

total_items

integer(int32)

exemplo450

_embedded

object

entries

array

country

string

exemploGB

interval

integer(int32)

exemplo60

threshold

integer(int32)

exemplo10

product

string

exemploSMS

string

exemploabcdef01-2345-6789-abcd-ef0123456789

_links

object

self

object

href

string

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

self link

_links

object

first

object

href

string

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

first link of the paginated result set

last

object

href

string

exemplohttps://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

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

previous link of the paginated result set

self

object

href

string

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

self link

Exemplo Resposta

{
   "page": 1,
   "page_size": 100,
   "total_pages": 5,
   "total_items": 450,
   "_embedded": {
      "entries": [
         {
            "country": "GB",
            "interval": 60,
            "threshold": 10,
            "product": "SMS",
            "id": "abcdef01-2345-6789-abcd-ef0123456789",
            "_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=1&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=1&size=100"
      },
      "self": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/SMS?page=1&size=100"
      }
   }
}

Edit custom fraud rule by ID

Update an existing fraud rule configuration using its unique identifier.

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Caminho Parâmetros

string

Obrigatório

exemploabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Corpo da solicitação
Tipo de conteúdo
application/json

product

string

exemploSMS

Product type (SMS or VOICE)

Deve ser uma das seguintes opções:VOICESMS

country

string

exemploGB

ISO country code

interval

integer(int32)

exemplo60

threshold

integer(int32)

exemplo10

Exemplo Solicitação

{
   "product": "SMS",
   "country": "GB",
   "interval": 60,
   "threshold": 10
}

Respostas
Tipo de conteúdo
application/json

country

string

exemploGB

interval

integer(int32)

exemplo60

threshold

integer(int32)

exemplo10

product

string

exemploSMS

string

exemploabcdef01-2345-6789-abcd-ef0123456789

_links

object

self

object

href

string

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

self link

Exemplo Resposta

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

Create custom fraud rule

Create a new custom fraud rule for a specific product and country.

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Corpo da solicitação
Tipo de conteúdo
application/json

product

string

exemploSMS

Product type (SMS or VOICE)

Deve ser uma das seguintes opções:VOICESMS

country

string

exemploGB

ISO country code

interval

integer(int32)

exemplo60

threshold

integer(int32)

exemplo10

Exemplo Solicitação

{
   "product": "SMS",
   "country": "GB",
   "interval": 60,
   "threshold": 10
}

Respostas
Tipo de conteúdo
application/json

Created

country

string

exemploGB

interval

integer(int32)

exemplo60

threshold

integer(int32)

exemplo10

product

string

exemploSMS

string

exemploabcdef01-2345-6789-abcd-ef0123456789

_links

object

self

object

href

string

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

self link

Exemplo Resposta

{
   "country": "GB",
   "interval": 60,
   "threshold": 10,
   "product": "SMS",
   "id": "abcdef01-2345-6789-abcd-ef0123456789",
   "_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

Retrieve detailed information for a specific custom fraud rule.

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Caminho Parâmetros

product

string

Obrigatório

Deve ser uma das seguintes opções:SMSVOICE

string

Obrigatório

exemploabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Respostas
Tipo de conteúdo
application/json

country

string

exemploGB

interval

integer(int32)

exemplo60

threshold

integer(int32)

exemplo10

product

string

exemploSMS

string

exemploabcdef01-2345-6789-abcd-ef0123456789

_links

object

self

object

href

string

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

self link

Exemplo Resposta

{
   "country": "GB",
   "interval": 60,
   "threshold": 10,
   "product": "SMS",
   "id": "abcdef01-2345-6789-abcd-ef0123456789",
   "_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

Permanently remove a custom fraud rule from the system.

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Caminho Parâmetros

product

string

Obrigatório

Deve ser uma das seguintes opções:SMSVOICE

string

Obrigatório

exemploabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Respostas

No Content

AIT protection

Artificial Inflation of Traffic protection configuration.

Operações disponíveis

Get AIT configuration

Retrieve the current AIT protection configuration for a given product.

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Caminho Parâmetros

product

string

Obrigatório

Padrãosms

product type

Deve ser uma das seguintes opções:sms

Respostas
Tipo de conteúdo
application/json

AIT protection config response

data

object

protection_enabled

boolean

Obrigatório

exemplotrue

used to turn on/off AIT protection

default_protection_level

string

exemplostandard

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

Deve ser uma das seguintes opções:highstandardnone

protection_level_per_country

array

array of specific per-country AIT protection level configurations

country

string

Obrigatório

exemploUS

country code in ISO 3166-1 Alpha-2 standard

protection_level

string

Obrigatório

exemplohigh

AIT protection level

Deve ser uma das seguintes opções:highstandardnone

_links

object

self

object

href

string

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

Exemplo Resposta

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

Enable or modify AIT protection settings globally or per country.

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Caminho Parâmetros

product

string

Obrigatório

Padrãosms

product type

Deve ser uma das seguintes opções:sms

Corpo da solicitação
Tipo de conteúdo
application/json

data

object

protection_enabled

boolean

Obrigatório

exemplotrue

used to turn on/off AIT protection

default_protection_level

string

exemplostandard

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

Deve ser uma das seguintes opções:highstandardnone

protection_level_per_country

array

array of specific per-country AIT protection level configurations

country

string

Obrigatório

exemploUS

country code in ISO 3166-1 Alpha-2 standard

protection_level

string

Obrigatório

exemplohigh

AIT protection level

Deve ser uma das seguintes opções:highstandardnone

Exemplo Solicitação

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

Respostas
Tipo de conteúdo
application/json

AIT protection config response

data

object

protection_enabled

boolean

Obrigatório

exemplotrue

used to turn on/off AIT protection

default_protection_level

string

exemplostandard

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

Deve ser uma das seguintes opções:highstandardnone

protection_level_per_country

array

array of specific per-country AIT protection level configurations

country

string

Obrigatório

exemploUS

country code in ISO 3166-1 Alpha-2 standard

protection_level

string

Obrigatório

exemplohigh

AIT protection level

Deve ser uma das seguintes opções:highstandardnone

_links

object

self

object

href

string

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

Exemplo Resposta

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

Rules

General fraud rule management and listing.

Operações disponíveis

Create rule

Create a new fraud rule based on phone number prefixes.

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Corpo da solicitação
Tipo de conteúdo
application/json

product

string

Obrigatório

exemplosms

Deve ser uma das seguintes opções:voicesms

prefix

string

Obrigatório

Max15

exemplo44

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

Obrigatório

exemploMy custom prefix rule

Human readable reason

action

string

Obrigatório

exemploblock

Deve ser uma das seguintes opções:blockallow

status

string

exemploactive

Deve ser uma das seguintes opções:activearchived

Exemplo Solicitação

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

Respostas
Tipo de conteúdo
application/json

rule operation success

string

exemplotest-id

product

string

exemplosms

Deve ser uma das seguintes opções:voicesms

prefix

string

exemplo44

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

exemplofrom

Deve ser uma das seguintes opções:fromto

traffic_direction

string

Padrãooutbound

exemplooutbound

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

action

string

exemploblock

Deve ser uma das seguintes opções:blockallow

reason

string

exemploMy custom prefix rule

Human readable reason

permission

string

exemploedit

Deve ser uma das seguintes opções:viewedit

status

string

exemploactive

Deve ser uma das seguintes opções:activearchived

created_timestamp

string

exemplo2022-12-09T18:19:26

updated_timestamp

string

exemplo2022-11-09T18:19:26

archived_timestamp

string

exemplo2022-10-09T18:19:26

_links

object

self

object

href

string

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

Exemplo Resposta

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

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

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Consulta Parâmetros

product

string

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

Deve ser uma das seguintes opções: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

Padrãotrue

defines whether to display default rules or not

show_custom_rules

boolean

Padrãotrue

show custom rules flag

page_size

string

Padrão150

page size parameter, starts from 1

page

string

Padrão1

page offset parameter, starts from 1

sort

string

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

Deve ser uma das seguintes opções:productprefixtraffic

order

string

Padrãodesc

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

Deve ser uma das seguintes opções:ascdesc

Respostas
Tipo de conteúdo
application/json

rule listing success

_links

object

first

object

href

string

exemplohttps://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

exemplohttps://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

exemplohttps://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

exemplohttps://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

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

self link

page

object

number

exemplo2

Page number

size

number

exemplo3

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

totalElements

number

exemplo11

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

totalPages

number

exemplo4

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

_embedded

object

rules

array

string

exemplotest-id

product

string

exemplosms

Deve ser uma das seguintes opções:voicesms

prefix

string

exemplo44

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

exemplofrom

Deve ser uma das seguintes opções:fromto

traffic_direction

string

Padrãooutbound

exemplooutbound

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

action

string

exemploblock

Deve ser uma das seguintes opções:blockallow

reason

string

exemploMy custom prefix rule

Human readable reason

permission

string

exemploedit

Deve ser uma das seguintes opções:viewedit

status

string

exemploactive

Deve ser uma das seguintes opções:activearchived

created_timestamp

string

exemplo2022-12-09T18:19:26

updated_timestamp

string

exemplo2022-11-09T18:19:26

archived_timestamp

string

exemplo2022-10-09T18:19:26

_links

object

self

object

href

string

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

Exemplo Resposta

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

Retrieve a specific fraud rule by its unique ID.

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Caminho Parâmetros

string

Obrigatório

exemploabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Respostas
Tipo de conteúdo
application/json

rule operation success

string

exemplotest-id

product

string

exemplosms

Deve ser uma das seguintes opções:voicesms

prefix

string

exemplo44

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

exemplofrom

Deve ser uma das seguintes opções:fromto

traffic_direction

string

Padrãooutbound

exemplooutbound

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

action

string

exemploblock

Deve ser uma das seguintes opções:blockallow

reason

string

exemploMy custom prefix rule

Human readable reason

permission

string

exemploedit

Deve ser uma das seguintes opções:viewedit

status

string

exemploactive

Deve ser uma das seguintes opções:activearchived

created_timestamp

string

exemplo2022-12-09T18:19:26

updated_timestamp

string

exemplo2022-11-09T18:19:26

archived_timestamp

string

exemplo2022-10-09T18:19:26

_links

object

self

object

href

string

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

Exemplo Resposta

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

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

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Caminho Parâmetros

string

Obrigatório

exemploabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Respostas

No Content

Update rule by id

Update specific fields of an existing fraud rule.

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Caminho Parâmetros

string

Obrigatório

exemploabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Corpo da solicitação
Tipo de conteúdo
application/json

reason

string

Obrigatório

exemploMy custom prefix rule

Human readable reason

Exemplo Solicitação

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

Respostas
Tipo de conteúdo
application/json

rule operation success

string

exemplotest-id

product

string

exemplosms

Deve ser uma das seguintes opções:voicesms

prefix

string

exemplo44

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

exemplofrom

Deve ser uma das seguintes opções:fromto

traffic_direction

string

Padrãooutbound

exemplooutbound

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

action

string

exemploblock

Deve ser uma das seguintes opções:blockallow

reason

string

exemploMy custom prefix rule

Human readable reason

permission

string

exemploedit

Deve ser uma das seguintes opções:viewedit

status

string

exemploactive

Deve ser uma das seguintes opções:activearchived

created_timestamp

string

exemplo2022-12-09T18:19:26

updated_timestamp

string

exemplo2022-11-09T18:19:26

archived_timestamp

string

exemplo2022-10-09T18:19:26

_links

object

self

object

href

string

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

Exemplo Resposta

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

Erros

A seguir, apresentamos uma lista não exaustiva de códigos de erro que podem ocorrer durante o uso desta API.

Esses códigos são adicionais aos que constam em nosso site códigos de erro genéricos.

Código	Informações
http:error:conflict	Rule couldn't be added as conflicts with currently existing rules
system:error:internal-error	Something went wrong.

Fraud Prevention API

Custom Fraud Rules

Operações disponíveis

List custom fraud rules

Autenticação

Caminho Parâmetros

Consulta Parâmetros

Respostas Tipo de conteúdoapplication/json

Exemplo Resposta

Edit custom fraud rule by ID

Autenticação

Caminho Parâmetros

Corpo da solicitação Tipo de conteúdoapplication/json

Exemplo Solicitação

Respostas Tipo de conteúdoapplication/json

Exemplo Resposta

Create custom fraud rule

Autenticação

Corpo da solicitação Tipo de conteúdoapplication/json

Exemplo Solicitação

Respostas Tipo de conteúdoapplication/json

Exemplo Resposta

Get custom fraud rule by product and id

Autenticação

Caminho Parâmetros

Respostas Tipo de conteúdoapplication/json

Exemplo Resposta

Delete custom fraud rule by ID

Autenticação

Caminho Parâmetros

Respostas

AIT protection

Operações disponíveis

Get AIT configuration

Autenticação

Caminho Parâmetros

Respostas Tipo de conteúdoapplication/json

Exemplo Resposta

Create or update AIT configuration

Autenticação

Caminho Parâmetros

Corpo da solicitação Tipo de conteúdoapplication/json

Exemplo Solicitação

Respostas Tipo de conteúdoapplication/json

Exemplo Resposta

Rules

Operações disponíveis

Create rule

Autenticação

Corpo da solicitação Tipo de conteúdoapplication/json

Exemplo Solicitação

Respostas Tipo de conteúdoapplication/json

Exemplo Resposta

Listing rules

Autenticação

Consulta Parâmetros

Respostas Tipo de conteúdoapplication/json

Exemplo Resposta

Get rule by id

Autenticação

Caminho Parâmetros

Respostas Tipo de conteúdoapplication/json

Exemplo Resposta

Archive rule by id

Autenticação

Caminho Parâmetros

Respostas

Update rule by id

Autenticação

Caminho Parâmetros

Corpo da solicitação Tipo de conteúdoapplication/json

Exemplo Solicitação

Respostas Tipo de conteúdoapplication/json

Exemplo Resposta

Erros

Respostas
Tipo de conteúdo
application/json

Corpo da solicitação
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Corpo da solicitação
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Corpo da solicitação
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Corpo da solicitação
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Corpo da solicitação
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json