{"id":36573295,"url":"https://github.com/ostdotcom/ost-kyc-sdk-java","last_synced_at":"2026-01-12T07:20:39.380Z","repository":{"id":57728203,"uuid":"158654378","full_name":"ostdotcom/ost-kyc-sdk-java","owner":"ostdotcom","description":"OST KYC SDK for Java","archived":false,"fork":false,"pushed_at":"2020-09-15T10:00:59.000Z","size":59,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":5,"default_branch":"develop","last_synced_at":"2025-08-15T11:02:35.241Z","etag":null,"topics":["java","kyc","kyc-service","openst","ost","ost-kyc-sdk","user-kyc"],"latest_commit_sha":null,"homepage":"https://kyc.ost.com","language":"Java","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","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-11-22T06:46:39.000Z","updated_at":"2020-09-15T09:59:29.000Z","dependencies_parsed_at":"2022-09-12T21:00:34.363Z","dependency_job_id":null,"html_url":"https://github.com/ostdotcom/ost-kyc-sdk-java","commit_stats":null,"previous_names":["openstfoundation/ost-kyc-sdk-java"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/ostdotcom/ost-kyc-sdk-java","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ostdotcom%2Fost-kyc-sdk-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ostdotcom%2Fost-kyc-sdk-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ostdotcom%2Fost-kyc-sdk-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ostdotcom%2Fost-kyc-sdk-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ostdotcom","download_url":"https://codeload.github.com/ostdotcom/ost-kyc-sdk-java/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ostdotcom%2Fost-kyc-sdk-java/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28336500,"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":["java","kyc","kyc-service","openst","ost","ost-kyc-sdk","user-kyc"],"created_at":"2026-01-12T07:20:39.326Z","updated_at":"2026-01-12T07:20:39.374Z","avatar_url":"https://github.com/ostdotcom.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OST KYC JAVA SDK\nThe official [OST KYC JAVA SDK](https://dev.ost.com/docs/kyc/index.html).\n\n\n[![Travis](https://travis-ci.org/ostdotcom/ost-kyc-sdk-java.svg?branch=master)](https://travis-ci.org/ostdotcom/ost-kyc-sdk-java)\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/index.html](https://dev.ost.com/docs/kyc/index.html)\n\n## Installation\n\n### Maven users\n#### Add this dependency to your project's POM:\n```xml\n\u003cdependency\u003e\n\u003cgroupId\u003ecom.ost\u003c/groupId\u003e\n\u003cartifactId\u003eost-kyc-sdk-java\u003c/artifactId\u003e\n\u003cversion\u003e2.0.4\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n### Building from source using Maven\n\nClone the repository\n```bash\ngit clone https://github.com/ostdotcom/ost-kyc-sdk-java.git\ncd ost-kyc-sdk-java\n```\n\n\nPackage using MVN (without dependencies)\n```bash\nmvn clean pacakge -DskipTests\n```\n\nWith dependencies\n```bash\nmvn clean compile assembly:single -DskipTests\n```\n\nThe jar file can be found in the target folder.\n\n## Example Usage\n\n\nInitialize the SDK object:\n\n```java\n// the latest valid API endpoint is \"https://kyc.sandboxost.com\", this may change in the future\nHashMap \u003cString,Object\u003e sdkConfig = new HashMap\u003cString,Object\u003e();\nsdkConfig.put(\"apiEndpoint\",\"[API_ENDPOINT]\");\nsdkConfig.put(\"apiKey\",\"[YOUR_API_KEY]\");\nsdkConfig.put(\"apiSecret\",\"[YOUR_API_SECRET]\");\n\n\n// The config field is optional for sdkConfig Object\nHashMap \u003cString,Object\u003e nestedparam = new HashMap\u003cString,Object\u003e();\n// This is the timeout in seconds for which the socket connection will remain open\n// The value of timeout will always be of type long\nnestedparam.put(\"timeout\", (long) 15);\nsdkConfig.put(\"config\", nestedparam);\n\n\nOSTKYCSDK ostObj = new OSTKYCSDK(sdkConfig);\ncom.ost.kyc.services.v2.Manifest services = (com.ost.kyc.services.v2.Manifest) ostObj.services;\n```\n\n### Users Module\n\n```java\ncom.ost.kyc.services.v2.User userService = services.user;\n```\n\nCreate a new user:\n\n```java\nHashMap \u003cString, Object\u003e params = new HashMap\u003cString, Object\u003e();\nparams.put(\"email\", \"email@domain.com\");\nJsonObject response = userService.create( params );\nSystem.out.println(\"response: \" + response.toString() );\n```\n\nGet an existing user:\n\n```java\nHashMap \u003cString,Object\u003e params = new HashMap\u003cString,Object\u003e();\nparams.put(\"id\", \"11007\");\nJsonObject response = userService.get( params );\nSystem.out.println(\"response: \" + response.toString() );\n```\n\nGet a list of existing users and other data:\n\n```java\nHashMap \u003cString,Object\u003e params = new HashMap\u003cString,Object\u003e();\nJsonObject response = userService.list( params );\nSystem.out.println(\"response: \" + response.toString() );\n```\n\n### UsersKyc Module\n\n```java\ncom.ost.kyc.services.v2.UsersKyc usersKycService = services.usersKyc;\n```\n\nGet an existing user kyc:\n\n```java\nHashMap \u003cString,Object\u003e params = new HashMap\u003cString,Object\u003e();\nparams.put(\"user_id\", \"11007\");\nJsonObject response = usersKycService.get( params );\nSystem.out.println(\"response: \" + response.toString() );\n```\n\nCreate/Update a new user kyc:\n\n```java\nHashMap \u003cString, Object\u003e params = new HashMap\u003cString, Object\u003e();\nparams.put(\"user_id\", \"11052\");\nparams.put(\"first_name\", \"YOGESH\");\nparams.put(\"last_name\", \"SAWANT\");\nparams.put(\"birthdate\", \"29/07/1992\");\nparams.put(\"country\", \"INDIA\");\nparams.put(\"document_id_number\", \"ABCD123\");\nparams.put(\"document_id_file_path\", \"2/i/016be96da275031de2787b57c99f1471\");\nparams.put(\"selfie_file_path\", \"2/i/9e8d3a5a7a58f0f1be50b7876521aebc\");\nparams.put(\"ethereum_address\", \"0x04d39e0b112c20917868ffd5c42372ecc5df577b\");\nparams.put(\"estimated_participation_amount\", \"1.2\");\nparams.put(\"residence_proof_file_path\", \"2/i/4ed790b2d525f4c7b30fbff5cb7bbbdb\");\nparams.put(\"city\", \"pune\");\nparams.put(\"nationality\", \"INDIAN\");\nparams.put(\"state\", \"maharashtra\");\nparams.put(\"postal_code\", \"411028\");\nJsonObject response = usersKycService.submit_kyc( params );\nSystem.out.println(\"response: \" + response.toString() );\n```\n\nSend Approve Email to User:\n\n```java\nHashMap \u003cString, Object\u003e params = new HashMap\u003cString, Object\u003e();\nparams.put(\"user_id\", \"11550\");\nJsonObject response = usersKycService.email_approve( params );\nSystem.out.println(\"response: \" + response.toString() );\n```\n\nSend Deny Email to User:\n\n```java\nHashMap \u003cString, Object\u003e params = new HashMap\u003cString, Object\u003e();\nparams.put(\"user_id\", \"11550\");\nJsonObject response = usersKycService.email_deny( params );\nSystem.out.println(\"response: \" + response.toString() );\n```\n\nSend Report Issue Email to User:\n\n```java\nHashMap \u003cString, Object\u003e params = new HashMap\u003cString, Object\u003e();\nparams.put(\"user_id\", \"11550\");\nJsonObject response = usersKycService.email_report_issue( params );\nSystem.out.println(\"response: \" + response.toString() );\n```\n\nGet a list of existing users kyc and other data:\n\n```java\nHashMap \u003cString,Object\u003e params = new HashMap\u003cString,Object\u003e();\nJsonObject response = usersKycService.list( params );\nSystem.out.println(\"response: \" + response.toString() );\n```\n\nGet an existing Presigned URL via POST call:\n\n```java\nHashMap \u003cString, Object\u003e params = new HashMap\u003cString, Object\u003e();\nHashMap \u003cString, String\u003e nestedparams = new HashMap\u003cString, String\u003e();\nnestedparams.put(\"selfie\", \"image/jpeg\");\nparams.put(\"files\", nestedparams);\nJsonObject response = usersKycService.get_presigned_url_post( params );\nSystem.out.println(\"response: \" + response.toString() );\n```\n\nGet an existing Presigned URL via PUT call:\n\n```java\nHashMap \u003cString, Object\u003e params = new HashMap\u003cString, Object\u003e();\nHashMap \u003cString, String\u003e nestedparams = new HashMap\u003cString, String\u003e();\nnestedparams.put(\"selfie\", \"image/jpeg\");\nparams.put(\"files\", nestedparams);\nJsonObject response = usersKycService.get_presigned_url_put( params );\nSystem.out.println(\"response: \" + response.toString() );\n```\n\n\n### UsersKycDetail Module\n\n```java\ncom.ost.kyc.services.v2.UsersKycDetail usersKycDetailService = services.usersKycDetail;\n```\n\nGet an user kyc detail:\n\n```java\nHashMap \u003cString, Object\u003e params = new HashMap\u003cString, Object\u003e();\nparams.put(\"user_id\", \"11052\");\nJsonObject response = usersKycDetailService.get( params );\nSystem.out.println(\"response: \" + response.toString() );\n```\n\n### Validators Module\n\n```java\ncom.ost.kyc.services.v2.Validators validatorService = services.validators;\n```\n\nVerify Ethereum Address:\n\n```java\nHashMap \u003cString, Object\u003e params = new HashMap\u003cString, Object\u003e();\nparams.put(\"ethereum_address\", \"0x7f2ED21D1702057C7d9f163cB7e5458FA2B6B7c4\");\nJsonObject response = validatorService.verify_ethereum_address( params );\nSystem.out.println(\"response: \" + response.toString() );\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fostdotcom%2Fost-kyc-sdk-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fostdotcom%2Fost-kyc-sdk-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fostdotcom%2Fost-kyc-sdk-java/lists"}