eKyc

Authorize/Identity

• Pre-prod: https://pre-prod-id.idshare.info/ (https://pre-prod-id.idshare.info/swagger/index.html)

• Production: https://id.idshare.info (https://id.idshare.info/swagger/index.html)

API INTEGRATION

POST /api/user-profile-management/user-info-kyc/save

Request Body

Name	Type	Description
id	String
kycStep	Enum
kycType	Enum
idType	Enum
frontSideIdCard	String
backSideIdCard	String
selfiePhoto	String
idCardNumber	String
nationalityId	String
countryId	String
placeOfBirth	String
placeOfResidence	String
firstName	String
lastName	String
middleName	String
fullName	String
gender	String
dateOfBirth	String
issuedDate	Date
expiredDate	Date

200: OK

{
    // Response
}

HTTP Request

Attribute	Type	Required
id	String
kycStep	Enum
kycType	Enum
idType	Enum
frontSideIdCard	String
backSideIdCard	String
selfiePhoto	String
idCardNumber	String
nationalityId	String
countryId	String
placeOfBirth	String
placeOfResidence	String
firstName	String
lastName	String
middleName	String
fullName	String
gender	String
dateOfBirth	String
issuedDate	Date
expiredDate	Date

Functional Specification

Field name	Format	Required	Description
Where are you from ?	Label		Show title "Where are you from ?"
Country	Selectbox		User selects country In case the user chooses Vietnam: ⦁ Implement new KYC process In case the user chooses a country other than Vietnam: ⦁ Based on the type of document to decide whether the process is new or old.
Type of document	Selectbox		User selects the document type: Passport, Other documents In case the user chooses a passport: ⦁ Implement new KYC process In case the user chooses another document: ⦁ Implement the old KYC process
Continue	Button		Disable if the above fields are not selected Enable if the above field is checked
Take the picture	Button		Users take pictures to get information extracted by OCR
Upload	Button		User chooses to upload image Maximum: 5MB
Back	Button		Back to the previous step
Type of document	Selectbox		Types: ⦁ Citizen ID card ⦁ Prove yourself to the people ⦁ Driving License Passport Birth Certificate ⦁ Other documents In case the user chooses Vietnam ⦁ The API automatically recognizes the document type and fills it in for the customer
ID of document	Textbox		In case of choosing Vietnam: ⦁ Format: does not accept any special characters, only numbers and letters are accepted. Remaining case: ⦁ Format: do not accept spaces' In case of the same number of documents: ⦁ If it matches the document number of the person who submitted the application, or the person has been authenticated, an error message "The ID number already exists" will be reported.
First and last name	Textbox		Can't edit directly this field information is combined from 3 fields (textboxes), which appear when you click edit: Name, Middle Name, Surname
Continue	Button		Press the button to enter the OTP code for email verification The system sends authentication mail to the user Go to the OTP code input screen “We have already sent an OTP code to [email]. Please enter the OTP code in the email into the field below”
OTP code	Textbox		Enter the OTP code sent to your 6-digit email The code is valid from 5 minutes to be sent Time to resend OTP code: 60s (counting from receiving the previous OTP code) – when the new code is sent, the old code is no longer valid In case the user leaves it blank, the message "Please enter OTP code" - "Please enter your OTP" In case the user enters the wrong OTP code “OTP code is incorrect” In case the OTP code has expired, the message "OTP has expired" In case of exceeding the number of times the message "Maximum number of retry reached" is displayed, the customer will be blocked for 20 minutes.
Resend/Send	Button		In case the email is not sent with the description “We have a temporary issue, please try again later” Click to resend the OTP code to the email entered when registering, cancel the old OTP code
Complete	Button		The user clicks done to save the information to the database and wait for the admin's confirmation
Successful KYC registration	Label		Successful KYC registration
Back	Button		User clicks to return to homepage

API Description

Step	Factor	Description
1	User	Go to the user's IDShare page at the profile menu, click eKyc
2	System	Check condition: In case of authenticated user: ⦁ Show message “Your account is verified”. Can't continue User case submitted (Status 'pending validation'): ⦁ Show message “Your account is under review” Other case: Continue
3	User	Go through the validation and submit process User selects a country field to start
4	System	Send email OTP code to verify email
5	User	Enter the OTP code to finish the authentication process
6	System	Send email "Successfully submitted" Save the file in the database
7	System	Update status "waiting for authentication" for users
8	Admin eKYC	Processing records
9	System	The system updates the status of the file based on the admin's processing activity The system sends the corresponding email to the user The system sends notifications to users