API ReferenceEndpointsCustomersVerify email

Verify email

Confirms the 6-digit code emailed at registration. The code expires after 10 minutes and the account locks after repeated wrong codes. For a pending registration (email verification on) the account is created now and a customer token is returned. Limited to 10 requests per minute per IP.

POST
/vc/{connectionId}/customers/verify-email
X-Sales-Channel-Origin<token>

For /api/vc/{connectionId}/* routes the connectionId (vc_*) is in the URL path — not a header. Live-mode requests must also send a matching Origin header.

In: header

Path Parameters

connectionIdstring

Sales channel ID (vc_*), the canonical salesChannelId. connectionId is the deprecated name of the same value and is still the literal path segment.

Header Parameters

originstring

Origin of the storefront page making the call, for example https://shop.example.com. Required: a request with no Origin header is refused with 403. On a LIVE channel its host must equal the channel's registered domain (or one of its subdomains) or match an allowed origin. A TEST channel with no domain accepts any origin; once a domain is set it is matched as on LIVE.

authorizationstring

Bearer token of the registration being verified: the token returned by customers/register when email verification is on, or the customer token of an existing account verifying its email. A missing header answers 403.

X-SDK-Version?string

Version of the calling SDK (the Brainerce SDK sends it automatically). Informational: it is recorded on the channel and never changes the response.

codestring

6-digit verification code from the email-verification message. Codes expire after 10 minutes.

Length6 <= length
curl -X POST "https://api.brainerce.com/api/vc/string/customers/verify-email" \  -H "origin: string" \  -H "authorization: string" \  -H "X-SDK-Version: string" \  -H "Content-Type: application/json" \  -d '{    "code": "482917"  }'
{
  "verified": true,
  "message": "Email verified",
  "customer": {
    "id": "clcus_abc123",
    "email": "[email protected]",
    "firstName": "Jane",
    "lastName": "Doe",
    "phone": "string",
    "emailVerified": true
  },
  "token": "string",
  "expiresAt": "2026-01-15T10:30:00.000Z",
  "requiresVerification": true
}

{
  "statusCode": 400,
  "code": "VALIDATION_FAILED",
  "message": "name should not be empty, price must be a positive number",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/customers/verify-email"
}

{
  "statusCode": 403,
  "code": "INSUFFICIENT_SCOPE",
  "message": "API key does not have the required scope: products:write",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/customers/verify-email"
}

{
  "statusCode": 404,
  "code": "RESOURCE_NOT_FOUND",
  "message": "Resource not found",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/customers/verify-email"
}

{
  "statusCode": 409,
  "code": "CONFLICT",
  "message": "The request conflicts with the current state of the resource",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/customers/verify-email"
}

{
  "statusCode": 429,
  "code": "RATE_LIMITED",
  "message": "Too many requests",
  "details": {
    "retryAfterSeconds": 12
  },
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/customers/verify-email"
}