Retrieve API key

GET

https://api.withverifa.com/api/v1/api-keys/:api_key_id

Returns a single API key by its public ID. The secret is never returned.

X-API-Keystring

Organization API key. Keys are prefixed with vk_live_ (production) or vk_sandbox_ (sandbox).

api_key_idstringRequired

API key details.

idstring

typeenum

environmentenum

key_prefixstring

First characters of the key for identification.

is_activeboolean

created_atdatetime

labelstring or nullOptional

notestring or nullOptional

scopeslist of strings or nullOptional

Permission scopes granted to this key.

api_versionstring or nullOptional

default_key_inflectionenumOptional

allowed_ipslist of strings or nullOptional

IP allowlist. Null means all IPs are allowed.

expires_atdatetime or nullOptional

last_used_atdatetime or nullOptional

401

Unauthorized Error

404

Not Found Error

1	{
2	"id": "key_abc123",
3	"type": "api-key",
4	"environment": "live",
5	"key_prefix": "vk_live_abc1",
6	"is_active": true,
7	"created_at": "2024-01-15T09:30:00Z",
8	"label": "string",
9	"note": "string",
10	"scopes": [
11	"string"
12	],
13	"api_version": "string",
14	"default_key_inflection": "camel",
15	"allowed_ips": [
16	"string"
17	],
18	"expires_at": "2024-01-15T09:30:00Z",
19	"last_used_at": "2024-01-15T09:30:00Z"
20	}

$	curl https://api.withverifa.com/api/v1/api-keys/key_abc123 \
>	-H "X-API-Key: <apiKey>"