Skip to main content
GET
Get digital card access code
Use this endpoint to retrieve the static access code for a digital card that uses access-code authentication.
Required parameters:
  • digitalCardId - the digital card identifier, passed as a path parameter. Look this up via GET /v3/digital-cards?filter[orderId]={orderId}.
Behavior notes:
  • Snappy-Account-Id is not accepted by this endpoint.
  • Returns { digitalCardId, accessCode }.
  • Returns 422 if the digital card’s authentication.method is OTP. Digital cards using OTP authentication do not have a static access code - the recipient authenticates via a one-time password delivered to their email at redemption time.
  • 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.

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

"digital_card_123"

Response

Digital card access code.

data
object
required

Digital card access code response.

Last modified on September 2, 2026