Reusable KYC(API) (Upcoming)
Enable secure reuse of existing KYC data via API.
1. Usage Steps
Integrating Reusable KYC involves a straightforward flow between the Donor (who owns the verified user data) and the Recipient (who wants to reuse the data).
Preparation:
- Sign Contract: Both Donor and Recipient sign the Reusable KYC product contract with Advance AI.
- Enable Permissions: Advance AI‘s operations team activates the product permissions.
- Partner Setup: The Donor adds the Recipient to their Donor list in the management dashboard. (For now, please contact us to have this added via the backend; a configuration page is not yet available.)
Execution:
-
Generate Token: The Donor calls the
Generate share token API, generating a uniqueshareTokenwith a specified expiry time (tokenSecs, defaulting to 1200 seconds). -
Reuse Profile:The Recipient calls the
Reuse profile API, and reuse the profile after the checks.(1)Import Data: The Recipient calls the
Reuse profile API, passing theshareTokenand their ownlevelId.(2)System Verification: The system automatically runs through all compliance and data checks.
(3)Data Reuse: If successful (
result: Green), the system creates a new profile for the Recipient, copying over the verified data. If failed (result: Red), an error code is returned.
2. How It Works
The product operates based on strict verification rules to ensure compliance and data integrity.
- Profile State Check: The system checks if the Donor's profile is
activeand contains verified info. - Level & Config Check: It verifies whether the Donor's and Recipient's
levelIdconfigurations are compatible. This includes checking if the verification steps align between the two levels. - Document Check: The system thoroughly validates the document data. This includes checking:
- Document Types: Whether the ID types match the Recipient's accepted list.
- Country & Nationality: Whether the issuing country is accepted by the Recipient.
- Age & Expiry: Whether the applicant meets the age criteria and if the document is expired.
- Face Check: The system verifies the liveness (
selfie-liveness) and face match (face-match) results. - Save Profile: Upon passing all checks, the system either creates a new profile or updates an existing one using the
externalUserId.
Note: There is a Preview reuse profile API that follows the exact same validation logic but does not create a profile or charge a fee, allowing for safe integration testing.
3. Current Reusable Scope
In this initial phase, the reusable data is strictly limited to document verification data and face verification data.
- Reusable:
- Document verification data (
Doc Step): ID cards, passports, etc. - Face verification data (
Face Step): Liveness and face match results.
- Document verification data (
- Not Reusable:
-
AML (
AMLStep): AML data doesn't save to profile and will check every time.(Note: If the Recipient's level requires AML, the system will flag it as an error, and requiring a full re-application).
-
4. Request & Response
The core API calls require specific inputs to function correctly:
Generate share token API:- Request:
profileId,accountId,tokenSecs(optional), etc. - Response:
shareToken,accountId.
- Request:
Reuse profile API:- Request:
shareToken,levelId,externalUserId, etc. - Response:
result(Green/Red), and other parameters as the followings:-
Green: Reuse successful. ReturnsprofileId,accountId,externalUserId,status(init/active),info(verified/fixed data),idDocs, andcreatedAt. -
Red: Reuse failed. Returns anerrorcodedetailing the specific failure reason.
-
- Request:
Updated about 1 month ago