> For the complete documentation index, see [llms.txt](https://docs.haven1.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.haven1.org/build/developer-tools/haven1-sdk/haven1-react-sdk/usesignin.md).

# useSignIn

## Function: useSignIn()

> **useSignIn**(`address`?): `object`

Custom hook to handle user sign-in status using the Haven1 SDK.

### Parameters

#### address?

`string`

Optional address of the user.

### Returns

`object`

#### isSignedIn

> **isSignedIn**: `boolean`

Indicates whether the user is signed in.

#### validate

> **validate**: `UseQueryResult`<`undefined` | `FetchResponse`<{ `parameters`: { `cookie`: `undefined`; `header`: `undefined`; `path`: { `token`: `string`; }; `query`: `undefined`; }; `requestBody`: `undefined`; `responses`: { `200`: { `content`: { `application/json`: { `data`: { `address`: ...; `isSignedIn`: ...; } | { `isSignedIn`: ...; }; `status`: `"success"`; }; `multipart/form-data`: { `data`: { `address`: ...; `isSignedIn`: ...; } | { `isSignedIn`: ...; }; `status`: `"success"`; }; `text/plain`: { `data`: { `address`: ...; `isSignedIn`: ...; } | { `isSignedIn`: ...; }; `status`: `"success"`; }; }; `headers`: {}; }; }; }, { `params`: { `path`: { `token`: `string`; }; }; }, \`${string}/${string}\`>, `Error`>

Query for validating the authentication token.

### Defined in

[packages/react/src/api/hook/useSignIn.tsx:9](https://github.com/haven1network/haven1-sdk/blob/7cd51fbeb78d9011a6b1c4b8e514287b0d830453/packages/react/src/api/hook/useSignIn.tsx#L9)