Sign in

v1

latestOpenAPI 3.1.0UNLICENSED2026-07-2613101.1 MB
Onboarding

Create an account

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

post/onboarding

Query parameters

productIdstring uuid

The ID of the product to work with.

Example:3ef24d53-6e22-4103-a16b-d268e4f7346d

Request body

accountType'business' | 'personal' required

The type of account that you want to onboard.

affiliateIdstring

The affiliate ID.

companyIdstring

The company ID.

market'UK' | 'EU' | 'US' | 'UP'

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, EU, and UP market accounts, but your account's geographical region doesn't necessarily have to be the one of those. The API validates that the selected market is allowed for the product.

featuresstring[]
preferredLanguage'EN' | 'FR' | 'DE' | 'ES' | 'IT' | 'NL' | 'PT'

The preferred language for business correspondence. ISO 639-1 uppercase.

Example request

{
  "accountType": "business",
  "affiliateId": "420e4d3c-2d51-4cad-9caf-d7300258cefd",
  "companyId": "420e4d3c-2d51-4cad-9caf-d7300258cefd",
  "contact": {
    "firstName": "John",
    "lastName": "Doe",
    "nationality": "GB",
    "annualIncome": {
      "currencyCode": "USD",
      "value": 0
    },
    "email": "test@example.com",
    "phone": "07123456789",
    "dob": "19/01/1946",
    "address": {
      "addressLine1": "Great Building",
      "addressLine2": "Greater Building",
      "townCity": "My Town",
      "postCode": "SE13UB",
      "countryCode": "GB"
    }
  },
  "account": {
    "companyName": "My Company",
    "companyNumber": "1111111111",
    "incorporationDate": "2004-01-30",
    "type": "ltd",
    "website": "https://www.my-business.com",
    "onboardingDetail": "detail",
    "address": {
      "addressLine1": "Great Building",
      "addressLine2": "Greater Building",
      "townCity": "My Town",
      "postCode": "SE13UB",
      "countryCode": "GB"
    }
  },
  "kyc": {
    "mainPurpose": "Sale of shares",
    "sourceOfFunds": "salary",
    "destinationOfFunds": "GB",
    "currenciesRequired": "GBP",
    "annualVolume": "Less than £10,000",
    "numberOfPayments": "More than 20 payments",
    "expectedCardUse": "advertising_and_marketing",
    "averageLoad": "10000_25000",
    "numberOfCards": "11_50",
    "cardFourthLine": "CUSTOMER",
    "employeeCards": true,
    "atmWithdrawals": true,
    "cardProducts": {
      "individualVirtual": "03e9e3df-ad27-4bfc-9e97-a3ba3d537580",
      "individualPhysical": "f90df540-a102-4876-bf01-8594cf50af5c",
      "shared": "2310830e-60d4-4930-8ee5-c729d2ce8303"
    }
  },
  "market": "UK",
  "features": "payments",
  "preferredLanguage": "EN"
}

Response

Accepted

okboolean required

Indicates if the onboarding was successful.

correlationIdstring required

The unique identifier used to track and link events in the AccountActivated and AccountCreated webhooks.

Example response

{
  "ok": true,
  "correlationId": "string",
  "account": {
    "product": "EQUALSMONEY",
    "market": "UK",
    "features": "payments",
    "accountType": "business",
    "affiliateId": "420e4d3c-2d51-4cad-9caf-d7300258cefd",
    "companyId": "420e4d3c-2d51-4cad-9caf-d7300258cefd",
    "preferredLanguage": "EN",
    "contact": {
      "firstName": "John",
      "lastName": "Doe",
      "nationality": "GB",
      "annualIncome": {
        "currencyCode": "USD",
        "value": 0
      },
      "email": "test@example.com",
      "phone": "07123456789",
      "dob": "19/01/1946",
      "address": {
        "addressLine1": "Great Building",
        "addressLine2": "Greater Building",
        "townCity": "My Town",
        "postCode": "SE13UB",
        "countryCode": "GB"
      }
    },
    "account": {
      "companyName": "My Company",
      "companyNumber": "1111111111",
      "incorporationDate": "1980-01-30",
      "type": "ltd",
      "website": "https://www.my-business.com",
      "onboardingDetail": "detail",
      "address": {
        "addressLine1": "Great Building",
        "addressLine2": "Greater Building",
        "townCity": "My Town",
        "postCode": "SE13UB",
        "countryCode": "GB"
      }
    },
    "kyc": {
      "expectedCardUse": "advertising_and_marketing",
      "onboardingDetail": "Extra info supplied by customer",
      "sourceOfFunds": "salary",
      "currenciesRequired": "GBP",
      "averageLoad": "10000_25000",
      "numberOfCards": "11_50",
      "numberOfPayments": "More than 20 payments",
      "destinationOfFunds": "GB",
      "mainPurpose": "Sale of shares",
      "cardFourthLine": "CUSTOMER",
      "employeeCards": true,
      "atmWithdrawals": true,
      "annualVolume": "Less than £10,000"
    }
  }
}