Onfido Integration

Instantly perform KYC on your Hydrogen clients



Back to Integrations



Onfido offers KYC for both individual and business identities and document verification.

Setup

To get started, you’ll first need to sign up for Onfido here and get your credentials.

Once obtained, you can enter the user name (under ID/Key Name) and password (under Password/Key Value) along with the rest of the setup for Onfido into Hydrogen’s Integrations Admin.

Verify an End User’s Identity

Once you have your Onfido credentials entered, you can now begin performing KYC on your end users. Before performing a KYC, you will need to ensure that the end user's personal details are stored in Nucleus /client.

We will submit all PII data such as name, DOB, address, and identification number that is stored in Nucleus for the client. At a minimum, the client_id should include the following information for Onfido to perform a verification:

  • first_name
  • last_name
  • date_of_birth

  • Once your client is created in Nucleus, you may pass that client_id to POST /integration/v1/kyc, which will submit the user's information to Onfido.

    Alternatively, if you selected the option in the Integration Admin settings to automatically KYC when you create a client, then you can bypass this call and the user will automatically be sent for verification when created in Nucleus via POST /nucleus/v1/client.

    If the KYC returns as a match the is_verified flag will be set to "true" in Nucleus /client.

    Retrieve KYC Receipts

    Each KYC performed will be stored as a receipt in Hydrogen. If you need to access the receipts, you can do so by using the following endpoint:

    GET /integration/v1/kyc_status/{nucleus_client_id}