Skip to main content
POST
/
onboarding
Create an account
curl --request POST \
  --url https://api.equalsmoney.com/v2/onboarding \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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
  },
  "market": "UK",
  "features": "payments"
}
'
{
  "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",
    "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"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
productId
string<uuid>
deprecated

The ID of the product to work with.

Maximum string length: 36
Example:

"3ef24d53-6e22-4103-a16b-d268e4f7346d"

Body

application/json

Body

​
accountType
enum<string>
required

The type of account that you want to onboard.

Available options:
business,
personal
​
contact
object
required
​
kyc
object
required
​
affiliateId
string

The affiliate ID.

Example:

"420e4d3c-2d51-4cad-9caf-d7300258cefd"

​
companyId
string

The company ID.

Example:

"420e4d3c-2d51-4cad-9caf-d7300258cefd"

​
account
object
​
market
enum<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, 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.

Available options:
UK,
EU,
US,
UP
Example:

"UK"

​
features
enum<string>[]

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

Available options:
payments,
cards
Example:

"payments"

Response

202 - application/json

Accepted

​
ok
boolean
required

Indicates if the onboarding was successful.

​
correlationId
string
required

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

​
account
object
required

Details about the account.