> ## Documentation Index
> Fetch the complete documentation index at: https://docs-provider.voucher.allride.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Request API access

> Asks AllRide to activate API access (`not-requested` → `requested`). AllRide decides in the admin dashboard; you are emailed the decision.

**Required permissions:** `request-api-access` · **API keys:** not allowed

> [!NOTE]
>
> Dashboard session only. API keys cannot call this operation.


## OpenAPI

````yaml /openapi/provider.v1.json post /partner/v1/api-access:request
openapi: 3.1.1
info:
  title: AllRide Voucher Provider API
  version: 1.0.0
  description: >-
    The Provider API (`/provider/v1`) and the shared workspace API
    (`/partner/v1`) of the AllRide Voucher Platform for Partner Providers. Start
    with the [quickstart](/quickstart). This reference lists only the sandbox
    server; production is `https://api.voucher.allride.io`.
  contact:
    name: AllRide API support
    url: https://docs-provider.voucher.allride.io
servers:
  - url: https://api.voucher-staging.allride.io
    description: Sandbox
security:
  - apiKey: []
tags:
  - name: Provider profile
    description: Your consumer-visible general information and general terms.
  - name: Listing branding
    description: How you look in consumer catalogs, and the images it uses.
  - name: Categories
    description: AllRide-managed categories for voucher sets.
  - name: Voucher sets
    description: Voucher sets, their lifecycle, revisions and link templates.
  - name: Change requests
    description: Proposed content changes that AllRide approves.
  - name: Vouchers
    description: 'Codes and links: batch create, reveal, revoke.'
  - name: Voucher uploads
    description: Asynchronous CSV and XLSX imports.
  - name: Stock alerts
    description: Threshold alerts on voucher set stock.
  - name: Redemptions
    description: Redemptions of your vouchers (provider projection).
  - name: Analytics
    description: Statistics without consumer dimension.
  - name: Partner
    description: Your partner record, settings, API access and reference values.
  - name: Members
    description: People in your partner.
  - name: Groups
    description: Groups of members and the permission catalog.
  - name: API keys
    description: Credentials for your backend.
  - name: Webhook endpoints
    description: Where AllRide sends events.
  - name: Webhook deliveries
    description: Delivery log, replays.
  - name: IP allowlist
    description: Addresses allowed to call the API.
  - name: Workspace branding
    description: Your dashboard theme and its images.
  - name: Single sign-on
    description: SAML and OIDC connections.
  - name: Audit log
    description: Who changed what.
  - name: Webhooks
    description: Events AllRide sends to your endpoints.
paths:
  /partner/v1/api-access:request:
    post:
      tags:
        - Partner
      summary: Request API access
      description: >-
        Asks AllRide to activate API access (`not-requested` → `requested`).
        AllRide decides in the admin dashboard; you are emailed the decision.


        **Required permissions:** `request-api-access` · **API keys:** not
        allowed
      operationId: partner.api-access.request
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestApiAccessBody'
            examples:
              example:
                summary: Example
                value:
                  note: Inventory sync from our ERP.
      responses:
        '200':
          description: Success.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
            Idempotent-Replayed:
              $ref: '#/components/headers/IdempotentReplayed'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerResponse'
              examples:
                example:
                  summary: Example
                  value:
                    data:
                      id: 42
                      resource: partner
                      slug: acme-scooters
                      name: Acme Scooters
                      legalName: Acme Scooters GmbH
                      isProvider: true
                      isConsumer: false
                      status: active
                      apiAccessStatus: active
                      apiAccessRequestedBy:
                        type: partner-user
                        id: 4043
                        label: ops@example.com
                      apiAccessRequestedAt: '2026-10-20T09:30:00Z'
                      apiAccessDecidedBy:
                        type: admin-user
                        id: null
                        label: AllRide
                      apiAccessDecidedAt: '2026-10-20T11:02:15Z'
                      apiAccessDecisionReason: null
                      defaultLocale: de
                      timezone: Europe/Berlin
                      country: DE
                      contacts:
                        technicalEmail: dev@example.com
                        operationsEmail: ops@example.com
                      settings:
                        mfaRequired: true
                        ipAllowlistEnforcement: api-keys
                      activatedAt: '2026-10-20T09:00:00Z'
                      suspendedAt: null
                      suspensionReason: null
                      createdAt: '2026-10-19T14:02:11.418Z'
                      updatedAt: '2026-10-22T07:44:09.120Z'
                      _links:
                        self:
                          href: >-
                            https://api.voucher-staging.allride.io/partner/v1/partner
                          type: application/json
                        providerProfile:
                          href: >-
                            https://api.voucher-staging.allride.io/provider/v1/provider-profile
                          type: application/json
                        workspaceBranding:
                          href: >-
                            https://api.voucher-staging.allride.io/partner/v1/branding/workspace
                          type: application/json
        '400':
          $ref: '#/components/responses/BadRequestPost'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: 'Conflict: `invalid-state-transition`, `idempotency-key-in-use`.'
          x-error-codes:
            - invalid-state-transition
            - idempotency-key-in-use
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalid-state-transition:
                  summary: Invalid state transition
                  value:
                    errors:
                      - message: >-
                          The command is not allowed in the resource's current
                          status; the message names the from and to states. This
                          is also the answer when another change moved the
                          resource first: the status is checked when the command
                          runs.
                        statusCode: 409
                        errorCode: invalid-state-transition
        '422':
          description: 'Unprocessable content: `idempotency-key-reused`.'
          x-error-codes:
            - idempotency-key-reused
          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
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
        - firebaseIdToken: []
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        Optional on every POST: 1-255 printable ASCII characters without spaces
        (a UUID is recommended). 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: 4e1c7f6a-2b0d-4c1e-9a7b-3f5e8d2c1b0a
  schemas:
    RequestApiAccessBody:
      type: object
      properties:
        note:
          type:
            - string
            - 'null'
          description: Intended use, up to 1,000 characters.
          maxLength: 1000
      required: []
      description: Request API access.
      additionalProperties: false
    PartnerResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Partner'
      required:
        - data
      description: Single-object envelope around Partner.
      additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorEntry'
          description: The errors; in v1 always exactly one.
          minItems: 1
      required:
        - errors
      description: >-
        Error body of every 4xx and 5xx response (Content-Type:
        application/json).
      additionalProperties: false
    Partner:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ULong'
          description: Partner id.
        resource:
          type: string
          enum:
            - partner
          description: Always partner.
        slug:
          type: string
          description: Partner slug.
        name:
          type: string
          description: Display name.
        legalName:
          type: string
          description: Legal name.
        isProvider:
          type: boolean
          description: The partner is a Partner Provider.
        isConsumer:
          type: boolean
          description: The partner is a Partner Consumer.
        status:
          type: string
          enum:
            - draft
            - onboarding
            - active
            - suspended
          description: 'Partner status. Treat as an open set: new values may be added.'
        apiAccessStatus:
          type: string
          enum:
            - not-requested
            - requested
            - active
            - suspended
          description: 'API access status. Treat as an open set: new values may be added.'
        apiAccessRequestedBy:
          oneOf:
            - $ref: '#/components/schemas/Actor'
            - type: 'null'
          description: Who requested API access.
        apiAccessRequestedAt:
          oneOf:
            - $ref: '#/components/schemas/Instant'
            - type: 'null'
          description: When the current request was made.
        apiAccessDecidedBy:
          oneOf:
            - $ref: '#/components/schemas/Actor'
            - type: 'null'
          description: Who last decided (AllRide).
        apiAccessDecidedAt:
          oneOf:
            - $ref: '#/components/schemas/Instant'
            - type: 'null'
          description: When AllRide last decided.
        apiAccessDecisionReason:
          type:
            - string
            - 'null'
          description: Reason of a decline or suspension.
        defaultLocale:
          $ref: '#/components/schemas/Locale'
        timezone:
          type: string
          description: IANA time zone with whole-hour offsets, used for calendar periods.
        country:
          $ref: '#/components/schemas/CountryCode'
        contacts:
          type: object
          properties:
            technicalEmail:
              type:
                - string
                - 'null'
              description: Technical contact; receives deprecation notices.
            operationsEmail:
              type:
                - string
                - 'null'
              description: >-
                Operations contact; receives stock alerts when no recipient is
                set.
          required:
            - technicalEmail
            - operationsEmail
          description: Contact addresses.
          additionalProperties: false
        settings:
          type: object
          properties:
            mfaRequired:
              type: boolean
              description: Members must use multi-factor authentication.
            ipAllowlistEnforcement:
              type: string
              enum:
                - 'off'
                - api-keys
                - api-keys-and-users
              description: >-
                IP allowlist enforcement. Treat as an open set: new values may
                be added.
          required:
            - mfaRequired
            - ipAllowlistEnforcement
          description: Security settings.
          additionalProperties: false
        activatedAt:
          oneOf:
            - $ref: '#/components/schemas/Instant'
            - type: 'null'
          description: When the partner was activated.
        suspendedAt:
          oneOf:
            - $ref: '#/components/schemas/Instant'
            - type: 'null'
          description: When the partner was suspended.
        suspensionReason:
          type:
            - string
            - 'null'
          description: Reason of a suspension.
        createdAt:
          $ref: '#/components/schemas/Instant'
          description: Creation time.
        updatedAt:
          $ref: '#/components/schemas/Instant'
          description: Last change.
        _links:
          type: object
          description: >-
            Links to related resources (self, providerProfile,
            workspaceBranding).
          additionalProperties:
            $ref: '#/components/schemas/Link'
      required:
        - id
        - resource
        - slug
        - name
        - legalName
        - isProvider
        - isConsumer
        - status
        - apiAccessStatus
        - apiAccessRequestedBy
        - apiAccessRequestedAt
        - apiAccessDecidedBy
        - apiAccessDecidedAt
        - apiAccessDecisionReason
        - defaultLocale
        - timezone
        - country
        - contacts
        - settings
        - activatedAt
        - suspendedAt
        - suspensionReason
        - createdAt
        - updatedAt
        - _links
      description: Your partner record (provider view).
      additionalProperties: false
    ErrorEntry:
      type: object
      properties:
        message:
          type: string
          description: >-
            Human-readable message. Do not parse it; it can change. 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. Branch on
            this field.
        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
      description: One error. Branch on `errorCode`; ignore members you do not know.
    ULong:
      type: integer
      format: uint64
      minimum: 0
      maximum: 18446744073709552000
      x-bigint: true
      description: >-
        Unsigned 64-bit integer. May exceed 2^53; parse with a BigInt-safe JSON
        parser in JavaScript.
    Actor:
      type: object
      properties:
        type:
          type: string
          enum:
            - admin-user
            - partner-user
            - api-key
            - redemption-session
            - system
          description: 'Kind of actor. Treat as an open set: new values may be added.'
        id:
          oneOf:
            - $ref: '#/components/schemas/ULong'
            - type: 'null'
          description: Id of the user or API key; null for AllRide staff.
        label:
          type: string
          description: >-
            Display snapshot: email or key name; AllRide staff appear as
            "AllRide".
      required:
        - type
        - id
        - label
      description: Who did something.
      additionalProperties: false
    Instant:
      type: string
      format: date-time
      description: >-
        RFC 3339 timestamp in UTC with Z, at millisecond precision; no fraction
        when the milliseconds are zero. Inputs need an offset.
      example: '2026-11-01T00:00:00Z'
    Locale:
      type: string
      pattern: ^[a-z]{2,3}(-[A-Z]{2})?$
      description: BCP 47 language tag; content locales are de and en.
    CountryCode:
      type: string
      pattern: ^[A-Z]{2}$
      description: ISO 3166-1 alpha-2 country code.
      x-standard: iso-3166-1-alpha-2
    Link:
      type: object
      properties:
        href:
          type: string
          description: Absolute URL.
          format: uri
        type:
          type: string
          description: Media type of the target.
      required:
        - href
        - type
      description: A link to a related resource.
      additionalProperties: false
    ValidationError:
      type: object
      properties:
        property:
          type: string
          description: >-
            Path of the offending property in your request body
            (`vouchers[17].value`), 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 violated constraint, for example `{"max": 120}`
            for `too-long`; absent when the constraint has none.
        value:
          type:
            - number
            - boolean
          description: >-
            The rejected value, only when it is a number or boolean. Strings are
            never echoed, so secrets, voucher values and personal data never
            come back in an error.
        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
      description: >-
        One invalid property or parameter of a `data-failed-validation` error
        (also used for item failures of batch operations and content checks).
  headers:
    XRequestId:
      description: >-
        Request id: your X-Request-Id (1-100 characters of [A-Za-z0-9._:-]) or a
        generated UUID.
      schema:
        type: string
    IdempotentReplayed:
      description: >-
        true when this response is a replay of a stored response for the same
        Idempotency-Key.
      schema:
        type: boolean
    RetryAfter:
      description: Seconds to wait before the next request or poll.
      schema:
        type: integer
        example: 2
  responses:
    BadRequestPost:
      description: >-
        Bad request: `data-failed-validation`, `malformed-json`,
        `invalid-header`, `invalid-idempotency-key`.
      x-error-codes:
        - data-failed-validation
        - malformed-json
        - invalid-header
        - invalid-idempotency-key
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            data-failed-validation:
              summary: Data failed validation
              value:
                errors:
                  - message: Data failed validation
                    statusCode: 400
                    errorCode: data-failed-validation
                    more:
                      validationErrors:
                        - property: internalName
                          constraint: too-long
                          params:
                            max: 120
                          message:
                            en: Must be at most 120 characters.
                            de: Darf höchstens 120 Zeichen lang sein.
                        - property: content.linkTemplate
                          constraint: invalid-link-template
                          message:
                            en: >-
                              Placeholders are allowed only in the path, query
                              or fragment.
                            de: >-
                              Platzhalter sind nur im Pfad, in der Query oder im
                              Fragment erlaubt.
            malformed-json:
              summary: Malformed JSON
              value:
                errors:
                  - message: The body is not valid UTF-8 JSON.
                    statusCode: 400
                    errorCode: malformed-json
            invalid-header:
              summary: Invalid header
              value:
                errors:
                  - message: >-
                      A standard or platform header is malformed;
                      more.validationErrors[].property names the header.
                    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 without spaces.
                    statusCode: 400
                    errorCode: invalid-idempotency-key
    Unauthorized:
      description: >-
        Unauthorized: `unauthenticated`, `token-invalid`, `api-key-invalid`,
        `token-expired`, `session-revoked`.
      x-error-codes:
        - unauthenticated
        - token-invalid
        - api-key-invalid
        - token-expired
        - session-revoked
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
        WWW-Authenticate:
          description: >-
            Bearer realm="voucher" (plus error="invalid_token" when a credential
            was sent).
          schema:
            type: string
      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, has an
                      unknown scheme, or two Authorization headers were sent.
                    statusCode: 401
                    errorCode: token-invalid
            api-key-invalid:
              summary: Invalid API key
              value:
                errors:
                  - message: >-
                      The API key is unknown, revoked, expired, or belongs to
                      the other environment (a vk_test_ key against production
                      or a vk_live_ key against the sandbox).
                    statusCode: 401
                    errorCode: api-key-invalid
            token-expired:
              summary: Credential expired
              value:
                errors:
                  - message: The dashboard user's ID token has expired.
                    statusCode: 401
                    errorCode: token-expired
            session-revoked:
              summary: Session revoked
              value:
                errors:
                  - message: The dashboard user's session was revoked.
                    statusCode: 401
                    errorCode: session-revoked
    Forbidden:
      description: >-
        Forbidden: `missing-permission`, `partner-role-missing`,
        `partner-suspended`, `partner-offboarded`, `api-access-inactive`,
        `ip-not-allowed`, `mfa-required`, `sso-required`.
      x-error-codes:
        - missing-permission
        - partner-role-missing
        - partner-suspended
        - partner-offboarded
        - api-access-inactive
        - ip-not-allowed
        - mfa-required
        - sso-required
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missing-permission:
              summary: Missing permission
              value:
                errors:
                  - message: >-
                      The membership or API key lacks a permission the operation
                      requires; more.requiredPermissions lists them. API keys
                      always get this code on dashboard-only operations.
                    statusCode: 403
                    errorCode: missing-permission
                    more:
                      requiredPermissions:
                        - manage-provider-voucher-sets
            partner-role-missing:
              summary: Partner role missing
              value:
                errors:
                  - message: >-
                      The partner lacks the role this surface needs
                      (more.requiredRole names it), for example a consumer-only
                      partner on /provider/v1.
                    statusCode: 403
                    errorCode: partner-role-missing
                    more:
                      requiredRole: provider
            partner-suspended:
              summary: Partner suspended
              value:
                errors:
                  - message: The partner is suspended; only reads are allowed.
                    statusCode: 403
                    errorCode: partner-suspended
            partner-offboarded:
              summary: Partner offboarded
              value:
                errors:
                  - message: The partner has been offboarded.
                    statusCode: 403
                    errorCode: partner-offboarded
            api-access-inactive:
              summary: API access inactive
              value:
                errors:
                  - message: >-
                      API access of the partner is not active, or the partner is
                      not active. API keys work only while both are active; the
                      same code answers key and webhook operations that need
                      active API access.
                    statusCode: 403
                    errorCode: api-access-inactive
            ip-not-allowed:
              summary: IP address not allowed
              value:
                errors:
                  - message: >-
                      The request came from an address outside the partner's IP
                      allowlist while enforcement is on.
                    statusCode: 403
                    errorCode: ip-not-allowed
            mfa-required:
              summary: Multi-factor authentication required
              value:
                errors:
                  - message: >-
                      The partner requires multi-factor authentication and the
                      session has not satisfied it.
                    statusCode: 403
                    errorCode: mfa-required
            sso-required:
              summary: Single sign-on required
              value:
                errors:
                  - message: >-
                      The partner enforces single sign-on for the user's email
                      domain.
                    statusCode: 403
                    errorCode: sso-required
    NotFound:
      description: 'Not found: `route-not-found`, `partner-not-found`.'
      x-error-codes:
        - route-not-found
        - partner-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
            partner-not-found:
              summary: Partner not found
              value:
                errors:
                  - message: >-
                      The token names a partner that does not exist or in which
                      the user has no active membership.
                    statusCode: 404
                    errorCode: partner-not-found
    InternalError:
      description: 'Internal error: `internal-error`.'
      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: 0b6f3c1e-9d5a-4c43-a2a8-1f3d2b7c9e10
    ServiceUnavailable:
      description: >-
        Service unavailable: `service-unavailable`, `db-unavailable`,
        `query-timeout`.
      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: 0b6f3c1e-9d5a-4c43-a2a8-1f3d2b7c9e10
            db-unavailable:
              summary: Database unavailable
              value:
                errors:
                  - message: Something went wrong on our side
                    statusCode: 503
                    errorCode: db-unavailable
                    requestId: 0b6f3c1e-9d5a-4c43-a2a8-1f3d2b7c9e10
            query-timeout:
              summary: Query timeout
              value:
                errors:
                  - message: Something went wrong on our side
                    statusCode: 503
                    errorCode: query-timeout
                    requestId: 0b6f3c1e-9d5a-4c43-a2a8-1f3d2b7c9e10
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: vk_live_<apiKeyId>_<secret>
      description: >-
        Partner API key: `Authorization: Bearer vk_live_…`. Use `vk_test_…` keys
        against the sandbox. See [Authentication](/guides/authentication).
    firebaseIdToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        ID token of a signed-in dashboard user. Operations that API keys cannot
        call use it.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.