{
    "info": {
        "author": "",
        "author_email": "",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "## OST KYC Python SDK\n\nThe official [OST KYC SDK](https://dev.ost.com/docs/kyc/index.html).\n\n## Requirements\n\nTo use this node module, developers will need to:\n1. Login on [https://kyc.ost.com/admin/login](https://kyc.ost.com/admin/login).\n2. Obtain an API Key and API Secret from [https://kyc.ost.com/admin/settings/developer-integrations](https://kyc.ost.com/admin/settings/developer-integrations).\n\n## Documentation\n\n[https://dev.ost.com/docs/kyc](https://dev.ost.com/docs/kyc/index.html)\n\n## Installation\n\nInstall OST KYC Python SDK\n\n```bash\n> pip install ost_kyc_sdk_python\n```\n\n## Example Usage\n\nRequire the SDK:\n\n```python\nimport ost_kyc_sdk_python\n```\n\nInitialize the SDK object:\n\n```python\n// the latest valid API endpoint is \"https://kyc.sandboxost.com\", this may change in the future\nkyc_sdk = ost_kyc_sdk_python.Services({'api_key': <api_key>, 'api_secret': <api_secret>, 'api_base_url': <api_secret>, \n'config': {'timeout': <desired_timeout_in_secs> }})\n\nHere timeout for requests can be passed inside config, timeout is in seconds (default is 15 secs). \n```\n\n### Users Module \n\n```python\nusers_service = kyc_sdk.services.users\n```\n\nCreate a new user:\n\n```python\nr = users_service.create({'email': 'alice+1@ost.com'})\nprint (r)\n```\n\nGet an existing user:\n\n```python\nr = users_service.get({'id': '11003'})\nprint (r)\n```\n\nGet a list of users and other data:\n\n```python\nr = users_service.list()\nprint (r)\n```\n\n### Users KYC module \n\n```python\nusers_kyc_service = kyc_sdk.services.users_kyc\n```\n\nSubmit KYC:\n\n```python\nr = users_kyc_service.submit_kyc({'user_id': 11035, 'first_name':'aniket','last_name':'ayachit', 'birthdate':'21/12/1991', 'country':'india', 'nationality':'indian', 'document_id_number':'arqpa7659a','document_id_file_path':'2/i/016be96da275031de2787b57c99f1471', 'selfie_file_path':'2/i/9e8d3a5a7a58f0f1be50b7876521aebc', 'residence_proof_file_path':'2/i/4ed790b2d525f4c7b30fbff5cb7bbbdb', 'ethereum_address': '0xdfbc84ccac430f2c0455c437adf417095d7ad68e', 'estimated_participation_amount':'2', 'street_address':'afawfveav ','city':'afawfveav', 'state':'afawfveav','postal_code':'afawfveav','investor_proof_files_path':['2/i/9ff6374909897ca507ba3077ee8587da', '2/i/4872730399670c6d554ab3821d63ebce']})\nprint (r)\n```\n\nList Users KYC:\n\n```python\nr = users_kyc_service.list()\nprint (r)\n```\n\nGet Users KYC\n\n```python\nr = users_kyc_service.get({'user_id':11003})\nprint (r)\n```\n\nGet PUT Presigned url\n\n```python\nr = users_kyc_service.get_pre_signed_url_put ({'files': {\n    'residence_proof': 'application/pdf',\n    'investor_proof_file1': 'application/pdf',\n    'investor_proof_file2': 'application/pdf',\n    'document_id': 'image/jpeg',\n    'selfie': 'image/jpeg'\n}})\nprint (r)\n```\n\nGet POST Presigned url\n\n```python\nr = users_kyc_service.get_pre_signed_url_post ({'files': {\n    'residence_proof': 'application/pdf',\n    'investor_proof_file1': 'application/pdf',\n    'investor_proof_file2': 'application/pdf',\n    'document_id': 'image/jpeg',\n    'selfie': 'image/jpeg'\n}})\nprint (r)\n```\n\nSend KYC approve email\n\n```python\nr = users_kyc_service.email_approve({'user_id': 11003})\nprint (r)\n\n```\n\n\nSend KYC deny email\n\n```python\nr = users_kyc_service.email_deny({'user_id': 11003})\nprint (r)\n\n```\n\nSend KYC report issue email\n\n```python\nr = users_kyc_service.email_report_issue({'user_id': 11003})\nprint (r)\n\n```\n\n\n\n### Users KYC details Module \n\n```python\nusers_kyc_details_service = kyc_sdk.services.users_kyc_details\n```\n\nGet user's kyc details\n\n```python\nr = users_kyc_details_service.get({'user_id':11003})\nprint (r)\n```\n\n### Validation Module \n\n```python\nvalidator_service = kyc_sdk.services.validators\n```\n\nVerify ethereum address\n\n```python\n r = validator_service.verify_ethereum_address({'ethereum_address': '0x32be343b94f860124dc4fee278fdcbd38c102d88'})\n print (r)\n\n ```\n\n Note: If user want to use non english characters in Python 2, write ```# -*- coding: utf-8 -*- ``` at the beginning of the file.\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/ostdotcom/ost-kyc-sdk-python",
        "keywords": "",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "ost-kyc-sdk-python",
        "package_url": "https://pypi.org/project/ost-kyc-sdk-python/",
        "platform": "",
        "project_url": "https://pypi.org/project/ost-kyc-sdk-python/",
        "project_urls": {
            "Homepage": "https://github.com/ostdotcom/ost-kyc-sdk-python"
        },
        "release_url": "https://pypi.org/project/ost-kyc-sdk-python/2.0.2/",
        "requires_dist": [
            "requests"
        ],
        "requires_python": "",
        "summary": "OST KYC SDK in python",
        "version": "2.0.2"
    },
    "last_serial": 4878555,
    "releases": {
        "2.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "411b7206496a9afe32dc876be2a17027",
                    "sha256": "6c0b7747d11179f43dc5b3d78a74695fb05783161e5823fe723e7da561e4c93b"
                },
                "downloads": -1,
                "filename": "ost_kyc_sdk_python-2.0.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "411b7206496a9afe32dc876be2a17027",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 10173,
                "upload_time": "2018-12-12T06:46:26",
                "url": "https://files.pythonhosted.org/packages/a9/93/18eb2d398fb66c932fcaa7f03a12191ec7729d10608cf7e90461376a3f78/ost_kyc_sdk_python-2.0.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "65fa05f7954d5e4c31c17b641d0e79b1",
                    "sha256": "3cdb343eafec43f4ea1ed941d878edc64fec2b81c2a789b1a99ddca5d1c0ed85"
                },
                "downloads": -1,
                "filename": "ost_kyc_sdk_python-2.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "65fa05f7954d5e4c31c17b641d0e79b1",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6611,
                "upload_time": "2018-12-12T06:46:27",
                "url": "https://files.pythonhosted.org/packages/02/b4/1c012f2183ced3940c867b350c95b647ee40a38e8fad6b697d22170f2263/ost_kyc_sdk_python-2.0.0.tar.gz"
            }
        ],
        "2.0.0b0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f06ccdd83495927ba480b8c050c271ac",
                    "sha256": "432966db9030b55d1eb62a1879df6dbaba3224af68d952e1ee2f22c9004eb346"
                },
                "downloads": -1,
                "filename": "ost_kyc_sdk_python-2.0.0b0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "f06ccdd83495927ba480b8c050c271ac",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 10193,
                "upload_time": "2018-12-11T12:20:38",
                "url": "https://files.pythonhosted.org/packages/6a/61/3311cd536cb9759a7b784968fd637fffe46fb7ceab07c6f01e0b675c246f/ost_kyc_sdk_python-2.0.0b0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "ffe96bd064ebce574da4dcaf43a38ac3",
                    "sha256": "8494e1f153c8fc3633984579b1f596eddf436ee1a62551e74169b008365a3679"
                },
                "downloads": -1,
                "filename": "ost_kyc_sdk_python-2.0.0b0.tar.gz",
                "has_sig": false,
                "md5_digest": "ffe96bd064ebce574da4dcaf43a38ac3",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6619,
                "upload_time": "2018-12-11T12:20:39",
                "url": "https://files.pythonhosted.org/packages/6f/ff/76f49e8e997751bb1d68916b8be0fc7abfd503471691b3c1e333a4748c67/ost_kyc_sdk_python-2.0.0b0.tar.gz"
            }
        ],
        "2.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "80c491afc691f385ced0f944c3e0b3fe",
                    "sha256": "ca1305138d56a72c158b490345817a657e6f264afdb937c7594e512032e93ba7"
                },
                "downloads": -1,
                "filename": "ost_kyc_sdk_python-2.0.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "80c491afc691f385ced0f944c3e0b3fe",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 10255,
                "upload_time": "2019-01-07T07:53:06",
                "url": "https://files.pythonhosted.org/packages/2c/db/455062addc73171fbb81c146ab493a3112c4473da2d7279915c389ed56c7/ost_kyc_sdk_python-2.0.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "b0657cf894318de3f511630c8fcd265d",
                    "sha256": "5809ba824a16da77b73467da2a8416761cd8c00f21cf2d843da1f6000bd8745f"
                },
                "downloads": -1,
                "filename": "ost_kyc_sdk_python-2.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "b0657cf894318de3f511630c8fcd265d",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7612,
                "upload_time": "2019-01-07T07:53:09",
                "url": "https://files.pythonhosted.org/packages/bf/a8/0c229e1da1719db6444ef754969284486771c4ca37a50d163f887765849d/ost_kyc_sdk_python-2.0.1.tar.gz"
            }
        ],
        "2.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "079ad3cab7f6ba4c1ebc16f5e5dbb54d",
                    "sha256": "c2cfb669f526dbeb3dd478adc2deb097b3d23c3836d8496864ee2e16c08bcda3"
                },
                "downloads": -1,
                "filename": "ost_kyc_sdk_python-2.0.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "079ad3cab7f6ba4c1ebc16f5e5dbb54d",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 10242,
                "upload_time": "2019-02-28T10:10:42",
                "url": "https://files.pythonhosted.org/packages/f3/69/67f3cdc95f2178142efc33578b6e2482a1d11a0fc2c09d2ea4daab0b2142/ost_kyc_sdk_python-2.0.2-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "faf5134c19028d117c42a2f852c78151",
                    "sha256": "0b88a06f08b8d2fad7c35b6a77bd0c4f9ff9a527819f450c45f0ccea98df26b7"
                },
                "downloads": -1,
                "filename": "ost_kyc_sdk_python-2.0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "faf5134c19028d117c42a2f852c78151",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7593,
                "upload_time": "2019-02-28T10:10:45",
                "url": "https://files.pythonhosted.org/packages/e5/41/55948448bbfe9e353591c2c73c6b7f207e0f70e979b3c0add30e6fb477c4/ost_kyc_sdk_python-2.0.2.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "079ad3cab7f6ba4c1ebc16f5e5dbb54d",
                "sha256": "c2cfb669f526dbeb3dd478adc2deb097b3d23c3836d8496864ee2e16c08bcda3"
            },
            "downloads": -1,
            "filename": "ost_kyc_sdk_python-2.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "079ad3cab7f6ba4c1ebc16f5e5dbb54d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 10242,
            "upload_time": "2019-02-28T10:10:42",
            "url": "https://files.pythonhosted.org/packages/f3/69/67f3cdc95f2178142efc33578b6e2482a1d11a0fc2c09d2ea4daab0b2142/ost_kyc_sdk_python-2.0.2-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "faf5134c19028d117c42a2f852c78151",
                "sha256": "0b88a06f08b8d2fad7c35b6a77bd0c4f9ff9a527819f450c45f0ccea98df26b7"
            },
            "downloads": -1,
            "filename": "ost_kyc_sdk_python-2.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "faf5134c19028d117c42a2f852c78151",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 7593,
            "upload_time": "2019-02-28T10:10:45",
            "url": "https://files.pythonhosted.org/packages/e5/41/55948448bbfe9e353591c2c73c6b7f207e0f70e979b3c0add30e6fb477c4/ost_kyc_sdk_python-2.0.2.tar.gz"
        }
    ]
}