Get API Keys

Customer flow diagrams

KYC Overview

The Unified Add Customer API is used for adding individual customers.

The two methods of performing KYC (Manual KYC and eKYC) as well as the Screening flows are detailed below.

Manual KYC

Add a customer using the Unified Add Customer API with compliance option as Manual KYC.

eKYC

Add a customer using the Unified Add Customer API with compliance option as eKYC.

eKYC in Australia by greenID

kycStatus values can be COMPLETED, REJECT, or ERROR. In addition to this service, we also run screening so the client needs to call GET Customer API to fetch the correct status.

GreenId can be re-initiated if the status is REJECT. If this status is ever ERROR, email Nium. It can also be switched to Manual KYC if the status is REJECT.

The full process.

  1. Your new customer signs up for verification.
  2. You send a GET request to the Terms and Conditions API.
  3. Nium returns the Terms and Conditions description.
  4. You display the Terms and Conditions to your customer to agree and accept. You collect all customer information for onboarding.
  5. You send a POST request to the Unified Add Customer API and include the following:
    • kycMode=E_KYC
    • countryCode=AU
    • customerDetails object
    • address object
    • the identification document (MEDICARE_CARD, PASSPORT, or DRIVERS_LICENCE)
  6. Nium initiates the eKYB process by connecting to GreenID and conducts screening and sanction checks. After completion, Nium updates the compliance status to either COMPLETED, ERROR, or REJECT.
  7. Nium returns the following fields:
    • customerHashId
    • walletHashId
    • status
    • complianceStatus
  8. You send a POST request to the Accept Terms and Conditions API and include the customerHashId.
  9. Nium returns a success confirmation upon receipt.
  10. You direct your customer to your home page for what?
  11. Nium sends a callback request for the complianceStatus with the customerHashId.
  12. You send a response with the HTTPS status code 200.
  13. You collect your customer's details and send them in a GET request to the Customer Details API with the customerHashId.
  14. Nium returns the customerDetails object, the complianceStatus field, and the kycStatus field.

eKYC in Singapore by MyInfo

Adding customer using Unified Add Customer API with compliance option as E-KYC.

The values for kycStatus can be IN PROGRESS, ERROR, or COMPLETED. In addition to this service, we also run screening so the client needs to call GET Customer API to fetch the correct status.

MyInfo can be re-initiated if the status is IN PROGRESS, REJECT, or ERROR. It can also be switched to Manual KYC if the status is REJECT.

eKYC in US by Trulioo

The values for kycStatus can be IN PROGRESS, ERROR, or COMPLETED. In addition to this service, we also run screening so the client needs to call GET Customer API to fetch the correct status.

Trulioo can be re-initiated if the status is IN PROGRESS, REJECT, or ERROR. It can also be switched to Manual KYC if the status is REJECT.

eDocVerify

eDocVerify in EU/UK by Onfido

complianceStatus values can be IN PROGRESS, COMPLETED, REJECT, or ERROR. In addition to this service, we also run screening so the client needs to call GET Customer API to fetch the correct status.

Onfido can be re-initiated if the status is IN PROGRESS, REJECT, or ERROR. It can also be switched to Manual KYC if the status is REJECT.

Screening

Add a customer using the Unified Add Customer API with compliance option as SCREENING.

Terms and Conditions

KYC Add Customer Exceptions

RFI Requested

Rejected

Error

Updated 9 days ago