Required Parameters
POST /api/v5/client/{clientHashId}/customers
Path Params
| Param | Description |
|---|---|
| clientHashId - string (required) | Unique client identifier generated and shared before API handshake. |
Body Parameters
| Field | M - Mandatory, O - Optional | Description | Data Type | Accepted values |
|---|---|---|---|---|
| type (M) | M | Type of the customer | enum | individual, corporate |
| kycType (M) | M | The type of KYC that will be performed on this customer | enum | full |
| region (M) | M | Regulatory region under which the client is onboarded | enum | e.g. AU/SG |
| externalId (O) | O | Customer specified reference ID | string | Max 36 char. Alphanumeric. Unique for a customer under a client |
Details when kycType=individual
| Field | M/O | Description | Data Type | Accepted values |
|---|---|---|---|---|
| firstName (M) | M | First name of the customer | string | Max 40 char |
| middleName (O) | O | Middle name of the customer | string | Max 40 char |
| lastName (M) | M | Last name of the customer | string | Max 40 char |
| email (M) | M | Email of the customer | string | Max 60 char; valid email id |
| nationality (M) | M | Nationality of the customer | string | category: countryName |
| mobile (M) | M | Numeric mobile number without the country code | string | max 15 char |
| mobileCountryCode (M) | M | Numeric country code for mobile numbers | string | max 6 char |
| dateOfBirth (M) | M | DOB of the customer | date | YYYY-MM-DD. Atleast 18 yrs. Should be past date |
taxDetails (C)
| Field | Description | Data Type | Accepted values |
|---|---|---|---|
| taxCountry | 2-letter ISO Alpha-2 country code denoting residence | enum | Max 2 char; category: CountryName |
| taxNumber | Tax ID number. Send CNPJ for Brazilian Tax Number | string | Max 64 |
billingAddress (M)
| Field | Description | Data Type | Accepted values |
|---|---|---|---|
| addressLine1 (M) | Address line 1 | string | Max 100 char |
| addressLine2 (O) | Address line 2 | string | Max 100 char |
| city (M) | City | string | Max 50 char |
| state (M) | State | string/enum | Max 50 char |
| postcode (M) | Post Code | string | Max 10 char, Alphanumeric & spaces |
| country (M) | Country | enum | category: countryName |
expectedAccountUsage (M)
credit (M)
| Field | Description | Data Type | Accepted values |
|---|---|---|---|
| monthlyTransactionVolume | Monthly transaction volume range in AUD | enum | category: monthlyTransactionVolume |
| topTransactionCountries | List of top 5 countries | enum | category: monthlyTransactionVolume |
debit (M)
| Field | Description | Data Type | Accepted values |
|---|---|---|---|
| monthlyTransactionVolume | Monthly transaction volume range in AUD | enum | category: monthlyTransactionVolume |
| debittopTransactionCountries | List of top 5 countries | enum | category: monthlyTransactionVolume |
| Field | Description | Data Type | Accepted values |
|---|---|---|---|
| intendedUses (M) | List of intended uses | array of enums | category: intendedUseOfAccount |
| intendedUsesDescription (C) | Description if “Others” selected | string | Max 500 char |
bankAccountDetails (M)
| Field | Description | Data Type | Accepted values |
|---|---|---|---|
| accountName (M) | Name exactly as registered | string | Max 140 char |
| accountNumber (M) | Bank account number | string | Max 35 char |
| bankCountry (M) | ISO 3166-1 alpha-2 | string | |
| bankAccountType (C) | Type of bank account | string | Call Bene schema API |
| bankName (C) | Full legal bank name | string | Max 255 char |
| currency (M) | ISO 4217 currency | string | |
| routingCodes.type (M) | Type of routing identifier | string | "SWIFT" |
| routingCodes.value (M) | Routing code value | string |
deviceDetails (M)
| Field | Description | Data Type | Accepted values |
|---|---|---|---|
| ipCountryCode (M) | Country of origin of IP | enum | category: countryName |
| deviceInfo (M) | OS of device | string | |
| ipAddress (M) | IP address | string | valid IP4 address |
| sessionId (M) | Session ID | string |
applicantDeclaration
| Field | Description | Data Type | Accepted values |
|---|---|---|---|
| applicantDeclaration (M) | Declaration confirmation | boolean | true |
| applicantDeclarationTimeStamp (M) | Timestamp | date |
Details required when type=corporate
| Field | Description | Data Type | Accepted values |
|---|---|---|---|
| businessType (M) | Business type | enum | category: businessType |
| businessName (M) | Business name | string | Max 80 char |
| businessRegistrationNumber (M) | Registration number | string | Max 30 char |
| registeredDate (M) | Date of registration | date | YYYY-MM-DD |
| registeredCountry (M) | Country of registration | enum | category: countryName |
| website (O) | Website | string | Max 255 char |
| isMultiLayeredCompany (M) | Multi-layer ownership exists | boolean |
Sample Request – Individual Customer
{
"type": "individual",
"kycType": "full",
"region": "SG",
"externalId": "C2ZfvtLAek9FKMmSHY",
"firstName": "Sharma",
"middleName": "",
"lastName": "Test",
"email": "pasumarthi.sashank+480@nium.com",
"nationality": "FR",
"dateOfBirth": "2000-08-01",
"mobile": "2000000467",
"mobileCountryCode": "31",
"website": "www.test4.com",
"tags": [
{
"key": "testing",
"value": "Automation"
},
{
"key": "key1",
"value": "value1"
}
],
"deviceDetails": {
"ipCountryCode": "sg",
"deviceInfo": "MAC",
"ipAddress": "192.168.1.16",
"sessionId": "hello-world"
},
"expectedAccountUsage": {
"intendedUsesDescription": "",
"credit": {
"monthlyTransactionVolume": "MVSG01",
"topTransactionCountries": [
"SG"
]
},
"intendedUses": [
"IU104"
],
"debit": {
"monthlyTransactionVolume": "MVSG01",
"topTransactionCountries": [
"SG"
]
}
},
"bankAccountDetails": {
"accountName": "Shane Sahrma",
"bankName": "Bank of Australia Limited",
"accountNumber": "77802",
"bankCountry": "AU",
"currency": "AUD",
"bankAccountType": "saving",
"routingCodes": [
{
"type": "BSB CODE",
"value": "BOSHHKHH"
}
]
},
"billingAddress": {
"addressLine1": "Test Add 123, Building 1, Block 2, Area 3",
"streetType" : "street type",
"addressLine2": "Test Add 123, Building 1, Block 2, Area 3",
"city": "Lorem ipsum dolor sit amet, consectetuer.",
"state": "ddfd",
"postcode": "SW1W",
"country": "SG"
}
}
Sample Request – Corporate Customer
{
"type": "corporate",
"kycType": "full",
"region": "SG",
"businessName": "ABC corporation",
"businessRegistrationNumber": "ABC26_127",
"registeredDate": "2024-05-21",
"registeredCountry": "SG",
"website": "www.idfc348.com",
"isMultiLayeredCompany": false,
"listedExchange":" Listed Exchange value"
"businessType": "public_company",
"bankAccountDetails": {
"accountName": "Name",
"bankName": "Bank of Australia Limited",
"accountNumber": "GB29NWBK6016133926820",
"currency": "AUD",
"bankAccountType": "saving",
"bankCountry": "AU",
"routingCodes": [
{
"type": "BSB CODE",
"value": "DBSSSGSG"
}
]
},
}
],
"applicantDeclaration": true,
"applicantDeclarationTimeStamp": "2025-08-20 15:49:30",
"addresses": {
"isBusinessAddressSameAsRegisteredAddress": false,
"registeredAddress": {
"addressLine1": "addressLine1",
"addressLine2": "addressLine2",
"city": "city",
"state": "FR-20R",
"postcode": "4857832",
"country": "FR"
},
"businessAddress": {
"addressLine1": "busaddressLine1",
"addressLine2": "addressLine2",
"city": "city",
"state": "FR-20R",
"postcode": "387593",
"country": "FR"
}
},
"applicant": {
"firstName": "applicantFirst",
"middleName": "applicantMiddle",
"lastName": "applicantLast",
"dateOfBirth": "1990-04-21",
"nationality": "SG",
"email": "pasumarthi.shank@trin.com",
"mobile": "7337223608",
"mobileCountryCode": "65",
"sharePercentage": 98,
"address": {
"addressLine1": "applicantLine1",
"addressLine2": "applicantLine2",
"city": "applicantCity",
"state": "FR-20R",
"postcode": "478547",
"country": "FR"
},
"documents": [
{
"type": "power_of_attorney",
"fileIds": [
"087244f3-b4f9-4c54-92df-b472123a6166"
]
}
],
"positions": [
{
"title": "ubo",
"startDate": "2025-04-21"
}
]
},
"stakeholders": {
"individual": [
{
"externalId": "10ab1818-ef2d-44ee-96c0-7d367842d861",
"firstName": "stake1",
"middleName": "stake1Mid",
"lastName": "stake1Last",
"dateOfBirth": "1990-04-21",
"nationality": "LT",
"email": "pasumarthi.sashank@nium.com",
"mobile": "8106869840",
"mobileCountryCode": "65",
"sharePercentage": 80,
"address": {
"addressLine1": "indiviAdd1",
"addressLine2": "indiviAdd2",
"city": "indiviCity",
"state": "FR-20R",
"postcode": "63535",
"country": "FR"
},
"positions": [
{
"title": "DIRECTOR",
"startDate": "2025-04-21"
}
]
},
{
"externalId": "10ab1818-ef2d-44ee-96c0-7d367842d864",
"firstName": "stake2",
"middleName": "stake2Middle1",
"lastName": "stake2Last1",
"dateOfBirth": "2000-04-21",
"nationality": "AU",
"email": "pasumarthi.sashank@nium.com",
"mobile": "8106869830",
"mobileCountryCode": "65",
"sharePercentage": 80,
"address": {
"addressLine1": "indiviAdd1",
"addressLine2": "indiviAdd2",
"city": "indiviCity",
"state": "FR-20R",
"postcode": "63535",
"country": "FR"
},
"positions": [
{
"title": "SETTLOR",
"startDate": "2025-04-21"
}
]
}
],
"corporate": [
{
"externalId": "90ab1818-ef2d-44ee-96c0-7d367842d869",
"businessName": "ABC Pvt Ltd",
"businessRegistrationNumber": "BRN123456",
"listedExchange": " Listed Exchange category"
"registeredCountry": "SG",
"positions": [
{
"title": "UBO"
}
]
}
]
},
"natureOfBusiness": {
"operatingCountries": [
"SG"
],
"industryCodes": [
"IS134"
],
"industryDescription": "industryDescription_864de5f58049"
},
"expectedAccountUsage": {
"intendedUses": [
"IU001"
],
"intendedUsesDescription": "intendedUsesDescription_78d7fdff1d03",
"credit": {
"monthlyTransactionVolume": "MVSG01",
"monthlyTransactions": "ATC01",
"averageTransactionValue": "ATVSG01",
"topTransactionCountries": [
"SG"
],
},
"debit": {
"monthlyTransactionVolume": "MVSG01",
"monthlyTransactions": "ATC01",
"averageTransactionValue": "ATVSG01",
"topTransactionCountries": [
"SG"
],
}
},
"sizeOfBusiness": {
"totalEmployees": "EM006",
"annualTurnover": "EU012"
},
"deviceDetails": {
"ipCountryCode": "sg",
"deviceInfo": "MAC",
"ipAddress": "192.168.1.1",
"sessionId": "40531ac01a6f11edafc28dba55d51275"
},
"tags": [
{
"key": "key_67cef24340df",
"value": "value_56606dcf8aa4"
}
],
"tradeName": "tradeName_f57f429a7dfb",
"documents": [
{
"type": "business_registration_doc",
"fileIds": [
"787244f3-b4f9-4c54-02af-b472123a6067"
]
}
]
}
Responses
Success Response: 200 - OK
Individual Customer – Sample Response
{
"wallets": [
{
"walletHashId": "a2f984d9-c978-4ec7-9dff-7281644efd65",
"walletType": "base"
}
],
"customerHashId": "bec92c44-de95-4f09-8b54-3004548b6643",
"status": "pending",
"subStatus": null,
"type": "individual",
"kycType": "full",
"region": "SG",
"externalId": "C2ZfvtLAek9FKMmSHY",
"tags": [
{
"key": "testing",
"value": "Automation"
},
{
"key": "key1",
"value": "value1"
}
],
"segment": null,
"firstName": "Sharma",
"middleName": "",
"lastName": "Test",
"email": "pasumarthi.sashank+480@nium.com",
"nationality": "FR",
"dateOfBirth": "2000-08-01",
"mobile": "2000000467",
"mobileCountryCode": "31",
"deviceDetails": {
"ipCountryCode": "sg",
"deviceInfo": "MAC",
"ipAddress": "192.168.1.16",
"sessionId": "hello-world"
},
"expectedAccountUsage": {
"intendedUses": [
"IU104"
],
"intendedUsesDescription": "",
"credit": {
"averageTransactionValue": "",
"monthlyTransactionVolume": "MVSG01",
"topTransactionCountries": [
"GB"
]
},
"debit": {
"averageTransactionValue": "ATVSG01",
"monthlyTransactionVolume": "MVSG01",
"topTransactionCountries": [
"GB"
]
}
},
"bankAccountDetails": {
"accountName": "Shane Sahrma",
"accountNumber": "xxxxx",
"bankAccountType": "saving",
"bankName": "Bank of Australia Limited",
"bankCountry": "AU",
"currency": "AUD",
"routingCodes": [
{
"type": "BSB CODE",
"value": "xxxxxxxx"
}
]
},
"billingAddress": {
"addressLine1": "Test Add 123, Building 1, Block 2, Area 3",
"addressLine2": "Test Add 123, Building 1, Block 2, Area 3",
"city": "Lorem ipsum dolor sit amet, consectetuer.",
"postcode": "SW1W",
"country": "AU",
"state": "ddfd"
},
"kycMode": null,
"documents": null
}
Corporate Customer – Sample Response
{
"wallets": [
{
"walletHashId": "d2b709b2-be2b-46ac-aade-3132da8d534e",
"walletType": "base"
}
],
"customerHashId": "14235ce5-a979-4d22-9692-2bdaf486f2d1",
"status": "pending",
"subStatus": null,
"type": "corporate",
"kycType": "full",
"region": "SG",
"externalId": null,
"tags": [
{
"key": "key_67cef24340df",
"value": "value_56606dcf8aa4"
}
],
"segment": null,
"businessName": "ABC Pvt Ltd",
"businessRegistrationNumber": "ABC26_127",
"registeredDate": "2024-05-21",
"registeredCountry": "SG",
"website": "www.idfc348.com",
"businessType": "public_company",
"applicantDeclaration": true,
"applicantDeclarationTimeStamp": "2025-08-20 15:49:30",
"tradeName": "tradeName_f57f429a7dfb",
"isMultiLayeredCompany": false,
"addresses": {
"registeredAddress": {
"addressLine1": "addressLine1",
"addressLine2": "addressLine2",
"city": "city",
"postcode": "4857832",
"country": "FR",
"state": "FR-20R"
},
"isBusinessAddressSameAsRegisteredAddress": false,
"businessAddress": {
"addressLine1": "busaddressLine1",
"addressLine2": "addressLine2",
"city": "city",
"postcode": "387593",
"country": "FR",
"state": "FR-20R"
}
},
"natureOfBusiness": {
"operatingCountries": [
"SG"
],
"industryCodes": [
"IS134"
],
"industryDescription": "industryDescription_864de5f58049"
},
"expectedAccountUsage": {
"intendedUses": [
"IU001"
],
"intendedUsesDescription": "intendedUsesDescription_78d7fdff1d03",
"credit": {
"averageTransactionValue": "ATVSG01",
"monthlyTransactionVolume": "MVSG01",
"monthlyTransactions": "ATC01",
"topTransactionCountries": [
"SG"
],
"topRemitters": [
"TEST"
]
},
"debit": {
"averageTransactionValue": "ATVSG01",
"monthlyTransactionVolume": "MVSG01",
"monthlyTransactions": "ATC01",
"topTransactionCountries": [
"SG"
],
"topBeneficiaries": [
"topBeneficiaries_7aaf5e207bab"
]
}
},
"sizeOfBusiness": {
"totalEmployees": "EM006",
"annualTurnover": "EU012"
},
"deviceDetails": {
"ipCountryCode": "sg",
"deviceInfo": "MAC",
"ipAddress": "192.168.1.1",
"sessionId": "40531ac01a6f11edafc28dba55d51275"
},
"bankAccountDetails": {
"accountName": "Name",
"accountNumber": "xxxxxxxxxxxxxxxxxxxxx",
"bankAccountType": "saving",
"bankName": "Bank of Australia Limited",
"bankCountry": "AU",
"currency": "AUD",
"routingCodes": [
{
"type": "BSB Code",
"value": "xxxxxxxx"
}
]
},
"applicant": {
"externalId": null,
"firstName": "applicantFirst",
"middleName": "applicantMiddle",
"lastName": "applicantLast",
"dateOfBirth": "1990-04-21",
"nationality": "SG",
"email": "pasumarthi.sashank@nium.com",
"mobile": "7337223608",
"mobileCountryCode": "65",
"sharePercentage": 98,
"address": {
"addressLine1": "applicantLine1",
"addressLine2": "applicantLine2",
"city": "applicantCity",
"postcode": "478547",
"country": "FR",
"state": "FR-20R"
},
"positions": [
{
"title": "ubo",
"startDate": "2025-04-21"
}
],
"documents": [
{
"type": "power_of_attorney",
"fileIds": [
"087244f3-b4f9-4c54-92df-b472123a6166"
],
"identificationNumber": null,
"issuanceCountry": null,
"expiryDate": null
}
],
"referenceId": "b4b42891-29c3-4cbb-a6eb-236e2a491598"
},
"stakeholders": {
"individual": [
{
"externalId": "10ab1818-ef2d-44ee-96c0-7d367842d861",
"firstName": "stake1",
"middleName": "stake1Mid",
"lastName": "stake1Last",
"dateOfBirth": "1990-04-21",
"nationality": "LT",
"email": "pasumarthi.sashank@nium.com",
"mobile": "8106869840",
"mobileCountryCode": "65",
"sharePercentage": 80,
"address": {
"addressLine1": "indiviAdd1",
"addressLine2": "indiviAdd2",
"city": "indiviCity",
"postcode": "63535",
"country": "FR",
"state": "FR-20R"
},
"positions": [
{
"title": "DIRECTOR",
"startDate": "2025-04-21"
}
],
"kycMode": null,
"documents": null,
"referenceId": "8d8a36d9-0909-43e9-88a4-7907454afccc"
}
],
"corporate": [
{
"externalId": "90ab1818-ef2d-44ee-96c0-7d367842d869",
"businessName": "ABC Pvt Ltd",
"businessRegistrationNumber": "BRN123456",
"registeredCountry": "SG",
"sharePercentage": null,
"positions": [
{
"title": "UBO",
"startDate": null
}
],
"referenceId": "5d866918-06d6-44fb-bf34-0041ecfb6f3b"
},
]
},
"documents": [
{
"type": "business_registration_doc",
"fileIds": [
"787244f3-b4f9-4c54-02af-b472123a6067"
]
}
]
}