{"id":36573125,"url":"https://github.com/ostdotcom/ost-kyc-sdk-python","last_synced_at":"2026-01-12T07:20:19.311Z","repository":{"id":57449773,"uuid":"157679245","full_name":"ostdotcom/ost-kyc-sdk-python","owner":"ostdotcom","description":"OST KYC SDK for Python","archived":false,"fork":false,"pushed_at":"2020-09-15T11:28:16.000Z","size":66,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":5,"default_branch":"develop","last_synced_at":"2025-09-28T23:16:48.271Z","etag":null,"topics":["kyc","kyc-service","openst","ost","ost-kyc-sdk","python","users-kyc"],"latest_commit_sha":null,"homepage":"https://kyc.ost.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ostdotcom.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-11-15T08:41:51.000Z","updated_at":"2020-09-15T11:28:31.000Z","dependencies_parsed_at":"2022-09-26T17:31:20.646Z","dependency_job_id":null,"html_url":"https://github.com/ostdotcom/ost-kyc-sdk-python","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/ostdotcom/ost-kyc-sdk-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ostdotcom%2Fost-kyc-sdk-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ostdotcom%2Fost-kyc-sdk-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ostdotcom%2Fost-kyc-sdk-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ostdotcom%2Fost-kyc-sdk-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ostdotcom","download_url":"https://codeload.github.com/ostdotcom/ost-kyc-sdk-python/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ostdotcom%2Fost-kyc-sdk-python/sbom","scorecard":{"id":713915,"data":{"date":"2025-08-11","repo":{"name":"github.com/ostdotcom/ost-kyc-sdk-python","commit":"095d789e11a48a1578c73370cf88170196e7ebae"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.2,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":5,"reason":"Found 5/10 approved changesets -- score normalized to 5","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.txt:0","Info: FSF or OSI recognized license: MIT License: LICENSE.txt:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-22T08:56:32.079Z","repository_id":57449773,"created_at":"2025-08-22T08:56:32.083Z","updated_at":"2025-08-22T08:56:32.083Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28336499,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T06:09:07.588Z","status":"ssl_error","status_checked_at":"2026-01-12T06:05:18.301Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["kyc","kyc-service","openst","ost","ost-kyc-sdk","python","users-kyc"],"created_at":"2026-01-12T07:20:18.829Z","updated_at":"2026-01-12T07:20:19.305Z","avatar_url":"https://github.com/ostdotcom.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"## 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\u003e 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': \u003capi_key\u003e, 'api_secret': \u003capi_secret\u003e, 'api_base_url': \u003capi_secret\u003e, \n'config': {'timeout': \u003cdesired_timeout_in_secs\u003e }})\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.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fostdotcom%2Fost-kyc-sdk-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fostdotcom%2Fost-kyc-sdk-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fostdotcom%2Fost-kyc-sdk-python/lists"}