Skip to main content
POST

Card Display with OTP Guide

How the OTP verification flow works end-to-end
Sends an email containing a secure link to the specified viewer. When the viewer clicks the link and verifies their phone number via OTP, PCI Booking displays the card details on a hosted page.

Error Responses

Parameter Constraints

Parameters

Authentication

API key only. This endpoint does not accept access tokens or session tokens.
string
required
Your API key prefixed with APIKEY. Example: APIKEY your-api-key. The x-pcibooking-api-key header is also accepted. See the Authentication guide.

Request Body

string
required
The PCI Booking card token to display.
string
required
Email address to send the secure viewing link to. (Legacy alias: ViewrEmail.)
string
required
Phone number for SMS verification. Format: country code + number, no + prefix (e.g. 1555123456 for US, 353858622255 for Ireland). (Legacy alias: ViewrPhone.)
string
Name of the viewer, used to personalize the email and verification screens. Max 100 characters. (Legacy alias: ViewerName.)
string
SMS sender name. Defaults to your account name.
number
default:"10"
How long the viewing link stays valid, in minutes. Range 1 to 30.
string
default:"en"
Two-letter language code for the email and verification screens, from the supported languages list.

Response