Skip to main content
GET
Get digital card by ID
Use this endpoint to retrieve a single digital card by its stable ID.
Required parameters:
  • digitalCardId - the digital card identifier, passed as a path parameter.
Optional query parameters:
  • include - related entities to expand. Currently supports brand (returns full brand details on the digital card).
Behavior notes:
  • Snappy-Account-Id is not accepted by this endpoint.
  • Returns the digital card’s access card URL and authentication.method (OTP or accessCode).
  • Returns 404 if the digital card does not exist or belongs to a different Company.

Authorizations

X-Api-Key
string
header
required

Company Level Authentication

Include your API key in the X-Api-Key header for every request:

Path Parameters

digitalCardId
string
required

The unique identifier of the digital card to retrieve.

Minimum string length: 1
Pattern: ^[A-Za-z0-9_-]+$
Example:

"digital_card_123"

Query Parameters

include
enum<string>[]

Related entities to include.

Related entities to include.

Available options:
brand
Example:

Response

Digital card object.

data
object
required

Digital card.

Last modified on September 2, 2026