Requests
Use these methods to manage submitted client requests.
GET[host]/api/v2/applications |
|
GET[host]/v2/applications/{applicationId} |
|
PUT[host]/v2/applications/{applicationId} PATCH[host]/v2/applications/{applicationId} |
POST[host]/api/v2/applications/{applicationId}/audit |
|
POST[host]/api/v2/applications/{applicationId}/approve |
|
POST[host]/api/v2/applications/{applicationId}/reject |
Use this method to get notifications about submitted client requests.
GET[host]/api/v2/applications/notifications |
Get a list of requests
Use this method to obtain a list of submitted client requests.
Note
If such a request is made by an admin user that is only permitted to view clients with certain tags, a response includes only the requests of clients marked with these tags.
To obtain detailed information about a specific client request, use a separate method to get request details.
Request
Header parameters:
Authorization: Bearer <access_token>
Query parameters:
The following filter parameters are available for this method:
- id
The request identifier.
- clientId
The client identifier.
- type
The request type. Possible values:
account
address
archive
clientType
deposit
document
external
investment
partner
profile
transfer
verification
withdrawal
- statusId
The identifier of a request status. Possible values:
0
—pending
1
—approved
2
—rejected
3
—inProgress
127
—new
Refer to the Query parameters section in the API Overview for details on applying filter parameters.
GET[host]/api/v2/applications
curl --location -g --request GET 'https://host.name/api/v2/applications?limit=10&offset=0&filter[id]=1&filter[clientId]=1&filter[type]=verification&filter[statusId]=1' \
--header 'Authorization: Bearer <token>'
Response
A response contains an array of Request objects providing information about the submitted client requests that correspond to the query parameters.
Get request details
Use this method to obtain detailed information about a specified client request.
To obtain a list of submitted client requests, use a separate method to get a list of requests.
Request
Header parameters:
Authorization: Bearer <access_token>
Path parameters:
- applicationId required
The request identifier.
GET[host]/v2/applications/{applicationId}
curl --location --request GET 'https://host.name/api/v2/applications/1' \
--header 'Authorization: Bearer <token>'
Response
A response contains a Request object providing information about the specified client request.
Update a request
Use this method to update a specified client request.
Note
Instead of the method described below, you can use a similar method that uses the HTTP verb PATCH.
Request
Header parameters:
Authorization: Bearer <access_token>
Path parameters:
- applicationId required
The request identifier.
Body:
The following field value can be updated for a specified request:
- color string
The HEX color code for request highlighting.
PUT[host]/v2/applications/{applicationId}
curl --location --request PUT 'https://host.name/api/v2/applications/1' \
--header 'Authorization: Bearer <token>'
--data-raw '{
"color": "#fbe1e3"
}'
Response
A response includes a Request object providing information about the client request that was updated.
Audit a request
Use this method to check all incoming transactions on a client account before approving or rejecting a specified client request. After checking, a notification is returned if a significant discrepancy is found on the balance.
Request
Header parameters:
Authorization: Bearer <access_token>
Path parameters:
- applicationId required
The request identifier.
POST[host]/api/v2/applications/{applicationId}/audit
curl --location --request POST 'https://host.name/api/v2/applications/1/audit' \
--header 'Authorization: Bearer <token>'
Response
- clintId integer
The client identifier.
- result array
An array of string values specifying the result of a transaction check.
{
"clintId": 1,
"result": [
"All OK"
]
}
Approve a request
Use this method to approve a specified client request.
Request
Header parameters:
Authorization: Bearer <access_token>
Path parameters:
- applicationId required
The request identifier.
Body:
You can specify the following parameter for a request:
- data array
An array of string values specifying internal comments that you can add to a request.
POST[host]/api/v2/applications/{applicationId}/approve
curl --location --request POST 'https://host.name/api/v2/applications/1/approve' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
"data": [
"Comment 1",
"Comment 2"
]
}'
Response
In case of success, no response body is returned.
Reject a request
Use this method to reject a specified client request.
Request
Header parameters:
Authorization: Bearer <access_token>
Path parameters:
- applicationId required
The request identifier.
Body:
Specify the following parameters for a request:
- resolutionId integer required
The resolution identifier.
- data array
An array of string values specifying internal comments that you can add to a request.
- resolutionType integer
The resolution type identifier.
POST[host]/api/v2/applications/{applicationId}/reject
curl --location --request POST 'https://host.name/api/v2/applications/1/reject' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
"resolutionId": 1,
"data": [
"Comment 1",
"Comment 2"
],
"resolutionType": 1
}'
Response
In case of success, no response body is returned.
Get request notifications
Use this method to get notifications about submitted client requests.
Request
Header parameters:
Authorization: Bearer <access_token>
GET[host]/api/v2/applications/notifications
curl --location --request GET 'https://host.name/api/v2/applications/notifications?limit=10' \
--header 'Authorization: Bearer <token>'
Response
A response contains an array of objects providing the following data:
- link string
The link to a request that must be approved or rejected.
- type string
The request type.
- text string
The notification text.
{
"total": 2,
"data": [
{
"link": "https://example.url/requests/edit/1",
"type": "Verification",
"text": "New user request"
},
{
"link": "https://example.url/requests/edit/2",
"type": "Payout",
"text": "Withdrawal request 2.000 BTC from 149"
}
]
}