Skip to main content
POST
local.verification.start

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
method
enum<string>
required

How to verify the listing.

Available options:
address,
email,
phone_call,
sms,
auto,
vetted_partner
accountId
string

The connected business account, from local.locations.list. Optional when only one is connected.

Required string length: 1 - 256
locationId
string

A location id from local.locations.list. Omit to use the selected location.

Required string length: 1 - 256
languageCode
string

BCP-47 language for the verification, e.g. "en-US".

Required string length: 1 - 35
phoneNumber
string

Where the code goes, for sms and phone_call.

Required string length: 1 - 64
emailAddress
string

Where the code goes, for email.

Required string length: 1 - 320
mailerContact
object

Postcard contact details, for address. Sent as given.

context
object

Service-business context (for example the service address), required for service-area businesses. Sent as given.

Response

The result

id
string

Pass to local.verification.complete.

method
enum<string>

How the listing is being verified.

Available options:
address,
email,
phone_call,
sms,
auto,
vetted_partner
state
enum<string>

pending, completed or failed.

Available options:
pending,
completed,
failed
createdAt
string

When the attempt started, ISO 8601.