Get key status
curl --request GET \
--url https://{host}/v1/status \
--header 'X-Api-Key: <api-key>'const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://{host}/v1/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/v1/status"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": {
"service": "<string>",
"server_time": "2023-11-07T05:31:56Z",
"key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"public_key_id": "<string>",
"client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"client_type": "<string>",
"permissions": [
"<string>"
],
"client_name": "<string>",
"business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mode": "<string>"
},
"code": "13"
}{
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": null,
"code": "13"
}Status
Get key status
Shows who the presented key belongs to and what it may do; a quick check that a key works.
GET
/
v1
/
status
Get key status
curl --request GET \
--url https://{host}/v1/status \
--header 'X-Api-Key: <api-key>'const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://{host}/v1/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/v1/status"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": {
"service": "<string>",
"server_time": "2023-11-07T05:31:56Z",
"key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"public_key_id": "<string>",
"client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"client_type": "<string>",
"permissions": [
"<string>"
],
"client_name": "<string>",
"business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mode": "<string>"
},
"code": "13"
}{
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": null,
"code": "13"
}