Authentication
Bearer API keys, how to create them and how revocation works.
Send your key in the Authorization header of every request:
Authorization: Bearer vz_live_YOUR_KEY| Problem | Response |
|---|---|
No Authorization: Bearer header | 401 missing_api_key |
| Unknown, malformed or revoked key | 401 invalid_api_key |
| Plan does not include API access | 403 plan_required |
| Account is suspended | 403 account_suspended |
Managing keys
Create and revoke keys at verizol.ai/userApiKeys.
- Live keys start with
vz_live_. - The full key is shown once, when you create it. We store only a hash, so we cannot show it again. If you lose it, revoke it and create a new one.
- You can have at most 5 active keys. Revoke one to create another.
- A revoked key stops working within 60 seconds.
- Keep keys on your server. Never ship a live key in a browser or mobile app.
The public sandbox key starts with vz_test_. See Sandbox.