> ## Documentation Index > Fetch the complete documentation index at: https://docs.snappy.com/llms.txt > Use this file to discover all available pages before exploring further. # 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: - 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. ###### Permissions: - Requires: `digital-card:read` #### Permissions - Requires: `digitalCards:read` ## OpenAPI ````yaml get /v3/digital-cards/{digitalCardId}/access-code openapi: 3.0.3 info: title: Snappy Public API v3 version: 3.0.0 contact: name: Snappy Support email: info@snappy.com description: >- Welcome to the Snappy API reference documentation! You can use this API to integrate with Snappy and spread smiles to your employees/clients/customers and much more. So let's get started! servers: - url: https://api.snappy.com/public-api description: Base API URL - url: https://mtls-api.snappy.com/public-api description: >- ## mTLS URL You can also use mTLS to enhance your API security. To get your specific certificates please contact our support. Once you configure the certificated correctly, you need to also update endpoints to use the following secure api base URL: security: [] tags: - name: Products description: >- Use these endpoints to retrieve products and tags for building catalog and browse experiences in your UI. - name: Collections description: >- Use these endpoints to retrieve products within curated collections for marketplace and browse experiences. - name: Variants description: >- Use these endpoints to retrieve variants, variant pricing, and country availability for orderable product SKUs. - name: Billing Methods description: >- A **Billing Method** is the funding source attached to an **Account** - for example, a Purchase Order (PO), Invoice, Prepay deposit, or Credit Card. Use these endpoints to retrieve billing method details such as remaining balance, status, and expiration. - name: Accounts description: >- An **Account** is a sub-entity within a **Company**, used to organize campaigns and gift sends. Use these endpoints to list, retrieve, and create accounts. - name: API Keys description: >- Use these endpoints to manage API keys for programmatic access. Key management requires company owner privileges. - name: Orders description: >- Use these endpoints to place, retrieve, cancel, and validate orders and shipping addresses. - name: Digital cards description: Use these endpoints to create, retrieve, and access digital cards. paths: /v3/digital-cards/{digitalCardId}/access-code: get: tags: - Digital cards summary: Get digital card access code description: >- 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: - 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. ###### Permissions: - Requires: `digital-card:read` #### Permissions - Requires: `digitalCards:read` parameters: - schema: allOf: - $ref: '#/components/schemas/DigitalCardIdV3' - description: The unique identifier of the digital card. required: true description: The unique identifier of the digital card. name: digitalCardId in: path - schema: type: string description: Optional account identifier for swag validation/filtering. example: acc123456 required: false description: Optional account identifier for swag validation/filtering. name: snappy-account-id in: header - schema: type: string description: Optional company identifier for swag validation/filtering. example: cmp123456 required: false description: Optional company identifier for swag validation/filtering. name: snappy-company-id in: header responses: '200': description: Digital card access code. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/GetDigitalCardAccessCodeV3Response' required: - data '400': description: Bad Request - Invalid request parameters. content: application/json: schema: $ref: '#/components/schemas/ErrorResponseV3' '404': description: Not Found. content: application/json: schema: $ref: '#/components/schemas/ErrorResponseV3' example: status: 404 errorCode: 404_DGTC_001 message: Digital card not found. '422': description: Unprocessable Entity - Digital card uses OTP authentication. content: application/json: schema: $ref: '#/components/schemas/ErrorResponseV3' example: status: 422 errorCode: 422_DGTC_001 message: >- Access code is not available for digital cards using OTP authentication. security: - ApiKeyAuthentication: [] components: schemas: DigitalCardIdV3: type: string minLength: 1 pattern: ^[A-Za-z0-9_-]+$ description: Stable digital card identifier. example: digital_card_123 GetDigitalCardAccessCodeV3Response: type: object properties: digitalCardId: $ref: '#/components/schemas/DigitalCardIdV3' accessCode: type: string description: Digital card access code. example: '1234' required: - digitalCardId - accessCode description: Digital card access code response. ErrorResponseV3: type: object properties: message: type: string description: Human-readable error message. example: Product not found. errorCode: type: string description: Structured error code. example: 404_PROD_001 errors: type: array items: type: object properties: message: type: string example: Product with id 'q1w2e3r4t5' was not found path: type: string description: Dot-separated path to the field that caused the error. example: pathParameters.productId errorCode: type: string example: 404_PROD_001 required: - message - path description: Optional field-level error details. required: - message - errorCode description: Standard v3 error envelope. securitySchemes: ApiKeyAuthentication: type: apiKey in: header name: X-Api-Key description: |- ## Company Level Authentication Include your API key in the `X-Api-Key` header for every request: ``` X-Api-Key: YOUR_API_KEY ``` ````