Fraud Prevention API
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.
利用可能な業務
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
Vodafone UKNetwork name
234Mobile Country Code
GBCountry code (ISO 3166-1 Alpha-2)
List of all Public Land Mobile Network codes, including primary and all aliases
HAL Links object
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Example Response
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
Query Parameters
smsFind rules for a specific product. When omitted, rules for all products are returned.
voicesms1644Find rules for a specific phone prefix
blockblockFind rules with a specific action
blockallowactiveFilter rules by status (active or archived). When omitted, rules of any status are returned.
activearchivedoutboundoutboundFind rules for a specific traffic direction
outboundinboundtrueDefines whether to display default rules or not
trueDefines whether to display custom rules or not
prefixSort by product, prefix or traffic, case-insensitively. When omitted, rules are sorted by creation time.
prefixproducttrafficdescSort order (asc or desc), case-insensitively
ascdesc11Page number.
1150100Number of items per page
111The current page
11020The size of the page
871The total number of items in the resource list
142Total number of pages
3efc212bc3f5482db6cdece03325ddc7Unique ID of the prefix traffic rule
smsProduct type. Values are matched case-insensitively; responses always return the lower-case form.
voicesms1644The 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. A leading + and any whitespace are removed before the rule is stored.
toPart of the traffic the prefix is matched against. to matches the destination number, from matches the originating number. It is derived from the traffic direction of the rule.
tofromoutboundoutboundOutbound rules apply to traffic generated from your API Key. Inbound rules apply to traffic sent to your phone numbers.
outboundinboundblockblockAction applied to the traffic matching the rule
blockallow1256reason for blockHuman readable reason. Commas and new lines are replaced with spaces.
editWhat can be done with the rule. edit - the rule can be updated and archived, view - the rule is read-only, locked - the rule is read-only and cannot be overridden by another rule.
editviewlockedactiveStatus of the prefix traffic rule
activearchived2025-07-01T10:11:22Date and time when the rule was created, in yyyy-MM-dd'T'HH:mm:ss format in UTC timezone
2025-07-02T09:15:43Date and time when the rule was last updated, in yyyy-MM-dd'T'HH:mm:ss format in UTC timezone. Omitted when the rule has never been updated.
2025-07-03T14:20:05Date and time when the rule was archived, in yyyy-MM-dd'T'HH:mm:ss format in UTC timezone. Omitted when the rule is active.
HAL Links object
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
HAL links for page-based paginated collections
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Example Response
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
smsProduct type. Values are matched case-insensitively; responses always return the lower-case form.
voicesms1644The 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. A leading + and any whitespace are removed before the rule is stored.
1256reason for blockHuman readable reason. Commas and new lines are replaced with spaces.
blockblockAction applied to the traffic matching the rule
blockallowoutboundoutboundOutbound rules apply to traffic generated from your API Key. Inbound rules apply to traffic sent to your phone numbers.
outboundinboundExample Request
3efc212bc3f5482db6cdece03325ddc7Unique ID of the prefix traffic rule
smsProduct type. Values are matched case-insensitively; responses always return the lower-case form.
voicesms1644The 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. A leading + and any whitespace are removed before the rule is stored.
toPart of the traffic the prefix is matched against. to matches the destination number, from matches the originating number. It is derived from the traffic direction of the rule.
tofromoutboundoutboundOutbound rules apply to traffic generated from your API Key. Inbound rules apply to traffic sent to your phone numbers.
outboundinboundblockblockAction applied to the traffic matching the rule
blockallow1256reason for blockHuman readable reason. Commas and new lines are replaced with spaces.
editWhat can be done with the rule. edit - the rule can be updated and archived, view - the rule is read-only, locked - the rule is read-only and cannot be overridden by another rule.
editviewlockedactiveStatus of the prefix traffic rule
activearchived2025-07-01T10:11:22Date and time when the rule was created, in yyyy-MM-dd'T'HH:mm:ss format in UTC timezone
2025-07-02T09:15:43Date and time when the rule was last updated, in yyyy-MM-dd'T'HH:mm:ss format in UTC timezone. Omitted when the rule has never been updated.
2025-07-03T14:20:05Date and time when the rule was archived, in yyyy-MM-dd'T'HH:mm:ss format in UTC timezone. Omitted when the rule is active.
HAL Links object
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Example Response
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
3efc212bc3f5482db6cdece03325ddc7Unique ID of the prefix traffic rule
smsProduct type. Values are matched case-insensitively; responses always return the lower-case form.
voicesms1644The 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. A leading + and any whitespace are removed before the rule is stored.
toPart of the traffic the prefix is matched against. to matches the destination number, from matches the originating number. It is derived from the traffic direction of the rule.
tofromoutboundoutboundOutbound rules apply to traffic generated from your API Key. Inbound rules apply to traffic sent to your phone numbers.
outboundinboundblockblockAction applied to the traffic matching the rule
blockallow1256reason for blockHuman readable reason. Commas and new lines are replaced with spaces.
editWhat can be done with the rule. edit - the rule can be updated and archived, view - the rule is read-only, locked - the rule is read-only and cannot be overridden by another rule.
editviewlockedactiveStatus of the prefix traffic rule
activearchived2025-07-01T10:11:22Date and time when the rule was created, in yyyy-MM-dd'T'HH:mm:ss format in UTC timezone
2025-07-02T09:15:43Date and time when the rule was last updated, in yyyy-MM-dd'T'HH:mm:ss format in UTC timezone. Omitted when the rule has never been updated.
2025-07-03T14:20:05Date and time when the rule was archived, in yyyy-MM-dd'T'HH:mm:ss format in UTC timezone. Omitted when the rule is active.
HAL Links object
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Example Response
Update an existing prefix traffic rule
Updates the details of a specific prefix traffic rule identified by id. Only the reason for the rule can be modified. Rules with a permission other than edit cannot be modified and are rejected with a 400 response.
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
1256reason for blockHuman readable reason. Commas and new lines are replaced with spaces.
Example Request
3efc212bc3f5482db6cdece03325ddc7Unique ID of the prefix traffic rule
smsProduct type. Values are matched case-insensitively; responses always return the lower-case form.
voicesms1644The 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. A leading + and any whitespace are removed before the rule is stored.
toPart of the traffic the prefix is matched against. to matches the destination number, from matches the originating number. It is derived from the traffic direction of the rule.
tofromoutboundoutboundOutbound rules apply to traffic generated from your API Key. Inbound rules apply to traffic sent to your phone numbers.
outboundinboundblockblockAction applied to the traffic matching the rule
blockallow1256reason for blockHuman readable reason. Commas and new lines are replaced with spaces.
editWhat can be done with the rule. edit - the rule can be updated and archived, view - the rule is read-only, locked - the rule is read-only and cannot be overridden by another rule.
editviewlockedactiveStatus of the prefix traffic rule
activearchived2025-07-01T10:11:22Date and time when the rule was created, in yyyy-MM-dd'T'HH:mm:ss format in UTC timezone
2025-07-02T09:15:43Date and time when the rule was last updated, in yyyy-MM-dd'T'HH:mm:ss format in UTC timezone. Omitted when the rule has never been updated.
2025-07-03T14:20:05Date and time when the rule was archived, in yyyy-MM-dd'T'HH:mm:ss format in UTC timezone. Omitted when the rule is active.
HAL Links object
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Example Response
Archive a prefix traffic rule
Marks a specific prefix traffic rule identified by id as archived. Archived rules are no longer active in the fraud detection flow and can be retrieved using the GET endpoint with the filter status=archived. Rules with a permission other than edit and rules that are already archived cannot be archived and are rejected with a 400 response.
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
Query Parameters
SMSFind rules for a specific product
SMSVOICE234Find rules for a specific Mobile Country Code (MCC)
GBFind rules for a specific ISO country code - alternative to MCC for identifying country
Vodafone UKFind rules for a specific network name.
23401Find rules for a specific public land mobile network (PLMN). Valid only with status=active, otherwise returns 400 error.
2025-08-26Find rules that expire on or after a specific date (YYYY-MM-DD) in UTC timezone. Valid only with status=active, otherwise returns 400 error.
2025-08-26Find rules that expire on or before a specific date (YYYY-MM-DD) in UTC timezone. Valid only with status=active, otherwise returns 400 error.
1dFind rules by time to live (TTL). Valid only with status=active, otherwise returns 400 error.
PERMANENT1d12h6h3h2h1hcreated_atcreated_atSort by field (product, mcc, country_code, network_name, created_at, expires_at)
productmcccountry_codenetwork_namecreated_atexpires_atactiveactiveFilter by rule status (active or archived).
activearchiveddescSort order (asc or desc)
ascdesc11Page number.
110010Number of items per page
3f8208fb-9aa3-4ea4-9a3f-de52a81e36bbUnique ID of the traffic rule
SMSProduct type for the traffic rule
SMSVOICE234Mobile Country Code
Vodafone UKNetwork name
1256reason for blocksReason for the traffic rule action
2025-08-01T10:11:22ZTimestamp when the rule expires (null for permanent rules) in UTC timezone
2025-07-01T10:11:22ZTimestamp when the rule was created
1dTime to live for the traffic rule. After this period, the rule will expire and no longer block traffic.
PERMANENT1d12h6h3h2h1h2025-08-02T10:11:22ZTimestamp when the rule was archived in UTC timezone, null if the rule is active
HAL links for page-based paginated collections
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
111The current page
11020The size of the page
871The total number of items in the resource list
142Total number of pages
Example Response
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
SMSProduct type for the traffic rule
SMSVOICE23401Unique network identifier consisting of Mobile Country Code (MCC) and Mobile Network Code (MNC) with no separators in between
1256reason for blocksReason for the traffic rule action
1dTime to live for the traffic rule. After this period, the rule will expire and no longer block traffic.
PERMANENT1d12h6h3h2h1hExample Request
3f8208fb-9aa3-4ea4-9a3f-de52a81e36bbUnique ID of the traffic rule
SMSProduct type for the traffic rule
SMSVOICE234Mobile Country Code
Vodafone UKNetwork name
1256reason for blocksReason for the traffic rule action
2025-08-01T10:11:22ZTimestamp when the rule expires (null for permanent rules) in UTC timezone
2025-07-01T10:11:22ZTimestamp when the rule was created
1dTime to live for the traffic rule. After this period, the rule will expire and no longer block traffic.
PERMANENT1d12h6h3h2h1hExample Response
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
1256reason for blocksReason for the traffic rule action
Example Request
3f8208fb-9aa3-4ea4-9a3f-de52a81e36bbUnique ID of the traffic rule
SMSProduct type for the traffic rule
SMSVOICE234Mobile Country Code
Vodafone UKNetwork name
1256reason for blocksReason for the traffic rule action
2025-08-01T10:11:22ZTimestamp when the rule expires (null for permanent rules) in UTC timezone
2025-07-01T10:11:22ZTimestamp when the rule was created
1dTime to live for the traffic rule. After this period, the rule will expire and no longer block traffic.
PERMANENT1d12h6h3h2h1hExample Response
Archive a network rule
Archives a specific network traffic rule identified by id. Archived rules become inactive and no longer block traffic. Still, a maximum of 50 archived rules remain accessible during 90 days for record-keeping and can be retrieved using the GET endpoint with the filter status=archived.
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
Complete list of country rules defining which country-product combinations should have their traffic blocked.
SMSProduct type for the traffic rule
SMSVOICEGBCountry code (ISO 3166-1 Alpha-2)
HAL Links object
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Example Response
Replace country rules
Replaces the country rules with the provided list. Country rules define which country-product combinations should have their traffic blocked. The rules array must always contain a complete list of rules - any existing rules not present in this request will be removed.
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
Complete list of country rules which should block the traffic. Any existing rules not present in this array will be removed.
SMSProduct type for the traffic rule
SMSVOICEGBCountry code (ISO 3166-1 Alpha-2)
Example Request
Complete list of country rules defining which country-product combinations should have their traffic blocked.
SMSProduct type for the traffic rule
SMSVOICEGBCountry code (ISO 3166-1 Alpha-2)
Example Response
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
Complete list of supported countries with their risk levels
PLCountry code (ISO 3166-1 Alpha-2)
EUContinent code to which the country belongs:
- AF - Africa
- AN - Antarctica
- AS - Asia
- EU - Europe
- NA - North America
- OC - Oceania
- SA - South America
AFANASEUNAOCSANONEHIGHRisk level for fraud detection. When not specified, defaults to NONE. Countries with HIGH risk will have their traffic blocked by default.
NONEHIGHHAL Links object
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Example Response
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
AIT protection configuration. default_protection_level is required when protection_enabled is true; omitting it returns a 400 error.
trueused to turn on/off AIT protection
standardDefault AIT protection level, used for countries with no specific per-country configuration. Required when protection_enabled is true. Values are matched case-insensitively; responses always return the lower-case form.
highstandardnonePer-country AIT protection level overrides. Countries not listed here use default_protection_level.
USCountry code in ISO 3166-1 Alpha-2 standard. Must be a supported country.
highAIT protection level for this country. Values are matched case-insensitively; responses always return the lower-case form.
highstandardnoneHAL Links object
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Example Response
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
AIT protection configuration. default_protection_level is required when protection_enabled is true; omitting it returns a 400 error.
trueused to turn on/off AIT protection
standardDefault AIT protection level, used for countries with no specific per-country configuration. Required when protection_enabled is true. Values are matched case-insensitively; responses always return the lower-case form.
highstandardnonePer-country AIT protection level overrides. Countries not listed here use default_protection_level.
USCountry code in ISO 3166-1 Alpha-2 standard. Must be a supported country.
highAIT protection level for this country. Values are matched case-insensitively; responses always return the lower-case form.
highstandardnoneExample Request
AIT protection configuration. default_protection_level is required when protection_enabled is true; omitting it returns a 400 error.
trueused to turn on/off AIT protection
standardDefault AIT protection level, used for countries with no specific per-country configuration. Required when protection_enabled is true. Values are matched case-insensitively; responses always return the lower-case form.
highstandardnonePer-country AIT protection level overrides. Countries not listed here use default_protection_level.
USCountry code in ISO 3166-1 Alpha-2 standard. Must be a supported country.
highAIT protection level for this country. Values are matched case-insensitively; responses always return the lower-case form.
highstandardnoneHAL Links object
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Example Response
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
Query Parameters
11020Page size in Integer format
111Page number in Integer format
Threshold value in Integer format
Interval value in Integer format it will be presented in minutes
Array of ISO countries codes
111The current page
11020The size of the page
871The total number of items in the resource list
142Total number of pages
GB60100smsProduct type. Values are matched case-insensitively; responses always return the lower-case form.
voicesmsabcdef01-2345-6789-abcd-ef0123456789Unique ID of the custom fraud alert.
HAL Links object
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
HAL links for page-based paginated collections
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Example Response
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
smsProduct type. Values are matched case-insensitively; responses always return the lower-case form.
voicesmsGBISO country code
360Interval 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
1510153045603607201440100Example Request
GB60100smsProduct type. Values are matched case-insensitively; responses always return the lower-case form.
voicesmsabcdef01-2345-6789-abcd-ef0123456789Unique ID of the custom fraud alert.
HAL Links object
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Example Response
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
smsProduct type. Values are matched case-insensitively; responses always return the lower-case form.
voicesmsGBISO country code
360Interval 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
1510153045603607201440100Example Request
GB60100smsProduct type. Values are matched case-insensitively; responses always return the lower-case form.
voicesmsabcdef01-2345-6789-abcd-ef0123456789Unique ID of the custom fraud alert.
HAL Links object
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Example Response
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
GB60100smsProduct type. Values are matched case-insensitively; responses always return the lower-case form.
voicesmsabcdef01-2345-6789-abcd-ef0123456789Unique ID of the custom fraud alert.
HAL Links object
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Example Response
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
111The current page
11020The size of the page
871The total number of items in the resource list
142Total number of pages
The embedded resources for this page.
The alert action configurations contained in this page.
4acf401c-91de-47a6-9f36-6e1e8ad4aaccUnique identifier of the alert action configuration.
customThe type of fraud the configuration applies to.
volumetric_changesait_protectioncustomnetwork_volumesmsProduct type. Values are matched case-insensitively; responses always return the lower-case form.
voicesms1000Severity metric threshold from which this configuration applies. When several configurations match an alert, the one with the highest threshold not exceeding the alert severity is used.
60Length in minutes of the window over which traffic is aggregated before the threshold is evaluated.
15304560360720nonenormalThe notification level applied to a matching fraud alert. When not specified, defaults to none, meaning no notification is sent. The values low and high are deprecated; they are accepted but applied as normal.
nonelownormalhighblockThe action applied to a matching fraud alert. review leaves the alert awaiting a decision by the customer; block blocks the offending traffic automatically; none records the alert without blocking.
noneblockreviewDestination countries this configuration applies to, as ISO 3166-1 alpha-2 codes. Use the single value ALL to apply it to every country. A country may only appear in one configuration per combination of fraud_alert_type, product and value.
1dHow long a block remains in effect. PERMANENT blocks indefinitely until the customer removes it; other values block for the given duration. Only meaningful for network alerts (fraud_alert_type set to network_volume). Required when action_type is block.
PERMANENT1d12h6h3h2h1hHAL Links object
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
HAL links for page-based paginated collections
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Example Response
{
"page": 1,
"page_size": 20,
"total_items": 871,
"total_pages": 42,
"_embedded": {
"entries": [
{
"id": "4acf401c-91de-47a6-9f36-6e1e8ad4aacc",
"fraud_alert_type": "custom",
"product": "sms",
"value": 1000,
"monitoring_interval_in_minutes": 60,
"notification_level": "normal",
"action_type": "block",
"countries": [
"ALL"
],
"block_duration": "1d",
"_links": {
"self": {
"href": "https://api.vonage.com/v1/resources/abc123",
"templated": false,
"type": "application/json",
"name": "resource-name",
"title": "Resource Title"
}
}
}
]
},
"_links": {
"first": {
"href": "https://api.nexmo.com/v2/fraud-defender/alerts/actions?page=1&page_size=100"
},
"last": {
"href": "https://api.nexmo.com/v2/fraud-defender/alerts/actions?page=4&page_size=100"
},
"prev": {
"href": "https://api.nexmo.com/v2/fraud-defender/alerts/actions?page=1&page_size=100"
},
"self": null
}
}Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
customThe type of fraud the configuration applies to.
volumetric_changesait_protectioncustomnetwork_volumesmsProduct type. Values are matched case-insensitively; responses always return the lower-case form.
voicesms1000Severity metric threshold from which this configuration applies. When several configurations match an alert, the one with the highest threshold not exceeding the alert severity is used.
60Length in minutes of the window over which traffic is aggregated before the threshold is evaluated.
15304560360720nonenormalThe notification level applied to a matching fraud alert. When not specified, defaults to none, meaning no notification is sent. The values low and high are deprecated; they are accepted but applied as normal.
nonelownormalhighblockThe action applied to a matching fraud alert. review leaves the alert awaiting a decision by the customer; block blocks the offending traffic automatically; none records the alert without blocking.
noneblockreviewDestination countries this configuration applies to, as ISO 3166-1 alpha-2 codes. Use the single value ALL to apply it to every country. A country may only appear in one configuration per combination of fraud_alert_type, product and value.
1dHow long a block remains in effect. PERMANENT blocks indefinitely until the customer removes it; other values block for the given duration. Only meaningful for network alerts (fraud_alert_type set to network_volume). Required when action_type is block.
PERMANENT1d12h6h3h2h1hExample Request
4acf401c-91de-47a6-9f36-6e1e8ad4aaccUnique identifier of the alert action configuration.
customThe type of fraud the configuration applies to.
volumetric_changesait_protectioncustomnetwork_volumesmsProduct type. Values are matched case-insensitively; responses always return the lower-case form.
voicesms1000Severity metric threshold from which this configuration applies. When several configurations match an alert, the one with the highest threshold not exceeding the alert severity is used.
60Length in minutes of the window over which traffic is aggregated before the threshold is evaluated.
15304560360720nonenormalThe notification level applied to a matching fraud alert. When not specified, defaults to none, meaning no notification is sent. The values low and high are deprecated; they are accepted but applied as normal.
nonelownormalhighblockThe action applied to a matching fraud alert. review leaves the alert awaiting a decision by the customer; block blocks the offending traffic automatically; none records the alert without blocking.
noneblockreviewDestination countries this configuration applies to, as ISO 3166-1 alpha-2 codes. Use the single value ALL to apply it to every country. A country may only appear in one configuration per combination of fraud_alert_type, product and value.
1dHow long a block remains in effect. PERMANENT blocks indefinitely until the customer removes it; other values block for the given duration. Only meaningful for network alerts (fraud_alert_type set to network_volume). Required when action_type is block.
PERMANENT1d12h6h3h2h1hHAL Links object
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Example Response
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
4acf401c-91de-47a6-9f36-6e1e8ad4aaccUnique identifier of the alert action configuration.
customThe type of fraud the configuration applies to.
volumetric_changesait_protectioncustomnetwork_volumesmsProduct type. Values are matched case-insensitively; responses always return the lower-case form.
voicesms1000Severity metric threshold from which this configuration applies. When several configurations match an alert, the one with the highest threshold not exceeding the alert severity is used.
60Length in minutes of the window over which traffic is aggregated before the threshold is evaluated.
15304560360720nonenormalThe notification level applied to a matching fraud alert. When not specified, defaults to none, meaning no notification is sent. The values low and high are deprecated; they are accepted but applied as normal.
nonelownormalhighblockThe action applied to a matching fraud alert. review leaves the alert awaiting a decision by the customer; block blocks the offending traffic automatically; none records the alert without blocking.
noneblockreviewDestination countries this configuration applies to, as ISO 3166-1 alpha-2 codes. Use the single value ALL to apply it to every country. A country may only appear in one configuration per combination of fraud_alert_type, product and value.
1dHow long a block remains in effect. PERMANENT blocks indefinitely until the customer removes it; other values block for the given duration. Only meaningful for network alerts (fraud_alert_type set to network_volume). Required when action_type is block.
PERMANENT1d12h6h3h2h1hHAL Links object
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Example Response
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
customThe type of fraud the configuration applies to.
volumetric_changesait_protectioncustomnetwork_volumesmsProduct type. Values are matched case-insensitively; responses always return the lower-case form.
voicesms1000Severity metric threshold from which this configuration applies. When several configurations match an alert, the one with the highest threshold not exceeding the alert severity is used.
60Length in minutes of the window over which traffic is aggregated before the threshold is evaluated.
15304560360720nonenormalThe notification level applied to a matching fraud alert. When not specified, defaults to none, meaning no notification is sent. The values low and high are deprecated; they are accepted but applied as normal.
nonelownormalhighblockThe action applied to a matching fraud alert. review leaves the alert awaiting a decision by the customer; block blocks the offending traffic automatically; none records the alert without blocking.
noneblockreviewDestination countries this configuration applies to, as ISO 3166-1 alpha-2 codes. Use the single value ALL to apply it to every country. A country may only appear in one configuration per combination of fraud_alert_type, product and value.
1dHow long a block remains in effect. PERMANENT blocks indefinitely until the customer removes it; other values block for the given duration. Only meaningful for network alerts (fraud_alert_type set to network_volume). Required when action_type is block.
PERMANENT1d12h6h3h2h1hExample Request
4acf401c-91de-47a6-9f36-6e1e8ad4aaccUnique identifier of the alert action configuration.
customThe type of fraud the configuration applies to.
volumetric_changesait_protectioncustomnetwork_volumesmsProduct type. Values are matched case-insensitively; responses always return the lower-case form.
voicesms1000Severity metric threshold from which this configuration applies. When several configurations match an alert, the one with the highest threshold not exceeding the alert severity is used.
60Length in minutes of the window over which traffic is aggregated before the threshold is evaluated.
15304560360720nonenormalThe notification level applied to a matching fraud alert. When not specified, defaults to none, meaning no notification is sent. The values low and high are deprecated; they are accepted but applied as normal.
nonelownormalhighblockThe action applied to a matching fraud alert. review leaves the alert awaiting a decision by the customer; block blocks the offending traffic automatically; none records the alert without blocking.
noneblockreviewDestination countries this configuration applies to, as ISO 3166-1 alpha-2 codes. Use the single value ALL to apply it to every country. A country may only appear in one configuration per combination of fraud_alert_type, product and value.
1dHow long a block remains in effect. PERMANENT blocks indefinitely until the customer removes it; other values block for the given duration. Only meaningful for network alerts (fraud_alert_type set to network_volume). Required when action_type is block.
PERMANENT1d12h6h3h2h1hHAL Links object
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Example Response
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
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 |
| http:error:validation-fail | There was an issue when validating the request. Please refer to the API specs |
| not-found | No rule was found against the passed rule id |
| system:error:internal-error | Something went wrong. |