Skip to main content

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 Australia. The endpoint accepts both individual and corporate customer.

For a breakdown of the request and parameters, see Onboard Corporate Customer.

Endpoint URL

POST /api/v5/client/{clientHashId}/customers

Path Parameters

ParameterTypeRequiredDescription
clientHashIdstringYesUnique client identifier, generated and shared before the API handshake.

Body Parameters

ParameterTypeRequiredAccepted Values / Notes
typestringYesindividual or corporate.
kycTypestringYesminimum or full. Use full when onboarding for payouts.
regionstringYesUse AU.
externalIdstringOptionalClient-defined unique ID (max 36). Returned in webhooks and GET APIs.

Individual Customers

Personal Information

FieldTypeRequiredNotes
firstNamestringYesMax 40.
middleNamestringOptionalMax 40.
lastNamestringYesMax 40.
emailstringYesMax 60; must match the valid email regex.
nationalityenumYesCategory: countryName.
mobilenumericYesWithout country code; max 15 digits.
mobileCountryCodenumericYesMax 6 digits.
dateOfBirthdateYesYYYY-MM-DD; age ≥ 18.
isPepbooleanYestrue if PEP.
birthCountryenumYesCategory: countryName.

Tax Details

Provide at least one entry.

FieldTypeRequiredNotes
taxCountryenumYesCategory: countryName.
taxNumberstringYesMax 64.

Billing Address

FieldTypeRequiredNotes
addressLine1stringYesMax 100.
addressLine2stringOptionalMax 100.
citystringYesMax 50.
stateenum/stringConditionalCategory: state. Optional if unavailable for country.
postcodestringYesMax 10.
countryenumYesCategory: countryName.

Expected Account Usage

FieldRequiredNotes
credit.monthlyTransactionVolumeYesCategory: monthlyTransactionVolume.
credit.topTransactionCountriesYesCategory: countryName.
debit.monthlyTransactionVolumeYesCategory: monthlyTransactionVolume.
debit.topTransactionCountriesYesDestination countries for payouts.
intendedUsesYesCategory: intendedUseOfAccount.
intendedUsesDescriptionConditionalRequired if Other is selected. Max 300 chars.

Bank Account Details (for refunds/returns)

FieldTypeRequiredNotes
accountNamestringYesRegistered bank name; max 140.
accountNumberstringYesMax 35.
bankCountrystringYesISO 3166-1 alpha-2.
bankAccountTypestringConditionalFor example, savings, checking, current.
bankNamestringConditionalMax 255.
currencystringYesISO 4217 (for example, USD, AUD).
routingCodes.typestringYesFor example, SWIFT, ABA, BRANCH_CODE.
routingCodes.valuestringYesMatches the selected type.

Corporate Customers (Full KYC)

Business Information

FieldTypeRequiredNotes
businessTypeenumYesCategory: businessType.
businessNamestringYesMax 80.
tradeNamestringOptionalIf not available, set equal to businessName.
businessRegistrationNumberstringYesMax 30.
registeredDatedateYesYYYY-MM-DD; past date.
registeredCountryenumYesCategory: countryName.
websitestringOptionalURL or verified social profile; else upload PROOF_OF_BUSINESS.
isMultiLayeredCompanybooleanYestrue/false. See the multi-layered structure guide.

Applicant Details

FieldTypeRequiredNotes
firstName / lastNamestringYesMax 40 each.
dateOfBirthdateYesPast date; age ≥ 18.
emailstringYesMax 60; valid email.
mobile / mobileCountryCodestringYes15/6 digit limits.
isPepbooleanYestrue if PEP.
positionsarrayYesInclude DIRECTOR, REPRESENTATIVE, UBO as applicable.
documentsarrayConditionalPOWER_OF_ATTORNEY required if applicant is not a director.

Stakeholders

Stakeholders can be individuals or corporates with roles such as UBO, Director, Partner, **Trustee **, Shareholder.

Individual Stakeholders

FieldRequiredNotes
firstName, lastName, dateOfBirth, nationalityYesPersonal details.
isPepYestrue if PEP.
positionsOptionalFor example, UBO, Partner, Director.
sharePercentageConditionalRequired when ownership ≥ 25%.
addressYesFull residential address.

Corporate Stakeholders

FieldRequiredNotes
businessNameYesRegistered name.
businessRegistrationNumberYesMax 30.
registeredCountryYesCategory: countryName.
positions.titleYesFor example, UBO, Shareholder, Trustee.
sharePercentageConditionalRequired for UBO/Shareholder.

Nature of Business

FieldRequiredNotes
operatingCountriesYesAll countries where the business operates.
industryCodesYesCategory: industrySector. Multiple allowed.
industryDescriptionConditional2–3 sentences if “Other” is selected or requested by Compliance.

See Prohibited Business Categories.

Expected Account Usage (Corporate)

FieldRequiredNotes
credit.monthlyTransactionVolumeYesEstimated total payins (AUD).
credit.monthlyTransactionsYesEstimated count of monthly payins.
credit.averageTransactionValueYesAverage payin value (AUD).
credit.topTransactionCountriesYesOrigin countries.
credit.topRemittersYesUp to 20 primary remitters (company names or entity types).
debit.monthlyTransactionVolumeYesEstimated total payouts (AUD).
debit.monthlyTransactionsYesEstimated count of monthly payouts.
debit.averageTransactionValueYesAverage payout value (AUD).
debit.topTransactionCountriesYesDestination countries.
debit.topBeneficiariesYesUp to 20 primary beneficiaries.
intendedUsesYesCategory: intendedUseOfAccount.
intendedUsesDescriptionConditionalRequired if Other.

Size of business

FieldRequiredNotes
totalEmployeesYesCategory: totalEmployees.
annualTurnoverYesCategory: annualTurnover. If < 1 year old, provide expected turnover.

Device details

FieldTypeRequiredNotes
ipCountryCodeenumYesCountry of origin of the IP; category: countryName.
deviceInfostringYesOS of the device initiating the request.
ipAddressstringYesValid IPv4 address.
sessionIdstringYesSession identifier for the request.

Tags

FieldTypeRequiredNotes
tagsobjectOptionalUp to 15 client-defined key/value pairs.
tags.keystringOptionalMax 128; keys must be unique.
tags.valuestringOptionalMax 255.

Examples

Individual Customer

Sample Request
{
"type": "individual",
"kycType": "full",
"region": "AU",
"externalId": "ext-123",
"firstName": "Jane1",
"middleName": "",
"lastName": "Smith1",
"applicantDeclaration": true,
"applicantDeclarationTimeStamp": "2024-01-31 11:30:00",
"email": "jane.smith3@example.com",
"nationality": "AU",
"dateOfBirth": "1990-05-15",
"mobile": "41234589",
"mobileCountryCode": "61",
"billingAddress": {
"addressLine1": "123 George Street",
"addressLine2": "Suite 4",
"city": "Sydney",
"state": "AU-NSW",
"postcode": "2000",
"streetType": "CH",
"country": "AU"
},
"expectedAccountUsage": {
"intendedUses": [
"IU104"
],
"intendedUsesDescription": "",
"credit": {
"monthlyTransactionVolume": "MVAU01",
"topTransactionCountries": [
"AU"
]
},
"debit": {
"monthlyTransactionVolume": "MVAU01",
"topTransactionCountries": [
"AU"
]
}
},
"bankAccountDetails": {
"accountName": "Jane Smith",
"bankName": "Commonwealth Bank of Australia",
"accountNumber": "12345678",
"bankCountry": "AU",
"currency": "AUD",
"bankAccountType": "saving",
"routingCodes": [
{
"type": "BSB CODE",
"value": "062000"
}
]
},
"deviceDetails": {
"ipCountryCode": "AU",
"deviceInfo": "Mac OS X 14.0",
"ipAddress": "203.0.113.10",
"sessionId": "sess-abc123-def456-ghi789"
},
"tags": [
{
"key": "source",
"value": "web_app"
}
]
}
Sample Successful Response
{
"wallets": [
{
"walletHashId": "c0ae32d9-8d28-482b-9f54-c8577b9741f4",
"walletType": "base"
}
],
"customerHashId": "c763fd2f-8476-4f8a-bb0f-fd6f0aa19d7f",
"referenceId": "cc8c06cb-f300-4cd3-8d90-6e47605744c5",
"status": "pending",
"subStatus": null,
"type": "individual",
"kycType": "full",
"region": "AU",
"externalId": "ext-123",
"tags": [
{
"key": "source",
"value": "web_app"
}
],
"segment": null,
"firstName": "Jane1",
"middleName": "",
"lastName": "Smith1",
"email": "jane.smith3@example.com",
"nationality": "AU",
"dateOfBirth": "1990-05-15",
"mobile": "41234589",
"mobileCountryCode": "61",
"kycStatus": "kyc_required",
"applicantDeclaration": true,
"applicantDeclarationTimeStamp": "2024-01-31 11:30:00",
"deviceDetails": {
"ipCountryCode": "AU",
"deviceInfo": "Mac OS X 14.0",
"ipAddress": "203.0.113.10",
"sessionId": "sess-abc123-def456-ghi789"
},
"expectedAccountUsage": {
"intendedUses": [
"IU104"
],
"intendedUsesDescription": "",
"credit": {
"monthlyTransactionVolume": "MVAU01",
"topTransactionCountries": [
"AU"
]
},
"debit": {
"monthlyTransactionVolume": "MVAU01",
"topTransactionCountries": [
"AU"
]
}
},
"bankAccountDetails": {
"accountName": "Jane Smith",
"accountNumber": "xxxxxxxx",
"bankAccountType": "saving",
"bankName": "Commonwealth Bank of Australia",
"bankCountry": "AU",
"currency": "AUD",
"bankCode": null,
"identificationType": null,
"identificationValue": null,
"localRegisteredName": null,
"routingCodes": [
{
"type": "BSB CODE",
"value": "xxxxxx"
}
]
},
"billingAddress": {
"addressLine1": "123 George Street",
"addressLine2": "Suite 4",
"city": "Sydney",
"postcode": "2000",
"country": "AU",
"state": "AU-NSW",
"streetType": "CH"
},
"kycMode": null,
"documents": null,
"redirectUrl": null
}

Corporate Customer

Sample Request
{
"type": "corporate",
"kycType": "full",
"region": "AU",
"externalId": "ext-1234",
"businessName": "AU_BusinessName_1",
"website": "https://monserrat.biz",
"businessDescription": "Technology solutions and consulting services provider",
"businessRegistrationNumber": "789564312",
"registeredDate": "2015-03-15",
"registeredCountry": "AU",
"isMultiLayeredCompany": false,
"businessType": "private_company",
"tradeName": "Greenholt - West Inc",
"bankAccountDetails": {
"accountName": "Champlin - Spinka Corporate Account",
"bankName": "Commonwealth Bank of Australia",
"accountNumber": "12345678",
"bankCountry": "AU",
"currency": "AUD",
"bankAccountType": "saving",
"routingCodes": [
{
"type": "BSB CODE",
"value": "062000"
}
]
},
"applicantDeclaration": true,
"applicantDeclarationTimeStamp": "2024-01-15 10:30:00",
"addresses": {
"isBusinessAddressSameAsRegisteredAddress": false,
"registeredAddress": {
"addressLine1": "1234 Corporate Blvd Suite 100",
"addressLine2": "Building A",
"city": "Wilmington",
"state": "AU-NT",
"postcode": "1980",
"country": "AU"
},
"businessAddress": {
"addressLine1": "5678 Business Park Drive",
"addressLine2": "Floor 5",
"city": "Newark",
"state": "AU-NT",
"postcode": "0710",
"country": "AU"
}
},
"applicant": {
"externalId": "95d4c75b-089b-4aad-a9ab-f3b2360aa171",
"firstName": "Tierra",
"middleName": "James",
"lastName": "White",
"dateOfBirth": "1985-06-20",
"nationality": "AU",
"trustBeneficiaryClass": "C",
"email": "test@nium.com",
"mobile": "197894",
"mobileCountryCode": "1",
"sharePercentage": 45,
"address": {
"addressLine1": "123 George Street",
"addressLine2": "Suite 4",
"city": "Sydney",
"state": "AU-NSW",
"postcode": "2000",
"country": "AU"
},
"documents": [
{
"type": "loa",
"fileIds": [
"a9f55262-77ea-44a0-a5b8-b01bca79cc84"
]
}
],
"positions": [
{
"title": "trust_beneficiary",
"startDate": "2015-03-15"
}
]
},
"stakeholders": {
"individual": [
{
"externalId": "2a902305-bf54-41df-bfaa-d80c94d16805",
"firstName": "Robert",
"middleName": "",
"lastName": "Volkman",
"dateOfBirth": "1980-11-10",
"nationality": "AU",
"email": "Rickie9@gmail.com",
"mobile": "197786",
"mobileCountryCode": "1",
"sharePercentage": 30,
"address": {
"addressLine1": "456 Investor Street",
"addressLine2": "Unit 8",
"city": "New York",
"state": "AU-WA",
"postcode": "10001",
"country": "AU"
},
"positions": [
{
"title": "ubo",
"startDate": "2016-01-20"
}
]
},
{
"externalId": "2a902305-bf54-41df-bfaa-d80c94d16802",
"firstName": "Michael",
"middleName": "",
"lastName": "Volkman",
"dateOfBirth": "1980-11-10",
"nationality": "US",
"email": "Rickie9@gmail.com",
"mobile": "197786",
"mobileCountryCode": "1",
"sharePercentage": 30,
"address": {
"addressLine1": "456 Investor Street",
"addressLine2": "Unit 8",
"city": "New York",
"state": "US-NY",
"postcode": "10001",
"country": "SG"
},
"positions": [
{
"title": "SHAREHOLDER",
"startDate": "2016-01-20"
}
]
}
],
"corporate": [
{
"externalId": "859ac163-08f0-4152-b26a-e96fce664372",
"businessName": "Investment Holdings LLC",
"businessRegistrationNumber": "123456789",
"registeredCountry": "US",
"sharePercentage": 25,
"positions": [
{
"title": "UBO"
}
]
}
]
},
"natureOfBusiness": {
"operatingCountries": [
"US",
"CA",
"GB"
],
"industryCodes": [
"IS134"
],
"industryDescription": "Comprehensive technology consulting and software development services specializing in enterprise solutions, cloud infrastructure, and digital transformation initiatives for Fortune 500 companies across North America and Europe"
},
"expectedAccountUsage": {
"intendedUses": [
"IU001"
],
"intendedUsesDescription": "Business operations including vendor payments, payroll processing, and international transactions",
"credit": {
"monthlyTransactionVolume": "MVAU01",
"monthlyTransactions": "ATC01",
"averageTransactionValue": "ATVAU01",
"topTransactionCountries": [
"US",
"CA",
"GB"
],
"topRemitters": [
"Enterprise Client A",
"Corporate Partner B"
]
},
"debit": {
"monthlyTransactionVolume": "MVAU01",
"monthlyTransactions": "ATC01",
"averageTransactionValue": "ATVAU01",
"topTransactionCountries": [
"US",
"CA",
"MX"
],
"topBeneficiaries": [
"Vendor Services Inc",
"Technology Suppliers Ltd"
]
}
},
"sizeOfBusiness": {
"totalEmployees": "EM006",
"annualTurnover": "AU008"
},
"deviceDetails": {
"ipCountryCode": "us",
"deviceInfo": "Mozilla/5.0 Windows",
"ipAddress": "192.168.1.100",
"sessionId": "15aaa7ad-7625-4047-a2ce-6fe4ac476728"
},
"tags": [
{
"key": "customer_type",
"value": "enterprise"
},
{
"key": "priority",
"value": "high"
}
],
"documents": [
{
"type": "business_registration_doc",
"fileIds": [
"3bb4595c-2d1b-47b3-a951-08175b9013c2"
]
}
]
}
Sample Successful Response
{
"wallets": [
{
"walletHashId": "ca60a683-62df-4068-a85a-ced831419ac9",
"walletType": "base"
}
],
"customerHashId": "09485f49-4bee-4f35-bb8a-0e9c94c1a972",
"referenceId": "fb3bf75a-e957-4af4-9e44-1a2ced66ee85",
"status": "pending",
"subStatus": null,
"type": "corporate",
"kycType": "full",
"region": "AU",
"externalId": "ext-1234",
"tags": [
{
"key": "customer_type",
"value": "enterprise"
},
{
"key": "priority",
"value": "high"
}
],
"segment": null,
"businessName": "AU_BusinessName_1",
"businessRegistrationNumber": "789564312",
"registeredDate": "2015-03-15",
"registeredCountry": "AU",
"website": "https://monserrat.biz",
"businessType": "private_company",
"applicantDeclaration": true,
"applicantDeclarationTimeStamp": "2024-01-15 10:30:00",
"formerName": null,
"tradeName": "Greenholt - West Inc",
"isMultiLayeredCompany": false,
"addresses": {
"registeredAddress": {
"addressLine1": "1234 Corporate Blvd Suite 100",
"addressLine2": "Building A",
"city": "Wilmington",
"postcode": "1980",
"country": "AU",
"state": "AU-NT",
"streetType": null
},
"isBusinessAddressSameAsRegisteredAddress": false,
"businessAddress": {
"addressLine1": "5678 Business Park Drive",
"addressLine2": "Floor 5",
"city": "Newark",
"postcode": "0710",
"country": "AU",
"state": "AU-NT",
"streetType": null
}
},
"natureOfBusiness": {
"operatingCountries": [
"US",
"CA",
"GB"
],
"industryCodes": [
"IS134"
],
"industryDescription": "Comprehensive technology consulting and software development services specializing in enterprise solutions, cloud infrastructure, and digital transformation initiatives for Fortune 500 companies across North America and Europe"
},
"expectedAccountUsage": {
"intendedUses": [
"IU001"
],
"intendedUsesDescription": "Business operations including vendor payments, payroll processing, and international transactions",
"credit": {
"averageTransactionValue": "ATVAU01",
"monthlyTransactionVolume": "MVAU01",
"monthlyTransactions": "ATC01",
"topTransactionCountries": [
"US",
"CA",
"GB"
]
},
"debit": {
"averageTransactionValue": "ATVAU01",
"monthlyTransactionVolume": "MVAU01",
"monthlyTransactions": "ATC01",
"topTransactionCountries": [
"US",
"CA",
"MX"
]
}
},
"sizeOfBusiness": {
"totalEmployees": "EM006",
"annualTurnover": "AU008"
},
"deviceDetails": {
"ipCountryCode": "us",
"deviceInfo": "Mozilla/5.0 Windows",
"ipAddress": "192.168.1.100",
"sessionId": "15aaa7ad-7625-4047-a2ce-6fe4ac476728"
},
"bankAccountDetails": {
"accountName": "Champlin - Spinka Corporate Account",
"accountNumber": "xxxxxxxx",
"bankAccountType": "saving",
"bankName": "Commonwealth Bank of Australia",
"bankCountry": "AU",
"currency": "AUD",
"bankCode": null,
"identificationType": null,
"identificationValue": null,
"localRegisteredName": null,
"routingCodes": [
{
"type": "BSB CODE",
"value": "xxxxxx"
}
]
},
"applicant": {
"externalId": "95d4c75b-089b-4aad-a9ab-f3b2360aa171",
"firstName": "Tierra",
"middleName": "James",
"lastName": "White",
"dateOfBirth": "1985-06-20",
"nationality": "AU",
"email": "test@nium.com",
"mobile": "197894",
"mobileCountryCode": "1",
"sharePercentage": "45",
"address": {
"addressLine1": "123 George Street",
"addressLine2": "Suite 4",
"city": "Sydney",
"postcode": "2000",
"country": "AU",
"state": "AU-NSW",
"streetType": null
},
"kycMode": null,
"birthCountry": null,
"taxDetails": null,
"trustBeneficiaryClass": "C",
"positions": [
{
"title": "trust_beneficiary"
}
],
"referenceId": "e90178c7-76f4-4fe5-8fc5-83fbd7096e11",
"kycStatus": "kyc_required",
"documents": [
{
"type": "loa",
"fileIds": [
"a9f55262-77ea-44a0-a5b8-b01bca79cc84"
],
"identificationNumber": null,
"issuanceCountry": null,
"expiryDate": null
}
],
"redirectUrl": null
},
"stakeholders": {
"individual": [
{
"externalId": "2a902305-bf54-41df-bfaa-d80c94d16805",
"firstName": "Robert",
"middleName": "",
"lastName": "Volkman",
"dateOfBirth": "1980-11-10",
"nationality": "AU",
"email": "Rickie9@gmail.com",
"mobile": "197786",
"mobileCountryCode": "1",
"sharePercentage": "30",
"address": {
"addressLine1": "456 Investor Street",
"addressLine2": "Unit 8",
"city": "New York",
"postcode": "10001",
"country": "AU",
"state": "AU-WA",
"streetType": null
},
"trustBeneficiaryClass": null,
"positions": [
{
"title": "ubo"
}
],
"documents": null,
"referenceId": "981752f4-fc3b-4fb2-805d-33c46fd0aa57",
"kycMode": null,
"kycStatus": "kyc_required",
"redirectUrl": null
},
{
"externalId": "2a902305-bf54-41df-bfaa-d80c94d16802",
"firstName": "Michael",
"middleName": "",
"lastName": "Volkman",
"dateOfBirth": "1980-11-10",
"nationality": "US",
"email": "Rickie9@gmail.com",
"mobile": "197786",
"mobileCountryCode": "1",
"sharePercentage": "30",
"address": {
"addressLine1": "456 Investor Street",
"addressLine2": "Unit 8",
"city": "New York",
"postcode": "10001",
"country": "SG",
"state": "US-NY",
"streetType": null
},
"trustBeneficiaryClass": null,
"positions": [
{
"title": "SHAREHOLDER"
}
],
"documents": null,
"referenceId": "8ad07371-dc95-4fe3-8b2d-32506280a2cb",
"kycMode": null,
"kycStatus": "kyc_not_required",
"redirectUrl": null
}
],
"corporate": [
{
"externalId": "859ac163-08f0-4152-b26a-e96fce664372",
"businessName": "Investment Holdings LLC",
"businessRegistrationNumber": "123456789",
"registeredCountry": "US",
"sharePercentage": "25",
"businessType": null,
"listedExchange": null,
"positions": [
{
"title": "UBO"
}
],
"referenceId": "b8341423-b8e6-46a8-ae4e-bdb852a85444",
"kycStatus": "kyc_not_required"
}
]
},
"documents": [
{
"type": "business_registration_doc",
"fileIds": [
"3bb4595c-2d1b-47b3-a951-08175b9013c2"
]
}
]
}

For response check Response Codes.