KYC Integration Guide

A simple guide to getting started with KYC integration

This guide outlines the integration process for the Know Your Customer (KYC) flow for partners using the CoinMena fiat-to-crypto payment gateway. The KYC flow is essential for verifying the identity of users and ensuring compliance with regulatory standards.

Note:

  • Webhook Endpoint: Partners must provide a webhook endpoint to receive confirmations.

  • Whitelisting: To use this utilise the flow, the partner must be whitelisted by the CoinMena team, and ensure you have a valid API key and API secret provided by the coinmena team.

Here are the steps for KYC integration process:

  1. User logs into the Partner Platform: Implement a secure login system on your platform where users can enter their credentials.

  2. Phone number and OTP flow: Incorporate a One-Time Password (OTP) mechanism that uses the user's phone number for an additional layer of security during login.

  3. User starts KYC process: Provide a clear and accessible option for users to initiate the KYC process from within their account dashboard.

  4. Basic KYC endpoint is triggered: Call the CoinMena's Basic KYC API endpoint with the collected KYC data to start the verification process, Refer to -> Get Kyc URL.

  5. Partner renders KYC page: Display the KYC form, ensuring it is user-friendly and captures all necessary information accurately, and is sent to coinmena.

  6. KYC status endpoint returns user KYC status: Poll the KYC status endpoint to retrieve the user's KYC verification status, Refer to -> Get KYC Status.

  7. Webhook KYC update: A callback is initiated to the preset webhook endpoint regarding the status of the KYC, Set up the webhook using -> KYC Webhook

  8. Notify User KYC succeeded: If KYC is successful, notify the user promptly, enabling them to proceed with using the platform.

  9. Notify User KYC failed: In case of failure, inform the user and provide options to retry the KYC process or contact support for assistance.

Error Handling

Integrate error handling mechanisms to manage scenarios where the KYC process fails. Ensure that you provide clear error messages and straightforward steps for users to correct their information or try again.

Last updated