Endpoints
Verify key
Endpoints
Verify key
POST
/
keys
/
verify
Headers
x-api-key
string
your workspace API key
Body
application/json
api_id
string
requiredAPI ID from your dashboard
key
string
requiredThe generated API key
Response
200 - application/json
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
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
name
string
The name assigned to the key
prefix
string
The prefix assigned to the key
length
integer
default: 16The length assigned to the key
Required range:
16 < x < 255meta
object
extra details you passed via the meta attribute
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