> ## Documentation Index > Fetch the complete documentation index at: https://docs-consumer.voucher.allride.io/llms.txt > Use this file to discover all available pages before exploring further. # Add a custom domain > Adds a host name in `pending-verification`. Publish the CNAME to `customers.voucher.allride.io` and the TXT ownership and certificate records that appear on the domain shortly after (poll it). Consumer partners only. See [Custom domains](/workspace/custom-domains). **Required permissions:** `manage-domains` · **API keys:** allowed ## OpenAPI ````yaml /openapi/consumer.v1.json post /partner/v1/custom-domains openapi: 3.1.1 info: title: AllRide Voucher Consumer API version: 1.0.0 description: >- The Consumer API (`/consumer/v1`) and the shared Workspace API (`/partner/v1`) of the AllRide Voucher Platform for Partner Consumers: browse your catalog, redeem vouchers, manage redemption entities and Redemption Links, configure email OTP, read analytics and billing, and administer your workspace. Start with the [quickstart](https://docs-consumer.voucher.allride.io/quickstart). This document lists the sandbox server; production uses `https://api.voucher.allride.io`. contact: name: AllRide url: https://allride.io servers: - url: https://api.voucher-staging.allride.io description: Sandbox security: - apiKey: [] tags: - name: Catalog description: >- Browse the providers, voucher sets and categories AllRide makes available to you. - name: Catalog settings description: >- Turn providers and voucher sets on or off for your channels and keep your own settings and references. - name: Redemptions description: >- Redeem vouchers (single or batch), read issued codes and links, and void redemptions. - name: Redemption entities description: Your end customers or accounts, identified by your own opaque `refId`. - name: Redemption links description: >- Shareable links that let an end customer redeem on an AllRide-hosted landing page. - name: Email (SMTP and templates) description: >- Email OTP Gate settings, your SMTP configuration and the OTP email templates. - name: Analytics description: Redemption, entity and link statistics in your partner time zone. - name: Billing description: >- Billing account, contacts, payment methods, invoices (including Stornorechnungen), payments, usage and balance. - name: Pricing description: Your resolved Price Terms per voucher set and your Price Acceptances. - name: Partner description: >- Your partner record, settings, principal introspection, API access and the developer reference. - name: Members description: Users of your partner and their invitations. - name: Groups description: Groups, their permissions and the permission catalog. - name: API keys description: API keys of your partner (dashboard only). - name: Webhook endpoints description: Webhook endpoints, their secrets and the event types you can subscribe to. - name: Webhook deliveries description: The webhook delivery log and replays. - name: IP allowlist description: Source address ranges allowed to call the API. - name: Custom domains description: Your own host names for Redemption Link landing pages. - name: Workspace branding description: Workspace Branding (dashboards and landing pages) and brand assets. - name: Single sign-on description: SAML and OIDC connections for your users. - name: Audit log description: Every change made in your partner, by whom and when. paths: /partner/v1/custom-domains: post: tags: - Custom domains summary: Add a custom domain description: >- Adds a host name in `pending-verification`. Publish the CNAME to `customers.voucher.allride.io` and the TXT ownership and certificate records that appear on the domain shortly after (poll it). Consumer partners only. See [Custom domains](/workspace/custom-domains). **Required permissions:** `manage-domains` · **API keys:** allowed operationId: partner.custom-domains.create parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateCustomDomainBody' examples: default: value: hostname: vouchers.example-transit.example.com purpose: redemption-landing responses: '201': description: Created headers: X-Request-Id: $ref: '#/components/headers/XRequestId' Location: $ref: '#/components/headers/Location' Idempotent-Replayed: $ref: '#/components/headers/IdempotentReplayed' content: application/json: schema: $ref: '#/components/schemas/CustomDomainResponse' examples: default: summary: Created value: data: id: 20017 resource: custom-domain partnerId: 1069 hostname: vouchers.example-transit.example.com purpose: redemption-landing status: pending-verification sslStatus: null verificationRecords: - type: cname name: vouchers.example-transit.example.com value: customers.voucher.allride.io purpose: routing verificationErrors: [] lastCheckedAt: null activatedAt: null isDefaultLanding: false activeLinkCount: 0 createdAt: '2026-10-22T10:00:00Z' updatedAt: '2026-10-22T10:00:00Z' _links: self: href: >- https://api.voucher.allride.io/partner/v1/custom-domains/20017 type: application/json '400': description: Bad Request x-error-codes: - malformed-json - invalid-header - invalid-idempotency-key - data-failed-validation headers: X-Request-Id: $ref: '#/components/headers/XRequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: malformed-json: summary: Malformed JSON value: errors: - message: >- The body is not valid UTF-8 JSON or nests deeper than 32 levels. statusCode: 400 errorCode: malformed-json invalid-header: summary: Invalid header value: errors: - message: >- A standard or platform header is malformed or missing; `more.validationErrors[].property` names it. statusCode: 400 errorCode: invalid-header invalid-idempotency-key: summary: Invalid Idempotency-Key value: errors: - message: >- The `Idempotency-Key` header is not 1-255 printable ASCII characters. statusCode: 400 errorCode: invalid-idempotency-key data-failed-validation: summary: Data failed validation value: errors: - message: >- One or more properties or parameters are invalid; each is listed in `more.validationErrors` with its property path and violated constraint. Unknown properties and query parameters are refused as well. statusCode: 400 errorCode: data-failed-validation more: validationErrors: - property: name constraint: required message: en: This property is required. '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': description: Conflict x-error-codes: - idempotency-key-in-use - domain-taken headers: X-Request-Id: $ref: '#/components/headers/XRequestId' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: idempotency-key-in-use: summary: Idempotency-Key in use value: errors: - message: >- A request with the same `Idempotency-Key` is still being processed. statusCode: 409 errorCode: idempotency-key-in-use domain-taken: summary: Domain taken value: errors: - message: The host name is already registered on the platform. statusCode: 409 errorCode: domain-taken '422': description: Unprocessable Content x-error-codes: - idempotency-key-reused - apex-domain-not-supported - domain-not-allowed - custom-domain-limit-reached headers: X-Request-Id: $ref: '#/components/headers/XRequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: idempotency-key-reused: summary: Idempotency-Key reused value: errors: - message: >- The `Idempotency-Key` was already used for a different request. statusCode: 422 errorCode: idempotency-key-reused apex-domain-not-supported: summary: Apex domain not supported value: errors: - message: >- Only subdomains (at least three labels, such as `vouchers.example-transit.example.com`) can be added. statusCode: 422 errorCode: apex-domain-not-supported domain-not-allowed: summary: Domain not allowed value: errors: - message: Host names under the platform domain cannot be added. statusCode: 422 errorCode: domain-not-allowed custom-domain-limit-reached: summary: Custom domain limit reached value: errors: - message: >- Your partner already has 10 custom domains that are not deleted. statusCode: 422 errorCode: custom-domain-limit-reached '500': $ref: '#/components/responses/InternalError' '503': $ref: '#/components/responses/ServiceUnavailable' components: parameters: IdempotencyKey: name: Idempotency-Key in: header required: false description: >- 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](/guides/idempotency). schema: type: string minLength: 1 maxLength: 255 pattern: ^[\x21-\x7E]{1,255}$ example: order-8812:line-1 schemas: CreateCustomDomainBody: type: object additionalProperties: false required: - hostname - purpose description: New custom domain. properties: hostname: type: string format: hostname description: Subdomain you own (at least three labels). purpose: type: string enum: - redemption-landing description: Always `redemption-landing`. CustomDomainResponse: type: object description: Single-object envelope around a `CustomDomain`. properties: data: $ref: '#/components/schemas/CustomDomain' required: - data additionalProperties: false ErrorResponse: type: object description: >- Error body of every 4xx and 5xx response (`Content-Type: application/json`). properties: errors: type: array minItems: 1 items: $ref: '#/components/schemas/ErrorEntry' description: The errors; in v1 always exactly one. required: - errors additionalProperties: false CustomDomain: type: object description: A custom host name for your Redemption Link landing pages. properties: id: $ref: '#/components/schemas/ULong' description: Numeric id of the resource, unique per resource type. resource: type: string enum: - custom-domain description: Always `custom-domain`. partnerId: $ref: '#/components/schemas/ULong' description: Your partner id. hostname: type: string description: Host name, a subdomain you own. purpose: type: string enum: - redemption-landing description: >- Always `redemption-landing`: custom domains serve only Redemption Link landing pages. Treat as an open set: new values may be added. status: type: string enum: - pending-verification - active - failed - moved - deleted description: 'Domain status. Treat as an open set: new values may be added.' sslStatus: type: - string - 'null' description: Certificate status reported by the edge provider. verificationRecords: type: array items: type: object properties: type: type: string enum: - cname - txt description: 'Record type. Treat as an open set: new values may be added.' name: type: string description: Record name. value: type: string description: Record value. purpose: type: string enum: - routing - ownership - dcv description: >- What the record is for. Treat as an open set: new values may be added. required: - type - name - value - purpose additionalProperties: false description: DNS records to publish. verificationErrors: type: array items: type: string description: Messages from the last check. lastCheckedAt: anyOf: - $ref: '#/components/schemas/Instant' - type: 'null' description: Last check. activatedAt: anyOf: - $ref: '#/components/schemas/Instant' - type: 'null' description: When the domain became active. isDefaultLanding: type: boolean description: Whether this is `settings.defaultLandingDomainId`. activeLinkCount: type: integer description: Number of active Redemption Links on this domain. createdAt: $ref: '#/components/schemas/Instant' description: When the resource was created. updatedAt: $ref: '#/components/schemas/Instant' description: When the resource was last changed. _links: type: object description: >- Related resources you may follow (HAL style). A link is present only when you hold the target's permissions. properties: self: $ref: '#/components/schemas/Link' description: This resource. required: - self additionalProperties: false required: - id - resource - partnerId - hostname - purpose - status - sslStatus - verificationRecords - verificationErrors - lastCheckedAt - activatedAt - isDefaultLanding - activeLinkCount - createdAt - updatedAt - _links additionalProperties: false ErrorEntry: type: object description: One error. Branch on `errorCode`; ignore members you do not know. properties: message: type: string description: >- Human-readable message. For 5xx errors it is always the generic `Something went wrong on our side`. statusCode: type: integer description: The HTTP status. errorCode: type: string description: Stable kebab-case error code, listed in the error catalog. requestId: type: string description: >- 5xx only: the request id (also in the `X-Request-Id` header). Quote it when you contact support. more: type: object additionalProperties: true description: >- Additional details for some codes, for example `validationErrors` (array of `ValidationError`) or `requiredPermissions`. The members per code are listed in the error catalog. properties: validationErrors: type: array items: $ref: '#/components/schemas/ValidationError' description: Invalid properties or parameters. required: - message - statusCode - errorCode additionalProperties: true ULong: type: integer format: uint64 minimum: 0 maximum: 18446744073709552000 x-bigint: true description: >- Unsigned 64-bit integer (ids and large counters). May exceed 2^53; parse with a BigInt-safe JSON parser in JavaScript. Instant: type: string format: date-time description: >- RFC 3339 timestamp in UTC with `Z`, millisecond precision, truncated: no fraction when the milliseconds are zero (`2026-11-01T00:00:00Z`), otherwise exactly three digits (`2026-10-21T17:42:10.120Z`). Inputs must carry an offset and are normalised to UTC. example: '2026-11-01T00:00:00Z' Link: type: object description: A link to a related resource. properties: href: type: string format: uri description: Absolute URL. type: type: string description: Media type of the target, usually `application/json`. required: - href - type additionalProperties: false ValidationError: type: object description: >- One invalid property or parameter of a `data-failed-validation` error (also used for item failures of batch operations and content checks). properties: property: type: string description: >- Path of the offending property in your request body (`items[2].quantity`), or the name of the query parameter, path parameter or header. constraint: type: string description: >- The violated rule as a kebab-case item code, for example `required`, `too-long`, `invalid-id`, `unknown-field`. See the validation item codes in the error catalog. params: type: object additionalProperties: true description: >- Parameters of the constraint, for example `min` and `max` for `invalid-page` or `allowed` for `invalid-sort`. value: description: The rejected value, when it is safe to return. message: type: object description: Explanation per locale. properties: en: type: string description: English message. de: type: string description: German message. required: - en additionalProperties: false required: - property - constraint - message additionalProperties: true headers: XRequestId: description: Request id (yours if you sent a valid `X-Request-Id`, else generated). schema: type: string Location: description: Absolute URL of the created resource or the job to poll. schema: type: string format: uri IdempotentReplayed: description: >- `true` when this response is a replay of a stored response for the same `Idempotency-Key`. schema: type: string enum: - 'true' RetryAfter: description: Seconds to wait before retrying or polling. schema: type: integer responses: Unauthorized: description: 'Unauthorized: the credential is missing or invalid.' x-error-codes: - unauthenticated - token-invalid - token-expired - api-key-invalid headers: X-Request-Id: $ref: '#/components/headers/XRequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: unauthenticated: summary: Authentication required value: errors: - message: No credential was sent with the request. statusCode: 401 errorCode: unauthenticated token-invalid: summary: Invalid credential value: errors: - message: >- The credential cannot be verified for this surface (wrong scheme, signature or credential kind). statusCode: 401 errorCode: token-invalid token-expired: summary: Credential expired value: errors: - message: The dashboard ID token has expired. statusCode: 401 errorCode: token-expired api-key-invalid: summary: Invalid API key value: errors: - message: >- The API key is unknown, revoked, expired, past its roll grace period or belongs to the other environment (`vk_test_` against production or `vk_live_` against the sandbox). statusCode: 401 errorCode: api-key-invalid Forbidden: description: 'Forbidden: an access gate refused the request.' x-error-codes: - partner-role-missing - partner-suspended - partner-offboarded - api-access-inactive - ip-not-allowed - mfa-required - sso-required - missing-permission - reauthentication-required headers: X-Request-Id: $ref: '#/components/headers/XRequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: partner-role-missing: summary: Partner role missing value: errors: - message: >- Your partner lacks the role (provider or consumer) this surface needs. statusCode: 403 errorCode: partner-role-missing more: requiredRole: consumer partner-suspended: summary: Partner suspended value: errors: - message: >- Your partner is suspended: writes are refused (billing writes from the dashboard excepted). statusCode: 403 errorCode: partner-suspended partner-offboarded: summary: Partner offboarded value: errors: - message: Your partner has been offboarded; every route is refused. statusCode: 403 errorCode: partner-offboarded api-access-inactive: summary: API access inactive value: errors: - message: >- API access of your partner is not active (not yet granted, revoked, or the partner is suspended), so API keys are refused. statusCode: 403 errorCode: api-access-inactive ip-not-allowed: summary: IP address not allowed value: errors: - message: >- The request's source address is not in your IP allowlist while enforcement is on. statusCode: 403 errorCode: ip-not-allowed mfa-required: summary: Multi-factor authentication required value: errors: - message: >- Your partner requires multi-factor authentication for dashboard users. statusCode: 403 errorCode: mfa-required sso-required: summary: Single sign-on required value: errors: - message: >- Your partner enforces single sign-on for this user's email domain. statusCode: 403 errorCode: sso-required missing-permission: summary: Missing permission value: errors: - message: >- The membership or API key lacks a permission the operation requires, including non-delegable permissions called with an API key. statusCode: 403 errorCode: missing-permission more: requiredPermissions: - create-consumer-redemptions reauthentication-required: summary: Recent sign-in required value: errors: - message: >- The operation needs a sign-in within the last 15 minutes (dashboard users only). statusCode: 403 errorCode: reauthentication-required NotFound: description: Not found. x-error-codes: - route-not-found headers: X-Request-Id: $ref: '#/components/headers/XRequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: route-not-found: summary: Route not found value: errors: - message: No operation exists for this path. statusCode: 404 errorCode: route-not-found InternalError: description: Unexpected failure; quote the `requestId`. x-error-codes: - internal-error headers: X-Request-Id: $ref: '#/components/headers/XRequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: internal-error: summary: Internal error value: errors: - message: Something went wrong on our side statusCode: 500 errorCode: internal-error requestId: 0c9f2ea5-fe09-463c-8f96-b6cae67800ad ServiceUnavailable: description: Temporarily unavailable; retry after `Retry-After`. x-error-codes: - service-unavailable - db-unavailable - query-timeout headers: X-Request-Id: $ref: '#/components/headers/XRequestId' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: service-unavailable: summary: Service unavailable value: errors: - message: Something went wrong on our side statusCode: 503 errorCode: service-unavailable requestId: 0c9f2ea5-fe09-463c-8f96-b6cae67800ad db-unavailable: summary: Database unavailable value: errors: - message: Something went wrong on our side statusCode: 503 errorCode: db-unavailable requestId: 0c9f2ea5-fe09-463c-8f96-b6cae67800ad query-timeout: summary: Query timeout value: errors: - message: Something went wrong on our side statusCode: 503 errorCode: query-timeout requestId: 0c9f2ea5-fe09-463c-8f96-b6cae67800ad securitySchemes: apiKey: type: http scheme: bearer bearerFormat: vk_live__ description: >- Your API key in `Authorization: Bearer `. Use `vk_test_…` keys against the sandbox and `vk_live_…` keys against production. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.