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> (productId) <= 36 characters
Deprecated

Your product ID.

Example: productId=911db6db-ef58-4992-87cd-2fe2cfde05f9
Request Body schema: application/json
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

The feature that you want to enable on the account. If not provided, this defaults to payments.

Items Enum: "payments" "cards"
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

Details about the account's contact.

(PersonalAccount (object or null)) or BusinessAccount (object)
required
kycCards (object) or kycPayments (object) or kycCombined (object)
Responses
202

Accepted

400

Bad request

401

Unauthorised

403

Forbidden

404

Not found

405

Method not allowed

415

Unsupported media type

429

Too many requests

500

Internal server error

post/onboarding
Request samples
application/json
{
  • "market": "UK",
  • "features": [
    ],
  • "accountType": "business",
  • "affiliateId": "420e4d3c-2d51-4cad-9caf-d7300258cefd",
  • "companyId": "420e4d3c-2d51-4cad-9caf-d7300258cefd",
  • "contact": {
    },
  • "account": {
    },
  • "kyc": {
    }
}
Response samples
application/json
{
  • "ok": true,
  • "correlationId": "420e4d3c-2d51-4cad-9caf-d7300258cefd",
  • "account": {
    }
}