User KYB process
nCore platform provides an automated feature to onboard SMEs (Small Medium Enterprises) under your business. With this feature you can create as many SMEs as you want under your business hub. As part of the SME onboarding process, the platform is required to automate the KYB (know your business) process through the APIs and the data is shown and validated by NymCard internally before making any decision to pass or fail the onboarding process.
For the KYB process, there are following sub-user types which are required to create and upload their supporting documents for the KYB process.
The sub-users are given below:
  • Director,
  • Signature, and
  • Shareholder
Once the users with such user types are created, then the system enables you to upload their identification documents.
After that you can create a main business user (i.e. the SME), and provide the sub-user’s (Director, Signature, and Shareholder) IDs in the request.
For example, you want to create a business user (SME) , whose name is “Test”. The SME Test has 3 Directors, 2 signatures and 5 shareholders. To create the use case, please follow the following steps:
  1. 1.
    Create all sub-users such as 3 Directors, 2 signatures and 5 shareholders one by one.
  2. 2.
    Then you should create identifications for each of 3 Directors, 2 signatures and 5 shareholders one by one.
  3. 3.
    After that you will be able to upload identification documents for each of 3 Directors, 2 signatures and 5 shareholders one by one.
  4. 4.
    And at last you will be able to create the business user (“Test”), and include all the created director’s, signature’s and shareholder’s IDs in the designated lists so that the sub-users will get linked with the SME Test.
  5. 5.
    If required you can create business SME Test’s identification and upload any supporting documents by using the same APIs mentioned in this section.

SME onboarding step by step process

Below you can find the step-by-step instructions on how to create a business user.

Create SME’s sub-users

To create a Director, Signature or Shareholder, send a POST request to /users endpoint and indicate relevant ‘user_type’ (DIRECTOR, SIGNATURE or SHAREHOLDER). Below you can find sample requests and responses with relevant parameters for each user type.
Note, you can create up to 10 sub-users of each type.

Create a sub-user type: Director

Response

Create a sub-user type: Signature

Response

Create a sub-user type: Shareholder

Response

Create SME’s sub user’s identifications

To create an identification, you should send a POST request to /users/{user_id}/identifications endpoint, where you should indicate a ‘type’ parameter, relevant to this specific sub-user. Below you can find the list of available identification types:
Name
Description
PASSPORT
Passport
VISA
Visa
NATIONAL_ID
National ID
TRADE_LICENSE
Trade license
COMMERCIAL_LICENSE
Commercial license
INCORPORATION_CERT
Company Certification of Incorporation
INCUMBENCY_CERT
Incumbency certificate
MEMORANDUM_ARTICLES
Memorandum and articles. Company Memorandum and Articles of Association/By-Laws
BANK_STATEMENT
Bank statement of 3 months. The size of the document should be up to 5 Mb.
ADDITIONAL
Additional document (other company legal document)
The identification can be created for sub-users as well as for the SME business user itself if required.
Below you can find an example for National ID identification creation:
Response
Also here you can find an example for VISA identification creation:
Response
You can create any of the identification types mentioned above by sending a POST request to /user/{user_id}/identification endpoint. Below you can find an example with Trade license:
Response
Note, that the user with 'user_type' "DIRECTOR", "SIGNATURE" or "SHAREHOLDER" is automatically created with user 'status' as 'PENDINGKYB' and 'status_reason_code' as 'I0' for user identification purposes.

Upload SME’s sub user’s documents

After identification is created, you can upload the relevant documents. For this you should send a POST request to /users/{user_id}/identifications/{identification_id}/files endpoint.
Below you can find a sample request:
Response
Note, that you can upload different types of documents such as NATIONAL_ID, VISA, MEMORANDUM, BANK_STATEMENT etc..

Create business (SME) user

Now you can create a business user along with the details and sub-users, created in step 1. For this you should send a POST request to /users endpoint and indicate ‘user_type’ = BUSINESS. Below you can find a sample request and response.
Response
Please Note:
  1. 1.
    You can create up to 10 sub-users (Director, Signature and Shareholder) for each SME.
  2. 2.
    You can create sub-users first, and then create a SME business user. While creating a SME business user, you should provide all of the sub-user’s IDs in the designated fields for linking. Or
  3. 3.
    You can create a SME business user first along with the further details, and then create a list of required sub-users, create their identifications and upload the documents. Then you should update the SME business user while providing all of the created sub-user’s IDs for linking.
  4. 4.
    Now you can create identification for business SME user and upload any supporting documents such as TRADE_LICENSE, COMMERCIAL_LICENSE, INCORPORATION_CERT, INCUMBENCY_CERT, MEMORANDUM_ARTICLES, BANK_STATEMENT and/or ADDITIONAL.
  5. 5.
    You can retrieve relationships linked to a specific user by sending a POST request to /users/{id}:getLinkedRelationships endpoint.

KYB status transitions

The SME’s sub-user, their identifications, and a SME itself will be created with a status as PENDINGKYB and it will only transition to ACTIVE when processed and approved by the NymCard’s compliance team after considerable amount of validation.
If the documents are not verified due to any reason, the system will mark the status as SUSPENDED and status_reason_code as S5 - ‘Admin rejected due to ID verification failed’. It means that the additional document is requested by the NymCard’s compliance team. You would be required to provide the requested documents by using the ‘Upload single image of identification’ API as mentioned in section ‘Upload SME’s sub user’s document’.