SDK Reference

useRecusStatus

Check whether the current user has completed onboarding. Use this anywhere in your app.

Import & Signature

tsx

import { useRecusStatus } from 'recus-react-native'

const { isComplete, isLoading, error } = useRecusStatus()

Return Values

Value	Type	Description
`isComplete`	`boolean`	true if the user has completed the active mandatory flow.
`isLoading`	`boolean`	true while Recus is checking the user's status.
`error`	`Error \| null`	Set if the status check failed.

Example

ProfileScreen.tsx

import { useRecusStatus } from 'recus-react-native'

function ProfileScreen() {
  const { isComplete, isLoading } = useRecusStatus()

  if (isLoading) return <LoadingSpinner />

  return (
    <View>
      {!isComplete && (
        <Banner message="Complete your profile to unlock all features" />
      )}
      <ProfileContent />
    </View>
  )
}

Usage Patterns

Conditional content

Show banners, upgrade prompts, or locked features based on whether the user has finished onboarding.

Navigation guards

Redirect users to a profile completion screen if isComplete is false.

Loading states

Show a spinner or skeleton while isLoading is true to prevent layout shifts.

Error handling

If the status check fails, fall back gracefully. The error object tells you what went wrong.