Endpoints
Verify key
POST
/
keys
/
verify
Headers
your workspace API key
Body
application/json
API ID from your dashboard
The generated API key
Response
200 - application/json
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
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
The ID of the API the key belongs to
The name assigned to the key
The prefix assigned to the key
The length assigned to the key
Required range:
16 < x < 255
extra details you passed via the meta attribute
Unix timestamp of when the key expires, returns null
when not set
maximum verification allowed for this key, returns null
when not set