Required Parameters
The following guide includes the details that are required when creating a customer using the Create Customer v5 request, along with validation rules and sample requests.
Use this request to create customers to onboard in United Kingdom. The endpoint accepts both individual and corporate customer.
For a breakdown of the request and parameters, see Onboard Corporate Customer.
For onboarding steps, see UK Onboarding. For document requirements, see UK Required Documents.
Endpoint URL
POST /api/v5/client/{clientHashId}/customers
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
clientHashId | string | Yes | Unique client identifier, generated and shared before the API handshake. |
Body parameters
| Parameter | Type | Required | Accepted Values / Notes |
|---|---|---|---|
type | string | Yes | individual or corporate. |
kycType | string | Yes | minimum or full. Use full when onboarding for payouts. |
region | string | Yes | Use UK. |
externalId | string | Optional | Client-defined unique ID. Returned in webhooks and GET APIs. |
Individual customers
Individual customers in the UK complete electronic KYC through the Pre-built KYC form.
Personal information
| Field | Type | Required | Notes |
|---|---|---|---|
firstName | string | Yes | Max 40. |
middleName | string | Optional | Max 40. |
lastName | string | Yes | Max 40. |
email | string | Yes | Max 60; must match the valid email format. |
nationality | enum | Yes | Category: countryName. |
mobile | numeric/string | Yes | Without country code; max 15 digits. |
mobileCountryCode | numeric/string | Yes | Max 6 digits. |
dateOfBirth | date | Yes | YYYY-MM-DD; age must be 18 or older. |
isPep | boolean | Yes | true if PEP. |
Billing address
| Field | Type | Required | Notes |
|---|---|---|---|
addressLine1 | string | Yes | Max 100. |
addressLine2 | string | Optional | Max 100. |
city | string | Yes | Max 50. |
state | enum/string | Conditional | Category: state. Optional if not applicable for the country. |
postcode | string | Yes | Max 10. |
country | enum | Yes | Category: countryName. |
Expected account usage
| Field | Required | Notes |
|---|---|---|
credit.monthlyTransactionVolume | Yes | Category: monthlyTransactionVolume. |
credit.topTransactionCountries | Yes | Category: countryName. |
debit.monthlyTransactionVolume | Yes | Category: monthlyTransactionVolume. |
debit.topTransactionCountries | Yes | Destination countries for payouts. |
intendedUses | Yes | Category: intendedUseOfAccount. |
intendedUsesDescription | Conditional | Required if Other is selected. Max 300 chars. |
Bank account details
Use these details for refunds and returns.
| Field | Type | Required | Notes |
|---|---|---|---|
accountName | string | Yes | Registered bank account name; max 140. |
accountNumber | string | Yes | Max 35. |
bankCountry | string | Yes | ISO 3166-1 alpha-2. |
bankAccountType | string | Conditional | For example, savings, checking, or current. |
bankName | string | Conditional | Max 255. |
currency | string | Yes | ISO 4217. |
routingCodes.type | string | Yes | For example, SWIFT, SORT_CODE, or other supported value. |
routingCodes.value | string | Yes | Must match the selected routing code type. |
Corporate customers (Full KYC)
Business information
| Field | Type | Required | Notes |
|---|---|---|---|
businessType | enum | Yes | Category: businessType. |
businessName | string | Yes | Max 80. |
tradeName | string | Optional | If not available, use the registered business name. |
businessRegistrationNumber | string | Yes | Max 30. |
registeredDate | date | Yes | YYYY-MM-DD; must be a past date. |
registeredCountry | enum | Yes | Category: countryName. |
website | string | Optional | URL or verified social profile. If omitted, upload PROOF_OF_BUSINESS. |
isMultiLayeredCompany | boolean | Yes | true or false. Upload CORPORATE_STRUCTURE when true. |
searchId | string | Conditional | Include when using the Fetch Exhaustive Corporate Details request. If omitted, the application follows the manual KYB flow. |
Applicant declaration
These fields are required before you submit the onboarding request.
| Field | Type | Required | Notes |
|---|---|---|---|
applicantDeclaration | boolean | Yes | Must be true after the applicant accepts the declaration. |
applicantDeclarationTimestamp | timestamp | Yes | Format: YYYY-MM-DD HH:MM:SS. |
Applicant details
| Field | Type | Required | Notes |
|---|---|---|---|
firstName | string | Yes | Max 40. |
middleName | string | Optional | Max 40. |
lastName | string | Yes | Max 40. |
dateOfBirth | date | Yes | YYYY-MM-DD; age must be 18 or older. |
email | string | Yes | Max 60; valid email. |
mobile | string | Yes | Max 15 digits. |
mobileCountryCode | string | Yes | Max 6 digits. |
nationality | enum | Yes | Category: countryName. |
isPep | boolean | Yes | true if PEP. |
sharePercentage | numeric | Conditional | Required if the applicant is also a shareholder or UBO. |
address | object | Yes | Full residential address. |
positions | array | Yes | Include all applicable roles such as DIRECTOR, REPRESENTATIVE, UBO, PARTNER, or TRUSTEE. |
documents | array | Conditional | Include POWER_OF_ATTORNEY if the applicant is not a director or otherwise not authorized by role. Include SOURCE_OF_WEALTH when isPep = true. |
Registered and business addresses
| Field | Type | Required | Notes |
|---|---|---|---|
addresses.registeredAddress.addressLine1 | string | Yes | Max 100. |
addresses.registeredAddress.addressLine2 | string | Optional | Max 100. |
addresses.registeredAddress.city | string | Yes | Max 50. |
addresses.registeredAddress.state | enum/string | Conditional | Category: state. Optional if not applicable. |
addresses.registeredAddress.postcode | string | Yes | Max 10. |
addresses.registeredAddress.country | enum | Yes | Category: countryName. |
addresses.isBusinessAddressSameAsRegisteredAddress | boolean | Yes | true or false. |
addresses.businessAddress | object | Conditional | Required when the business address is different from the registered address. |
Stakeholders
Stakeholders can be individuals or corporates with roles such as UBO, Director, Partner, **Trustee **, Shareholder, or CONTROL_PRONG.
Individual stakeholders
| Field | Required | Notes |
|---|---|---|
firstName, lastName, dateOfBirth, nationality | Yes | Personal details. |
email, mobile, mobileCountryCode | Yes | Contact details used for KYC. |
isPep | Yes | true if PEP. |
positions | Yes | Include all applicable roles. |
sharePercentage | Conditional | Required when ownership is declared. |
address | Yes | Full residential address. |
documents | Conditional | Used for manual KYC or when additional supporting documents are required. |
Corporate stakeholders
| Field | Required | Notes |
|---|---|---|
businessName | Yes | Registered business name. |
businessRegistrationNumber | Yes | Max 30. |
registeredCountry | Yes | Category: countryName. |
positions.title | Yes | For example, UBO, Shareholder, or Trustee. |
sharePercentage | Conditional | Required for ownership-based roles. |
Nature of business
| Field | Required | Notes |
|---|---|---|
operatingCountries | Yes | All countries where the business operates. |
industryCodes | Yes | Category: industrySector. Multiple values allowed. |
industryDescription | Conditional | Required when Other is selected or when Compliance requests more detail. |
Expected account usage (Corporate)
| Field | Required | Notes |
|---|---|---|
credit.monthlyTransactionVolume | Yes | Estimated total payins. |
credit.monthlyTransactions | Yes | Estimated count of monthly payins. |
credit.averageTransactionValue | Yes | Average payin value. |
credit.topTransactionCountries | Yes | Origin countries. |
credit.topRemitters | Yes | Up to 20 primary remitters. |
debit.monthlyTransactionVolume | Yes | Estimated total payouts. |
debit.monthlyTransactions | Yes | Estimated count of monthly payouts. |
debit.averageTransactionValue | Yes | Average payout value. |
debit.topTransactionCountries | Yes | Destination countries. |
debit.topBeneficiaries | Yes | Up to 20 primary beneficiaries. |
intendedUses | Yes | Category: intendedUseOfAccount. |
intendedUsesDescription | Conditional | Required if Other is selected. |
Size of business
| Field | Required | Notes |
|---|---|---|
totalEmployees | Yes | Category: totalEmployees. |
annualTurnover | Yes | Category: annualTurnover. If the business is less than one year old, provide expected turnover. |
Device details
| Field | Type | Required | Notes |
|---|---|---|---|
ipCountryCode | enum | Yes | Country of origin of the IP; category: countryName. |
deviceInfo | string | Yes | OS or device information for the request. |
ipAddress | string | Yes | Valid IPv4 or IPv6 address. |
sessionId | string | Yes | Session identifier for the request. |
Tags
| Field | Type | Required | Notes |
|---|---|---|---|
tags | array/object | Optional | Up to 15 client-defined key/value pairs. |
tags.key | string | Optional | Max 128; keys must be unique. |
tags.value | string | Optional | Max 255. |
Examples
Individual Customer
Sample Request
{
"type": "individual",
"kycType": "full",
"region": "UK",
"externalId": "ext-123456",
"firstName": "Rahul",
"middleName": "Kumar",
"lastName": "Rajawat",
"isPep": "false",
"email": "support@nium.com",
"nationality": "GB",
"mobile": "123489767",
"mobileCountryCode": "1",
"dateOfBirth": "2000-08-01",
"applicantDeclarationTimeStamp": "2025-08-20 15:49:30",
"applicantDeclaration": "true",
"tags": [
{
"key": "testing",
"value": "Automation"
}
],
"deviceDetails": {
"ipCountryCode": "gb",
"deviceInfo": "MAC",
"ipAddress": "192.168.1.16",
"sessionId": "hello-world"
},
"expectedAccountUsage": {
"intendedUsesDescription": "Business Description or the purpose of account",
"credit": {
"monthlyTransactionVolume": "MVUK01",
"topTransactionCountries": [
"GB",
"GB",
"GB",
"IN"
]
},
"intendedUses": [
"IU108",
"IU107"
],
"debit": {
"monthlyTransactionVolume": "MVUK01",
"topTransactionCountries": [
"GB",
"GB",
"GB",
"IN",
"US"
]
}
},
"bankAccountDetails": {
"accountName": "Rahul Rajawat",
"bankName": "HSBC Bank",
"accountNumber": "78956432",
"currency": "GBP",
"bankAccountType": "current",
"bankCountry": "GB",
"routingCodes": [
{
"type": "SORT CODE",
"value": "230363"
}
]
},
"billingAddress": {
"addressLine1": "AddressLine1 Building Floor",
"addressLine2": "",
"city": "London",
"state": "GB-ENG",
"postcode": "SW1A 1AA",
"country": "GB"
}
}
Sample Successful Response
{
"wallets": [
{
"walletHashId": "b48501dd-14d8-48b6-bfd6-7d4fb5440f48",
"walletType": "base"
}
],
"customerHashId": "705fe3a8-0820-4bb5-ad68-d3cbb0b7712c",
"referenceId": "c3cd4b74-2da8-42cf-9503-5e092747ceda",
"status": "pending",
"subStatus": null,
"type": "individual",
"kycType": "full",
"region": "UK",
"externalId": "ext-123456",
"tags": [
{
"key": "testing",
"value": "Automation"
}
],
"segment": null,
"firstName": "Rahul",
"middleName": "Kumar",
"lastName": "Rajawat",
"email": "support@nium.com",
"nationality": "GB",
"dateOfBirth": "2000-08-01",
"mobile": "123489767",
"mobileCountryCode": "1",
"kycStatus": "kyc_required",
"isPep": false,
"applicantDeclaration": true,
"applicantDeclarationTimeStamp": "2025-08-20 15:49:30",
"deviceDetails": {
"ipCountryCode": "gb",
"deviceInfo": "MAC",
"ipAddress": "192.168.1.16",
"sessionId": "hello-world"
},
"expectedAccountUsage": {
"intendedUses": [
"IU108",
"IU107"
],
"intendedUsesDescription": "Business Description or the purpose of account",
"credit": {
"monthlyTransactionVolume": "MVUK01",
"topTransactionCountries": [
"GB",
"GB",
"GB",
"IN"
]
},
"debit": {
"monthlyTransactionVolume": "MVUK01",
"topTransactionCountries": [
"GB",
"GB",
"GB",
"IN",
"US"
],
"bankAccountDetails": null
}
},
"bankAccountDetails": {
"accountName": "Rahul Rajawat",
"accountNumber": "xxxxxxxx",
"bankAccountType": "current",
"bankName": "HSBC Bank",
"bankCountry": "GB",
"currency": "GBP",
"bankCode": null,
"identificationType": null,
"identificationValue": null,
"localRegisteredName": null,
"routingCodes": [
{
"type": "SORT CODE",
"value": "xxxxxx"
}
]
},
"billingAddress": {
"addressLine1": "AddressLine1 Building Floor",
"addressLine2": "",
"city": "London",
"postcode": "SW1A 1AA",
"country": "GB",
"state": "GB-ENG"
},
"kycMode": null,
"documents": null,
"redirectUrl": null
}
Corporate Customer
Sample Request
{
"type": "corporate",
"kycType": "full",
"region": "UK",
"externalId": "ext-1234",
"businessName": "UK_BusinessName",
"businessRegistrationNumber": "2026040609339M",
"registeredDate": "2020-07-20",
"registeredCountry": "GB",
"website": "https://www.ukcompany.com",
"isMultiLayeredCompany": false,
"businessType": "private_company",
"bankAccountDetails": {
"accountName": "BusinessName Pvt Ltd",
"bankName": "HSBC Bank",
"accountNumber": "78956432",
"currency": "GBP",
"bankAccountType": "current",
"bankCountry": "GB",
"routingCodes": [
{
"type": "SORT CODE",
"value": "230363"
}
]
},
"applicantDeclaration": true,
"applicantDeclarationTimeStamp": "2026-04-07 12:30:00",
"addresses": {
"isBusinessAddressSameAsRegisteredAddress": false,
"registeredAddress": {
"addressLine1": "High Street 101, 56th Avenue",
"addressLine2": "Hyung County",
"city": "London",
"state": "GB-ENG",
"postcode": "SW1A 1AA",
"country": "GB"
},
"businessAddress": {
"addressLine1": "High Street 101, 56th Avenue",
"addressLine2": "Hyung County",
"city": "Singapore",
"state": "SG",
"postcode": "28046",
"country": "SG"
}
},
"applicant": {
"firstName": "Hardik",
"middleName": "Kumar",
"lastName": "Roshan",
"dateOfBirth": "1982-07-17",
"nationality": "IN",
"isPep": true,
"email": "hardik+093920@roecny.com",
"mobile": "222268870",
"mobileCountryCode": "91",
"sharePercentage": 80,
"address": {
"addressLine1": "7 Ang Mo Kio Street",
"addressLine2": "64 No.01-01",
"city": "London",
"state": "GB-ENG",
"postcode": "SW1A 1AA",
"country": "GB"
},
"documents": [
{
"type": "power_of_attorney",
"fileIds": [
"b3cdc844-71cd-4c01-907e-593ddd91debd"
]
}
],
"positions": [
{
"title": "signatory",
"startDate": "2020-07-20"
}
]
},
"stakeholders": {
"individual": [
{
"externalId": "ind-001",
"firstName": "John",
"middleName": "A",
"lastName": "Doe",
"dateOfBirth": "1990-01-01",
"isPep": true,
"nationality": "SG",
"email": "john.doe@example.com",
"mobile": "9876543210",
"mobileCountryCode": "65",
"sharePercentage": 10,
"address": {
"addressLine1": "Street 1",
"addressLine2": "Block A",
"city": "Singapore",
"state": "SG",
"postcode": "123456",
"country": "SG"
},
"positions": [
{
"title": "DIRECTOR",
"startDate": "2021-01-01"
}
]
},
{
"externalId": "ind-002",
"firstName": "Jane",
"middleName": "B",
"lastName": "Smith",
"dateOfBirth": "1992-02-02",
"nationality": "SG",
"isPep": false,
"email": "jane.smith@example.com",
"mobile": "9123456780",
"mobileCountryCode": "65",
"sharePercentage": 10,
"address": {
"addressLine1": "Street 2",
"addressLine2": "Block B",
"city": "London",
"state": "GB-ENG",
"postcode": "SW1A 1AA",
"country": "GB"
},
"positions": [
{
"title": "SHAREHOLDER",
"startDate": "2021-02-01"
}
]
}
],
"corporate": [
{
"externalId": "corp-001",
"businessName": "XYZ Holdings",
"businessRegistrationNumber": "BRN987654",
"listedExchange": "NYSE",
"registeredCountry": "US",
"positions": [
{
"title": "UBO"
}
]
}
]
},
"natureOfBusiness": {
"operatingCountries": [
"HK",
"IN"
],
"industryCodes": [
"IS144"
],
"industryDescription": "Retail, Wholesale, E-commerce - Household items"
},
"expectedAccountUsage": {
"intendedUses": [
"IU003"
],
"intendedUsesDescription": "Payments to the Supplier",
"credit": {
"monthlyTransactionVolume": "MVUK10",
"monthlyTransactions": "ATC03",
"averageTransactionValue": "ATVUK02",
"topTransactionCountries": [
"SG",
"HK"
]
},
"debit": {
"monthlyTransactionVolume": "MVUK05",
"monthlyTransactions": "ATC02",
"averageTransactionValue": "ATVUK01",
"topTransactionCountries": [
"IN",
"SG"
]
}
},
"sizeOfBusiness": {
"totalEmployees": "EM009",
"annualTurnover": "GB008"
},
"deviceDetails": {
"ipCountryCode": "SG",
"deviceInfo": "Windows Laptop",
"ipAddress": "192.168.0.1",
"sessionId": "session-123456"
},
"tags": [
{
"key": "priority",
"value": "high"
}
],
"tradeName": "BusinessHit Trade",
"documents": [
{
"type": "business_registration_doc",
"fileIds": [
"b3cdc844-71cd-4c01-907e-593ddd91debd"
]
}
]
}
Sample Successful Response
{
"wallets": [
{
"walletHashId": "507f8a63-28f9-4b4d-a85b-bc2c22faabeb",
"walletType": "base"
}
],
"customerHashId": "7ddcbea5-2fbe-4b1d-948e-be753cde2043",
"referenceId": "bbd2c8a6-4a93-4029-8063-540933647063",
"status": "pending",
"subStatus": null,
"type": "corporate",
"kycType": "full",
"region": "UK",
"externalId": "ext-1234",
"tags": [
{
"key": "priority",
"value": "high"
}
],
"segment": null,
"businessName": "UK_BusinessName",
"businessRegistrationNumber": "2026040609339M",
"registeredDate": "2020-07-20",
"registeredCountry": "GB",
"website": "https://www.ukcompany.com",
"businessType": "private_company",
"applicantDeclaration": true,
"isMultiLayeredCompany": false,
"applicantDeclarationTimeStamp": "2026-04-07 12:30:00",
"tradeName": "BusinessHit Trade",
"addresses": {
"registeredAddress": {
"addressLine1": "High Street 101, 56th Avenue",
"addressLine2": "Hyung County",
"city": "London",
"postcode": "SW1A 1AA",
"country": "GB",
"state": "GB-ENG"
},
"isBusinessAddressSameAsRegisteredAddress": false,
"businessAddress": {
"addressLine1": "High Street 101, 56th Avenue",
"addressLine2": "Hyung County",
"city": "Singapore",
"postcode": "28046",
"country": "SG",
"state": "SG"
}
},
"natureOfBusiness": {
"operatingCountries": [
"HK",
"IN"
],
"industryCodes": [
"IS144"
],
"industryDescription": "Retail, Wholesale, E-commerce - Household items"
},
"expectedAccountUsage": {
"intendedUses": [
"IU003"
],
"intendedUsesDescription": "Payments to the Supplier",
"credit": {
"averageTransactionValue": "ATVUK02",
"monthlyTransactionVolume": "MVUK10",
"monthlyTransactions": "ATC03",
"topTransactionCountries": [
"SG",
"HK"
]
},
"debit": {
"averageTransactionValue": "ATVUK01",
"monthlyTransactionVolume": "MVUK05",
"monthlyTransactions": "ATC02",
"topTransactionCountries": [
"IN",
"SG"
]
}
},
"sizeOfBusiness": {
"totalEmployees": "EM009",
"annualTurnover": "GB008"
},
"deviceDetails": {
"ipCountryCode": "SG",
"deviceInfo": "Windows Laptop",
"ipAddress": "192.168.0.1",
"sessionId": "session-123456"
},
"bankAccountDetails": {
"accountName": "BusinessName Pvt Ltd",
"accountNumber": "xxxxxxxx",
"bankAccountType": "current",
"bankName": "HSBC Bank",
"bankCountry": "GB",
"currency": "GBP",
"bankCode": null,
"identificationType": null,
"identificationValue": null,
"localRegisteredName": null,
"routingCodes": [
{
"type": "SORT CODE",
"value": "xxxxxx"
}
]
},
"applicant": {
"externalId": null,
"firstName": "Hardik",
"middleName": "Kumar",
"lastName": "Roshan",
"dateOfBirth": "1982-07-17",
"nationality": "IN",
"email": "hardik+093920@roecny.com",
"mobile": "222268870",
"mobileCountryCode": "91",
"sharePercentage": "80",
"address": {
"addressLine1": "7 Ang Mo Kio Street",
"addressLine2": "64 No.01-01",
"city": "London",
"postcode": "SW1A 1AA",
"country": "GB",
"state": "GB-ENG"
},
"isPep": true,
"positions": [
{
"title": "signatory"
}
],
"kycMode": null,
"documents": [
{
"type": "power_of_attorney",
"fileIds": [
"b3cdc844-71cd-4c01-907e-593ddd91debd"
],
"identificationNumber": null,
"issuanceCountry": null,
"expiryDate": null
}
],
"redirectUrl": null,
"referenceId": "11d26e4c-83f0-4bea-a20e-ed99d982b3ab",
"kycStatus": "kyc_required"
},
"stakeholders": {
"individual": [
{
"externalId": "ind-001",
"firstName": "John",
"middleName": "A",
"lastName": "Doe",
"dateOfBirth": "1990-01-01",
"nationality": "SG",
"email": "john.doe@example.com",
"mobile": "9876543210",
"mobileCountryCode": "65",
"sharePercentage": "10",
"address": {
"addressLine1": "Street 1",
"addressLine2": "Block A",
"city": "Singapore",
"postcode": "123456",
"country": "SG",
"state": "SG"
},
"isPep": true,
"positions": [
{
"title": "DIRECTOR"
}
],
"documents": null,
"kycMode": null,
"redirectUrl": null,
"referenceId": "e5bb7965-4771-4d2f-8c8e-2b7b9bbd28c0",
"kycStatus": "kyc_not_required"
},
{
"externalId": "ind-002",
"firstName": "Jane",
"middleName": "B",
"lastName": "Smith",
"dateOfBirth": "1992-02-02",
"nationality": "SG",
"email": "jane.smith@example.com",
"mobile": "9123456780",
"mobileCountryCode": "65",
"sharePercentage": "10",
"address": {
"addressLine1": "Street 2",
"addressLine2": "Block B",
"city": "London",
"postcode": "SW1A 1AA",
"country": "GB",
"state": "GB-ENG"
},
"isPep": false,
"positions": [
{
"title": "SHAREHOLDER"
}
],
"documents": null,
"kycMode": null,
"redirectUrl": null,
"referenceId": "8c0c5f45-75d3-4192-8192-48a895b603d8",
"kycStatus": "kyc_not_required"
}
],
"corporate": [
{
"externalId": "corp-001",
"businessName": "XYZ Holdings",
"businessRegistrationNumber": "BRN987654",
"registeredCountry": "US",
"sharePercentage": null,
"positions": [
{
"title": "UBO"
}
],
"referenceId": "dfd5b84f-4de4-4353-b51a-d81ea3c6de44",
"kycStatus": "kyc_not_required"
}
]
},
"documents": [
{
"type": "business_registration_doc",
"fileIds": [
"b3cdc844-71cd-4c01-907e-593ddd91debd"
]
}
]
}
For response check Response Codes.