POST
/
keys
/
verify
curl --request POST \
  --url https://api.datkey.dev/keys/verify \
  --header 'Content-Type: application/json' \
  --data '{
  "api_id": "{api_id}",
  "key": "key_xxxxxxxxxxxxxxxx"
}'
{
  "valid": true,
  "key": {
    "id": "<id>",
    "name": "ACME INC",
    "key": "flox_sk_05ad2bf*********",
    "prefix": "flox_sk",
    "length": 16,
    "verifications": 5,
    "verification_limit": 90,
    "expires_at": 1733237153,
    "meta": null,
    "created_at": "2023-12-05T11:31:23.000000Z",
    "updated_at": "2023-12-05T13:03:24.000000Z"
  }
}

Headers

​
x-api-key
string

your workspace API key

Body

application/json
​
api_id
string
required

API ID from your dashboard

Example:

"{api_id}"

​
key
string
required

The generated API key

Example:

"key_xxxxxxxxxxxxxxxx"

Response

200
application/json
OK
​
valid
boolean

Whether the key is valid or not. A key could be invalid for a number of reasons, for example if it has expired or has no more verifications left

Example:

true

​
status
enum<string>

If the key status is false this field will be set to the reason why it is invalid. Possible values are:

  • USAGE_EXCEEDED: the key has exceeded its validation limit
  • EXPIRED: the key has expired,
Available options:
EXPIRED,
USAGE_EXCEEDED
​
api_id
string

The ID of the API the key belongs to

Example:

"{api_id}"

​
name
string

The name assigned to the key

Example:

"{api_name}"

​
prefix
string

The prefix assigned to the key

Example:

"prefix"

​
length
integer
default:16

The length assigned to the key

Required range: 16 <= x <= 255
​
meta
object

extra details you passed via the meta attribute

Example:
{ "user_id": "123456" }
​
expires_at
integer

Unix timestamp of when the key expires, returns null when not set

​
verification_limit
integer

maximum verification allowed for this key, returns null when not set

Get keyRevoke key