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.

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 integration is set up.

Body parameters

Field (M/O/C)	Description	Data type	Accepted values
`type` (M)	Customer type.	enum	`individual`, `corporate`
`kycType` (M)	KYC type performed for this customer.	enum	`minimum`, `full`
`region` (M)	Regulatory region the customer is onboarded under.	enum	Use `US`
`externalId` (O)	Customer-provided reference ID.	string	Max 36 chars; alphanumeric; unique per customer under a client.

Individual Customers

billingAddress

Field (M/O/C)	Description	Data type	Accepted values
`billingAddress` (M)	Customer billing address.	object	—
`billingAddress.addressLine1` (M)	Address line 1.	string	Max 100 chars
`billingAddress.addressLine2` (O)	Address line 2.	string	Max 100 chars
`billingAddress.city` (M)	City.	string	Max 50 chars
`billingAddress.state` (M)	State/region.	string/enum	enum: `icategory=isoState` for `countryCode=xx` (e.g., `US`, `SG`). If enum list is empty, pass as string (max 50 chars).
`billingAddress.postcode` (M)	Postal/ZIP code.	string	Max 10 chars; alphanumeric and spaces
`billingAddress.country` (M)	Country.	enum	category: `countryName`

expectedAccountUsage

Field (M/O/C)	Description	Data type	Accepted values
`expectedAccountUsage` (M)	Account usage activity profile.	object	—
`expectedAccountUsage.credit` (M)	Expected account usage for payins.	object	—
`expectedAccountUsage.credit.monthlyTransactionVolume` (M)	Monthly transaction volume range.	enum	category: `monthlyTransactionVolume`
`expectedAccountUsage.credit.topTransactionCountries` (M)	Top 5 countries where funding is expected to originate.	array of enums	category: `countryName`
`expectedAccountUsage.debit` (M)	Expected account usage for payouts.	object	—
`expectedAccountUsage.debit.monthlyTransactionVolume` (M)	Monthly transaction volume range.	enum	category: `monthlyTransactionVolume`
`expectedAccountUsage.debit.topTransactionCountries` (M)	Top 5 countries for payouts.	array of enums	category: `countryName`
`expectedAccountUsage.intendedUses` (M)	Intended uses of the account.	array of enums	category: `intendedUseOfAccount`
`expectedAccountUsage.intendedUsesDescription` (C)	Required if `intendedUses` includes `Others`.	string	Max 500–1000 chars (varies by flow)

bankAccountDetails

Field (M/O/C)	Description	Data type	Accepted values
`bankAccountDetails` (M)	Bank account details used to return funds (returns/refunds).	object	—
`bankAccountDetails.accountName` (M)	Account holder name as registered with the bank.	string	Alphanumeric plus: `& . , ( ) _ ' / -`; max 140 chars
`bankAccountDetails.accountNumber` (M)	Bank account number for returns/refunds.	string	Alphanumeric; max 35 chars
`bankAccountDetails.bankCountry` (M)	Country where the bank account is held (ISO 3166-1 alpha-2).	string	category: `countryName`
`bankAccountDetails.bankAccountType` (C)	Bank account type (e.g., `savings`, `checking`, `current`).	string	Use the Bene schema endpoint to fetch exact requirements.
`bankAccountDetails.bankName` (C)	Full legal bank name.	string	Max 255 chars
`bankAccountDetails.currency` (M)	Bank account currency (ISO 4217).	string	Example: `USD`, `INR`
`bankAccountDetails.routingCodes.type` (M)	Routing identifier type.	string	`ACH CODE`, `SWIFT`
`bankAccountDetails.routingCodes.value` (M)	Routing identifier value for the specified type.	string	—

deviceDetails

Field (M/O/C)	Description	Data type	Accepted values
`deviceDetails` (M)	Device/session details (security/risk).	object	—
`deviceDetails.ipCountryCode` (M)	Country of origin for the IP address.	enum	category: `countryName`
`deviceDetails.deviceInfo` (M)	Device operating system information.	string	—
`deviceDetails.ipAddress` (M)	Device IP address.	string	Valid IPv4 address
`deviceDetails.sessionId` (M)	Session ID that initiated the request.	string	—

declarations

Field (M/O/C)	Description	Data type	Accepted values
`applicantDeclaration` (M)	Applicant confirmation they accept the declaration.	boolean	Must be `true`
`applicantDeclarationTimeStamp` (M)	Timestamp when the declaration was accepted.	date	—

Field (M/O/C)	Description	Data type	Accepted values
`tags` (O)	User-defined metadata.	object	—
`tags.key` (O)	User-defined key.	string	Example: `merchantID`
`tags.value` (O)	User-defined value.	string	Example: `MID123`

Corporate Customers

corporateCustomerFields

Field (M/O/C)	Description	Data type	Accepted values
`businessType` (M)	Business type for the corporate customer.	enum	category: `businessType`
`businessName` (M)	Legal business name.	string	Max 80 chars
`tradeName` (M)	Doing-business-as name (if different from legal name).	string	Max 80 chars
`businessRegistrationNumber` (M)	Business registration number (EIN). Sole traders may submit TIN/SSN if EIN is unavailable.	string	9 digits
`registeredDate` (M)	Business registration date.	date	`YYYY-MM-DD`; must be a past date
`registeredCountry` (M)	Country of registration.	enum	category: `countryName`
`website` (C)	Business website. If unavailable, provide a proof-of-business document.	string	Max 255 chars
`isMultiLayeredCompany` (M)	Whether the business has multi-layer ownership (via intermediaries).	boolean	—
`listedExchange` (C)	Required for public companies.	enum	—
`stockSymbol` (C)	Public ticker symbol (public companies).	string	—
`trustType` (C)	Unregulated trust type (trust companies).	string	—

registeredAddress

Field (M/O/C)	Description	Data type	Accepted values
`registeredAddress` (M)	Registered address for the corporate customer.	object	—
`registeredAddress.addressLine1` (M)	Address line 1.	string	Max 100 chars
`registeredAddress.addressLine2` (O)	Address line 2.	string	Max 100 chars
`registeredAddress.city` (M)	City.	string	Max 50 chars
`registeredAddress.state` (M)	State/region.	string/enum	enum: `icategory=isoState` for `countryCode=xx` (e.g., `US`, `SG`). If enum list is empty, pass as string (max 50 chars).
`registeredAddress.postcode` (M)	Postal/ZIP code.	string	Max 10 chars; alphanumeric and spaces
`registeredAddress.country` (M)	Country.	enum	category: `countryName`

businessAddress

Field (M/O/C)	Description	Data type	Accepted values
`businessAddress` (M)	Communication/business address.	object	—
`businessAddress.addressLine1` (M)	Address line 1.	string	Max 100 chars
`businessAddress.addressLine2` (O)	Address line 2.	string	Max 100 chars
`businessAddress.city` (M)	City.	string	Max 50 chars
`businessAddress.state` (M)	State/region.	string/enum	enum: `icategory=isoState` for `countryCode=xx` (e.g., `US`, `SG`). If enum list is empty, pass as string (max 50 chars).
`businessAddress.postcode` (M)	Postal/ZIP code.	string	Max 10 chars; alphanumeric and spaces
`businessAddress.country` (M)	Country.	enum	category: `countryName`

natureOfBusiness

Field (M/O/C)	Description	Data type	Accepted values
`natureOfBusiness` (M)	Business profile for the corporate customer.	object	—
`natureOfBusiness.operatingCountries` (M)	Countries where the business operates.	array of enums	category: `countryOfOperation`
`natureOfBusiness.industryCodes` (M)	Industry sectors the business operates in (multiple allowed).	array of enums	category: `industrySector`
`natureOfBusiness.industryDescription` (M)	Description of the business.	string	Max 1000 chars

sizeOfBusiness

Field (M/O/C)	Description	Data type	Accepted values
`sizeOfBusiness` (M)	Business size profile.	object	—
`sizeOfBusiness.totalEmployees` (M)	Total number of employees.	enum	—
`sizeOfBusiness.annualTurnover` (M)	Annual revenue/turnover range.	enum	category: `annualTurnover`

applicant

Field (M/O/C)	Description	Data type	Accepted values
`applicant` (M)	Individual submitting the application on behalf of the customer.	object	—
`applicant.externalId` (O)	Applicant reference identifier.	string	Max 36 chars; alphanumeric; unique across applicant + stakeholders
`applicant.firstName` (M)	Applicant first name.	string	Max 40 chars
`applicant.middleName` (O)	Applicant middle name.	string	Max 40 chars
`applicant.lastName` (M)	Applicant last name.	string	Max 40 chars
`applicant.dateOfBirth` (M)	Applicant date of birth.	date/string	`YYYY-MM-DD`; must be a past date
`applicant.nationality` (M)	Applicant nationality.	enum	category: `countryName`
`applicant.email` (M)	Applicant email.	string	Max 60 chars; valid email
`applicant.mobile` (M)	Mobile number (without country code).	string	Max 15 chars
`applicant.mobileCountryCode` (M)	Mobile country calling code.	string	Max 6 chars
`applicant.sharePercentage` (O)	Applicant ownership share percentage.	numeric	0–100 (decimal). Required if applicant is UBO/shareholder.

address

Field (M/O/C)	Description	Data type	Accepted values
`address` (M)	Residential address (used for applicant and individual stakeholders).	object	—
`address.addressLine1` (M)	Address line 1.	string	Max 100 chars
`address.addressLine2` (O)	Address line 2.	string	Max 50–100 chars (varies by flow)
`address.city` (M)	City.	string	Max 50 chars
`address.state` (M)	State/region.	string/enum	enum: `icategory=isoState` for `countryCode=xx` (e.g., `US`, `SG`). If enum list is empty, pass as string (max 50 chars).
`address.country` (M)	Country.	enum	category: `countryName`
`address.postcode` (M)	Postal/ZIP code.	string	Max 10 chars; alphanumeric and spaces

positions

Field (M/O/C)	Description	Data type	Accepted values
`positions` (M)	Positions held (multiple allowed).	array of objects	—
`positions.title` (M)	Position title (e.g., authorised representative, director, UBO).	enum	category: `positions` / `position`

documents

Field (M/O/C)	Description	Data type	Accepted values
`documents` (C)	Documents for the customer or applicant.	array of objects	Examples: `PROOF_OF_BUSINESS`, `OWNERSHIP_CHART` (varies by flow)
`documents.type` (C)	Document type.	enum	category: `documentType`
`documents.fields` (C)	File IDs returned by the Upload Document endpoint.	—	—

stakeholders

Field (M/O/C)	Description	Data type	Accepted values
`stakeholders` (O)	Stakeholders who hold positions in the corporate customer (as shown in official records).	object	At least one control prong must exist between applicant and individual stakeholder.
`stakeholders.individual` (O)	Individual stakeholders (natural persons).	array of objects	—
`stakeholders.corporate` (O)	Corporate stakeholders (organizations).	array of objects	—

stakeholders.individual

Field (M/O/C)	Description	Data type	Accepted values
`externalId` (O)	Reference identifier used to identify the stakeholder. Must be unique across stakeholders and applicant.	string	Max 36 chars; alphanumeric
`firstName` (M)	Stakeholder first name.	string	Max 40 chars
`middleName` (O)	Stakeholder middle name.	string	Max 40 chars
`lastName` (M)	Stakeholder last name.	string	Max 40 chars
`dateOfBirth` (M)	Stakeholder date of birth.	date	`YYYY-MM-DD`; must be a past date
`nationality` (M)	Stakeholder nationality.	enum	category: `countryName`
`email` (O)	Stakeholder email address.	string	Max 60 chars; valid email
`mobile` (O)	Stakeholder mobile number (without country code).	string	Max 15 chars
`mobileCountryCode` (O)	Stakeholder mobile country calling code.	string	Max 6 chars
`sharePercentage` (O)	Ownership percentage held by the stakeholder.	numeric	0–100 (decimal). Required if stakeholder holds a UBO or shareholder position.
`address` (M)	Residential address of the stakeholder.	object	—
`positions` (M)	Positions held by the stakeholder.	array of objects	—

stakeholders.corporate

Field (M/O/C)	Description	Data type	Accepted values
`externalId` (O)	Reference identifier used to identify the stakeholder.	string	Max 36 chars; alphanumeric
`businessName` (M)	Legal name of the corporate stakeholder.	string	Max 80 chars
`businessRegistrationNumber` (M)	Registration number of the corporate stakeholder.	string	Max 30 chars
`registeredCountry` (M)	Country of registration for the corporate stakeholder.	enum	category: `countryName`
`sharePercentage` (O)	Ownership percentage held by the stakeholder.	numeric	0–100 (decimal). Required if stakeholder also holds a UBO/shareholder position.
`positions` (M)	Positions held by the stakeholder in the corporate customer.	array of objects	—

bankAccountDetails

Field (M/O/C)	Description	Data type	Accepted values
`bankAccountDetails` (M)	Bank account details used to return funds (returns/refunds).	object	—
`bankAccountDetails.accountName` (M)	Account holder name as registered with the bank.	string	Alphanumeric plus: `& . , ( ) _ ' / -`; max 140 chars
`bankAccountDetails.accountNumber` (M)	Bank account number for returns/refunds.	string	Alphanumeric; max 35 chars
`bankAccountDetails.bankCountry` (M)	Country where the bank account is held (ISO 3166-1 alpha-2).	string	category: `countryName`
`bankAccountDetails.bankAccountType` (C)	Bank account type (e.g., `savings`, `checking`, `current`).	string	Use the Bene schema endpoint to fetch exact requirements.
`bankAccountDetails.bankName` (C)	Full legal bank name.	string	Max 255 chars
`bankAccountDetails.currency` (M)	Bank account currency (ISO 4217).	string	Example: `USD`, `INR`
`bankAccountDetails.routingCodes.type` (M)	Routing identifier type.	string	`ACH CODE`, `SWIFT`
`bankAccountDetails.routingCodes.value` (M)	Routing identifier value for the specified type.	string	—

deviceDetails

Field (M/O/C)	Description	Data type	Accepted values
`deviceDetails` (M)	Device/session details (security/risk).	object	—
`deviceDetails.ipCountryCode` (M)	Country of origin for the IP address.	enum	category: `countryName`
`deviceDetails.deviceInfo` (M)	Device operating system information.	string	—
`deviceDetails.ipAddress` (M)	Device IP address.	string	Valid IPv4 address
`deviceDetails.sessionId` (M)	Session ID that initiated the request.	string	—

declarations

Field (M/O/C)	Description	Data type	Accepted values
`applicantDeclaration` (M)	Applicant confirmation they accept the declaration.	boolean	Must be `true`
`applicantDeclarationTimestamp` (M)	Timestamp when the declaration was accepted.	date	—

Field (M/O/C)	Description	Data type	Accepted values
`tags` (O)	User-defined metadata.	Array of objects	—
`tags.key` (O)	User-defined key.	string	Example: `merchantID`
`tags.value` (O)	User-defined value.	string	Example: `MID123`

Sample Request & Response

Individual Customer

Sample Request

{
  "type": "individual",
  "kycType": "full",
  "region": "US",
  "externalId": "ext-123456",
  "firstName": "Rahul",
  "middleName": "Kumar",
  "lastName": "Rajawat",
  "email": "support@nium.com",
  "nationality": "FR",
  "mobile": "123489767",
  "mobileCountryCode": "1",
  "dateOfBirth": "2000-08-01",
  "applicantDeclarationTimeStamp": "2025-08-20 15:49:30",
  "applicantDeclaration": "true",
  "tags": [
    {
      "key": "testing",
      "value": "Automation"
    }
  ],
  "deviceDetails": {
    "ipCountryCode": "us",
    "deviceInfo": "MAC",
    "ipAddress": "192.168.1.16",
    "sessionId": "hello-world"
  },
  "expectedAccountUsage": {
    "intendedUsesDescription": "Business Description or the purpose of account",
    "credit": {
      "monthlyTransactionVolume": "MVUS01",
      "topTransactionCountries": [
        "GB",
        "GB",
        "GB",
        "IN"
      ]
    },
    "intendedUses": [
      "IU108",
      "IU107"
    ],
    "debit": {
      "monthlyTransactionVolume": "MVUS01",
      "topTransactionCountries": [
        "GB",
        "GB",
        "GB",
        "IN",
        "US"
      ]
    }
  },
  "bankAccountDetails": {
    "accountName": "Rahul Rajawat",
    "accountNumber": "AT483200000012345",
    "bankName": "DEUTSCHE BANK AG - POSTBANK BRANCH",
    "bankCountry": "US",
    "bankAccountType": "saving",
    "currency": "USD",
    "routingCodes": [
      {
        "type": "ACH CODE",
        "value": "042100175"
      }
    ]
  },
  "billingAddress": {
    "addressLine1": "AddressLine1 Building Floor",
    "addressLine2": "",
    "city": "California",
    "state": "US-AK",
    "postcode": "102034",
    "country": "US"
  }
}

Sample Successful Response

{
  "wallets": [
    {
      "walletHashId": "be8e8d76-0d1f-49c1-8ca2-1c37926aa428",
      "walletType": "base"
    }
  ],
  "customerHashId": "8ff562fa-2a6e-4e7a-821a-9544e587de42",
  "referenceId": "b99df203-87bf-4bd3-ae0b-0b750552c89a",
  "status": "pending",
  "subStatus": null,
  "type": "individual",
  "kycType": "full",
  "region": "US",
  "externalId": "ext-123456",
  "tags": [
    {
      "key": "testing",
      "value": "Automation"
    }
  ],
  "segment": null,
  "firstName": "Rahul",
  "middleName": "Kumar",
  "lastName": "Rajawat",
  "email": "support@nium.com",
  "nationality": "FR",
  "dateOfBirth": "2000-08-01",
  "mobile": "123489767",
  "mobileCountryCode": "1",
  "kycStatus": "kyc_required",
  "applicantDeclaration": true,
  "applicantDeclarationTimeStamp": "2025-08-20 15:49:30",
  "deviceDetails": {
    "ipCountryCode": "us",
    "deviceInfo": "MAC",
    "ipAddress": "192.168.1.16",
    "sessionId": "hello-world"
  },
  "expectedAccountUsage": {
    "intendedUses": [
      "IU108",
      "IU107"
    ],
    "intendedUsesDescription": "Business Description or the purpose of account",
    "credit": {
      "monthlyTransactionVolume": "MVUS01",
      "topTransactionCountries": [
        "GB",
        "GB",
        "GB",
        "IN"
      ]
    },
    "debit": {
      "monthlyTransactionVolume": "MVUS01",
      "topTransactionCountries": [
        "GB",
        "GB",
        "GB",
        "IN",
        "US"
      ],
      "bankAccountDetails": null
    }
  },
  "bankAccountDetails": {
    "accountName": "Rahul Rajawat",
    "accountNumber": "xxxxxxxxxxxxxxxxx",
    "bankAccountType": "saving",
    "bankName": "DEUTSCHE BANK AG - POSTBANK BRANCH",
    "bankCountry": "US",
    "currency": "USD",
    "bankCode": null,
    "identificationType": null,
    "identificationValue": null,
    "localRegisteredName": null,
    "routingCodes": [
      {
        "type": "ACH CODE",
        "value": "xxxxxxxxx"
      }
    ]
  },
  "billingAddress": {
    "addressLine1": "AddressLine1 Building Floor",
    "addressLine2": "",
    "city": "California",
    "postcode": "102034",
    "country": "US",
    "state": "US-AK"
  },
  "kycMode": null,
  "documents": null
}

Corporate Customer

Sample Request

{
  "type": "corporate",
  "kycType": "full",
  "region": "US",
  "businessName": "ABC corporation",
  "businessRegistrationNumber": "123456788",
  "registeredDate": "2024-05-21",
  "registeredCountry": "US",
  "website": "www.idfc348.com",
  "isMultiLayeredCompany": false,
  "listedExchange": "EX101",
  "stockSymbol": "NSE",
  "businessType": "public_company",
  "bankAccountDetails": {
    "accountName": "ABC corporation",
    "accountNumber": "AT483200000012345",
    "bankName": "DEUTSCHE BANK AG - POSTBANK BRANCH",
    "bankCountry": "US",
    "bankAccountType": "saving",
    "currency": "USD",
    "routingCodes": [
      {
        "type": "ACH CODE",
        "value": "042100175"
      }
    ]
  },
  "applicantDeclaration": true,
  "applicantDeclarationTimeStamp": "2025-08-20 15:49:30",
  "addresses": {
    "isBusinessAddressSameAsRegisteredAddress": false,
    "registeredAddress": {
      "addressLine1": "addressLine1",
      "addressLine2": "addressLine2",
      "city": "city",
      "state": "US-AL",
      "postcode": "35203",
      "country": "US"
    },
    "businessAddress": {
      "addressLine1": "busaddressLine1",
      "addressLine2": "addressLine2",
      "city": "city",
      "state": "US-AK",
      "postcode": "35203",
      "country": "US"
    }
  },
  "applicant": {
    "firstName": "applicantFirst",
    "middleName": "applicantMiddle",
    "lastName": "applicantLast",
    "dateOfBirth": "1990-04-21",
    "nationality": "US",
    "email": "test.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": "LOA",
        "fileIds": [
          "087244f3-b4f9-4c54-92df-b472123a6166"
        ]
      }
    ],
    "positions": [
      {
        "title": "control_prong",
        "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": "test@nium.com",
        "mobile": "8106869840",
        "mobileCountryCode": "65",
        "sharePercentage": 80,
        "address": {
          "addressLine1": "indiviAdd1",
          "addressLine2": "indiviAdd2",
          "city": "indiviCity",
          "state": "US-CA",
          "postcode": "63535",
          "country": "US"
        },
        "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": "test@nium.com",
        "mobile": "65656565656",
        "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",
        "registeredCountry": "SG",
        "positions": [
          {
            "title": "UBO"
          }
        ]
      }
    ]
  },
  "natureOfBusiness": {
    "operatingCountries": [
      "US"
    ],
    "industryCodes": [
      "IS134"
    ],
    "industryDescription": "<business Description>"
  },
  "expectedAccountUsage": {
    "intendedUses": [
      "IU001"
    ],
    "intendedUsesDescription": "intendedUsesDescription_78d7fdff1d03",
    "credit": {
      "monthlyTransactionVolume": "MVUS01",
      "monthlyTransactions": "ATC01",
      "averageTransactionValue": "ATVUS01",
      "topTransactionCountries": [
        "SG"
      ]
    },
    "debit": {
      "monthlyTransactionVolume": "MVUS01",
      "monthlyTransactions": "ATC01",
      "averageTransactionValue": "ATVUS01",
      "topTransactionCountries": [
        "SG"
      ]
    }
  },
  "sizeOfBusiness": {
    "totalEmployees": "EM006",
    "annualTurnover": "US008"
  },
  "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"
      ]
    }
  ]
}

Sample Successful Response

{
  "wallets": [
    {
      "walletHashId": "ec305b62-b529-4c23-aeff-ff0a76054cf9",
      "walletType": "base"
    }
  ],
  "customerHashId": "2691e5b0-db0d-4a21-a80f-eb3dd8dad4dd",
  "referenceId": "3cd0f914-9132-4055-8ad4-52c797358c71",
  "status": "pending",
  "subStatus": null,
  "type": "corporate",
  "kycType": "full",
  "region": "US",
  "externalId": null,
  "tags": [
    {
      "key": "key_67cef24340df",
      "value": "value_56606dcf8aa4"
    }
  ],
  "segment": null,
  "businessName": "ABC corporation",
  "businessRegistrationNumber": "123456788",
  "registeredDate": "2024-05-21",
  "registeredCountry": "US",
  "website": "www.idfc348.com",
  "businessType": "public_company",
  "applicantDeclaration": true,
  "applicantDeclarationTimeStamp": "2025-08-20 15:49:30",
  "stockSymbol": "NSE",
  "listedExchange": "EX101",
  "trustType": null,
  "tradeName": "tradeName_f57f429a7dfb",
  "isMultiLayeredCompany": false,
  "addresses": {
    "registeredAddress": {
      "addressLine1": "addressLine1",
      "addressLine2": "addressLine2",
      "city": "city",
      "postcode": "35203",
      "country": "US",
      "state": "US-AL"
    },
    "isBusinessAddressSameAsRegisteredAddress": false,
    "businessAddress": {
      "addressLine1": "busaddressLine1",
      "addressLine2": "addressLine2",
      "city": "city",
      "postcode": "35203",
      "country": "US",
      "state": "US-AK"
    }
  },
  "natureOfBusiness": {
    "operatingCountries": [
      "US"
    ],
    "industryCodes": [
      "IS134"
    ],
    "industryDescription": "<business Description>"
  },
  "expectedAccountUsage": {
    "intendedUses": [
      "IU001"
    ],
    "intendedUsesDescription": "intendedUsesDescription_78d7fdff1d03",
    "credit": {
      "averageTransactionValue": "ATVUS01",
      "monthlyTransactionVolume": "MVUS01",
      "monthlyTransactions": "ATC01",
      "topTransactionCountries": [
        "SG"
      ]
    },
    "debit": {
      "averageTransactionValue": "ATVUS01",
      "monthlyTransactionVolume": "MVUS01",
      "monthlyTransactions": "ATC01",
      "topTransactionCountries": [
        "SG"
      ]
    }
  },
  "sizeOfBusiness": {
    "totalEmployees": "EM006",
    "annualTurnover": "US008"
  },
  "deviceDetails": {
    "ipCountryCode": "sg",
    "deviceInfo": "MAC",
    "ipAddress": "192.168.1.1",
    "sessionId": "40531ac01a6f11edafc28dba55d51275"
  },
  "bankAccountDetails": {
    "accountName": "ABC corporation",
    "accountNumber": "xxxxxxxxxxxxxxxxx",
    "bankAccountType": "saving",
    "bankName": "DEUTSCHE BANK AG - POSTBANK BRANCH",
    "bankCountry": "US",
    "currency": "USD",
    "bankCode": null,
    "identificationType": null,
    "identificationValue": null,
    "localRegisteredName": null,
    "routingCodes": [
      {
        "type": "ACH CODE",
        "value": "xxxxxxxxx"
      }
    ]
  },
  "applicant": {
    "externalId": null,
    "firstName": "applicantFirst",
    "middleName": "applicantMiddle",
    "lastName": "applicantLast",
    "dateOfBirth": "1990-04-21",
    "nationality": "US",
    "email": "test.shank@trin.com",
    "mobile": "7337223608",
    "mobileCountryCode": "65",
    "sharePercentage": "98",
    "address": {
      "addressLine1": "applicantLine1",
      "addressLine2": "applicantLine2",
      "city": "applicantCity",
      "postcode": "478547",
      "country": "FR",
      "state": "FR-20R"
    },
    "positions": [
      {
        "title": "control_prong"
      }
    ],
    "referenceId": "8b721568-f99c-458f-b2df-5c82f2fbddcc",
    "kycMode": null,
    "kycStatus": "kyc_required",
    "documents": [
      {
        "type": "LOA",
        "fileIds": [
          "087244f3-b4f9-4c54-92df-b472123a6166"
        ],
        "identificationNumber": null,
        "issuanceCountry": null,
        "expiryDate": null
      }
    ]
  },
  "stakeholders": {
    "individual": [
      {
        "externalId": "10ab1818-ef2d-44ee-96c0-7d367842d861",
        "firstName": "stake1",
        "middleName": "stake1Mid",
        "lastName": "stake1Last",
        "dateOfBirth": "1990-04-21",
        "nationality": "LT",
        "email": "test@nium.com",
        "mobile": "8106869840",
        "mobileCountryCode": "65",
        "sharePercentage": "80",
        "address": {
          "addressLine1": "indiviAdd1",
          "addressLine2": "indiviAdd2",
          "city": "indiviCity",
          "postcode": "63535",
          "country": "US",
          "state": "US-CA"
        },
        "positions": [
          {
            "title": "director"
          }
        ],
        "documents": null,
        "referenceId": "44d5ca39-5f62-4611-855c-d5d7d51bc6d2",
        "kycMode": null,
        "kycStatus": "kyc_required"
      },
      {
        "externalId": "10ab1818-ef2d-44ee-96c0-7d367842d864",
        "firstName": "stake2",
        "middleName": "stake2Middle1",
        "lastName": "stake2Last1",
        "dateOfBirth": "2000-04-21",
        "nationality": "AU",
        "email": "test@nium.com",
        "mobile": "65656565656",
        "mobileCountryCode": "65",
        "sharePercentage": "80",
        "address": {
          "addressLine1": "indiviAdd1",
          "addressLine2": "indiviAdd2",
          "city": "indiviCity",
          "postcode": "63535",
          "country": "FR",
          "state": "FR-20R"
        },
        "positions": [
          {
            "title": "SETTLOR"
          }
        ],
        "documents": null,
        "referenceId": "ba767e05-e838-484e-9968-f5e039ff9b4e",
        "kycMode": null,
        "kycStatus": "kyc_required"
      }
    ],
    "corporate": [
      {
        "externalId": "90ab1818-ef2d-44ee-96c0-7d367842d869",
        "businessName": "ABC Pvt Ltd",
        "businessRegistrationNumber": "BRN123456",
        "registeredCountry": "SG",
        "sharePercentage": null,
        "positions": [
          {
            "title": "UBO"
          }
        ],
        "referenceId": "bcb7c9ad-957d-426c-93e5-12867cf66a51",
        "kycStatus": "kyc_not_required"
      }
    ]
  },
  "documents": [
    {
      "type": "business_registration_doc",
      "fileIds": [
        "787244f3-b4f9-4c54-02af-b472123a6067"
      ]
    }
  ]
}

For response check Response Codes. |

Endpoint URL​

Path parameters​

Body parameters​

Individual Customers​

billingAddress​

expectedAccountUsage​

bankAccountDetails​

deviceDetails​

declarations​

tags​

Corporate Customers​

corporateCustomerFields​

registeredAddress​

businessAddress​

natureOfBusiness​

sizeOfBusiness​

applicant​

address​

positions​

documents​

stakeholders​

stakeholders.individual​

stakeholders.corporate​

bankAccountDetails​

deviceDetails​

declarations​

tags​

Sample Request & Response​

Individual Customer​

Corporate Customer​

Endpoint URL

Path parameters

Body parameters

Individual Customers

billingAddress

expectedAccountUsage

bankAccountDetails

deviceDetails

declarations

tags

Corporate Customers

corporateCustomerFields

registeredAddress

businessAddress

natureOfBusiness

sizeOfBusiness

applicant

address

positions

documents

stakeholders

stakeholders.individual

stakeholders.corporate

bankAccountDetails

deviceDetails

declarations

tags

Sample Request & Response

Individual Customer

Corporate Customer