Skip to main content

Interface: DiscoveredOtpContact

Defined in: auth/src/routes/BaseAuthDiscoverRoute.ts:17

A hint about one of the caller's OTP-eligible contacts — enough to jog their memory, not enough to sign in with.

Properties​

channel?​

optional channel?: "whatsapp"

Defined in: auth/src/routes/BaseAuthDiscoverRoute.ts:27

Set to "whatsapp" on the extra hint listed for a verified phone contact when its code can also be delivered over WhatsApp (only while WhatsApp is configured). Absent on every other hint - a hint with no channel is delivered over the contact type's default channel (e-mail or SMS), exactly as before. Pass the same value as channel to BaseAuthOTPRoute to have the code sent over that channel.

contact​

contact: string

Defined in: auth/src/routes/BaseAuthDiscoverRoute.ts:19

The contact, obfuscated (e.g. j***n@example.com, ***1234) — never the real value.

type​

type: "email" | "phone"

Defined in: auth/src/routes/BaseAuthDiscoverRoute.ts:20