AU required parameters

The API fields shown on this page are relevant to Australia only. To see the full payload, refer to the Onboard Corporate Customer API Reference.

đŸ“˜

Note

All fields have a maximum limit of 255 characters unless stated otherwise.

Request parameters

PropertyDescriptionRequired
regionThe country or geographic region where the corporate end customer is located and is onboarded. To onboard an AU-based customer, use the AU value.Yes
businessDetailsAn object that contains business details about the corporate customer.Yes
riskAssessmentInfoAn object that contains the risk assessment information.Yes
tagsAn object that contains the tags.No
deviceDetailsAn object that contains information about the customer's device and IP address.Yes
clientIdThis field contains the Nium client ID of the customer. It's received in the response of the previously executed Onboard Corporate Customer API.
Note: This field is required to reinitiate the KYB process.
Yes *
customerHashIdThis field contains the unique customer identifier generated at the time of the customer creation. It's received in the response of the previously executed Onboard Corporate Customer API.
Note: This field is required to reinitiate the KYB process.
Yes *

Table header API fields

The below table headers refer to the businessType fields page:

Association
Private
Sole trader
Government
Partnership
Public
Regulated trust
Unregulated trust
ASSOCIATION
PRIVATE_COMPANY
SOLE_TRADER
GOVERNMENT_ENTITY
PARTNERSHIP
PUBLIC_COMPANY
REGULATED_TRUST
UNREGULATED_TRUST

businessDetails object

An object that contains business details about the corporate customer.

PropertyDescriptionAssociation
Private
Sole trader
Government
Partnership
Public
Regulated trust
Unregulated trust
referenceIdThe universally unique identifier (UUID) of the business entity that Nium uses to identify the businessDetails entity. If it's not provided, Nium generates one. The UUID is used to respond to a request for information (RFI) or to upload required documents for the business entity.OptionalOptionalOptional
businessNameThe name a corporate customer is registered under.RequiredRequiredRequired
businessRegistrationNumberThe business registration number. This fields accepts only nine digits when businessType is PRIVATE_COMPANY or PUBLIC_COMPANY and only 11 digits for any other businessType.RequiredRequiredRequired
tradeNameAnother name that the corporate customer uses to do business under, which is different than their licensed business name.OptionalOptionalOptional
websiteThe corporate customer's website.OptionalOptionalOptional
businessTypeThe legal entity type of the business. Use Fetch corporate constants API for valid values.RequiredRequiredRequired
trusteeNameThe full name of the trustee.N/AN/AOptional
settlorNameThe full name of the trust settlor.
Note: This field is optional for, UNREGULATED_TRUST and not applicable for REGULATED_TRUST.
N/AN/AOptional *
partnershipDetailsAn object that contains the partnership details.
Note: This field is optional for a PARTNERSHIP and not required for other business types.
N/AOptional *N/A
associationDetailsAn object that contains the association details.
Note: This field is required for an ASSOCIATION.
Required *N/AN/A
legalDetailsAn object that contains the legal details.RequiredRequiredRequired
regulatoryDetailsThe regulatory details about the corporate customer.N/AN/ARequired
addressesAn object that contains the registered and business addresses of the corporate customer.RequiredRequiredRequired
documentDetailsAn array of objects that contains the business documents.
Note: This is required for Manual KYB and for eKYB when the businessDetails.businessType is one of the following:
  • ASSOCIATION
  • PARTNERSHIP
  • REGULATED_TRUST
  • UNREGULATED_TRUST
  • .
    Required *Required *Required
    stakeholdersAn array of objects that contains the individual and corporate stakeholders of the corporate customer.Required *Required *Required *
    applicantDetailsAn object that contains the applicant's details.RequiredRequiredRequired
    additionalInfoAn object that contains additional information about the business.RequiredRequiredRequired

    partnershipDetails object

    An object within the businessDetails object that contains the partnership details.

    * This object is required if businessDetails.businessType = PARTNERSHIP.

    PropertyDescriptionAssociation
    Private
    Sole trader
    Government
    Partnership
    Public
    Regulated trust
    Unregulated trust
    partnerNameThe complete name of the partner.N/AOptional *N/A
    partnerCountryThe country where the partnership is established.N/AOptional *N/A
    partnerStateThe state where the partnership is established.N/AOptional *N/A

    associationDetails object

    An object within the businessDetails object that contains the association details.

    * This object is required if businessDetails.businessType = ASSOCIATION.

    PropertyDescriptionAssociation
    Private
    Sole trader
    Government
    Partnership
    Public
    Regulated trust
    Unregulated trust
    associationNameThe complete name of the association.Required *N/AN/A
    associationNumberThe association number as issued by the applicable state or territoryRequired *N/AN/A
    associationChairPersonThe full name of the association chair, secretary, or treasurer.Required *N/AN/A

    legalDetails object

    An object within the businessDetails object that contains the corporate customer's legal details.

    PropertyDescriptionAssociation
    Private
    Sole trader
    Government
    Partnership
    Public
    Regulated trust
    Unregulated trust
    registeredDateThe date the business is registered entered in the YYYY-MM-DD format. Registered date cannot be a past date.RequiredRequiredRequired
    registeredCountryThe country where the business is registered. Use Fetch corporate constants API for valid values.RequiredRequiredRequired
    listedExchangeThe exchange where the business is publicly listed. Use Fetch corporate constants API for valid values.
    Note: This field is required for a PUBLIC_COMPANY.
    N/ARequired *N/A
    legislationNameThe name under which the entity is formed.
    Note: This field is optional if businessDetails.businessType is GOVERNMENT_ENTITY and not applicable to others.
    N/AOptional *N/A
    legislationTypeThe legislation type under which the government entity is formed.
    Note: This field is optional if businessDetails.businessType is GOVERNMENT_ENTITY and not applicable to others.
    Use Fetch corporate constants API for valid values.
    N/AOptional *N/A

    regulatoryDetails object

    An object within the businessDetails object that contains the regulatory details about the corporate customer.

    This object is required if businessDetails.businessType is REGULATED_TRUST or UNREGULATED_TRUST.

    PropertyDescriptionRegulated trustUnregulated trust
    regulatedTrustTypeThe regulated trust type detail. Use Fetch corporate constants API for valid values. This field is an arrayRequiredN/A
    unregulatedTrustTypeThe unregulated trust type detail. Use Fetch corporate constants API for valid values. This field is an array.N/ARequired

    addresses object

    An object within the businessDetails object that contains one or more business addresses.

    PropertyDescriptionAssociation
    Private
    Sole trader
    Government
    Partnership
    Public
    Regulated trust
    Unregulated trust
    registeredAddressAn object that contains the address where the business is registered.RequiredRequiredRequired
    businessAddressAn object that contains the address where the business is mainly conducted, if different than the registered address.
    Note: This is required if isSameBusinessAddress = No
    Required *Required *Required *

    registeredAddress object

    An object within the businessDetails.addresses object that contains the address details where the corporate customer is registered.

    PropertyDescriptionAssociation
    Private
    Sole trader
    Government
    Partnership
    Public
    Regulated trust
    Unregulated trust
    addressLine1The first address line of the registered business.RequiredRequiredRequired
    addressLine2The second address line of the registered business.OptionalOptionalOptional
    cityThe city where the corporate customer is registered.RequiredRequiredRequired
    stateThe state where the corporate customer is registered.RequiredRequiredRequired
    countryThe country where the corporate customer is registered. Use Fetch corporate constants API for valid values.RequiredRequiredRequired
    postcodeThe postal code where the corporate customer is registered.RequiredRequiredRequired

    businessAddress object

    An object within the businessDetails.addresses object that contains the address details about the principal place of business only when the registered address is different.

    * This object is required if businessDetails.additionalInfo.isSameBusinessAddress = No.

    PropertyDescriptionAssociation
    Private
    Sole trader
    Government
    Partnership
    Public
    Regulated trust
    Unregulated trust
    addressLine1The first address line of the principal place of business if different than the registered business.Required *Required *Required *
    addressLine2The second address line of the principal place of business if different than the registered business.OptionalOptionalOptional
    cityThe city of the principal place of business if different than the registered address.Required *Required *Required *
    stateThe state of the principal place of business if different than the registered address.Required *Required *Required *
    countryThe country where the principal place of business occurs if different than the registered country. Use Fetch corporate constants API for valid values.Required *Required *Required *
    postcodeThe postal code where the principal place of business occurs if different than the registered address.Required *Required *Required *

    documentDetails object

    An array of objects within the businessDetails object that contains one or more business documents.

    * This object is required if either is true:

    • Manual KYB is used.
    • eKYB is used and businessDetails.businessType is one of the following:
      • ASSOCIATION
      • PARTNERSHIP
      • REGULATED_TRUST
      • UNREGULATED_TRUST
    PropertyDescriptionAssociation
    Private
    Sole trader
    Government
    Partnership
    Public
    Regulated trust
    Unregulated trust
    documentTypeThe type of business document. Use Fetch corporate constants API for valid values.Required *Required *Required
    documentAn array of objects that contains a copy of the document.Required *Required *Required

    document object

    An array of objects within the businessDetails.documentDetails object.

    PropertyDescriptionAssociation
    Private
    Sole trader
    Government
    Partnership
    Public
    Regulated trust
    Unregulated trust
    fileNameThe name of the file.Required *Required *Required
    fileTypeThe type of the file. Valid types are application/pdf, image/jpeg, image/jpg, image/png, jpeg, jpg, and png.Required *Required *Required
    documentThe file as a base64 encoded string.Required *Required *Required

    additionalInfo object

    An object within the businessDetails object that contains additional information about the business.

    PropertyDescriptionAssociation
    Private
    Sole trader
    Government
    Partnership
    Public
    Regulated trust
    Unregulated trust
    isSameBusinessAddressThis field accepts Yes or No to indicate if the principal place of business is the same or different from the registered business entity address.OptionalOptionalOptional

    stakeholders array

    An array of objects within the businessDetails object that contains information about one or many stakeholders. For every stakeholder object, you need to send either the stakeholderDetails or the businessPartner parameters.

    DescriptionAssociation
    Private
    Sole trader
    Government
    Partnership
    Public
    Regulated trust
    Unregulated trust
    referenceIdThe UUID associated with the stakeholder and stakeholder object. If the UUID isn't provided, Nium generates one. The UUID can be used to respond to an RFI or to upload the required documents.OptionalOptionalOptional
    stakeholderDetailsAn object that contains the details about the individual stakeholders.Required *Required *Required *
    businessPartnerAn object that contains the details about the corporate stakeholders, if available.
    Note: This is required only if a business partner exists.
    Required *Required *Required *

    stakeholderDetails object

    An object within the stakeholders object that contains the details about an individual stakeholder.

    * This object is required if individual stakeholder for the following scenarios:

    • client is configured for Manual KYB.
    • client is configured for eKYB and businessDetails.businessType is one of the following:
      • ASSOCIATION
      • PARTNERSHIP
      • SOLE_TRADER
      • UNREGULATED_TRUST and REGULATED_TRUST
    PropertyDescriptionAssociation
    Private
    Sole trader
    Government
    Partnership
    Public
    Regulated trust
    Unregulated trust
    kycModeThe KYC mode for verifying the individual stakeholder. Valid values are E_KYC and MANUAL_KYC.RequiredRequiredRequired
    firstNameThe given name of the individual stakeholder.Required *Required *Required *
    middleNameThe middle name of the individual stakeholder.OptionalOptionalOptional
    lastNameThe last name of the individual stakeholder.Required *Required *Required *
    nationalityThe nationality of the individual stakeholder.Required *Required *Required *
    dateOfBirthThe date the individual stakeholder was born in the YYYY-MM-DD format. Date of birth cannot be a future date.Required *Required *Required *
    professionalDetailsAn array of objects that contains the individual stakeholder's professional details.Required *Required *Required *
    addressAn object that contains the residential address of the individual stakeholder.Required *Required *Required *
    documentDetailsAn array of object that contains the document details about the individual stakeholder.
    Note: This is required if kycMode = MANUAL_KYC.
    Required *Required *Required *

    professionalDetails array

    An array of objects within the businessDetails.stakeholders.stakeholderDetails object that contains the individual stakeholder's professional details.

    PropertyDescriptionAssociation
    Private
    Sole trader
    Government
    Partnership
    Public
    Regulated trust
    Unregulated trust
    positionThe position of the individual stakeholder. Use Fetch corporate constants API for valid values.Required *Required *Required *

    address object

    An object within the businessDetails.stakeholders.stakeholderDetails object that contains the individual stakeholder's residential address.

    PropertyDescriptionAssociation
    Private
    Sole trader
    Government
    Partnership
    Public
    Regulated trust
    Unregulated trust
    addressLine1The first address line of the individual stakeholder's residential address.
    If kycMode = E_KYC then the following needs to be passed in this field as comma-separated values:
  • unit number (if available)
  • street number
  • street name
  • Required *Required *Required *
    addressLine2The second address line of the individual stakeholder's residential address.
    Note: If kycMode = E_KYC then streetType needs to be passed in this field. Use Fetch corporate constants API for valid values.
    Required *Required *Required *
    cityThe city or suburb of the individual stakeholder.
    If kycMode = E_KYC then suburb needs to be passed in this.
    Required *Required *Required *
    stateThe state of the individual stakeholder's residential address.Required *Required *Required *
    countryThe country of the individual stakeholder's residential address. Use Fetch corporate constants API for valid values.Required *Required *Required *
    postcodeThe postal code of the individual stakeholder's residential address.Required *Required *Required *

    documentDetails object

    An array of objects within the businessDetails.stakeholders.stakeholderDetails object that contains the individual stakeholder's document details.

    * This object is required if kycMode = MANUAL_KYC.

    PropertyDescriptionAssociation
    Private
    Sole trader
    Government
    Partnership
    Public
    Regulated trust
    Unregulated trust
    documentTypeThe type of document. Use Fetch corporate constants API for valid values.Required *Required *Required *
    documentNumberThe ID number for the given document type.Required *Required *Required *
    documentIssuanceCountryThe country that issued the business document. Use Fetch corporate constants API for valid values.Required *Required *Required *
    documentExpiryDateThe date the document expires in the YYYY-MM-DD format. Date of expiry cannot be a past date.Required *Required *Required *
    documentA copy of the document.Required *Required *Required *

    <a id="businessDetails-stakeholders-stakeholderDetails-documentDetails-document>

    document

    An array of object within the businessDetails.stakeholders.stakeholderDetails.documentDetails object that contains a copy of the document.

    * This object is required if kycMode = MANUAL_KYC.

    PropertyDescriptionAssociation
    Private
    Sole trader
    Government
    Partnership
    Public
    Regulated trust
    Unregulated trust
    fileNameThe name of the file.Required *Required *Required *
    fileTypeThe file type. Valid types are application/pdf, image/jpeg, image/jpg, image/png, jpeg, jpg, and png.Required *Required *Required *
    documentThe document saved as a base64 encoded string.Required *Required *Required *

    businessPartner

    An object within the businessDetails.stakeholders object that contains the business details about the corporate stakeholder.

    * This object is required if a corporate stakeholder exists for any businessType for both Manual KYB and eKYB.

    PropertyDescriptionAssociation
    Government
    Partnership
    Public
    Regulated trust
    Unregulated trust
    businessNameThe registered business name of the corporate stakeholder.Required *Required *Required *
    businessRegistrationNumberThe business registration number.Required *Required *Required *
    businessTypeThe legal entity type of the business.
    Note: For Manual KYB, this field is not applicable; for eKYB this field is required for UNREGULATED_TRUST and REGULATED_TRUST Valid values are only:
  • PUBLIC_COMPANY
  • PRIVATE_COMPANY
  • GOVERNMENT_ENTITY
  • N/AN/ARequired *
    businessEntityTypeThe position of the corporate stakeholder in the company. Use Fetch corporate constants API for valid values.Required *Required *Required *
    legalDetailsThe corporate stakeholder's legal details.Required *Required *Required *

    legalDetails object

    An object within the businessDetails.stakeholders.businessPartner object that contains the corporate stakeholder's legal details.

    PropertyDescriptionAssociation
    Sole trader
    Trust
    Government
    Private
    Public
    LLP
    registeredCountryThe country where the corporate stakeholder is registered. Use Fetch corporate constants API for valid values.Required *Required *Required *

    applicantDetails object

    An object within the businessDetails object that contains details about the applicant.

    PropertyDescriptionAssociation
    Private
    Sole trader
    Government
    Partnership
    Public
    Regulated trust
    Unregulated trust
    referenceIdThe UUID associated with the applicant and the applicant object. If the UUID isn't provided, Nium generates one. The UUID can be used to respond to an RFI or to upload required documents.OptionalOptionalOptional
    kycModeThe KYC mode for verifying the identity of the applicant. Valid values are E_KYC , E_DOC_VERIFY, and MANUAL_KYC.RequiredRequiredRequired
    firstNameThe first name of the applicant. The maximum length is 40 alphabetic characters or spaces.RequiredRequiredRequired
    middleNameThe middle name of the applicant. The maximum length is 40 alphabetic characters or spaces.OptionalOptionalOptional
    lastNameThe last name or the applicant. The maximum length is 40 alphabetic characters or spaces.RequiredRequiredRequired
    nationalityThe nationality of the applicant. Use Fetch corporate constants API for valid values.RequiredRequiredRequired
    dateOfBirthThe date on which the applicant was born in the YYYY-MM-DD format. Date of birth cannot be a future date. Applicant cannot be below 18 years of age.RequiredRequiredRequired
    professionalDetailsAn array of objects that contains the applicant's professional details.RequiredRequiredRequired
    addressAn object that contains the applicant's residential address.RequiredRequiredRequired
    contactDetailsThe contact details of the applicant.RequiredRequiredRequired
    documentDetailsAn array of objects that contains the applicant's document details. Note: This object is required only for E_DOC_VERIFY and MANUAL_KYC. In E_KYC, LOA is required if the applicant isn't a DIRECTOR/ UBO.Required *Required *Required *

    professionalDetails array

    An array of objects within the businessDetails.applicantDetails object to contain the professional details about the applicant.

    PropertyDescriptionAssociation
    Private
    Sole trader
    Government
    Partnership
    Public
    Regulated trust
    Unregulated trust
    positionThe position of the applicant. Use Fetch corporate constants API for valid values.RequiredRequiredRequired

    address object

    An object within the businessDetails.applicantDetails object that contains the applicant's residential address.

    PropertyDescriptionAssociation
    Private
    Sole trader
    Government
    Partnership
    Public
    Regulated trust
    Unregulated trust
    addressLine1The first address line of the applicant. The maximum character length is 40.
    If kycMode = E_KYC then the following needs to be passed in this field as comma-separated values:
  • unit number (if available)
  • street number
  • street name
  • RequiredRequiredRequired
    addressLine2The second address line of the applicant. The maximum character length is 40.
    If kycMode = E_KYC then StreetType needs to be passed in this field. Use Fetch corporate constants API for valid values.
    RequiredRequiredRequired
    cityThe city or suburb of the applicant. The maximum character length is 20.
    If kycMode = E_KYC then suburb needs to be passed in this field.
    RequiredRequiredRequired
    stateThe state of the applicant. The maximum character length is 30. Use Fetch corporate constants API for valid values.RequiredRequiredRequired
    countryThe country where the applicant resides. Use Fetch corporate constants API for valid values.RequiredRequiredRequired
    postcodeThe postal code of the applicant. The minimum length is 3 and the maximum length is 10 alphanumeric characters or spaces.RequiredRequiredRequired

    contactDetails object

    An object within the businessDetails.applicantDetails object to contain the applicant's contact information.

    PropertyDescriptionAssociation
    Private
    Sole trader
    Government
    Partnership
    Public
    Regulated trust
    Unregulated trust
    emailThe applicant's email address. The maximum character length is 40 and needs to be a valid email address. See Regex for emailRequiredRequiredRequired
    countryCode.The country code of the applicant's phone number. Use Fetch corporate constants API for valid values.RequiredRequiredRequired
    contactNoThe applicant's phone number. The maximum length is 20 numeric characters.RequiredRequiredRequired

    documentDetails object

    An array of objects within the businessDetails.applicantDetails object that contains the applicant's document information.

    * This object is required if kycMode is MANUAL_KYC or E_DOC_VERIFY. In E_KYC, LOA is required if the applicant isn't a DIRECTOR/ UBO.

    PropertyDescriptionAssociation
    Private
    Sole trader
    Government
    Partnership
    Public
    Regulated trust
    Unregulated trust
    documentTypeThe type of document. Use Fetch corporate constants API for valid values.Required *Required *Required *
    documentNumberThe ID number for the given document type.Required *Required *Required *
    documentIssuanceCountryThe country that issued the business document. Use Fetch corporate constants API for valid values.Required *Required *Required *
    documentExpiryDateThe date the document expires in the YYYY-MM-DD format. Dare of expiry cannot be a past date.Required *Required *Required *
    documentAn array of objects that contains a copy of the document. Note: This object is required only for MANUAL_KYC. In E_KYC or E_DOC_VERIFY, LOA is required if the applicant isn't a DIRECTOR/ UBO.Required *Required *Required *

    document object

    An array of objects within the businessDetails.applicantDetails.documentDetails object that contains the document copy.

    * This object is required if kycMode = MANUAL_KYC. In E_KYC or E_DOC_VERIFY, LOA is required if the applicant isn't a DIRECTOR/ UBO.

    PropertyDescriptionAssociation
    Private
    Sole trader
    Government
    Partnership
    Public
    Regulated trust
    Unregulated trust
    fileNameThe name of the file.Required *Required *Required *
    fileTypeThe file type. Valid types are application/pdf, image/jpeg, image/jpg, image/png, jpeg, jpg, and png.Required *Required *Required *
    documentThe document saved as a base64 encoded string. The maximum size is 5 MB.Required *Required *Required *

    riskAssessmentInfo object

    An object that contains the following details that are required to determine a corporate customer's risk profile.

    PropertyDescriptionAssociation
    Private
    Sole trader
    Government
    Partnership
    Public
    Regulated trust
    Unregulated trust
    totalEmployeesThe corporate customer's total number of employees. Use Fetch corporate constants API for valid values.RequiredRequiredRequired
    annualTurnoverThe corporate customer's amount of annual turnover. Use Fetch corporate constants API for valid values.RequiredRequiredRequired
    industrySectorThe corporate customer's industry sector. Use Fetch corporate constants API for valid values.RequiredRequiredRequired
    countryOfOperationAn array of countries the corporate customer operates in. Use Fetch corporate constants API for valid values.RequiredRequiredRequired
    transactionCountriesAn array of countries where the transactions occur. Use Fetch corporate constants API for valid values.RequiredRequiredRequired
    intendedUseOfAccountThe customer's intended use of the account. Use Fetch corporate constants API for valid values.RequiredRequiredRequired

    deviceDetails object

    This object contains the information about the customer's device and IP address where the onboarding request originated.

    PropertyDescriptionAssociation
    Private
    Sole trader
    Government
    Partnership
    Public
    Regulated trust
    Unregulated trust
    countryIPCountry of the IP address e.g. US. Use Fetch corporate constants API for valid values.RequiredRequiredRequired
    deviceInfoInformation of the device e.g. Mac OS.RequiredRequiredRequired
    ipAddressIP address of the device e.g. 45.48.241.198RequiredRequiredRequired
    sessionIdA unique identifier for the session, generated by your application.RequiredRequiredRequired

    tags object

    This object contains the user-defined key-value pairs that the client provides. The maximum number of tags is 15.

    PropertyDescriptionAssociation
    Private
    Sole trader
    Government
    Partnership
    Public
    Regulated trust
    Unregulated trust
    keyThe name of the tag. The maximum character length is 128. Key should be unique.OptionalOptionalOptional
    valueThe value of the tag. The maximum character length is 256.OptionalOptionalOptional