AU

This page contains details about the Australia Know Your Business (KYB) flows and links to the following sub-pages for a quick reference:

Page nameDescription
AU required fieldsThis page lists the required API fields of each entity type.
AU required documentsThis page contains tables listing the required documents for verification of the business entity, stakeholders, and applicants.
AU position mappingThis page gives a quick glance at the required positions of each entity type.
AU request examplesThis page contains API request examples for AU entities.

Nium offers E_KYB and MANUAL_KYB flows for customers in Australia.

The E_KYB flow is fully automated, allowing corporate customers to be approved within a few minutes of submitting their application, making it the preferred mode for all customers. Reach out to Nium's sales team to configure the E_KYB flow for your account.

eKYB flow

The following steps are required to complete the E_KYB application.

A diagram showing the eKYB flow for Australia.

A diagram showing the eKYB flow for Australia. (click to enlarge)

Step 1. Public Corporate Details Using Business ID API

To start the eKYB process, collect the basic details about the corporate customer from the applicant through an onboarding form, including the businessRegistrationNumber and countryCode, and then call Nium's Public Corporate Details Using Business ID API.

This API returns publicly available information about the corporate customer, which you then display to the customer so they can select and confirm the businessName and businessRegistrationNumber along with any other optional details.

This step is optional and is intended to help the applicant select the right details.

This API returns multiple results for a given businessRegistrationNumber which you display to your customer and let them select the correct result.

If no results are returned, call the Onboard Corporate Customer API with a full request body. Such applications go through manual review, making the eKYB process not applicable.

Step 2. Onboard Corporate Customer API

You need to collect all the details required to call the Onboard Corporate Customer API through an onboarding form and call it with the full request body.

KYC for applicants

Australia supports all three KYC flows, (E_KYC, E_DOC_VERIFY, and MANUAL_KYC). You need to pass the following parameter in the businessDetails.applicantDetails.kycMode object:

  • E_KYC for Australian residents
  • E_DOC_VERIFY for non-Australian residents

If required, you can use Manual_KYC for non-Australian residents, but those applications go through manual review and cannot be verified in real time. Uploading of documents is mandatory for MANUAL_KYC which needs to be sent in the businessDetails.applicantDetails.documentDetails object. For details, see AU required documents for applicants.

Upon submission, the status in the response of the Onboard Corporate Customer API is IN_PROGRESS.

If any documents are required, the applicant needs to upload them to proceed further. Once done, Nium initiates real-time verification and sends the response via a webhook. The application can be approved at this stage. If it can't be approved, it goes through manual review.

Any changes in thestatus is communicated via a webhook. For the next steps based on the response of a webhook, see Webhooks.

E_DOC_VERIFY for applicants

As a response to the Onboard Corp Customer API, Nium returns a redirect URL. You need to save this URL and redirect the applicant to the redirectURL. Applicant then lands on our KYC vendor's page, where he can complete the KYC verification by uploading his proof of identity and proof of address documents with a live selfie. After that, applicants are redirected back to your client KYC redirect URL that was configured with Nium.

Redirection can result in the following scenarios, based on the below parameters.

  • errorCode
  • errorMessage
  • isSuccess - This field indicates if the applicant completed the required steps in the vendor’s UI. It doesn't mean KYC is successful.
ScenarioExpected action from clientQuery parameters in the redirection
The applicant completed the required steps in the vendor’s UI.Wait for webhook.errorCode: N/A

errorMessage: N/A

isSuccess: TRUE
The redirect URL expired due to timeout.Call Regenerate KYC URL API.errorCode: R408

errorMessage: redirectURLExpired

isSuccess: FALSE
The document has already been submitted in the vendor's UI.KYC Process is completed. Client needs to wait for webhook.errorCode: R403

errorMessage: documentAlreadySubmitted

isSuccess: FALSE
The customer has provided incorrect data in the vendor's UI.Ask customer to submit correct data in the vendors page.errorCode: I400

errorMessage: vendorValidationError

isSuccess: FALSE
Verification Failure at the Vendor.The application goes to manual review. The client needs to wait for webhook.errorCode: R401

errorMessage: vendorVerificationFailure

isSuccess: FALSE
Internal Server error at Nium.Try after some time or reach out to Nium's support.errorCode: R500

errorMessage: internalServerError

isSuccess: FALSE
Any unexpected error from the vendor.Try after some time or reach out to Nium's support.errorCode: I500

errorMessage: unexpectedError

isSuccess: FALSE
Validation already completed and customer retries the same link.KYC Process is completed. The client need to wait for webhook.errorCode: R606

errorMessage: verificationAlreadyCompleted

isSuccess: TRUE

Based on the scenario, you can implement the next steps as provided in the table above.

Example of a redirect to the client in a successful case

https://www.clientRedirectURL.com/?clientId=NIM1681898211881&caseId=4ff53849-3d30-45c8-af11-

f95c315ce83c&isSucces=true&errorCode=&errorMessage=

Example of a redirect to the client in a failed case

https://www.clientRedirectURL.com/?clientId=NIM1681898211881&caseId=4ff53849-3d30-45c8-af11-

f95c315ce83c&errorCode=R408&errorMessage=redirectURLExpired&isSucces=false

For applicants where the businessDetails.applicantDetails.address.country is US, the applicant's address' state needs to be a valid 2 letter state code. Use Fetch corporate constants API for acceptable values.

⚠️

CAUTION

There's an expiration time for the redirectURL so the applicant needs to complete the process soon after submitting the application.

If the URL expires, the applicant is redirected to your configured client KYC redirect URL with an error message. Use Regenerate KYC URL API to get a new URL with a new expiration time.

Stakeholder KYC

The E_KYC and MANUAL_KYC modes are offered for KYC of Individual stakeholders in the eKYB flow in Australia.

For stakeholders, you pass E_KYC (for AU residents) or MANUAL_KYC (for non-AU residents) in businessDetails.stakeholders.stakeholderDetails.kycMode.

Applications with MANUAL_KYC go through manual review and cannot be verified in real-time.

The uploading of documents is mandatory for MANUAL_KYC which has to be sent in businessDetails.stakeholders.stakeholderDetails. See AU required documents for details.

Upload documents if required

If no results are returned as part of the Public Corporate Details Using Business ID API for the particular businessRegistrationNumber, you need to upload documents since Nium doesn't retrieve certain required information from some of its sources.

If the Public Corporate Details Using Business ID API returns a match, you generally don't need to upload documents. However, even in this flow, there might be a particular scenario that requires the applicant to provide some documents.

Documents can be submitted either of two ways:

The Upload Document API is preferred since it uploads one document at a time, which reduces the loading time. This API can be called only while the application is in the IN_PROGRESS state.

You can use the remarks field to list which documents Nium is expecting, in the response of both APIs.

For the entire list of required documents for manual KYB and eKYB flows, see AU required documents.

Manual KYB flow

The MANUAL_KYB process is similar to E_KYB with one exception, documents are mandatory in all cases.

A diagram showing the manual KYB flow for Australia.

A diagram showing the manual KYB flow for Australia. (click to enlarge)

  1. The manual KYB flow requires the submission of business documents. You can send them via the Onboard Corporate Customer API or via the Upload Document API under the businessDetails.documentDetails section. Nium doesn't initiate verification until all required documents are submitted.
    The Upload Document API is preferred since it can upload one document at a time, which reduces loading times.
  2. The KYC applicant is the same in the E_KYB, E_DOC_VERIFY, and MANUAL_KYB flows.
  3. Only the MANUAL_KYC process is offered for individual stakeholders. You need to pass MANUAL_KYC in the businessDetails.applicantDetails.kycMode object. You need to upload your documents. Send the information in the businessDetails.stakeholders.stakeholderDetails.documentDetails\ object.
    For details, see AU required documents.

Once the API is submitted, the next steps are the same as those in the eKYB process, except that all applications are required to go through the manual review. For the next steps, see Quickstart: Corporate Customer.