Create an API key
curl --request POST \
--url https://api.voucher-staging.allride.io/partner/v1/api-keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Redemption service",
"scopes": [
"view-consumer-catalog",
"create-consumer-redemptions",
"view-consumer-redemptions"
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Redemption service',
scopes: [
'view-consumer-catalog',
'create-consumer-redemptions',
'view-consumer-redemptions'
]
})
};
fetch('https://api.voucher-staging.allride.io/partner/v1/api-keys', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.voucher-staging.allride.io/partner/v1/api-keys"
payload = {
"name": "Redemption service",
"scopes": ["view-consumer-catalog", "create-consumer-redemptions", "view-consumer-redemptions"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.post("https://api.voucher-staging.allride.io/partner/v1/api-keys")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Redemption service\",\n \"scopes\": [\n \"view-consumer-catalog\",\n \"create-consumer-redemptions\",\n \"view-consumer-redemptions\"\n ]\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/partner/v1/api-keys"
payload := strings.NewReader("{\n \"name\": \"Redemption service\",\n \"scopes\": [\n \"view-consumer-catalog\",\n \"create-consumer-redemptions\",\n \"view-consumer-redemptions\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voucher-staging.allride.io/partner/v1/api-keys",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Redemption service',
'scopes' => [
'view-consumer-catalog',
'create-consumer-redemptions',
'view-consumer-redemptions'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"id": 12017,
"resource": "api-key",
"partnerId": 1069,
"name": "Redemption service",
"environment": "test",
"keyHint": "vk_test_01m5h6n1mjfgk9m1g3jg7bx74b_…Qa7Z",
"last4": "Qa7Z",
"scopes": [
"view-consumer-catalog",
"create-consumer-redemptions",
"view-consumer-redemptions"
],
"status": "active",
"expiresAt": "2027-10-22T10:00:00Z",
"lastUsedAt": null,
"lastUsedIp": null,
"rolledFromId": null,
"createdBy": {
"type": "partner-user",
"id": 4069,
"label": "ops@example.com"
},
"revokedBy": null,
"revokedAt": null,
"secret": "vk_test_01m5h6n1mjfgk9m1g3jg7bx74b_ExampleSecretDoNotUse0000000000000000000000",
"createdAt": "2026-10-22T10:00:00Z",
"updatedAt": "2026-10-22T10:00:00Z",
"_links": {
"self": {
"href": "https://api.voucher.allride.io/partner/v1/api-keys/12017",
"type": "application/json"
}
}
}
}
API keys
Create an API key
Creates a key with least-privilege scopes. The secret is returned once in this response; store it in a secret manager. Needs active API access; at most 20 active keys. API keys are managed only in the developer dashboard; API keys cannot call this operation. See API keys.
Required permissions: manage-api-keys · API keys: not allowed · Recent sign-in: required for dashboard users (15 minutes)
POST
/
partner
/
v1
/
api-keys
Create an API key
curl --request POST \
--url https://api.voucher-staging.allride.io/partner/v1/api-keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Redemption service",
"scopes": [
"view-consumer-catalog",
"create-consumer-redemptions",
"view-consumer-redemptions"
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Redemption service',
scopes: [
'view-consumer-catalog',
'create-consumer-redemptions',
'view-consumer-redemptions'
]
})
};
fetch('https://api.voucher-staging.allride.io/partner/v1/api-keys', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.voucher-staging.allride.io/partner/v1/api-keys"
payload = {
"name": "Redemption service",
"scopes": ["view-consumer-catalog", "create-consumer-redemptions", "view-consumer-redemptions"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.post("https://api.voucher-staging.allride.io/partner/v1/api-keys")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Redemption service\",\n \"scopes\": [\n \"view-consumer-catalog\",\n \"create-consumer-redemptions\",\n \"view-consumer-redemptions\"\n ]\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/partner/v1/api-keys"
payload := strings.NewReader("{\n \"name\": \"Redemption service\",\n \"scopes\": [\n \"view-consumer-catalog\",\n \"create-consumer-redemptions\",\n \"view-consumer-redemptions\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voucher-staging.allride.io/partner/v1/api-keys",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Redemption service',
'scopes' => [
'view-consumer-catalog',
'create-consumer-redemptions',
'view-consumer-redemptions'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"id": 12017,
"resource": "api-key",
"partnerId": 1069,
"name": "Redemption service",
"environment": "test",
"keyHint": "vk_test_01m5h6n1mjfgk9m1g3jg7bx74b_…Qa7Z",
"last4": "Qa7Z",
"scopes": [
"view-consumer-catalog",
"create-consumer-redemptions",
"view-consumer-redemptions"
],
"status": "active",
"expiresAt": "2027-10-22T10:00:00Z",
"lastUsedAt": null,
"lastUsedIp": null,
"rolledFromId": null,
"createdBy": {
"type": "partner-user",
"id": 4069,
"label": "ops@example.com"
},
"revokedBy": null,
"revokedAt": null,
"secret": "vk_test_01m5h6n1mjfgk9m1g3jg7bx74b_ExampleSecretDoNotUse0000000000000000000000",
"createdAt": "2026-10-22T10:00:00Z",
"updatedAt": "2026-10-22T10:00:00Z",
"_links": {
"self": {
"href": "https://api.voucher.allride.io/partner/v1/api-keys/12017",
"type": "application/json"
}
}
}
}
Dashboard session only. API keys cannot call this operation.
Authorizations
Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.
Headers
Optional key (1-255 printable ASCII characters, no spaces; a UUID is ideal) that makes this POST safe to retry: the same key with the same request replays the stored response for 24 hours. See Idempotency.
Required string length:
1 - 255Pattern:
^[\x21-\x7E]{1,255}$Body
application/json
New API key.
Name (1-80 characters).
Required string length:
1 - 80Delegable permissions you hold yourself (1-100).
Required array length:
1 - 100 elementsA permission (role) key such as view-consumer-catalog or create-consumer-redemptions. See Permissions and scopes and GET /partner/v1/permissions.
Pattern:
^[a-z][a-z0-9-]*$Expiry, at most 2 years ahead; null for none (rotate at least every 12 months).
Example:
"2026-11-01T00:00:00Z"
Response
Created
Single-object envelope around a ApiKeyWithSecret.
A newly created or rolled API key with its secret.
Show child attributes
Show child attributes