decentro-in-kyc-python-sdk 4.2.0

decentro-in-kyc

decentro-in-kyc-python-sdk

KYC & Onboarding

• API version: 1.0.0
• Package version: 4.2.0 For more information, please visit https://decentro.tech

Requirements.

Python >=3.7

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install decentro-in-kyc-python-sdk==4.2.0

(you may need to run pip with root permission: sudo pip install decentro-in-kyc-python-sdk==4.2.0)

Then import the package:

import decentro_in_kyc_client

Getting Started

Please follow the installation procedure and then run the following:

from pprint import pprint
from decentro_in_kyc_client import Decentro

decentro = Decentro(
    # Defining the host is optional and defaults to https://in.staging.decentro.tech
    # See configuration.py for a list of all supported configuration parameters.
    host = "https://in.staging.decentro.tech",

    # Configure API key authorization: client_id
    client_id = 'YOUR_API_KEY',
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # api_key_prefix = {'client_id': 'Bearer'},

    # Configure API key authorization: client_secret
    client_secret = 'YOUR_API_KEY',
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # api_key_prefix = {'client_secret': 'Bearer'},

    # Configure API key authorization: module_secret
    module_secret = 'YOUR_API_KEY',
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # api_key_prefix = {'module_secret': 'Bearer'},
)

body = {
        "reference_id": "ABCDEF12345",
        "consent": False,
        "consent_purpose": "For Testing Purpose Only",
        "quality_parameter": "all",
    }
try:
    # Image Quality Check
    check_image_quality_response = decentro.kyc.check_image_quality(
        body=body
    )
    pprint(check_image_quality_response.body)
    pprint(check_image_quality_response.body["decentroTxnId"])
    pprint(check_image_quality_response.body["status"])
    pprint(check_image_quality_response.body["responseCode"])
    pprint(check_image_quality_response.body["message"])
    pprint(check_image_quality_response.body["data"])
    pprint(check_image_quality_response.headers)
    pprint(check_image_quality_response.status)
    pprint(check_image_quality_response.round_trip_time)
except ApiException as e:
    print("Exception when calling CheckImageQualityResponse.check_image_quality: %s\n" % e)
    pprint(e.body)
    if e.status == 400:
        pprint(e.body["decentroTxnId"])
        pprint(e.body["status"])
        pprint(e.body["responseCode"])
        pprint(e.body["message"])
    pprint(e.headers)
    pprint(e.status)
    pprint(e.reason)
    pprint(e.round_trip_time)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
KYCApi	check_image_quality	post /v2/kyc/forensics/image_quality	Image Quality Check
KYCApi	check_photocopy	post /v2/kyc/forensics/photocopy_check	Photocopy Check
KYCApi	check_video_liveness	post /v2/kyc/forensics/video_liveness	Liveness Check
KYCApi	classify_document	post /v2/kyc/document_classification	ID Classification
KYCApi	extract_text	post /kyc/scan_extract/ocr	Scan & Extract
KYCApi	mask_aadhaar_uid	post /v2/kyc/identities/mask_aadhaar_uid	Aadhaar Masking
KYCApi	match_face	post /v2/kyc/forensics/face_match	Face Match
KYCApi	validate	post /kyc/public_registry/validate	Validate

Documentation For Models

• CheckImageQuality400Response
• CheckImageQualityRequest
• CheckImageQualityResponse
• CheckPhotocopy400Response
• CheckPhotocopyRequest
• CheckPhotocopyResponse
• CheckVideoLiveness400Response
• CheckVideoLivenessRequest
• CheckVideoLivenessResponse
• ClassifyDocument400Response
• ClassifyDocumentRequest
• ClassifyDocumentResponse
• ExtractText400Response
• ExtractTextRequest
• ExtractTextResponse
• MaskAadhaarRequest
• MaskAadhaarResponse
• MaskAadhaarUidResponse
• MatchFace400Response
• MatchFaceRequest
• MatchFaceResponse
• Validate400Response
• ValidateRequest
• ValidateResponse

Documentation For Authorization

Authentication schemes defined for the API:

client_id

• Type: API key
• API key parameter name: client_id
• Location: HTTP header

client_secret

• Type: API key
• API key parameter name: client_secret
• Location: HTTP header

module_secret

• Type: API key
• API key parameter name: module_secret
• Location: HTTP header