idOS Documentation
  • OVERVIEW
  • What is idOS?
  • Why idOS?
  • What is self-custodial data?
  • Market focus
  • Example use cases
    • Neobank/wallet integration
    • Financial module integration
    • TradFi → onchain integration
  • The idOS Consortium
  • HOW IT WORKS
    • System design
      • Roles
      • idOS Storage Network
      • idOS Economy Network (Coming soon)
      • idOS SDKs
      • Application-layer tools
    • Key flows
      • Encryption flows
      • Data flows
  • COMPLIANCE
    • idOS Regulatory approach
    • KYC Re-usability
      • Passporting
      • Data ingestion
      • Case studies for KYC re-usability
    • Compliance overview
      • idOS & Regulatory frameworks
    • idOS Compliance partners
  • Legal Considerations
  • Integrate
    • Journey Overview
    • Getting Started With the SDKs
    • FAQs
  • Additional resources
    • Official links
Powered by GitBook
On this page
  1. HOW IT WORKS
  2. System design

idOS SDKs

PreviousidOS Economy Network (Coming soon)NextApplication-layer tools

Last updated 8 days ago

The idOS SDK provides developers with a comprehensive toolkit for interacting with the idOS node network, allowing seamless integration of identity verification, access management, and encrypted data handling into applications. It is designed to be modular and flexible, enabling developers to choose which functionalities they need without unnecessary overhead.

For simplicity and developer experience reasons, we've split the SDK into 3 focused SDKs depending on your use case and role in the system

  • idOS Client: the browser SDK. Enables websites to integrate with idOS, and includes both Issuer and Consumer functionality.

    • Github:

    • NPM:

  • idOS Consumer Server: helps a consumer integrate their backend with idOS.

    • Github:

    • NPM:

  • idOS Issuer Server: helps an Issuer integrate their backend with idOS.

    • Github:

    • NPM:

For more on how to use the SDKs, check out our guide on

https://github.com/idos-network/idos-sdk-js/tree/feat/docs-v1/packages/idos-sdk-js
https://www.npmjs.com/package/@idos-network/idos-sdk
https://github.com/idos-network/idos-sdk-js/tree/feat/docs-v1/packages/consumer-sdk-js
https://www.npmjs.com/package/@idos-network/idos-sdk
https://github.com/idos-network/idos-sdk-js/tree/feat/docs-v1/packages/issuer-sdk-js
https://www.npmjs.com/package/@idos-network/issuer-sdk-js
Getting Started With the SDKs