Skip to main content
POST

Contact Verification Guide

How the email + OTP verification flow works end-to-end
Initiates a new contact details verification. PCI Booking sends an email containing a secure link to the provided address. When the recipient clicks the link, they verify their phone number using a one-time passcode (OTP) sent via SMS or voice call.

Error Responses

Parameter Constraints

Phone numbers must be in international format, including the country code, without a leading + sign (e.g. 972544735557).

Parameters

Headers

Authorization
string
required
Your API key prefixed with APIKEY. Example: APIKEY your-api-key. See the Authentication guide.

Contact Details

email
string
required
The email address to send the verification link to.
phone
string
required
The phone number to verify via OTP, in international format without a leading + sign (e.g. 972544735557).
personName
string
The name of the recipient. Shown in the email greeting and verification screens.

Message Options

senderName
string
The name that appears as the SMS sender (supported in most countries).
language
string
default:"en"
The language for the email and verification page, as a two-letter ISO 639-1 code (e.g. en).
ttlMinutes
number
default:"10"
How long the verification link stays valid, in minutes. Allowed range: 1 to 30.

Callback & Tracking

callbackUrl
string
A URL to which PCI Booking will POST the result when the session reaches a terminal state. See Receive Result Notification.
metadata
string
A free-form reference string stored with the session and echoed back in all responses and callbacks.

Response