Skip to content

status

Get current status of a Farcaster Auth request.

Returns the current state of the request, either 'pending' if the user's Farcaster wallet app has not yet sent back a signature, or 'completed' once the wallet app has returned a response.

In 'completed' state, the response includes the generated Sign in With Farcaster message, a signature from the user's custody address, the user's verified fid, and user profile information.

ts
const status = await appClient.status({
  channelToken: '210f1718-427e-46a4-99e3-2207f21f83ec',
});

Parameters

ParameterTypeDescriptionRequiredExample
channelTokenstringFarcaster Auth channel token.Yes8d0494d9-e0cf-402b-ab0a-394ac7fe07a0

Returns

ts
{
    response: Response
    data: {
        state: 'pending' | 'completed'
        nonce: string
        message?: string
        signature?: Hex
        fid?: number
        username?: string
        bio?: string
        displayName?: string
        pfpUrl?: string
        custody?: Hex;
        verifications?: Hex[];
    }
    isError: boolean
    error: Error
}
ParameterDescription
responseHTTP response from the Connect relay server.
data.stateStatus of the sign in request, either "pending" or "complete"
data.nonceRandom nonce used in the SIWE message. If you don't provide a custom nonce as an argument to the hook, you should read this value.
data.messageThe generated SIWE message.
data.signatureHex signature produced by the user's Warpcast wallet.
data.fidUser's Farcaster ID.
data.usernameUser's Farcaster username.
data.bioUser's Farcaster bio.
data.displayNameUser's Farcaster display name.
data.pfpUrlUser's Farcaster profile picture URL.
data.custodyUser's FID custody address.
data.verificationsList of user's verified addresses.
isErrorTrue when an error has occurred.
errorError instance.