Summary

1. Create the User: Register a new user using the Create User endpoint.
2. Generate KYC Link: Use the Generate KYC Link endpoint to generate a KYC link for the user.
   1. Implement the KYC Link: Embed the link in your application and guide users to complete their KYC.
   2. Get KYC Information: Get the KYC Information with the Get KYC Details endpoint.
   3. Handle Webhook Responses: Set up your system to handle webhook notifications from Capa, acting on the KYC verification results. Use the 📣 Webhooks guide
3. Send KYC Information: If you already have the user KYC'd send us that information with the Send User KYC Information endpoint

By following these steps, you can successfully onboard and verify users, ensuring compliance with regulatory requirements while providing a smooth user experience.

Create the User

To onboard a new user into your system, you first need to register them with the Capa API. Here’s how the process works:

1. Send a Request to Create a User

   • Make a POST request to the User Endpoint /api/partner/v1/user with the necessary user information, such as externalUserId, method, and identifier.
   • The externalUserId is your own unique identifier for this user, ensuring we make your user as unique as posible.
   • The method defines how you intend to authenticate the user (e.g., by EMAIL, PHONE_NUMBER, or NONE).

2. Receive the User ID

   • Upon successful creation, Capa will return a unique userId for the newly created user. This userId is required for generating the KYC verification link in the next step.

3. Store the User ID

   • Save the returned userId in your system, linking it to your own externalUserId. This userId will be used whenever you need to perform actions related to this user, such as KYC verification.

Complete User KYC

📘

NOTE: For the KYC you have two options Generate KYC Verification Link or Send the KYC Information Directly

Generate KYC Verification Link with our Provider

Once you have successfully created a user, the next step is to generate a KYC verification link. This link allows the user to complete the Know Your Customer (KYC) process, which is required for regulatory compliance.

1. Generate Link

1. Prepare the KYC Verification Request

   • Use the userId obtained from the user creation step.
   • Determine the country in which the user resides or where the verification is needed. Ensure the country code is compliant with the supported countries in the Capa API.
   • If the country is "MX" (Mexico), gather additional personal information required by local regulations, such as profession, phoneNumber, and birthCountry.

2. Send a Request to Generate the KYC Link

   • Make a POST request to the Generate KYC Link Endpoint/api/partner/v2/kyc/verification-link endpoint with the required parameters (userId, country, and any necessary personal information).

3. Receive the KYC Link

   • Upon successful submission, Capa will return a direct kycLink for the user. This link directs the user to a secure Metamap webpage where they can complete the KYC process.

4. Distribute the KYC Link to the User

   • Share the kycLink with the user via email, SMS, or within your app. Provide clear instructions on how to use the link to complete the KYC verification.

2. Implement the KYC Link on Your Platform

1. Embed the KYC Link in Your User Interface

   • Use the kycLink in your website or application to create a button or hyperlink that users can click to start their KYC verification.
   • Example:
   HTML

   <button onclick="window.location.href='https://example.com/kyc-link';">
     Complete Your KYC Verification
   </button>
   

2. Guide the User Through the KYC Process

   • Ensure the user knows they will be redirected to a third-party webpage (Metamap) for KYC verification. Provide any necessary guidance to help them complete the process smoothly.

3. Get KYC Information

To get the KYC Information on demand use the Get KYC Details endpoint to obtain all of the information from the user's KYC including the status. This is an optional step since you will be able to get the information through the webhook too.

4. Handle the Webhook Verification Response

Follow the 📣 Webhooks for more information

1. Receive the Webhook Notification

   • After the user completes the KYC process, Capa will send a verification response to your system via a webhook. This response will contain the result of the KYC process.

2. Process the Webhook Data

   • Set up your system to handle incoming webhook notifications. Verify the authenticity of the webhook by checking the signature included in the header and process the KYC status accordingly (e.g., update the user's verification status in your database).

3. Act on the Verification Result

   • Based on the result from the webhook, take appropriate action:
     • If Verified: Grant access to features or services that require a verified status.
     • If Rejected: Notify the user and provide instructions on how to retry the verification process.
     • If Further Review is Needed: Follow up as required to assist the user through any manual review processes.
       
       

Send the KYC Information Directly

If you already KYC yours users, don't worry we can receive that information in Capa so they dont need to redo the verification process

Send verification from already Send KYC Information Endpoint