Skip to main content

userTokenVerify

Verifies a user token. See Verifying requests for more details.

Input arguments for the mutation.

Anchor to token
token
string
required

The temporary user token to verify.

This mutation returns a UserTokenVerifyPayload object with the following fields:

Anchor to userErrors
userErrors
[]
required

List of errors that occured while executing the mutation.

Anchor to publicId
publicId
string | null

The public ID of the user.

Anchor to tokenExpiresAt
tokenExpiresAt
| null

The expiration date of the token.

Anchor to userState
userState
'VERIFIED' | 'GUEST' | null

The state of the user.

Anchor to userIdentifier
userIdentifier
string | null

A permanent identifier for the user.

Deprecated

Use publicId instead.

Examples

graphql

mutation VerifyUserToken($token: String!) {
userTokenVerify(token: $token) {
tokenExpiresAt
publicId

userErrors {
code
field
message
}
}
}

Was this page helpful?