RegistrationCompleteResponse

Returned after successful email verification or key rotation. Contains your API key.

  • apiKey
    Type: string | null

    Your API key. Use as a Bearer token in the Authorization header.

  • cacheRefreshed
    Type: boolean

    Whether the server's in-memory config/token caches were refreshed immediately after your key was issued. Your key is valid regardless; {false} means the refresh is deferred (it reconciles within a short window) and does not require any action from you. Defaults to {true}.

  • expiresAt
    Type: string Format: date-time

    When your API key expires. You can rotate your key before expiry.

  • partnerId
    Type: string | null

    Your unique partner identifier. Used to identify your integration.

  • rateLimits
    Type: object ยท RegistrationRateLimitsnullable

    Your current rate limits based on tier.

    • requestsPerDay
      Type: integer Format: int32

      Maximum number of API requests allowed per day.

    • requestsPerHour
      Type: integer Format: int32

      Maximum number of API requests allowed per hour.

  • tier
    Type: string | null

    Your current tier level.