Skip to main content

ProtectCheckResource

A pending Clerk Protect challenge that must be completed before the current sign-in or sign-up attempt can continue.

This resource is only returned when Protect mid-flow challenges are enabled for the instance. When present, load the challenge SDK from sdkUrl, initialize it with token and uiHints, and submit the proof token returned by the SDK with submitProtectCheck().

Properties

  • Name
    expiresAt?
    Type
    number
    Description

    Unix epoch timestamp, in milliseconds, when the challenge expires and can no longer be completed.

  • Name
    sdkUrl
    Type
    string
    Description

    The URL of the Protect challenge SDK to load for this specific challenge.

  • Name
    status
    Type
    "pending"
    Description

    The current state of the Protect challenge. Protect check resources are only returned while the challenge is waiting to be completed.

  • Name
    token
    Type
    string
    Description

    An opaque challenge token generated by Clerk. Pass this value unchanged to the Protect challenge SDK.

  • Name
    uiHints?
    Type
    Record<string, string>
    Description

    Optional Clerk-provided presentation hints. Pass these values through to the Protect challenge SDK as-is.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub