Retrieve API key | Verifa

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

Allowed values:

environmentenum

Allowed values:

key_prefixstring

First characters of the key for identification.

is_activeboolean

created_atdatetime

labelstring or null

notestring or null

scopeslist of strings or null

Permission scopes granted to this key.

api_versionstring or null

default_key_inflectionenum

Allowed values:

allowed_ipslist of strings or null

IP allowlist. Null means all IPs are allowed.

expires_atdatetime or null

last_used_atdatetime or null

401

Unauthorized Error

404

Not Found Error

1	import requests
2
3	url = "https://devapi.withverifa.com/api/v1/api-keys/key_abc123"
4
5	headers = {"X-API-Key": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

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	}