decentro-in-kyc
Project description
decentro-in-kyc-python-sdk
KYC & Onboarding
- API version: 1.0.0
- Package version: 4.1.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.1.0
(you may need to run pip with root permission: sudo pip install decentro-in-kyc-python-sdk==4.1.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'},
)
# Image Quality Check
check_image_quality_response = decentro.kyc.check_image_quality(
body = {
"reference_id": "ABCDEF12345",
"consent": False,
"consent_purpose": "For Testing Purpose Only",
"quality_parameter": "all",
},
)
try:
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)
except ApiException as e:
print("Exception when calling CheckImageQualityResponse.check_image_quality: %s\n" % e)
pprint(e.body)
pprint(e.headers)
pprint(e.status)
pprint(e.reason)
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
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
Authentication schemes defined for the API:
module_secret
- Type: API key
- API key parameter name: module_secret
- Location: HTTP header
Author
This Python package is automatically generated by Konfig
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file decentro-in-kyc-python-sdk-4.1.0.tar.gz.
File metadata
- Download URL: decentro-in-kyc-python-sdk-4.1.0.tar.gz
- Upload date:
- Size: 83.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
269a35a3c2f98eed841b318d36e0ac4e2c106e5b2d350be6dcf8fe82edacd5d8
|
|
| MD5 |
c2784a81e051823c7b5894407e9695a5
|
|
| BLAKE2b-256 |
e5c28bdabc32ae3478718ef2f49f05fa9c6bd88a7c65768cfcb520530fbf46ee
|
File details
Details for the file decentro_in_kyc_python_sdk-4.1.0-py3-none-any.whl.
File metadata
- Download URL: decentro_in_kyc_python_sdk-4.1.0-py3-none-any.whl
- Upload date:
- Size: 130.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c2779f327316b89d2c7acc41e36917ec14310c7ec34988314bec240045d85779
|
|
| MD5 |
121f00e162e24b86c3b2ba7870cb6e03
|
|
| BLAKE2b-256 |
5f34df2e9d8f05db5437cdc9df376549ea1d1b17ddfbafe3604015a8aeb55724
|