Learn more about Mintlify
Enter your email to receive updates about new features and product releases.
Generate and verify one-time passwords
otp resource provides methods for creating, verifying, and managing one-time passwords for authentication flows.
await contiguity.otp.new(params: OtpNewParams): Promise<{ otp_id: string }>
const result = await contiguity.otp.new({
to: '+1234567890',
language: 'en',
name: 'MyApp'
});
console.log(result.otp_id); // "otp_..."
await contiguity.otp.verify(params: OtpVerifyParams): Promise<{ verified: boolean }>
true if the OTP code is correct, false otherwise.const result = await contiguity.otp.verify({
otp_id: 'otp_...',
otp: '123456'
});
if (result.verified) {
console.log('OTP verified successfully!');
} else {
console.log('Invalid OTP code.');
}
await contiguity.otp.resend(params: OtpResendParams): Promise<{ resent: boolean }>
true if the OTP was successfully resent.const result = await contiguity.otp.resend({
otp_id: 'otp_...'
});
console.log(result.resent); // true
await contiguity.otp.reverse.initiate(params: OtpReverseInitiateParams): Promise<any>
const result = await contiguity.otp.reverse.initiate({
number: '+1234567890',
language: 'en',
success_url: 'https://yourapp.com/verified'
});
console.log(result);
await contiguity.otp.reverse.verify(otp_id: string): Promise<any>
const status = await contiguity.otp.reverse.verify('otp_...');
console.log(status);
await contiguity.otp.reverse.cancel(otp_id: string): Promise<any>
await contiguity.otp.reverse.cancel('otp_...');
import { Contiguity } from 'contiguity';
const contiguity = new Contiguity('contiguity_sk_...');
// Step 1: Send OTP
const { otp_id } = await contiguity.otp.new({
to: '+1234567890',
language: 'en',
name: 'MyApp'
});
// Step 2: User enters code, verify it
const userCode = '123456'; // From user input
const { verified } = await contiguity.otp.verify({
otp_id,
otp: userCode
});
if (verified) {
// Proceed with authentication
console.log('User verified!');
} else {
// Show error or allow resend
console.log('Invalid code');
}
// Step 3 (optional): Resend if needed
await contiguity.otp.resend({ otp_id });