> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.withverifa.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.withverifa.com/_mcp/server.

# Create API key

POST https://api.withverifa.com/api/v1/api-keys
Content-Type: application/json

Creates a new API key. The full secret is returned only in this
response — store it securely.


Reference: https://docs.withverifa.com/api-reference/api-keys/create-api-key

## Authentication

- `X-API-Key` header (required) — Organization API key. Keys are prefixed with `vk_live_` (production) or `vk_sandbox_` (sandbox).

## Request

### Headers

- `Verifa-Version` (date, optional) — API version date string (e.g. `2026-02-01`). If omitted, the version pinned to your API key is used.

### Body (application/json)

This endpoint expects a CreatePublicApiKeyRequest.

- `label` (string, optional, nullable) — Human-readable label for the key.
- `note` (string, optional, nullable) — Internal note about this key's purpose.
- `environment` (enum, optional, default: live) — Environment the key is scoped to.
  - Allowed values: `live`, `sandbox`
- `scopes` (list of string, optional, nullable) — Permission scopes to grant.
- `api_version` (string, optional, nullable)
- `allowed_ips` (list of string, optional, nullable) — IP allowlist for this key.
- `expires_at` (string, optional, nullable) — ISO 8601 expiration timestamp.

## Response

### 201

API key created. The `secret` field is only returned here.

- `created_at` (datetime, required)
- `environment` (enum, required)
  - Allowed values: `live`, `sandbox`
- `id` (string, required)
- `is_active` (boolean, required)
- `key_prefix` (string, required) — First characters of the key for identification.
- `secret` (string, required) — Full API key secret. Only returned at creation time — store it securely as it cannot be retrieved again.
- `type` (enum, required)
  - Allowed values: `api-key`
- `allowed_ips` (list of string, optional, nullable) — IP allowlist. Null means all IPs are allowed.
- `api_version` (string, optional, nullable)
- `default_key_inflection` (enum, optional)
  - Allowed values: `camel`, `snake`, `kebab`
- `expires_at` (datetime, optional, nullable)
- `label` (string, optional, nullable)
- `last_used_at` (datetime, optional, nullable)
- `note` (string, optional, nullable)
- `scopes` (list of string, optional, nullable) — Permission scopes granted to this key.
- `warning` (string, optional) — Reminder to store the secret securely.

## Errors

### 401 Unauthorized Error

Missing or invalid API key.

- `error` (string, required) — Short error code.
- `status_code` (integer, required) — HTTP status code.
- `detail` (string, optional) — Human-readable error description.

### 422 Unprocessable Entity Error

Request validation failed.

- `error` (string, required) — Short error code.
- `status_code` (integer, required) — HTTP status code.
- `detail` (string, optional) — Human-readable error description.

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "created_at": "2024-01-15T09:30:00Z",
  "environment": "live",
  "id": "key_abc123",
  "is_active": true,
  "key_prefix": "vk_live_abc1",
  "secret": "string",
  "type": "api-key",
  "allowed_ips": [
    "string"
  ],
  "api_version": "string",
  "default_key_inflection": "camel",
  "expires_at": "2024-01-15T09:30:00Z",
  "label": "string",
  "last_used_at": "2024-01-15T09:30:00Z",
  "note": "string",
  "scopes": [
    "string"
  ],
  "warning": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.withverifa.com/api/v1/api-keys"

payload = {}
headers = {
    "X-API-Key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.withverifa.com/api/v1/api-keys';
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withverifa.com/api/v1/api-keys"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.withverifa.com/api/v1/api-keys")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.withverifa.com/api/v1/api-keys")
  .header("X-API-Key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.withverifa.com/api/v1/api-keys', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-API-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.withverifa.com/api/v1/api-keys");
var request = new RestRequest(Method.POST);
request.AddHeader("X-API-Key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-API-Key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.withverifa.com/api/v1/api-keys")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```