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

# Get embedded wallet status

> Returns the authenticated user's embedded wallet status. Always 200: branch on `status` to handle the not-yet-provisioned case (`status === "not_provisioned"`) versus an active wallet (`status === "active"`, with `data` populated).



## OpenAPI

````yaml https://platform.spritz.finance/openapi.json get /v1/wallet-kit/
openapi: 3.0.3
info:
  title: Spritz Finance API
  version: 1.0.0
  description: API for the Spritz Finance platform with RFC 9457 error handling
servers:
  - url: https://platform.spritz.finance
    description: Production
  - url: https://sandbox.spritz.finance
    description: Sandbox
security: []
tags:
  - name: Users
    description: User management endpoints
  - name: Bank Accounts
    description: Manage bank accounts for off-ramp destinations
  - name: Bills
    description: Manage bill pay accounts
  - name: Cards
    description: Spritz-issued debit cards
  - name: Auto-Ramp Accounts
    description: Virtual bank accounts that automatically convert fiat deposits to crypto
  - name: Spritz App
    description: >-
      Endpoints used by the Spritz app and internal SDKs. Excluded from the
      public partner spec.
paths:
  /v1/wallet-kit/:
    get:
      tags:
        - Wallet Kit
      summary: Get embedded wallet status
      description: >-
        Returns the authenticated user's embedded wallet status. Always 200:
        branch on `status` to handle the not-yet-provisioned case (`status ===
        "not_provisioned"`) versus an active wallet (`status === "active"`, with
        `data` populated).
      operationId: getV1Wallet-kit
      responses:
        '200':
          description: >-
            Wallet status envelope. `data` is present only when `status ===
            "active"`. Branch on `status` to handle the not-yet-provisioned
            case.
          content:
            application/json:
              schema:
                description: >-
                  Wallet status envelope. `data` is present only when `status
                  === "active"`. Branch on `status` to handle the
                  not-yet-provisioned case.
                anyOf:
                  - description: >-
                      Wallet status envelope for an active (provisioned) wallet.
                      The only response shape returned by POST /v1/wallet-kit.
                    type: object
                    properties:
                      status:
                        description: An embedded wallet has been provisioned for this user.
                        type: string
                        enum:
                          - active
                      data:
                        description: >-
                          An embedded wallet for the authenticated user. Backed
                          by a Turnkey sub-organization that holds the user's
                          keys.
                        type: object
                        properties:
                          id:
                            description: >-
                              Stable wallet identifier. Pass this as the
                              organization id when calling the Turnkey SDK.
                            type: string
                            example: 8b3f7e2a-7c5e-4a3a-8a8a-2c5e8a8a2c5e
                          userId:
                            description: >-
                              Wallet user identifier. Pass this as the user id
                              when calling the Turnkey SDK.
                            type: string
                            example: e3a2c5e8-4a3a-7c5e-8a8a-2c5e8a8a2c5e
                          createdAt:
                            description: >-
                              Timestamp when the wallet was provisioned (ISO
                              8601)
                            format: date-time
                            type: string
                            example: '2025-01-15T10:30:00.000Z'
                        required:
                          - id
                          - userId
                          - createdAt
                    required:
                      - status
                      - data
                  - type: object
                    properties:
                      status:
                        description: >-
                          No embedded wallet has been provisioned for this user
                          yet. Call POST /v1/wallet-kit to provision one.
                        type: string
                        enum:
                          - not_provisioned
                    required:
                      - status
        '401':
          description: Response for status 401
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    default: about:blank
                    description: A URI reference that identifies the problem type
                    type: string
                    example: urn:problem-type:auth:unauthorized
                  title:
                    description: A short, human-readable summary of the problem type
                    type: string
                    example: Unauthorized
                  status:
                    description: The HTTP status code
                    type: number
                    example: 401
                  detail:
                    description: A human-readable explanation specific to this occurrence
                    type: string
                    example: Bearer token required
                  instance:
                    description: A URI reference that identifies the specific occurrence
                    type: string
                  realm:
                    description: The authentication realm
                    type: string
                    example: API
                  scope:
                    description: The required scope for this resource
                    type: string
                    example: read:users
                required:
                  - title
                  - status
                additionalProperties: false
        '500':
          description: Response for status 500
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    default: about:blank
                    description: A URI reference that identifies the problem type
                    type: string
                    example: urn:problem-type:auth:unauthorized
                  title:
                    description: A short, human-readable summary of the problem type
                    type: string
                    example: Unauthorized
                  status:
                    description: The HTTP status code
                    type: number
                    example: 400
                  detail:
                    description: A human-readable explanation specific to this occurrence
                    type: string
                  instance:
                    description: A URI reference that identifies the specific occurrence
                    type: string
                    example: /errors/1234567890
                  code:
                    description: >-
                      Machine-readable cause, present when exactly one thing
                      failed. Branch on this, never on `detail`, which is
                      human-facing copy and may change. For deposit limits the
                      vocabulary matches the `reason` values the limits API
                      returns pre-flight.
                    type: string
                    example: transaction_limit
                  field:
                    description: The offending request field, present alongside `code`.
                    type: string
                    example: amountUsd
                  retryable:
                    description: >-
                      Whether retrying the same request later may succeed
                      without changing its inputs.
                    type: boolean
                    example: true
                required:
                  - title
                  - status
                additionalProperties: false
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Cognito JWT token for regular user authentication

````