API Reference
Get StartedExport API CollectionSupport

Developer Quickstart

Welcome to the KYC & Onboarding Developer Quickstart guide.

This document is designed to assist you in integrating Decentro's KYC & Onboarding module into your applications efficiently.

This module offers a comprehensive suite of APIs to streamline customer verification and onboarding processes.

Prerequisites

Before you begin, ensure you have:

  • API Credentials: Obtain your API keys from the Decentro dashboard.
  • Sandbox Access: Access to Decentro's sandbox environment for testing purposes.
  • API Documentation: Familiarity with Decentro's API basics and endpoints.

Integration Steps

  1. Sign Up and Obtain API Keys

    • Register on the Decentro platform.
    • Navigate to the API section in your dashboard to retrieve your API keys.

  2. Understand the API Endpoints

    • Familiarize yourself with the available API endpoints for the KYC & Onboarding module.
    • Note the base URLs for both sandbox and production environments.

  3. Set Up Your Development Environment

    • Configure your application to include the API keys and endpoint URLs.
    • Ensure your application can handle HTTP requests and responses.

  4. Test in Sandbox Environment

    • Use the sandbox environment to test API calls without affecting live data.
    • Refer to the testing credentials provided by Decentro.

  5. Handle API Responses

    • Implement logic to process the data returned by the APIs appropriately.
    • Handle errors and exceptions as per the API documentation.

  6. Move to Production

    • Once testing is successful, switch to the production environment.
    • Replace sandbox API keys with production keys.

Key API Groups in KYC & Onboarding Module

  • Workflows

    • HyperStreams: Automate complex workflows by fetching data from diverse sources, including internal databases and government repositories like DigiLocker.
    • UIStreams: Generate dynamic user interfaces that guide users through tailored workflows, prompting them for necessary information while automatically fetching relevant documents.

  • Farsight

    • Document Forensics: Classify and extract information from various document types, assess document quality, and detect alterations or forgeries.
    • Face Forensics: Perform passive face liveness tests and face match tests to verify identity.
    • Data Forensics: Conduct name matching, text matching, and geolocation matching to enhance data accuracy.

  • Identities

    • Aadhaar Services: Verify Aadhaar numbers without OTP, retrieve Aadhaar XML, and access upgraded Aadhaar XML.
    • Verification Services: Validate customer, business, and employment information, and convert IDs.
    • DigiLocker Services: Access DigiLocker documents and enable Single Sign-On (SSO) for DigiLocker.
    • CKYC Services: Search, download, and upload CKYC information for individuals and legal entities.

Best Practices

  • Security: Keep your API keys confidential and rotate them periodically.
  • Error Handling: Implement robust error handling to manage API response errors gracefully.
  • Compliance: Ensure your application complies with relevant data protection regulations when handling user data.

For detailed information on each API, refer to the KYC & Onboarding Overview and Guide.

If you encounter any issues or have questions, consult the Decentro FAQs or contact Decentro's support team for assistance.