KYC Integration Docs

The following documentation provides instructions for integrating “Numio ID Verification”, which takes just one day for integration and less than 2 minutes for users to be onboarded.


Step 1: Register as a Verified Integration Partner ✓

Before development can begin, a company needs to become a verified integration partner.

Partner Application ↓

Your application contains basic information that we can use to verify that this integration satisfies your business needs.

To get started, fill out a quick application.

Step 2: Create your first integration project ↓

Once step one is complete, we will reach out and your first project will be created. This will allow you to access our end points and services.

Partner Application ↓

Your project is the application or website that contains the integration. An integration partner can have multiple concurrent projects.​

After registration we will provide a unique “APP_ID” and “APP_SECRET” which is different for every website or application registered to use Numio Authenticator. These tokens will allow your application to communicate with our service.

Step 3: Learn about Numio ID Verification ↓

We strive to make integrations as painless as possible by giving you all the tools and code snippets you need to get up and running.

Numip Verification Technology ↓

Powered by 3D face-mapping technology and NumioCloud secure storage, Numio one time KYC instantly verifies users into all partner platforms.

(Figure: Numio ID Verification integrated into BitExchange web application.)

High Level Overview ↓

Add a button to your website or application that triggers a modal QR code a user can scan with their secure Numio application. Upon scanning, a custom, branded screen appears in-app and asks the user to grant access using our advanced biometrics system. Upon pass/fail, the user is instantly onboarded and KYC verified into your application instantly. If they have not completed KYC, they are immediately taken to the Identity Verification screen on the Numio app.

Step 4: The Technical Overview ↓

The following outlines what happens in the user experience.

The following 2 scenarios outline what happens in the user experience.

Scenario when user has not been KYC verified on the Numio app:

  1. A user scans a QR code on your website or application through the Numio Pay mobile app.
  2. User approves the request and gives permission to share data with the provider.
  3. User is taken to the identity verification screen.
  4. User completes the Identity Verification.
  5. Users are checked with all Legal/Regulatory monitored lists for AML verification including PEP and all government watchlists.

Scenario when user has already been KYC verified on the Numio app:

  1. A user scans a QR code on your website or application through the Numio mobile app.
  2. After scanning the QR code, the user is shown a custom branded in-app screen asking the user to approve the login request.
  3. User approves the request and verifies himself through biometrics.
  4. Encrypted user data is sent to the provider’s front-end by the Numio-CDN.
  5. The provider’s back-end receives the token and sends it to the SIP Server, with help of Numio-SDK, for authentication.
  6. After receiving the token and encrypted user data, it is sent to the provider’s back-end.
  7. The SIP Server receives the token and determines if the sent token is valid or not.
    1. If the sent token is valid, it is then decrypted with the help of NodeRSA and the generated keys (which were generated in step 3) are deleted. “return success” response is sent to the provider’s back-end.
    2. If the sent token is invalid, then the response of failure is sent to the provider’s back-end.
  8. Identity documents are checked with all Legal/Regulatory monitored lists for AML verification including PEP and all government watchlists.

Step 4: Integration Guide ↓

  1. To integrate Numio ID Verification into your site you will need to install two npm packages: numio-cdn for front-end and numio-sdk for backend.
  2. Before installing the packages, be sure you are registered as a verified integration partner and have the tokens for your project.
  3. You will be initializing the numio-cdn on the front-end which will provide you an object.
  4. You will then pass that object in the QR code generator component.
  5. When a user scans that QR code with Numio app they will be asked to give permission to share the information.
  6. After the user gives the permission, a token will be sent to the front-end of the website through the numio-cdn package.
  7. As soon as your website front-end receives that token it will send it to your back-end where that token is authenticated with the help of numio-sdk package.
  8. The KYC/AML data on the verified/denied users are then passed into the NumioCloud. This dashboard is accessible via Numio Authenticator.
Important Note ↓

Without the “APP_ID” and “APP_SECRET” passed with the request object, the Numio Authenticator service the return object will deny access to the integration.

The Packages ↓

For complete details, installation and example snippets visit these NPM package repositories: These packages can be installed using NPM or Yarn

The QR Code Data Object ↓

To generate the QR code, providers can use a variety of tools. For instance, if using React, qrcode.react could be used to generate the required assets.

"url :"",

(Figure: Custom QR code injected in by Numio-CDN.)
Important Note ↓

The QR code contains the SIP Server route, provider APP_ID and user SOCKET_ID.

The SOCKET_ID is a unique id of each individual connection that is made to the server. SOCKET_ID is used to send the data for that unique connection.

In-App Custom Dialog ↓

The In-App Custom Dialog is the permission screen that is presented inside the Numio app that the user will see every time they request permission to login.

  • Logo: 180×100 dimensions in PNG format.
  • Provider Name: “Vault”
(Figure: Custom branded KYC verification screen after the user scans the QR code.)

Access & Privacy ↓

A log of whether the user approved or denied the KYC request will be kept in the user’s device, along with whether they were successfully verified or not.

(Figure: Access Log of KYC activity for a users identity.)
Important Note ↓

The 3rd party service does not need to alter their database for this integration.

User Data ↓

The Numio SDK provides configuration options as to what data should be returned from the Numio app. In-scope items are:

  • First Name
  • Last Name
  • Email
  • Numio ID
  • Profile Image
  • Address / Country
  • Date of Birth
  • Phone Number
  • Verification Status of user (Pass/Fail)

Pricing ↓

To see the cost of using Numio Identity Verification, please check this page.

Integration Time ↓

With the tools provided, we anticipate this integration to take ~1 day.