Verify a key
curl --request POST \
--url https://api.formizee.com/v1/key/verify \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"key": "key_4VjHrJoEwAFC6itz8oUBW9NW2bia"
}
'import requests
url = "https://api.formizee.com/v1/key/verify"
payload = { "key": "key_4VjHrJoEwAFC6itz8oUBW9NW2bia" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({key: 'key_4VjHrJoEwAFC6itz8oUBW9NW2bia'})
};
fetch('https://api.formizee.com/v1/key/verify', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.formizee.com/v1/key/verify",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'key' => 'key_4VjHrJoEwAFC6itz8oUBW9NW2bia'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.formizee.com/v1/key/verify"
payload := strings.NewReader("{\n \"key\": \"key_4VjHrJoEwAFC6itz8oUBW9NW2bia\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.formizee.com/v1/key/verify")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"key_4VjHrJoEwAFC6itz8oUBW9NW2bia\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.formizee.com/v1/key/verify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"key\": \"key_4VjHrJoEwAFC6itz8oUBW9NW2bia\"\n}"
response = http.request(request)
puts response.read_body{
"id": "key_4VjHrJoEwAFC6itz8oUBW9NW2bia",
"name": "My New Key",
"workspaceId": "ws_4VjHrJoEwAFC6itz8oUBW9NW2bia",
"expiresAt": "2024-07-23 12:41:45.38215",
"lastAccess": "2024-07-23 12:41:45.38215"
}{
"code": "BAD_REQUEST",
"message": "Missing required field 'name'.",
"docs": "https://formizee.com/api-references/errors/code/BAD_REQUEST",
"requestId": "<string>"
}{
"code": "UNAUTHORIZED",
"message": "Missing required field 'name'.",
"docs": "https://formizee.com/api-references/errors/code/UNAUTHORIZED",
"requestId": "<string>"
}{
"code": "FORBIDDEN",
"message": "Missing required field 'name'.",
"docs": "https://formizee.com/api-references/errors/code/FORBIDDEN",
"requestId": "<string>"
}{
"code": "NOT_FOUND",
"message": "Missing required field 'name'.",
"docs": "https://formizee.com/api-references/errors/code/NOT_FOUND",
"requestId": "<string>"
}{
"code": "METHOD_NOT_ALLOWED",
"message": "Missing required field 'name'.",
"docs": "https://formizee.com/api-references/errors/code/METHOD_NOT_ALLOWED",
"requestId": "<string>"
}{
"code": "CONFLICT",
"message": "Missing required field 'name'.",
"docs": "https://formizee.com/api-references/errors/code/CONFLICT",
"requestId": "<string>"
}{
"code": "PAYLOAD_TOO_LARGE",
"message": "Missing required field 'name'.",
"docs": "https://formizee.com/api-references/errors/code/PAYLOAD_TOO_LARGE",
"requestId": "<string>"
}{
"code": "TOO_MANY_REQUESTS",
"message": "Missing required field 'name'.",
"docs": "https://formizee.com/api-references/errors/code/TOO_MANY_REQUESTS",
"requestId": "<string>"
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Missing required field 'name'.",
"docs": "https://formizee.com/api-references/errors/code/INTERNAL_SERVER_ERROR",
"requestId": "<string>"
}{
"code": "GATEWAY_TIMEOUT",
"message": "Missing required field 'name'.",
"docs": "https://formizee.com/api-references/errors/code/GATEWAY_TIMEOUT",
"requestId": "<string>"
}Keys
Verify a key
POST
/
v1
/
key
/
verify
Verify a key
curl --request POST \
--url https://api.formizee.com/v1/key/verify \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"key": "key_4VjHrJoEwAFC6itz8oUBW9NW2bia"
}
'import requests
url = "https://api.formizee.com/v1/key/verify"
payload = { "key": "key_4VjHrJoEwAFC6itz8oUBW9NW2bia" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({key: 'key_4VjHrJoEwAFC6itz8oUBW9NW2bia'})
};
fetch('https://api.formizee.com/v1/key/verify', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.formizee.com/v1/key/verify",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'key' => 'key_4VjHrJoEwAFC6itz8oUBW9NW2bia'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.formizee.com/v1/key/verify"
payload := strings.NewReader("{\n \"key\": \"key_4VjHrJoEwAFC6itz8oUBW9NW2bia\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.formizee.com/v1/key/verify")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"key_4VjHrJoEwAFC6itz8oUBW9NW2bia\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.formizee.com/v1/key/verify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"key\": \"key_4VjHrJoEwAFC6itz8oUBW9NW2bia\"\n}"
response = http.request(request)
puts response.read_body{
"id": "key_4VjHrJoEwAFC6itz8oUBW9NW2bia",
"name": "My New Key",
"workspaceId": "ws_4VjHrJoEwAFC6itz8oUBW9NW2bia",
"expiresAt": "2024-07-23 12:41:45.38215",
"lastAccess": "2024-07-23 12:41:45.38215"
}{
"code": "BAD_REQUEST",
"message": "Missing required field 'name'.",
"docs": "https://formizee.com/api-references/errors/code/BAD_REQUEST",
"requestId": "<string>"
}{
"code": "UNAUTHORIZED",
"message": "Missing required field 'name'.",
"docs": "https://formizee.com/api-references/errors/code/UNAUTHORIZED",
"requestId": "<string>"
}{
"code": "FORBIDDEN",
"message": "Missing required field 'name'.",
"docs": "https://formizee.com/api-references/errors/code/FORBIDDEN",
"requestId": "<string>"
}{
"code": "NOT_FOUND",
"message": "Missing required field 'name'.",
"docs": "https://formizee.com/api-references/errors/code/NOT_FOUND",
"requestId": "<string>"
}{
"code": "METHOD_NOT_ALLOWED",
"message": "Missing required field 'name'.",
"docs": "https://formizee.com/api-references/errors/code/METHOD_NOT_ALLOWED",
"requestId": "<string>"
}{
"code": "CONFLICT",
"message": "Missing required field 'name'.",
"docs": "https://formizee.com/api-references/errors/code/CONFLICT",
"requestId": "<string>"
}{
"code": "PAYLOAD_TOO_LARGE",
"message": "Missing required field 'name'.",
"docs": "https://formizee.com/api-references/errors/code/PAYLOAD_TOO_LARGE",
"requestId": "<string>"
}{
"code": "TOO_MANY_REQUESTS",
"message": "Missing required field 'name'.",
"docs": "https://formizee.com/api-references/errors/code/TOO_MANY_REQUESTS",
"requestId": "<string>"
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Missing required field 'name'.",
"docs": "https://formizee.com/api-references/errors/code/INTERNAL_SERVER_ERROR",
"requestId": "<string>"
}{
"code": "GATEWAY_TIMEOUT",
"message": "Missing required field 'name'.",
"docs": "https://formizee.com/api-references/errors/code/GATEWAY_TIMEOUT",
"requestId": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The id of the key
Pattern:
^[a-zA-Z]+_[a-zA-Z0-9]+$Example:
"key_4VjHrJoEwAFC6itz8oUBW9NW2bia"
Response
Key verified
The id of the key
Example:
"key_4VjHrJoEwAFC6itz8oUBW9NW2bia"
The name of the key
Required string length:
4 - 64Example:
"My New Key"
The id of the workspace
Example:
"ws_4VjHrJoEwAFC6itz8oUBW9NW2bia"
The expiration date of the key
Example:
"2024-07-23 12:41:45.38215"
The last time the key was used
Example:
"2024-07-23 12:41:45.38215"
Was this page helpful?
⌘I