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

# Regenerate API secret

> Regenerates the integrator's API secret. The new secret is returned in the response - this is the only time it will be exposed.

**Grace Period**: Optionally specify `oldSecretValidForSeconds` (0-3600) to keep the old secret valid during rotation. This prevents service disruption while updating your systems.

**Warning**: Without a grace period, the old secret is invalidated immediately. Any requests signed with the old secret will fail.

Store the new secret securely - it cannot be retrieved again.



## OpenAPI

````yaml https://platform.spritz.finance/openapi.json post /v1/integrator/regenerate-secret
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/integrator/regenerate-secret:
    post:
      tags:
        - Integrator
      summary: Regenerate API secret
      description: >-
        Regenerates the integrator's API secret. The new secret is returned in
        the response - this is the only time it will be exposed.


        **Grace Period**: Optionally specify `oldSecretValidForSeconds` (0-3600)
        to keep the old secret valid during rotation. This prevents service
        disruption while updating your systems.


        **Warning**: Without a grace period, the old secret is invalidated
        immediately. Any requests signed with the old secret will fail.


        Store the new secret securely - it cannot be retrieved again.
      operationId: postV1IntegratorRegenerate-secret
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                oldSecretValidForSeconds:
                  description: >-
                    Grace period in seconds during which the old secret remains
                    valid. Allows for safe rotation without service disruption.
                    Default: 0 (immediate invalidation), Maximum: 3600 (1 hour).
                  minimum: 0
                  maximum: 3600
                  default: 0
                  type: number
                  example: 300
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                oldSecretValidForSeconds:
                  description: >-
                    Grace period in seconds during which the old secret remains
                    valid. Allows for safe rotation without service disruption.
                    Default: 0 (immediate invalidation), Maximum: 3600 (1 hour).
                  minimum: 0
                  maximum: 3600
                  default: 0
                  type: number
                  example: 300
          multipart/form-data:
            schema:
              type: object
              properties:
                oldSecretValidForSeconds:
                  description: >-
                    Grace period in seconds during which the old secret remains
                    valid. Allows for safe rotation without service disruption.
                    Default: 0 (immediate invalidation), Maximum: 3600 (1 hour).
                  minimum: 0
                  maximum: 3600
                  default: 0
                  type: number
                  example: 300
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                type: object
                properties:
                  secret:
                    description: >-
                      The newly generated API secret. This is the only time the
                      secret will be exposed - store it securely.
                    type: string
                    example: sk_live_abc123def456ghi789
                  oldSecretExpiresAt:
                    description: >-
                      ISO 8601 timestamp when the old secret will expire. Only
                      present if a grace period was specified.
                    format: date-time
                    type: string
                    example: '2026-08-06T14:33:21.833Z'
                required:
                  - secret
        '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
        '404':
          description: Response for status 404
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    default: about:blank
                    description: A URI reference that identifies the problem type
                    type: string
                  title:
                    description: A short, human-readable summary of the problem type
                    type: string
                  status:
                    description: The HTTP status code
                    type: number
                    example: 404
                  detail:
                    description: A human-readable explanation specific to this occurrence
                    type: string
                  instance:
                    description: A URI reference that identifies the specific occurrence
                    type: string
                  resourceType:
                    description: The type of resource that was not found
                    type: string
                    example: user
                  resourceId:
                    description: The identifier of the resource that was not found
                    type: string
                required:
                  - title
                  - status
                  - resourceType
                  - resourceId
                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:
        - hmacAuth: []
          integratorKey: []
          timestamp: []
components:
  securitySchemes:
    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.

````