API Reference
Get StartedExport API CollectionSupport

Developer Quickstart

Welcome to the Scanner Developer Quickstart guide.

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

The Scanner module offers advanced machine learning and computer vision capabilities, providing actionable insights from data retrieved through Decentro's KYC & Onboarding and Bytes modules.

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 Scanner 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 Scanner Module

  • Document Forensics

    • OCR and Document Data Extraction: Extract text and data from various document types.

    • Aadhaar Masking: Automatically mask sensitive information on Aadhaar documents.

    • Document Classification: Identify and classify document types.

    • Forged Document Check: Detect alterations or forgeries in documents.

    • Document Quality Check: Assess the quality of scanned documents to ensure readability.

  • Data Forensics

    • Name Matching: Perform name matching, including phonetic matching and automatic salutation removal.

    • Text Matching: Conduct text matching with phonetic matching capabilities.

    • Geolocation Matching: Compare and match geolocation data.

  • Face Forensics

    • Passive Face Liveness Test (Image Input): Determine if a face in an image is live.

    • Passive Face Liveness Test (Video Input): Assess liveness from video input.

    • Face Match Test: Compare two facial images to verify identity.

  • Intelligence Suite

    • Mule Detector API: Identify potential mule accounts or fraudulent activities.

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 Scanner Overview and Guide.

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