Create account - Interchange API

Authorizations

Authorization

string

header

required

API key or access token

Body

application/json

Request body for creating a Buyer or Seller account

name

string

required

Name for the new account

Required string length: 1 - 255

Example:

"Nike"

customerRole

enum<string>

required

Whether the account is a buyer or seller

Available options:

BUYER,

SELLER

Example:

"BUYER"

idempotencyKey

string

Stable retry key for this account-creation attempt. Current clients always send one; omission is supported during rolling deploys.

Required string length: 8 - 128

Pattern: ^[A-Za-z0-9._:-]+$

Example:

"child-account:550e8400-e29b-41d4-a716-446655440000"

parentName

string

Name for the organization created during standalone conversion. Defaults to the current standalone account's name if omitted.

Required string length: 1 - 255

Example:

"Acme HQ"

confirmOrganizationConversion

boolean

Required only for a fresh account creation from a standalone account. Must be true after presenting that the operation creates an organization container, attaches the standalone account to it, moves contract and billing authority to the organization, makes the confirmer an organization administrator, preserves account-only membership boundaries, applies account-specific standing before inherited organization standing, and requires a dedicated migration for detachment. Omission or false returns 409 Conflict. Callers already managed by an organization should omit this field.

Example:

true

customerDomain

string

Registered account domain. For SELLER accounts, also seeds the auto-created storefront's publisher and operator domain.

Maximum string length: 255

Pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)+$

Example:

"nike.com"

defaultCurrency

string

For SELLER accounts, seller-confirmed primary settlement currency (ISO-4217) for the auto-created storefront.

Pattern: ^[A-Z]{3}$

Example:

"USD"

paymentCurrencies

string[]

For SELLER accounts, ISO-4217 currencies the auto-created storefront will be paid in. The primary defaultCurrency must be included when both are provided.

Maximum array length: 25

Pattern: ^[A-Z]{3}$

Example:

["USD", "EUR"]

accountMode

enum<string>

default:STANDARD

Internal account provisioning mode. DEMO is restricted to Scope3 platform administrators and provisions a leased synthetic Storefront.

Available options:

STANDARD,

DEMO

Example:

"STANDARD"

demoRecipeIds

enum<string>[]

Versioned synthetic source recipes to attach when accountMode is DEMO.

Required array length: 1 - 3 elements

Available options:

sample-publisher-display,

sample-publisher-ctv,

sample-retail-media

Example:

[
  "sample-publisher-display",
  "sample-publisher-ctv",
  "sample-retail-media"
]

Response

Create account

Full user context scoped to the newly created account

user

object

required

User profile data

Show child attributes

customer

object

required

Customer context for the newly created child

Show child attributes

customers

object[]

required

All accessible customer accounts

Show child attributes

showTosBox

boolean

required

Whether to show the ToS acceptance dialog

canAcceptTos

boolean

required

Whether the current user may accept Terms of Service for the organization governing this child.

hasContract

boolean

required

Whether the customer has an active contract

latestTosVersion

string

required

Latest Terms of Service version identifier

convertedFromStandalone

boolean

required

True if the request created an organization and attached the formerly standalone account to it

tosUpdate

object

Successor Terms of Service context inherited from the organization.

Show child attributes

organizationContractMissing

boolean

True when the newly created account cannot operate because the organization it inherits from has no active contract. UI should render a block page until an organization admin accepts ToS.