Skip to main content
POST
/
clients
Create a new client
curl --request POST \
  --url https://api.platform.dakota.xyz/clients \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "client_name": "Acme Financial Services",
  "user_first_name": "John",
  "user_last_name": "Smith",
  "user_email": "john.smith@acme.com",
  "bridge_subdeveloper_id": "sub_dev_123456",
  "dakota_organization_id": "71e335dd-da91-41a3-b1a5-b596e2f5e798"
}
'
{
  "client": {
    "id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi",
    "name": "Acme Financial Services"
  },
  "setup_statuses": {
    "client_created": {
      "success": true,
      "error": "<string>",
      "details": {}
    },
    "subdeveloper_added": {
      "success": true,
      "error": "<string>",
      "details": {}
    },
    "user_created": {
      "success": true,
      "error": "<string>",
      "details": {}
    },
    "stytch_user_created": {
      "success": true,
      "error": "<string>",
      "details": {}
    },
    "bridge_customer_fetched": {
      "success": true,
      "error": "<string>",
      "details": {}
    },
    "customer_copied": {
      "success": true,
      "error": "<string>",
      "details": {}
    },
    "webhooks_setup": {
      "success": true,
      "error": "<string>",
      "details": {}
    },
    "webhook_activated": {
      "success": true,
      "error": "<string>",
      "details": {}
    },
    "webhook_key_stored": {
      "success": true,
      "error": "<string>",
      "details": {}
    },
    "endorsements_synced": {
      "success": true,
      "error": "<string>",
      "details": {}
    }
  }
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
client_name
string
required

Name of the new client organization

Example:

"Acme Financial Services"

​
user_first_name
string
required

First name of the primary user for this client

Example:

"John"

​
user_last_name
string
required

Last name of the primary user for this client

Example:

"Smith"

​
user_email
string<email>
required

Email address of the primary user for this client

Example:

"john.smith@acme.com"

​
bridge_subdeveloper_id
string

Bridge subdeveloper ID for this client. Required in production, optional in sandbox mode.

Example:

"sub_dev_123456"

​
dakota_organization_id
string<uuid>

Dakota organization ID (UUID) that maps to Platform customer external_id. Required in production, optional in sandbox mode.

Example:

"71e335dd-da91-41a3-b1a5-b596e2f5e798"

Response

Client created successfully

​
client
object
required
​
setup_statuses
object
required

Status of each setup step