Antifraud procedures
Use these methods to manage the antifraud procedures configured in the Back Office.
GET[host]/api/v2/antifraud/procedures |
|
GET[host]/api/v2/antifraud/procedures/{procedureId} |
|
POST[host]/api/v2/antifraud/procedures |
|
PATCH[host]/api/v2/antifraud/procedures/{procedureId} |
|
DELETE[host]/api/v2/antifraud/procedures/{procedureId} |
Get a list of antifraud procedures
Use this method to obtain a list of available antifraud procedures.
Request
Header parameters:
Authorization: Bearer <token>
Query parameters:
The following filter parameters are available for this method:
- id
The identifier of a procedure.
- caption
The procedure description.
- priority
The priority index assigned to a procedure.
The following sorting parameter is available for this method:
- createTime
The date and time when a procedure was configured.
Refer to the Query parameters section in the API Overview for details on applying filter and sorting parameters.
GET[host]/api/v2/antifraud/procedures
curl --location --request GET 'https://host.name/api/v2/antifraud/procedures?limit=10&offset=0&sort_by=createTime&filter[id]=1&filter[caption]=identical_ip&filter[priority]=1' \
--header 'accept-language: <string>' \
--header 'Authorization: Bearer <token>'
Response
A response contains an array of Antifraud Procedure objects providing information about the antifraud procedures matching the request parameters.
Get antifraud procedure details
Use this method to obtain detailed information about a specified antifraud procedure.
Request
Header parameters:
Authorization: Bearer <token>
Path parameters:
- procedureId required
The identifier of a procedure.
GET[host]/api/v2/antifraud/procedures/{procedureId}
curl --location --request GET 'https://host.name/api/v2/antifraud/procedures/:procedureId' \
--header 'Authorization: Bearer <token>'
Response
A response contains an Antifraud Procedure object providing information about the specified antifraud procedure.
Create an antifraud procedure
Use this method to create an antifraud procedure.
Request
Header parameters:
Authorization: Bearer <token>
Content-Type: application/json
Body:
- caption string required
The procedure description.
- notificationType string required
The event type.
- priority integer
The priority index assigned to a procedure.
- responsibilities array
An array of integer values indicating the Back Office users who are notified about the occurred event type and responsible for further processing of an antifraud procedure.
POST[host]/api/v2/antifraud/procedures
curl --location --request POST 'https://host.name/api/v2/antifraud/procedures' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
"caption": "identical_ip",
"notificationType": "identical_ip",
"priority": 3,
"responsibilities": [
1,
20
]
}'
Response
A response contains an Antifraud Procedure object providing information about the created antifraud procedure.
Update an antifraud procedure
Use this method to update a specified antifraud procedure.
Request
Header parameters:
Authorization: Bearer <token>
Content-Type: application/json
Path parameters:
- procedureId required
The identifier of a procedure.
Body:
- caption string
The procedure description.
- notificationType string
The event type.
- priority integer
The priority index assigned to a procedure.
- responsibilities array
An array of integer values indicating the Back Office users who are notified about the occurred event type and responsible for further processing of an antifraud procedure.
PATCH[host]/api/v2/antifraud/procedures/{procedureId}
curl --location --request PATCH 'https://host.name/api/v2/antifraud/procedures/:procedureId' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
"caption": "identical_ip",
"notificationType": "identical_ip",
"priority": 1,
"responsibilities": [
1,
20
]
}'
Response
A response contains an Antifraud Procedure object providing information about the antifraud procedure that was updated.
Delete an antifraud procedure
Use this method to delete a specified antifraud procedure.
Request
Header parameters:
Authorization: Bearer <token>
Path parameters:
- procedureId required
The identifier of a procedure.
DELETE[host]/api/v2/antifraud/procedures/{procedureId}
curl --location --request DELETE 'https://host.name/api/v2/antifraud/procedures/:procedureId' \
--header 'Authorization: Bearer <token>'
Response
In case of success, no response body is returned.