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.0.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.0-py2.py3-none-any.whl (10.6 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: sparshik-kyc-0.2.0.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.0.tar.gz
Algorithm Hash digest
SHA256 b2b7419fc4e9e1f2347d74dc8ef77519a169c24e918895707c5afe20faae3666
MD5 21ac08eca5e7a5cb1dca6102e8870f40
BLAKE2b-256 d4854ef9b685c46e6f5edf0616182811a92237b521296194bada639220999bda

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sparshik_kyc-0.2.0-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.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8eef5b127f8759b7ec6c8af3458db1f5734e0d5549a5bd0b1156c1cd423dd72c
MD5 b8248bd1a9a88ac1bd15a0e46c8b1bec
BLAKE2b-256 d43198aa4eee67c6b59836b5db3775c92443737bb593d31145149bdec1164c6a

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