api.md

API's

Core API

Our Core API exists to enable SSI and DNS applications. It consists of two main parts:

• Write SSI/DNS states via layer-1 transactions.
• Read SSI/DNS states via layer-2 APIs.

Please visit our get started page to get a full overview of IOP's stack.

Layer-1 API

Write State

Use it to do SSI or DNS write operations, such as

• Add/revoke a key to/from a DID
• Add/revoke a right to/from a DID
• Tombstone a DID
• Register a Proof of Existence
• Name your data (i.e. register DNS domain)
• Etc.

BROWSE LAYER-1 API

Layer-2 API

Read State

Use it to:

• Query DID Document or its Transactions, Operations
• Query Proof of Existence or its History
• Query SSI Transaction Status
• Resolve data of a DNS domain
• Query metadata of a DNS domain
• Etc.

BROWSE LAYER-2 API

SSI Entities' APIs

SSI has multiple entities (people, companies or bots) defined for claim verification and issuance. IOP does not host such services, but provides you a well-defined API described below and it is not that complex to develop an implementation on your own. If you do not have the resources to develop and maintain such a service, the commercial company IOP Global GmbH has reference implementations of both Authority service and Inspector service and can provide you help in integrating them into your workflows-.

Authority API

Get a claim proved

BROWSE AUTHORITY API

Inspector API

Present a proved claim

BROWSE INSPECTOR API

Verifier API

Verify proved claims

BROWSE VERIFIER API

Network API

This API allows you to query information about the public blockchain, the Hydra network, upon which our stack is built.

Hydra API

Retrieve network information

BROWSE HYDRA API