Skip to main content

Python SDK for Privy Digital Signature

Project description

Privy Python SDK

Python SDK for Privy Digital Signature https://console.privy.id/

API Documentation

Please check Privy Api Reference.

Requirements

Python 3.7 or later

Installation

pip install privy-python-sdk

Usage

Initialization

from privy_python_sdk.privy import Privy

prv = Privy(
    privy_enterprise_token="key-123",
    privy_merchant_key="xxxxxxxxxxxxx",
    privy_username="foo",
    privy_password="bar",
    privy_id='TE1111',
    production=False
)

Privy User Registration

Args:

  • email string - User's email
  • phone string - User's phone (e.g: 08233324223)
  • selfie string - Close up photo of registrant (.png, .jpg, or .jpeg)
  • ktp string - KTP Photo of the user (.png, .jpg, or .jpeg)
  • nik string - NIK must be 16 digits and the sixteenth digit can't be 0
  • name string - name of the user
  • date_of_birth string - date of birth of the user (1983-01-02)

Returns:
Return reference https://console.privy.id/documentation#registration

prv.register_user(
        date_of_birth="1983-01-02",
        email="foo@bar.com",
        ktp="/upload/ktp.jpg",
        selfie="/upload/selfie.jpg",
        name="foo bar",
        nik="1234567891234567",
        phone="08233324223"
)

Get User's Registration Status

Check registration status of user.

Args:

  • token string - User's token from Registration API

Returns:
Return reference https://console.privy.id/documentation#check-registration-status

prv.register_status(token="b3lkdfaoir0294058klkadfk45qeorlkldakfgh")

Upload Document

Args:

  • title string - title of the document
  • document_path string - path of the document
  • recipient string - recipient of the document
  • owner string - owner of the document

Returns:
Return reference https://console.privy.id/documentation#upload-document

prv.upload_document(
        document_path="/upload/document.jpg",
        title="foo bar",
        recipient="LA1234"
    )

Get Document Status

Args:

  • doc_Token string - Document's token

Returns:
Return reference https://console.privy.id/documentation#check-document-status

prv.document_status(
        doc_token="b3lkdfaoir0294058klkadfk45qeorlkldakfgh"
    )

Update Data

for invalid or rejected user who wants to update their data and reregister

  1. Update Data KTP

    prv.reregister_ktp(
            ktp="/upload/ktp.jpg",
            user_token="b3lkdfaoir0294058klkadfk45qeorlkldakfgh"
        )
    
  2. Update Data Selfie

    prv.reregister_selfie(
            selfie="/upload/selfie.jpg",
            user_token="b3lkdfaoir0294058klkadfk45qeorlkldakfgh"
        )
    
  3. Update Data File Support

    prv.reregister_file_support(
            file_support="/upload/KK.jpg",
            file_support_category="KK",
            user_token="b3lkdfaoir0294058klkadfk45qeorlkldakfgh"
        )
    

License

privy-python-sdk is released under the MIT License. Check License file for detail.

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

privy_python_sdk-1.0.7.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

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

privy_python_sdk-1.0.7-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

Details for the file privy_python_sdk-1.0.7.tar.gz.

File metadata

  • Download URL: privy_python_sdk-1.0.7.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.9.15 Linux/5.15.0-1022-azure

File hashes

Hashes for privy_python_sdk-1.0.7.tar.gz
Algorithm Hash digest
SHA256 4296423dbc3f6095be31c1806a0f6e610176ec595115d9ae8d4e1382191f201f
MD5 9d2e434b4620d55abf237dd30858c9e6
BLAKE2b-256 0676e869b9895fd128da27c104d97b319ec4969ef10d5d4f9cf636fdb181c6e5

See more details on using hashes here.

File details

Details for the file privy_python_sdk-1.0.7-py3-none-any.whl.

File metadata

  • Download URL: privy_python_sdk-1.0.7-py3-none-any.whl
  • Upload date:
  • Size: 4.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.9.15 Linux/5.15.0-1022-azure

File hashes

Hashes for privy_python_sdk-1.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 d407197e9e885832bc61a4fcaf0ddbde3e94073de135b10ef5110fbd8ebdd806
MD5 41affd9fd358268326d5677df2ba3791
BLAKE2b-256 e6bdb638e210bbffd56aec52799331b51db9e869282221185847cde319a27fed

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