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

post/onboarding

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"accountType": "business",
"affiliateId": "420e4d3c-2d51-4cad-9caf-d7300258cefd",
"companyId": "420e4d3c-2d51-4cad-9caf-d7300258cefd",
"contact": {"firstName": "John",
"lastName": "Doe",
"nationality": "GB",
"annualIncome": {"value": 100000,
"currencyCode": "GBP"
},
"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"
}

Response samples

application/json

{"ok": true,
"correlationId": "48fb4cd3-2ef6-4479-bea1-7c92721b988c",
"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": {"value": 100000,
"currencyCode": "GBP"
},
"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"
}
}
}
}