Get a custom domain
curl --request GET \
--url https://api.voucher-staging.allride.io/partner/v1/custom-domains/{customDomainId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.voucher-staging.allride.io/partner/v1/custom-domains/{customDomainId}', 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/custom-domains/{customDomainId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.get("https://api.voucher-staging.allride.io/partner/v1/custom-domains/{customDomainId}")
.header("Authorization", "Bearer <token>")
.asString();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/partner/v1/custom-domains/{customDomainId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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/custom-domains/{customDomainId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"id": 20017,
"resource": "custom-domain",
"partnerId": 1069,
"hostname": "vouchers.example-transit.example.com",
"purpose": "redemption-landing",
"status": "active",
"sslStatus": "active",
"verificationRecords": [
{
"type": "cname",
"name": "vouchers.example-transit.example.com",
"value": "customers.voucher.allride.io",
"purpose": "routing"
},
{
"type": "txt",
"name": "_allride-voucher-domain.vouchers.example-transit.example.com",
"value": "4f0c2b1e9d8a7c6b",
"purpose": "ownership"
}
],
"verificationErrors": [],
"lastCheckedAt": "2026-10-22T10:20:00Z",
"activatedAt": "2026-10-22T10:20:00Z",
"isDefaultLanding": true,
"activeLinkCount": 12,
"createdAt": "2026-10-22T10:00:00Z",
"updatedAt": "2026-10-22T10:20:00Z",
"_links": {
"self": {
"href": "https://api.voucher.allride.io/partner/v1/custom-domains/20017",
"type": "application/json"
}
}
}
}
Custom domains
Get a custom domain
Returns one domain with its DNS records and status. Consumer partners only. See Custom domains.
Required permissions: view-domains · API keys: allowed
GET
/
partner
/
v1
/
custom-domains
/
{customDomainId}
Get a custom domain
curl --request GET \
--url https://api.voucher-staging.allride.io/partner/v1/custom-domains/{customDomainId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.voucher-staging.allride.io/partner/v1/custom-domains/{customDomainId}', 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/custom-domains/{customDomainId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.get("https://api.voucher-staging.allride.io/partner/v1/custom-domains/{customDomainId}")
.header("Authorization", "Bearer <token>")
.asString();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/partner/v1/custom-domains/{customDomainId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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/custom-domains/{customDomainId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"id": 20017,
"resource": "custom-domain",
"partnerId": 1069,
"hostname": "vouchers.example-transit.example.com",
"purpose": "redemption-landing",
"status": "active",
"sslStatus": "active",
"verificationRecords": [
{
"type": "cname",
"name": "vouchers.example-transit.example.com",
"value": "customers.voucher.allride.io",
"purpose": "routing"
},
{
"type": "txt",
"name": "_allride-voucher-domain.vouchers.example-transit.example.com",
"value": "4f0c2b1e9d8a7c6b",
"purpose": "ownership"
}
],
"verificationErrors": [],
"lastCheckedAt": "2026-10-22T10:20:00Z",
"activatedAt": "2026-10-22T10:20:00Z",
"isDefaultLanding": true,
"activeLinkCount": 12,
"createdAt": "2026-10-22T10:00:00Z",
"updatedAt": "2026-10-22T10:20:00Z",
"_links": {
"self": {
"href": "https://api.voucher.allride.io/partner/v1/custom-domains/20017",
"type": "application/json"
}
}
}
}
Authorizations
Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.
Path Parameters
Custom domain id. Unsigned 64-bit integer (ids and large counters). May exceed 2^53; parse with a BigInt-safe JSON parser in JavaScript.
Required range:
0 <= x <= 18446744073709552000Response
OK
Single-object envelope around a CustomDomain.
A custom host name for your Redemption Link landing pages.
Show child attributes
Show child attributes