Create child account - Interchange API

Authorizations

Authorization

string

header

required

API key or access token

Body

application/json

Request body for creating a child customer account

name

string

required

Name for the new child 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"

parentName

string

Name for the parent account created during standalone conversion. Defaults to "{company} (Admin)" if omitted.

Required string length: 1 - 255

Example:

"Acme HQ"

customerDomain

string

Registered organization 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 child account

Full user context scoped to the new child customer

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 embedded sales agent version identifier

convertedFromStandalone

boolean

required

True if the request triggered a standalone-to-parent conversion

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.