Create an account

Starts the process of onboarding an account. This endpoint can only be accessed by product-level permissions.

SecurityCommonAuth
Request
query Parameters
productId
string <uuid> <= 36 characters
Deprecated

The ID of the product to work with.

Example: productId=3ef24d53-6e22-4103-a16b-d268e4f7346d
Request Body schema: application/json

Body

accountType
required
string

The type of account that you want to onboard.

Enum: "business" "personal"
affiliateId
string

The affiliate ID.

companyId
string

The company ID.

required
object
object or object
required
object or object or object
market
string
Default: "UK"

The market relating to the license that the account operates under. This may be different from the geographical region that the account operates in. Currently, we support UK, US and EU market accounts, but your account's geographical region doesn't necessarily have to be the one of those.

Enum: "UK" "EU" "US"
features
Array of strings
Enum: "payments" "cards"
Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

415

Unsupported Media Type

422

Unable to process the request

429

Too Many Requests

500

Internal Server Error

post/onboarding
Request samples
application/json
{
  • "accountType": "business",
  • "affiliateId": "420e4d3c-2d51-4cad-9caf-d7300258cefd",
  • "companyId": "420e4d3c-2d51-4cad-9caf-d7300258cefd",
  • "contact": {
    },
  • "account": {
    },
  • "kyc": {
    },
  • "market": "UK",
  • "features": "payments"
}
Response samples
application/json
{
  • "ok": true,
  • "correlationId": "48fb4cd3-2ef6-4479-bea1-7c92721b988c",
  • "account": {
    }
}