Skip to main content
European CommissionEBSI European Blockchain
Get Help

Trusted Issuers Registry API

OpenAPI documentation

tir get <url>​

Command to GET in the Trusted Issuers Registry API.

Parameters:

  • url: Path to get.

Examples:

tir get /issuers
tir get /issuers/did:ebsi:12a...

tir (build-)setAttributeMetadata <did> <attributeId> <issuerType> <tao> <taoAttributeId>​

Command to pre-register a new issuer in the registry. The JWT is set in the headers. This method requires trust chain rights in the Trusted Issuers Registry.

Use the build- prefix to call the API helper to build the transaction. If this prefix is not set then the command will perform the following steps:

  • call tir build-insertIssuer to build an unsigned transaction.
  • call compute signTransaction to sign the transaction with the user defined in using user.
  • call tir sendSignedTransaction to send the transaction signed.
  • call view transactionInfo to see relevant data for this transaction.

Parameters:

  • did: DID of the new issuer.
  • attributeId: New attribute ID.
  • issuerType: Issuer type. It must be ti, tao, roottao, or revoked.
  • tao: DID of the parent issuer.
  • taoAttributeId: Attribute ID that accredits the issuer parent as TAO.

tir (build-)setAttributeData <did> <attributeId> <attribute>​

Command to register a verifiable credential new issuer in the registry. The JWT is set in the headers. This method requires trust chain rights in the Trusted Issuers Registry.

Use the build- prefix to call the API helper to build the transaction. If this prefix is not set then the command will perform the following steps:

  • call tir build-insertIssuer to build an unsigned transaction.
  • call compute signTransaction to sign the transaction with the user defined in using user.
  • call tir sendSignedTransaction to send the transaction signed.
  • call view transactionInfo to see relevant data for this transaction.

Parameters:

  • did: DID of the issuer.
  • attributeId: Attribute ID.
  • attribute: Verifiable credential in JWT.

tir (build-)addIssuerProxy <did> <proxyData>​

Command to register an issuer proxy. This proxy must be up and running and reply VCs with StatusList2021. Use the (build-) prefix to just call the API helper without signing the transaction.

Parameters:

  • did: DID of the issuer.
  • proxyData: JSON object containing the proxy data.

Examples:

tir addIssuerProxy user.did {"prefix": "https://example.com/my-provider/revocation","headers":{"Authorization": "Bearer ABC"}, "testSuffix": "/credentials/status/1"}

tir (build-)updateIssuerProxy <did> <proxyId> <proxyData>​

Command to update an issuer proxy. This proxy must be up and running and reply VCs with StatusList2021. Use the (build-) prefix to just call the API helper without signing the transaction.

Parameters:

  • did: DID of the issuer.
  • proxyId: Proxy ID to update.
  • proxyData: JSON object containing the proxy data.

tir (build-)removeIssuerProxy <did> <proxyId>​

Command to remove an issuer proxy. Use the (build-) prefix to just call the API helper without signing the transaction.

Parameters:

  • did: DID of the issuer.
  • proxyId: Proxy ID to remove.

tir sendSignedTransaction <unsignedTransaction> <signedTransaction>​

Command to send a signed transaction to the Trusted Issuers Registry. The JWT is set in the headers. It's also possible to load the parameters from the saved variables by referencing the names.

Parameters:

  • unsignedTransaction: JSON with the unsigned transaction.
  • signedTransaction: Signed transaction in raw format.

Examples:

tir sendSignedTransaction {"from":"0x6b...} 0xf9022...
tir sendSignedTransaction utx sgntx