SDK — create a business account

Create a business account from the SDK. The authenticated JWT user becomes the first owner member. Gated by the enable-business-accounts feature flag.

POST /sdk/{environmentId}/businessAccounts

SDK — create a business account

cURL

curl --request POST \
  --url https://app.dynamicauth.com/api/v0/sdk/{environmentId}/businessAccounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "externalRef": "<string>",
  "metadata": {}
}
'

201

{
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "projectEnvironmentId": "95b11417-f18f-457f-8804-68e361f9164f",
  "name": "<string>",
  "externalRef": "<string>",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId · string · required

ID of the environment

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Body

application/json

SDK-side create-business-account request. Caller becomes the first owner.

name · string | null

Maximum string length: 255

externalRef · string | null

Developer-supplied stable ID inside the env

Maximum string length: 255

metadata · object

Response

201

application/json

Business account created

A multi-operator wallet container (product name "Business Accounts")

id · string · required

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

projectEnvironmentId · string · required

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

name · string | null

Maximum string length: 255

externalRef · string | null

Developer-supplied stable ID inside the env

Maximum string length: 255

metadata · object

createdAt · string<date-time>

updatedAt · string<date-time>