Create a Verification

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Initiates a new contact details verification. PCI Booking sends an email to the provided address containing a link to a hosted verification page. The property opens the page and confirms their phone number using a one-time passcode (OTP) sent to them via SMS or voice call.

When submitted successfully, the response body will contain the verification session ID, its initial status, and the expiry time.

📘 Both email and phone are required

email is used to deliver the verification link to the property. phone is the number that will be confirmed via OTP. Both fields must be provided.

📘 Phone number format

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


The response for this request will be a JSON with the following fields:

FieldTypeDescription
verifyIdstringThe unique ID of the verification session. Use this in all subsequent status and results calls.
statusstringThe initial status of the verification. Always Pending on creation.
expiresAtdatetimeThe UTC datetime at which the verification link will expire, based on ttlMinutes. ISO 8601 format.
Body Params
string

The email address to verify.

string

The phone number to verify, in international format without a leading + sign (e.g. 972544735557).

string

The name of the recipient, used to personalise the verification message.

string

The name that will appear as the SMS sender (supported in most countries).

string
Defaults to en

The language for the verification message as a two-letter ISO 639-1 code (e.g. en). Defaults to English.

string
Defaults to 10

Time-to-live for the verification link, in minutes. Allowed range: 1–30. Default: 10.

string

A URL to which PCI Booking will POST the result when the session reaches a terminal state.

string

A free-form reference string that will be stored with the session and echoed back in all responses and callbacks.

Headers
string
required

Your PCI Booking API key in the format of ApiKey <your_api_key>

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json