Skip to main content
POST
Verify a one-time code

Authorizations

Authorization
string
header
required

Organization API key, sent as Authorization: Bearer boom_org_....

Body

application/json
code
string
required

The digits the person entered.

Pattern: ^\d{6,10}$
otpId
string
Minimum string length: 1
phone
string

Recipient phone in E.164 format, e.g. +5215512345678.

Minimum string length: 1
personExternalId
string

Your own ID for the person; Boom uses their stored phone.

Minimum string length: 1
reference
string

Your label for what the code is for, e.g. an appointment ID. People sharing a phone get separate codes when this or personExternalId is passed.

Maximum string length: 255

Response

Success

valid
boolean
required
status
enum<string>
required
Available options:
PENDING,
VERIFIED,
EXPIRED,
LOCKED
attemptsRemaining
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991