> ## 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.

# Bypass KYC (sandbox only)

> Simulate KYC verification for testing purposes. **Only available in sandbox environments** — returns 403 in production.

To simulate a successful verification, pass a `country` — the capability group to verify the user into. To simulate a failed check, pass `failed: true`. Exactly one of the two is required; an empty body is a 400.

`US` and `EU` can be simulated today. `CA` and `GB` are real capability groups with no sandbox fixture yet and return **501**, which is distinct from the **400** an unrecognised value gets.



## OpenAPI

````yaml https://platform.spritz.finance/openapi.json post /v1/sandbox/bypass-kyc
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/sandbox/bypass-kyc:
    post:
      tags:
        - Sandbox
      summary: Bypass KYC (sandbox only)
      description: >-
        Simulate KYC verification for testing purposes. **Only available in
        sandbox environments** — returns 403 in production.


        To simulate a successful verification, pass a `country` — the capability
        group to verify the user into. To simulate a failed check, pass `failed:
        true`. Exactly one of the two is required; an empty body is a 400.


        `US` and `EU` can be simulated today. `CA` and `GB` are real capability
        groups with no sandbox fixture yet and return **501**, which is distinct
        from the **400** an unrecognised value gets.
      operationId: postV1SandboxBypass-kyc
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                country:
                  description: >-
                    Which capability group to verify the user into. Determines
                    which offerings become available.


                    This is a capability group, not an ISO country code — `EU`
                    is the EEA as a whole, since every member state gets the
                    same offerings. Real country codes such as `DE` or `ES` are
                    rejected.


                    `US`: ACH and wire on-ramps, ACH / RTP / push-to-card
                    payouts, cards. Simulatable in sandbox.

                    `EU`: SEPA credit transfer on-ramp and payout, gated behind
                    EU regional compliance. Simulatable in sandbox.

                    `CA`: Canadian offerings. No sandbox fixture yet — returns
                    501.

                    `GB`: UK offerings. No sandbox fixture yet — returns 501.
                  type: string
                  enum:
                    - US
                    - CA
                    - EU
                    - GB
                  example: EU
                failed:
                  description: Set to true to simulate a failed KYC check
                  type: boolean
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                country:
                  description: >-
                    Which capability group to verify the user into. Determines
                    which offerings become available.


                    This is a capability group, not an ISO country code — `EU`
                    is the EEA as a whole, since every member state gets the
                    same offerings. Real country codes such as `DE` or `ES` are
                    rejected.


                    `US`: ACH and wire on-ramps, ACH / RTP / push-to-card
                    payouts, cards. Simulatable in sandbox.

                    `EU`: SEPA credit transfer on-ramp and payout, gated behind
                    EU regional compliance. Simulatable in sandbox.

                    `CA`: Canadian offerings. No sandbox fixture yet — returns
                    501.

                    `GB`: UK offerings. No sandbox fixture yet — returns 501.
                  type: string
                  enum:
                    - US
                    - CA
                    - EU
                    - GB
                  example: EU
                failed:
                  description: Set to true to simulate a failed KYC check
                  type: boolean
          multipart/form-data:
            schema:
              type: object
              properties:
                country:
                  description: >-
                    Which capability group to verify the user into. Determines
                    which offerings become available.


                    This is a capability group, not an ISO country code — `EU`
                    is the EEA as a whole, since every member state gets the
                    same offerings. Real country codes such as `DE` or `ES` are
                    rejected.


                    `US`: ACH and wire on-ramps, ACH / RTP / push-to-card
                    payouts, cards. Simulatable in sandbox.

                    `EU`: SEPA credit transfer on-ramp and payout, gated behind
                    EU regional compliance. Simulatable in sandbox.

                    `CA`: Canadian offerings. No sandbox fixture yet — returns
                    501.

                    `GB`: UK offerings. No sandbox fixture yet — returns 501.
                  type: string
                  enum:
                    - US
                    - CA
                    - EU
                    - GB
                  example: EU
                failed:
                  description: Set to true to simulate a failed KYC check
                  type: boolean
      responses:
        '200':
          description: The resulting verification document
          content:
            application/json:
              schema:
                description: The resulting verification document
        '400':
          description: Response for status 400
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - 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
                  - type: object
                    properties:
                      errors:
                        description: >-
                          Every cause. A single-cause failure also reports it
                          via top-level `code`/`field`/`detail`; a multi-field
                          failure is described only here.
                        type: array
                        items:
                          type: object
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                            code:
                              type: string
                          required:
                            - field
                            - message
        '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
        '403':
          description: Response for status 403
          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
        '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
        '501':
          description: Response for status 501
          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: []
        - integratorJwt: []
        - hmacAuth: []
          integratorKey: []
          timestamp: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Cognito JWT token for regular user authentication
    integratorJwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Integrator JWT token (prefix: spr_) for frontend integrator
        authentication. Obtained via token exchange endpoint.
    hmacAuth:
      type: apiKey
      in: header
      name: X-Signature
      description: >-
        HMAC signature authentication for backend integrators.


        **Required Headers:**

        - X-Integrator-Key: Integrator API key (format: int_...)

        - X-Signature: HMAC signature (format: sha256={hex})

        - X-Timestamp: Unix timestamp in milliseconds

        - Authorization: Bearer {user-api-key}


        **Signature Algorithm:** HMAC-SHA256


        **Signature Format:** {timestamp}.{METHOD}.{path}.{bodyHash}

        - timestamp: Unix timestamp in milliseconds

        - METHOD: HTTP method in UPPERCASE (GET, POST, etc.)

        - path: Request path (e.g., /v1/transactions)

        - bodyHash: SHA256 hex digest of request body (empty string if no body)


        **Timestamp Tolerance:** ±5 minutes (300 seconds)


        **Example:**

        For POST /v1/transactions with body {"amount":100} and timestamp
        1234567890000:

        Payload: 1234567890000.POST./v1/transactions.{sha256(body)}

        Signature: sha256=abc123...
    integratorKey:
      type: apiKey
      in: header
      name: X-Integrator-Key
      description: 'Integrator API key (format: int_...) used with HMAC authentication'
    timestamp:
      type: apiKey
      in: header
      name: X-Timestamp
      description: >-
        Unix timestamp in milliseconds for replay attack prevention. Must be
        within 5 minutes of server time.

````