Skip to main content
POST
Confirm a customer's email verification code

Authorizations

Authorization
string
header
required

API token authentication using format <api token id>:<api client secret>

Path Parameters

customerId
string
required

The Grid customer ID whose email is being verified.

Body

application/json

Request body for confirming an email or phone verification challenge.

code
string
required

The one-time verification code the customer received via email or SMS. In sandbox, the code is always 123456.

Example:

"123456"

Response

Email verified.

platformCustomerId
string
required

Platform-specific customer identifier

Example:

"9f84e0c2a72c4fa"

customerType
enum<string>
required

Whether the customer is an individual or a business entity

Available options:
INDIVIDUAL,
BUSINESS
Example:

"INDIVIDUAL"

umaAddress
string
required

Full UMA address (always present in responses, even if system-generated). This is an optional identifier to route payments to the customer.

Example:

"$john.doe@uma.domain.com"

id
string
read-only

System-generated unique identifier

Example:

"Customer:019542f5-b3e7-1d02-0000-000000000001"

region
string

Country code (ISO 3166-1 alpha-2) representing the customer's regional identity and regulatory jurisdiction.

Example:

"US"

currencies
string[]

List of currency codes enabled for this customer.

Example:
email
string<email>

Email address for the customer.

Example:

"john.doe@example.com"

phoneNumber
string

Phone number for the customer in strict E.164 format.

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

"+14155551234"

createdAt
string<date-time>
read-only

Creation timestamp

Example:

"2025-07-21T17:32:28Z"

updatedAt
string<date-time>
read-only

Last update timestamp

Example:

"2025-07-21T17:32:28Z"

isDeleted
boolean
read-only

Whether the customer is marked as deleted

Example:

false

contactVerification
object

Email and phone verification state. Only present when the customer's payment provider requires it (e.g. EU customers); omitted otherwise.