Skip to main content
API docs by Redocly

IDUnion Trust List API (0.0.1)

Download OpenAPI specification:Download

IDUnion Trust List API

HealthCheck

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

TlCreate

Creates a Trust List based on the specified payload.

Authorizations:
accessToken
Request Body schema: application/json

Trust List create payload.

name
required
string (Trust List name)

Trust List human-readable name

description
required
string (Trust List description)

Trust List description

suggestedId
string (Suggested Trust List ID)
governanceWalletId
required
string (Wallet Identifier)

The Wallet used by the Trust List for VC interactions

verifierId
required
string (Verifier Identifier)

The Verifier used to verify onboarding credentials

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "suggestedId": "string",
  • "governanceWalletId": "string",
  • "verifierId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "didBase": "string",
  • "governanceWalletId": "string",
  • "verifierId": "string"
}

TlList

Provides a list of public Trusted Lists

query Parameters
search
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

TlGetPublicInfo

Provides a public information about a specific Trusted List

path Parameters
tl_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "didBase": "string",
  • "governanceWalletId": "string"
}

TlListByOwner

Provides a list of Trusted Lists for an authenticated owner

Authorizations:
accessToken

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

TlGet

Gets the specified Trust List

Authorizations:
accessToken
path Parameters
tl_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "didBase": "string",
  • "governanceWalletId": "string",
  • "verifierId": "string"
}

TlPatch

Updates a Trust List based on the specified payload.

Authorizations:
accessToken
path Parameters
tl_id
required
string
Request Body schema: application/json

Trust List create payload.

name
required
string (Trust List name)

Trust List human-readable name

description
required
string (Trust List description)

Trust List description

suggestedId
string (Suggested Trust List ID)
governanceWalletId
required
string (Wallet Identifier)

The Wallet used by the Trust List for VC interactions

verifierId
required
string (Verifier Identifier)

The Verifier used to verify onboarding credentials

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "suggestedId": "string",
  • "governanceWalletId": "string",
  • "verifierId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "didBase": "string",
  • "governanceWalletId": "string",
  • "verifierId": "string"
}

TlDelete

Destroys the Trust List.

Authorizations:
accessToken
path Parameters
tl_id
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "message": "string"
}

TlrSearch

Retrieves a list of Trust List Records.

path Parameters
org_name
required
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

TlrsGet

Retrieves a list of Trust List records.

Authorizations:
accessToken
path Parameters
tl_id
required
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

TlrCreate

Directly creates a new Trusted List Record. When a Certificate Signing Request is provided, it will also issue an x509 certificate and update the ETSI TS 119 6**

Authorizations:
accessToken
path Parameters
tl_id
required
string
Request Body schema: application/json

Trust List Record Create Payload.

didKey
string (DID Key)
csr
string (Certificate signing request in PEM format)
orgName
required
string (Organization Name)

Responses

Request samples

Content type
application/json
{
  • "didKey": "string",
  • "csr": "string",
  • "orgName": "string"
}

Response samples

Content type
application/json
{
  • "did": "string",
  • "x509Certificate": "string"
}

DidVerificationMethodAdd

Adds DID Verification method.

Authorizations:
accessToken
path Parameters
tl_id
required
string (Trust List ID)

Trust List Identifier

tlr_id
required
string (Trust List Record ID)

Trust List Record Identifier

Request Body schema: application/json

Verification method.

controller
required
string (DID)
id
required
string (Key ID)
type
required
string (Type)

The value of the type property MUST be a string that references exactly one verification method type. In order to maximize global interoperability, the verification method type SHOULD be registered in the DID Specification Registries [DID-SPEC-REGISTRIES].

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "controller": "string",
  • "id": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "message": "string"
}

DidVerificationMethodPatch

Adds DID Verification method.

Authorizations:
accessToken
path Parameters
tl_id
required
string (Trust List ID)

Trust List Identifier

tlr_id
required
string (Trust List Record ID)

Trust List Record Identifier

Request Body schema: application/json

Verification method.

controller
string (DID)
id
required
string (Key ID)
revoked
string <date-time> (Revoked)

DateTimeStamp string specifying when the verification method MUST NOT be used.

Responses

Request samples

Content type
application/json
{
  • "controller": "string",
  • "id": "string",
  • "revoked": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "message": "string"
}

DidSuggest

Suggests a DID

Authorizations:
accessToken
path Parameters
tl_id
required
string

Responses

Response samples

Content type
application/json
"string"

EtsiTlGet

Returns an ETSI Trusted list

Authorizations:
accessToken
path Parameters
tl_id
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "message": "string"
}

VpGet

Gets a Verifiable Presentation.

Authorizations:
accessToken
path Parameters
tl_id
required
string
did
required
string
id
required
string

Responses

Response samples

Content type
application/json
{
  • "vp": "string"
}

TlrGet

Retrieves a specific Trust List record

path Parameters
tl_id
required
string (Trust List ID)

Trust List Identifier

tlr_id
required
string (Trust List Record ID)

Trust List Record Identifier

Responses

Response samples

Content type
application/json
{
  • "orgName": "string",
  • "id": "string",
  • "did": "string",
  • "tlId": "string",
  • "tlName": "string",
  • "status": "onboarded",
  • "accreditedFor": [],
  • "onboardingCredentials": [
    ],
  • "isRoot": true
}

TlrDelete

Removes a specific Trust List Record

Authorizations:
accessToken
path Parameters
tl_id
required
string (Trust List ID)

Trust List Identifier

tlr_id
required
string (Trust List Record ID)

Trust List Record Identifier

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "message": "string"
}

TlrTrustChainGet

Gets Trust List Records that make up a single Trust Chain

path Parameters
tl_id
required
string (Trust List ID)

Trust List Identifier

tlr_id
required
string (Trust List Record ID)

Trust List Record Identifier

Responses

Response samples

Content type
application/json
[
  • {
    }
]

DidGet

Retrieves a specific DID Document

path Parameters
tl_id
required
string (Trust List ID)

Trust List Identifier

tlr_id
required
string (Trust List Record ID)

Trust List Record Identifier

Responses

Response samples

Content type
application/json
{
  • "@context": [
    ],
  • "controller": [
    ],
  • "id": "string",
  • "verificationMethod": [
    ],
  • "capabilityInvocation": [
    ],
  • "authentication": [
    ],
  • "assertionMethod": [
    ],
  • "service": [
    ]
}

OnboardingInit

Initiates the onboarding process to the DID registry.

path Parameters
tl_id
required
string (Trust List ID)

Trust List identifier

Request Body schema: application/json

DID onboarding init payload.

verifierId
required
string (Verifier ID)

The Verifier ID that should be used to verify the onboarding credential.

holderEntityId
string

Holder identifier, i.e. did:key of the holder

Responses

Request samples

Content type
application/json
{
  • "verifierId": "string",
  • "holderEntityId": "string"
}

Response samples

Content type
application/json
{
  • "verifierUrl": "string",
  • "verifierState": "string"
}

OnboardingStatus

path Parameters
verifier_state
required
string

Verifier state

Responses

Response samples

Content type
application/json
{
  • "did": "string",
  • "message": "string",
  • "status": "in_progress",
  • "tl": {
    },
  • "verifierUrl": "string"
}