Check OTP availability

client.auth.canSendOtp

Use the Core SDK to check OTP availability.

Import and client prerequisite

import { createCapxulClient } from "@capxul/sdk";

const created = await createCapxulClient({
  publishableKey: "cap_pk_…",
});

if (!created.ok) throw created.error;
const client = created.value;

Usage

declare const input: { readonly email: string };

const result = await client.auth.canSendOtp(input);

if (!result.ok) {
  console.error(result.error.code);
  return;
}

console.log(result.value);

Signature

client.auth.canSendOtp(input: { readonly email: string; }, options?: AuthMethodOptions): Promise<CapxulResult<CanSendOtpStatus>>;

Source: packages/sdk/src/surface/auth.ts:37.

Parameters

input

Required.

{ readonly email: string; }

options

Optional.

InvocationControls | undefined;

Returns

Promise<CapxulResult<CanSendOtpStatus>>;

Read the ok discriminant before accessing value or error.

Errors

Expected failures resolve as { ok: false, error: CapxulError }; they are not thrown as the normal domain contract. Branch on result.ok and use the stable error.code. Provider messages and internal causes are not public contracts.

Availability and evidence

Available in the Core SDK. Evidence classification: shipped-proven.

shipped-proven at the typed or hermetic Core SDK contract boundary. The callable surface and result mapping are covered by release-trunk type or hermetic tests. That does not by itself prove a live backend, provider, email, browser, or chain journey. Check the capability-status reference before presenting this operation as live.

Related

• No dedicated React SDK hook currently projects this method.
• Platform capability matrix
• Core SDK scaffold inventory
• Result and proof boundaries