Skip to main content

Python SDK for Sparshik KYC API

Project description

Sparshik KYC API: Python SDK & Sample

PyPi Version License

About

The Sparshik API is based on REST principles. It uses standard HTTP response codes and verbs, and token-based authentication. You should use a Content-Type: application/json header with all PUT and POST requests except when uploading documents or live photos. For these requests, use a Content-Type: multipart/form-data header.

Responses return JSON with a consistent structure.

You must make all your requests to the API over HTTPS, with Server Name Indication enabled. Any requests made over HTTP will fail. Text fields support UTF-8.

Getting started

Installation:

pip install sparshik-kyc

For Direct API Usage and Documentation, please refer :

Example

The example used below is used to create an applicant in the database.

import sparshik as sk

TOKEN="Your Authentication Token"
URL="https://api.kyc.sparshik.com/v3/"

sk.BaseUrl.set(URL)
sk.Key.set(TOKEN)

response = sk.applicants.create_applicant(first_name="FIRST NAME", last_name="LAST NAME", email="name.surname@domain.com, phone="+91123456789", dob="1997-03-03", file_path="test.jpg")

print("CREATE APPLICANT RESPONSE : ", "\n", response.json())

Contributing

We welcome contributions. Feel free to file issues and pull requests on the repo and we'll address them as we can.

You can reach out to us anytime with questions and suggestions using our communities below:

Release History

0.1.0 (2020-08-14)

  • Initial Release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sparshik-kyc-0.2.1.tar.gz (8.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sparshik_kyc-0.2.1-py2.py3-none-any.whl (10.6 kB view details)

Uploaded Python 2Python 3

File details

Details for the file sparshik-kyc-0.2.1.tar.gz.

File metadata

  • Download URL: sparshik-kyc-0.2.1.tar.gz
  • Upload date:
  • Size: 8.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.3.2 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.9

File hashes

Hashes for sparshik-kyc-0.2.1.tar.gz
Algorithm Hash digest
SHA256 481da562673c76f67378bba46b59cf95ea6f9bb2f1216d07dbded747b893328d
MD5 65f7d3908cd0cbe7bab31a2af5313ae3
BLAKE2b-256 74e8a7f4e8c480ba2a4fce6959bc29fe314b78b875c659a3c52aacb1b7499cd2

See more details on using hashes here.

File details

Details for the file sparshik_kyc-0.2.1-py2.py3-none-any.whl.

File metadata

  • Download URL: sparshik_kyc-0.2.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 10.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.3.2 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.9

File hashes

Hashes for sparshik_kyc-0.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3c96bfd09cd54a61f961c9d191ff76922ab2370c9643abbc086372ca63547252
MD5 2cc170fa2c3ad233e0fcbe076eb1110e
BLAKE2b-256 607d2fe6f0d8e683a2adaf59d81d57c8fcdabd694cd8b04df7db34b924ff5761

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page