API ReferenceEndpointsCustomersLink o auth provider

Link o auth provider

Starts linking a social account to the signed-in customer. Returns the provider consent URL and state; the callback then attaches the provider to the account.

POST
/vc/{connectionId}/oauth/{provider}/link
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.

providerstring

OAuth provider, case-insensitive (google and GOOGLE both work). Only GOOGLE is implemented: FACEBOOK and GITHUB answer 400 (code: provider_unsupported).

Value in"GOOGLE" | "FACEBOOK" | "GITHUB"

Query Parameters

redirectUrl?string

Where the shopper lands after linking. Same rules as for oauth/{provider}/authorize.

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

Customer token as Bearer <token>, returned by customers/login, customers/register or the OAuth callback. Expires after 7 days. It is a customer token, never an API key.

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.

curl -X POST "https://api.brainerce.com/api/vc/string/oauth/GOOGLE/link?redirectUrl=string" \  -H "origin: string" \  -H "authorization: string" \  -H "X-SDK-Version: string"
{
  "authorizationUrl": "https://shop.example.com/page",
  "state": "string",
  "provider": "GOOGLE"
}

{
  "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}/oauth/{provider}/link"
}

{
  "statusCode": 401,
  "code": "UNAUTHORIZED",
  "message": "Invalid or expired credential",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/oauth/{provider}/link"
}

{
  "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}/oauth/{provider}/link"
}

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

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