○ Start using AuthMe identification service
Suggest Edits

1 Introduction
AuthMe provides a complete e-KYC solution, including ID recognition, liveness detection, facial recognition, selfie-ID comparison, fraud detection, etc. In addition, it can also integrate Near Field Communication (NFC) technology and connect with MyData for multiple identity verifications. This document is a SaaS service API specification. It mainly provides an API interface for identification, so that enterprises can easily interface and use this service.

2. API tour
Before starting, it is recommended that developers read the following two pages:

Prep work on AuthMe Dashboard : Before using any API, you must use the Access token. Therefore, you need to set up the Client and Secret in the AuthMe cloud dashboard. In addition, the ID watermark and Webhook will also be performed in the AuthMe Dashboard. Pending for setting
API sequence diagram : This page presents all API interactions in a sequence diagram, which can clearly demonstrate the timing, sequence, and related roles that affect the API
3. APIs currently provided
(1) Get the access token : Before using any API, you must obtain the access token.
(2) ID OCR recognition : upload a ID photo and analyze it through OCR to determine the ID type and extract personal identification data
(3) Confirm and modify OCR identification results : confirm whether the data analyzed by OCR is correct, the data can be edited.
(4) Liveness detection: upload a selfie to detect whether the portrait in the photo is a live human
(5) Comparison result between ID and selfie : After completing ID identification and liveness detection, the system will automatically perform a selfie-ID comparison
(6) Obtain identification data of the ID : the enterprise can obtain the user's identification data and store it in the enterprise host
(7) Obtain the ID and selfie photo file code : the enterprise can obtain the user's ID and the live photo, which are stored in the enterprise host
(8) Obtain ID and selfie photo file code : extract the actual photo from the photo file code
(9) Modify the approval status and ID data : If the enterprise adopts manual approval, it can change the approval status and revise the ID data through this API
(10) Delete all user data : the user identification data shall be deleted
(11) Automatically return the identification result to the enterprise (Webhook) : When the identification process is completed, AuthMe will actively call the enterprise's API to report the detection result
(12) ID photo and selfie comparison ( personal ID comparison): It can be compared with the ID uploaded by the user through historical ID photos or selfies