decentro-in-kyc-typescript-sdk

decentro-in-kyc-typescript-sdk@1.0.2

KYC & Onboarding

Installing

npm

npm install decentro-in-kyc-typescript-sdk --save

yarn

yarn add decentro-in-kyc-typescript-sdk

Important note: this library is can be used in both the client-side or server-side, but using it in client-side browser code is not recommended as you would expose security credentials.

File Upload from Browser

This SDK supports uploading files from the browser, see example usage in a React App here.

Getting Started

import { Decentro } from "decentro-in-kyc-typescript-sdk";

const decentro = new Decentro({
  // Defining the base path is optional and defaults to https://in.staging.decentro.tech
  // basePath: "https://in.staging.decentro.tech",
  client_id: "API_KEY",
  client_secret: "API_KEY",
  module_secret: "API_KEY",
});

const checkImageQualityResponse = await decentro.kyc.checkImageQuality({
  reference_id: "ABCDEF12345",
  consent: false,
  consent_purpose: "For Testing Purpose Only",
  quality_parameter: "all",
});

console.log(checkImageQualityResponse);

Documentation for API Endpoints

All URIs are relative to https://in.staging.decentro.tech

Class	Method	HTTP request	Description
KycApi	checkImageQuality	POST /v2/kyc/forensics/image_quality	Image Quality Check
KycApi	checkPhotocopy	POST /v2/kyc/forensics/photocopy_check	Photocopy Check
KycApi	checkVideoLiveness	POST /v2/kyc/forensics/video_liveness	Liveness Check
KycApi	classifyDocument	POST /v2/kyc/document_classification	ID Classification
KycApi	extractText	POST /kyc/scan_extract/ocr	Scan & Extract
KycApi	maskAadhaarUid	POST /v2/kyc/identities/mask_aadhaar_uid	Aadhaar Masking
KycApi	matchFace	POST /v2/kyc/forensics/face_match	Face Match
KycApi	validate	POST /kyc/public_registry/validate	Validate