Skip to main content
Docs

verify()

Warning

API keys is currently in beta. The API may change before general availability.

Verifies an API key secret. Returns an APIKeyResourceJavaScript Icon object.

  • If the API key is valid, the method returns the API key object with its properties.
  • If the API key is invalid, revoked, or expired, the method will throw an error.

Note

In most cases, you'll want to verify API keys using framework-specific helpers like auth() in Next.js, which handles the verification automatically. See the verifying API keysNext.js Icon guide for more details.

function verify(secret: string): Promise<APIKeyResource>

Parameters

  • Name
    secret
    Type
    string
    Description

    The API key secret to verify.

Example

Note

Using clerkClient varies based on your framework. Refer to the JS Backend SDK overview for usage details, including guidance on how to access the userId and other properties.

const apiKeySecret = 'ak_live_123'

const response = await clerkClient.apiKeys.verify(apiKeySecret)

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint POST/api_keys/verify. See the BAPI reference for more information.

Feedback

What did you think of this content?
GitHubEdit on GitHub

Last updated on