Verification history
Use these methods to obtain information about all operations of granting verification levels to clients.
GET[host]/api/v2/verifications |
|
GET[host]/v2/verifications/{verificationId} |
Get verification history
Use this method to obtain a list of all operations of granting verification levels to clients.
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 verification history of clients marked with these tags.
To obtain detailed information about a specified operation, use a separate method to get verification details.
Request
Header parameters:
Authorization: Bearer <access_token>
Query parameters:
The following filter parameter is available for this method:
- clientId
The client identifier.
The following sorting parameter is available for this method:
- createTime
The date and time when a verification level was granted to a client.
Refer to the Query parameters section in the API Overview for details on applying filter and sorting parameters.
GET[host]/api/v2/verifications
curl --location -g --request GET 'https://host.name/api/v2/verifications?limit=10&offset=0&sort_order=desc&sort_by=createTime&filter[clientId]=222' \
--header 'Authorization: Bearer <token>'
Response
- id integer
The identifier of an operation of granting a verification level.
- clientId integer
The client identifier.
- currentLevel object
The details about a client’s current verification level:
Show object fields- id integer
The identifier of a verification level.
- name string
The name of a verification level.
- previuosLevel object or null
The details about a client’s previous verification level.
If a client is only granted the initial verification level so far,
null
is returned for the previous verification level.Show object fields- id integer
The identifier of a verification level.
- name string
The name of a verification level.
- reason object
The details about the reason for granting a verification level.
Show object fields- name string
The reason why a verification level was granted.
- userId integer or null
The identifier of an admin who granted a verification level.
- createTime string or null
The date and time when a verification level was granted to a client.
{
"total": 2,
"data": [
{
"id": 75,
"clientId": 222,
"currentLevel": {
"id": 2,
"name": "Level 1"
},
"previousLevel": {
"id": 1,
"name": "Level 0"
},
"reason": {
"name": "Application: 838"
},
"userId": "1",
"createTime": "2022-01-01T00:00:00+00:00"
},
{
"id": 186,
"clientId": 222,
"currentLevel": {
"id": 1,
"name": "Level 0"
},
"previousLevel": null,
"reason": {
"name": "created"
},
"userId": "1",
"createTime": "2022-01-01T00:00:00+00:00"
}
]
}
Get verification details
Use this method to obtain detailed information about a specified operation of granting a verification level.
To obtain a list of all operations of granting verification levels, use a separate method to get verification history.
Request
Header parameters:
Authorization: Bearer <access_token>
Path parameters:
- verificationId required
The identifier of an operation of granting a verification level.
GET[host]/v2/verifications/{verificationId}
curl --location --request GET 'https://host.name/api/v2/verifications/18' \
--header 'Authorization: Bearer <token>'
Response
- id integer
The identifier of an operation of granting a verification level.
- clientId integer
The client identifier.
- currentLevel object
The details about a client’s current verification level:
Show object fields- id integer
The identifier of a verification level.
- name string
The name of a verification level.
- previousLevel object or null
The details about a client’s previous verification level.
If a client is only granted the initial verification level so far,
null
is returned for the previous verification level.Show object fields- id integer
The identifier of a verification level.
- name string
The name of a verification level.
- reason object
The details about the reason for granting a verification level.
Show object fields- name string
The reason why a verification level was granted.
- userId integer or null
The identifier of an admin who granted a verification level.
- createTime string or null
The date and time when a verification level was granted to a client.
{
"total": 1,
"data": [
{
"id": 18,
"clientId": 17,
"currentLevel": {
"id": 1,
"name": "Level 0"
},
"previousLevel": null,
"reason": {
"name": "created"
},
"userId": 11,
"createTime": "2022-01-01T00:00:00+00:00"
}
]
}