Capxul Docs
HooksIdentity & auth

useCapxulAuth

Drive the canonical identity journey through six stable verbs.

useCapxulAuth() returns a provider-lifetime facade with exactly six verbs: requestCode, verifyCode, signOut, completePersonal, createOrganization, and state-directed retry.

import { useCapxulAuth } from "@capxul/sdk-react";

function RequestCode({ email }: { email: string }) {
  const auth = useCapxulAuth();
  return <button onClick={() => void auth.requestCode(email)}>Send code</button>;
}

Expected failures resolve { ok: false, reason }; they do not reject. Pass correlationId, journeyId, timeout/deadline, and signal as the optional second argument. The application owns those identifiers.