Skip to main content
API docs by Redocly

Truvity Platform API. (0.28.6)

Download OpenAPI specification:Download

Truvity Team: feedback@truvity.com URL: https://www.truvity.com/contact License: MIT Terms of Service

Truvity Platform API.

API Key

The API to manage Truvity API's keys.

Create a new API key.

Create a new API key resource.

Authorizations:
ApiKey
header Parameters
Idempotency-Key
string [ 32 .. 256 ] characters [a-zA-Z0-9-]{32,256}

From Zalando RESTful API Guidelines - models/headers-1.0.0.yaml. The Idempotency-Key is a free identifier created by the client to identify a request. It is used by the service to identify repeated request to ensure idempotent behavior by sending the same (or a similar) response without executing the request a second time.

Clients should be careful as any subsequent requests with the same key may return the same response without further check. Thus, it is recommended to use a UUID version 4 (random) or any other random string with enough entropy to avoid collisions.

Keys expire after 24 hours. Clients are responsible to stay within this limit, if they require idempotent behavior.

See [API Guideline Rule #181][api-230] for further details.

[api-230]: https://opensource.zalando.com/restful-api-guidelines/#230.

Request Body schema: application/json
required
object

The annotations of the resource.

object

The labels of the resource.

Responses

Request samples

Content type
application/json
{
  • "annotations": {
    },
  • "labels": {
    }
}

Response samples

Content type
application/vnd.truvity.api-key+json;version=1
{
  • "kind": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "etag": "string",
  • "revision": 1,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "labels": {
    },
  • "data": {
    },
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Search for API Keys.

Search for API Keys with extended filters capabilities.

Authorizations:
ApiKey
Request Body schema: application/json
required
Array of objects or null (ApiKeyFilter) <= 4 items

The filter to apply to the search.

Array of objects or null (ApiKeySort) <= 4 items

The sort order to apply to the search.

Responses

Request samples

Content type
application/json
{
  • "filter": [
    ],
  • "sort": [
    ]
}

Response samples

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

Get the latest version of API Key.

Get the latest version of API Key.

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

The ID of the resource.

header Parameters
If-None-Match
string

The ETag of the latest version of the resource.

Responses

Request samples 

import (
	context "context"
	option "github.com/truvity/sdk-go/option"
	sdkgo "github.com/truvity/sdk-go"
	sdkgoclient "github.com/truvity/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.ApiKeys.ApiKeyLatest(
	context.TODO(),
	"id",
	&sdkgo.ApiKeyLatestRequest{},
)

Response samples

Content type
application/vnd.truvity.api-key+json;version=1
{
  • "kind": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "etag": "string",
  • "revision": 1,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "labels": {
    },
  • "data": {
    },
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Update API Key.

Update API Key's resource.

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

The primary and unique identifier of the resource (inside tenant) according to RFC 4122.

header Parameters
Idempotency-Key
string [ 32 .. 256 ] characters [a-zA-Z0-9-]{32,256}

From Zalando RESTful API Guidelines - models/headers-1.0.0.yaml. The Idempotency-Key is a free identifier created by the client to identify a request. It is used by the service to identify repeated request to ensure idempotent behavior by sending the same (or a similar) response without executing the request a second time.

Clients should be careful as any subsequent requests with the same key may return the same response without further check. Thus, it is recommended to use a UUID version 4 (random) or any other random string with enough entropy to avoid collisions.

Keys expire after 24 hours. Clients are responsible to stay within this limit, if they require idempotent behavior.

See [API Guideline Rule #181][api-230] for further details.

[api-230]: https://opensource.zalando.com/restful-api-guidelines/#230.

If-Match
required
string

From Zalando RESTful API Guidelines - models/headers-1.0.0.yaml. The If-Match header field is used to declare a list of identifiers that are required to match the current resource version identifier in at least one position as a pre-condition for executing the request on the server side. This behavior is used to validate and reject optimistic updates, by checking if the resource version a consumer has based his changes on is outdated on arrival of the change request to prevent lost updates.

If the pre-condition fails the server will respond with status code 412 (Precondition Failed). See RFC 9110 Section 13.1.1 as well as [API Guideline Rule #182][api-182] for further details.

[api-182]: https://opensource.zalando.com/restful-api-guidelines/#182.

Request Body schema: application/json
required
object

The annotations of the resource.

object

The labels of the resource.

Responses

Request samples

Content type
application/json
{
  • "annotations": {
    },
  • "labels": {
    }
}

Response samples

Content type
application/vnd.truvity.api-key+json;version=1
{
  • "kind": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "etag": "string",
  • "revision": 1,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "labels": {
    },
  • "data": {
    },
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Delete API Key.

Delete API Key's resource.

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

The primary and unique identifier of the resource (inside tenant) according to RFC 4122.

header Parameters
Idempotency-Key
string [ 32 .. 256 ] characters [a-zA-Z0-9-]{32,256}

From Zalando RESTful API Guidelines - models/headers-1.0.0.yaml. The Idempotency-Key is a free identifier created by the client to identify a request. It is used by the service to identify repeated request to ensure idempotent behavior by sending the same (or a similar) response without executing the request a second time.

Clients should be careful as any subsequent requests with the same key may return the same response without further check. Thus, it is recommended to use a UUID version 4 (random) or any other random string with enough entropy to avoid collisions.

Keys expire after 24 hours. Clients are responsible to stay within this limit, if they require idempotent behavior.

See [API Guideline Rule #181][api-230] for further details.

[api-230]: https://opensource.zalando.com/restful-api-guidelines/#230.

If-Match
required
string

From Zalando RESTful API Guidelines - models/headers-1.0.0.yaml. The If-Match header field is used to declare a list of identifiers that are required to match the current resource version identifier in at least one position as a pre-condition for executing the request on the server side. This behavior is used to validate and reject optimistic updates, by checking if the resource version a consumer has based his changes on is outdated on arrival of the change request to prevent lost updates.

If the pre-condition fails the server will respond with status code 412 (Precondition Failed). See RFC 9110 Section 13.1.1 as well as [API Guideline Rule #182][api-182] for further details.

[api-182]: https://opensource.zalando.com/restful-api-guidelines/#182.

Responses

Request samples 

import (
	context "context"
	option "github.com/truvity/sdk-go/option"
	sdkgo "github.com/truvity/sdk-go"
	sdkgoclient "github.com/truvity/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
err := client.ApiKeys.ApiKeyDelete(
	context.TODO(),
	"id",
	&sdkgo.ApiKeyDeleteRequest{
		IfMatch: "If-Match",
	},
)

Response samples

Content type
application/problem+json
Example
{
  • "type": "/bad-request",
  • "title": "string",
  • "status": 100,
  • "detail": "string",
  • "errors": [
    ],
  • "instance": "http://example.com"
}

Restore API Key.

Restore API Key's resource.

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

The primary and unique identifier of the resource (inside tenant) according to RFC 4122.

header Parameters
Idempotency-Key
string [ 32 .. 256 ] characters [a-zA-Z0-9-]{32,256}

From Zalando RESTful API Guidelines - models/headers-1.0.0.yaml. The Idempotency-Key is a free identifier created by the client to identify a request. It is used by the service to identify repeated request to ensure idempotent behavior by sending the same (or a similar) response without executing the request a second time.

Clients should be careful as any subsequent requests with the same key may return the same response without further check. Thus, it is recommended to use a UUID version 4 (random) or any other random string with enough entropy to avoid collisions.

Keys expire after 24 hours. Clients are responsible to stay within this limit, if they require idempotent behavior.

See [API Guideline Rule #181][api-230] for further details.

[api-230]: https://opensource.zalando.com/restful-api-guidelines/#230.

If-Match
required
string

From Zalando RESTful API Guidelines - models/headers-1.0.0.yaml. The If-Match header field is used to declare a list of identifiers that are required to match the current resource version identifier in at least one position as a pre-condition for executing the request on the server side. This behavior is used to validate and reject optimistic updates, by checking if the resource version a consumer has based his changes on is outdated on arrival of the change request to prevent lost updates.

If the pre-condition fails the server will respond with status code 412 (Precondition Failed). See RFC 9110 Section 13.1.1 as well as [API Guideline Rule #182][api-182] for further details.

[api-182]: https://opensource.zalando.com/restful-api-guidelines/#182.

Responses

Request samples 

import (
	context "context"
	option "github.com/truvity/sdk-go/option"
	sdkgo "github.com/truvity/sdk-go"
	sdkgoclient "github.com/truvity/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.ApiKeys.ApiKeyRestore(
	context.TODO(),
	"id",
	&sdkgo.ApiKeyRestoreRequest{
		IfMatch: "If-Match",
	},
)

Response samples

Content type
application/vnd.truvity.api-key+json;version=1
{
  • "kind": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "etag": "string",
  • "revision": 1,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "labels": {
    },
  • "data": {
    },
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Read API Key's history.

History of the API Key's resources.

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

The ID of the resource.

header Parameters
If-None-Match
string

The ETag of the latest version of the resource.

Responses

Request samples 

import (
	context "context"
	option "github.com/truvity/sdk-go/option"
	sdkgo "github.com/truvity/sdk-go"
	sdkgoclient "github.com/truvity/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.ApiKeys.ApiKeyHistory(
	context.TODO(),
	"id",
	&sdkgo.ApiKeyHistoryRequest{},
)

Response samples

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

Read the specific version of the API Key.

Read the specific version of the API Key's resource.

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

The ID of the resource.

revision
required
integer <int32> [ 1 .. 999999 ]

The revision of the resource.

header Parameters
If-None-Match
string

The ETag of the latest version of the resource.

Responses

Request samples 

import (
	context "context"
	option "github.com/truvity/sdk-go/option"
	sdkgo "github.com/truvity/sdk-go"
	sdkgoclient "github.com/truvity/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.ApiKeys.ApiKeyRevision(
	context.TODO(),
	"id",
	1,
	&sdkgo.ApiKeyRevisionRequest{},
)

Response samples

Content type
application/json
{
  • "kind": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "etag": "string",
  • "revision": 1,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "labels": {
    },
  • "data": {
    },
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Credential

The API to manage Verifiable Credentials.

Import Credential.

Import a Verifiable Credential.

Authorizations:
ApiKey
query Parameters
blob_id
required
string <uuid>

The primary and unique identifier of the resource (inside tenant) according to RFC 4122.

header Parameters
Idempotency-Key
string [ 32 .. 256 ] characters [a-zA-Z0-9-]{32,256}

From Zalando RESTful API Guidelines - models/headers-1.0.0.yaml. The Idempotency-Key is a free identifier created by the client to identify a request. It is used by the service to identify repeated request to ensure idempotent behavior by sending the same (or a similar) response without executing the request a second time.

Clients should be careful as any subsequent requests with the same key may return the same response without further check. Thus, it is recommended to use a UUID version 4 (random) or any other random string with enough entropy to avoid collisions.

Keys expire after 24 hours. Clients are responsible to stay within this limit, if they require idempotent behavior.

See [API Guideline Rule #181][api-230] for further details.

[api-230]: https://opensource.zalando.com/restful-api-guidelines/#230.

Request Body schema: application/json
required
object

The annotations of the resource.

object

The labels of the resource.

Responses

Request samples

Content type
application/json
{
  • "annotations": {
    },
  • "labels": {
    }
}

Response samples

Content type
application/vnd.truvity.credential+json;version=1
{
  • "kind": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "etag": "string",
  • "revision": 1,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "labels": {
    },
  • "data": {},
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Search for Credentials.

Search for Credentials with extended filters capabilities.

Authorizations:
ApiKey
Request Body schema: application/json
required
Array of objects or null (CredentialFilter) <= 4 items

The filter to apply to the search.

Array of objects or null (CredentialSort) <= 4 items

The sort order to apply to the search.

Responses

Request samples

Content type
application/json
{
  • "filter": [
    ],
  • "sort": [
    ]
}

Response samples

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

Upload Credential's blob.

The upload Credential's blob operation.

Authorizations:
ApiKey
header Parameters
Idempotency-Key
string [ 32 .. 256 ] characters [a-zA-Z0-9-]{32,256}

From Zalando RESTful API Guidelines - models/headers-1.0.0.yaml. The Idempotency-Key is a free identifier created by the client to identify a request. It is used by the service to identify repeated request to ensure idempotent behavior by sending the same (or a similar) response without executing the request a second time.

Clients should be careful as any subsequent requests with the same key may return the same response without further check. Thus, it is recommended to use a UUID version 4 (random) or any other random string with enough entropy to avoid collisions.

Keys expire after 24 hours. Clients are responsible to stay within this limit, if they require idempotent behavior.

See [API Guideline Rule #181][api-230] for further details.

[api-230]: https://opensource.zalando.com/restful-api-guidelines/#230.

Responses

Request samples 

import (
	context "context"
	option "github.com/truvity/sdk-go/option"
	sdkgo "github.com/truvity/sdk-go"
	sdkgoclient "github.com/truvity/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.Credentials.CredentialUpload(
	context.TODO(),
	&sdkgo.CredentialUploadRequest{},
)

Response samples

Content type
application/json
{
  • "blob_id": "8249af2f-dd23-416e-b9c4-6cb13a792190",
  • "timeout": 1,
  • "upload_uri": "http://example.com"
}

Get the latest version of Credential.

Get the latest version of Credential.

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

The ID of the resource.

header Parameters
If-None-Match
string

The ETag of the latest version of the resource.

Responses

Request samples 

import (
	context "context"
	option "github.com/truvity/sdk-go/option"
	sdkgo "github.com/truvity/sdk-go"
	sdkgoclient "github.com/truvity/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.Credentials.CredentialLatest(
	context.TODO(),
	"id",
	&sdkgo.CredentialLatestRequest{},
)

Response samples

Content type
application/vnd.truvity.credential+json;version=1
{
  • "kind": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "etag": "string",
  • "revision": 1,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "labels": {
    },
  • "data": {},
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Delete Credential.

Delete Credential's resource.

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

The primary and unique identifier of the resource (inside tenant) according to RFC 4122.

header Parameters
Idempotency-Key
string [ 32 .. 256 ] characters [a-zA-Z0-9-]{32,256}

From Zalando RESTful API Guidelines - models/headers-1.0.0.yaml. The Idempotency-Key is a free identifier created by the client to identify a request. It is used by the service to identify repeated request to ensure idempotent behavior by sending the same (or a similar) response without executing the request a second time.

Clients should be careful as any subsequent requests with the same key may return the same response without further check. Thus, it is recommended to use a UUID version 4 (random) or any other random string with enough entropy to avoid collisions.

Keys expire after 24 hours. Clients are responsible to stay within this limit, if they require idempotent behavior.

See [API Guideline Rule #181][api-230] for further details.

[api-230]: https://opensource.zalando.com/restful-api-guidelines/#230.

If-Match
required
string

From Zalando RESTful API Guidelines - models/headers-1.0.0.yaml. The If-Match header field is used to declare a list of identifiers that are required to match the current resource version identifier in at least one position as a pre-condition for executing the request on the server side. This behavior is used to validate and reject optimistic updates, by checking if the resource version a consumer has based his changes on is outdated on arrival of the change request to prevent lost updates.

If the pre-condition fails the server will respond with status code 412 (Precondition Failed). See RFC 9110 Section 13.1.1 as well as [API Guideline Rule #182][api-182] for further details.

[api-182]: https://opensource.zalando.com/restful-api-guidelines/#182.

Responses

Request samples 

import (
	context "context"
	option "github.com/truvity/sdk-go/option"
	sdkgo "github.com/truvity/sdk-go"
	sdkgoclient "github.com/truvity/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
err := client.Credentials.CredentialDelete(
	context.TODO(),
	"id",
	&sdkgo.CredentialDeleteRequest{
		IfMatch: "If-Match",
	},
)

Response samples

Content type
application/problem+json
Example
{
  • "type": "/bad-request",
  • "title": "string",
  • "status": 100,
  • "detail": "string",
  • "errors": [
    ],
  • "instance": "http://example.com"
}

Restore Credential.

Restore Credential's resource.

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

The primary and unique identifier of the resource (inside tenant) according to RFC 4122.

header Parameters
Idempotency-Key
string [ 32 .. 256 ] characters [a-zA-Z0-9-]{32,256}

From Zalando RESTful API Guidelines - models/headers-1.0.0.yaml. The Idempotency-Key is a free identifier created by the client to identify a request. It is used by the service to identify repeated request to ensure idempotent behavior by sending the same (or a similar) response without executing the request a second time.

Clients should be careful as any subsequent requests with the same key may return the same response without further check. Thus, it is recommended to use a UUID version 4 (random) or any other random string with enough entropy to avoid collisions.

Keys expire after 24 hours. Clients are responsible to stay within this limit, if they require idempotent behavior.

See [API Guideline Rule #181][api-230] for further details.

[api-230]: https://opensource.zalando.com/restful-api-guidelines/#230.

If-Match
required
string

From Zalando RESTful API Guidelines - models/headers-1.0.0.yaml. The If-Match header field is used to declare a list of identifiers that are required to match the current resource version identifier in at least one position as a pre-condition for executing the request on the server side. This behavior is used to validate and reject optimistic updates, by checking if the resource version a consumer has based his changes on is outdated on arrival of the change request to prevent lost updates.

If the pre-condition fails the server will respond with status code 412 (Precondition Failed). See RFC 9110 Section 13.1.1 as well as [API Guideline Rule #182][api-182] for further details.

[api-182]: https://opensource.zalando.com/restful-api-guidelines/#182.

Responses

Request samples 

import (
	context "context"
	option "github.com/truvity/sdk-go/option"
	sdkgo "github.com/truvity/sdk-go"
	sdkgoclient "github.com/truvity/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.Credentials.CredentialRestore(
	context.TODO(),
	"id",
	&sdkgo.CredentialRestoreRequest{
		IfMatch: "If-Match",
	},
)

Response samples

Content type
application/vnd.truvity.credential+json;version=1
{
  • "kind": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "etag": "string",
  • "revision": 1,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "labels": {
    },
  • "data": {},
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Read Credential's history.

History of the Credential's resources.

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

The ID of the resource.

header Parameters
If-None-Match
string

The ETag of the latest version of the resource.

Responses

Request samples 

import (
	context "context"
	option "github.com/truvity/sdk-go/option"
	sdkgo "github.com/truvity/sdk-go"
	sdkgoclient "github.com/truvity/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.Credentials.CredentialHistory(
	context.TODO(),
	"id",
	&sdkgo.CredentialHistoryRequest{},
)

Response samples

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

Read the specific version of the Credential.

Read the specific version of the Credential's resource.

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

The ID of the resource.

revision
required
integer <int32> [ 1 .. 999999 ]

The revision of the resource.

header Parameters
If-None-Match
string

The ETag of the latest version of the resource.

Responses

Request samples 

import (
	context "context"
	option "github.com/truvity/sdk-go/option"
	sdkgo "github.com/truvity/sdk-go"
	sdkgoclient "github.com/truvity/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.Credentials.CredentialRevision(
	context.TODO(),
	"id",
	1,
	&sdkgo.CredentialRevisionRequest{},
)

Response samples

Content type
application/json
{
  • "kind": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "etag": "string",
  • "revision": 1,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "labels": {
    },
  • "data": {},
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Download of Credential's blob.

Download of Credential's blob.

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

The ID of the resource.

revision
required
integer <int32> [ 1 .. 999999 ]

The revision of the resource.

header Parameters
If-None-Match
string

The ETag of the latest version of the resource.

Responses

Response samples

Content type
application/vc+ld+json
"string"

Verify Credential.

Verify a Verifiable Credential.

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

The ID of the resource.

Responses

Request samples 

import (
	context "context"
	option "github.com/truvity/sdk-go/option"
	sdkgoclient "github.com/truvity/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.Credentials.CredentialVerify(
	context.TODO(),
	"id",
)

Response samples

Content type
application/json
{
  • "verified": true
}

Desk

The API to manage DID Documents and to receive DIDComm messages.

Get DID-Document.

Get DID-Document for did:web Method Specification.

path Parameters
tenant_id
required
string <uuid>

The ID of the tenant.

header Parameters
If-None-Match
string

From Zalando RESTful API Guidelines - models/headers-1.0.0.yaml. The If-None-Match header field is used to declare a list of identifiers that are required to fail matching all the current resource version identifiers as a pre-condition for executing the request on the server side. This is especially used in conjunction with an * (asterix) that is matching all possible resource identifiers to ensure the initial creation of a resource. Other use cases are possible but rare.

If the pre-condition fails the server will respond with status code 412 (Precondition Failed). See RFC 9110 Section 13.1.2 as well as [API Guideline Rule #182][api-182] for further details.

[api-182]: https://opensource.zalando.com/restful-api-guidelines/#182.

Responses

Request samples 

import (
	context "context"
	option "github.com/truvity/sdk-go/option"
	sdkgo "github.com/truvity/sdk-go"
	sdkgoclient "github.com/truvity/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.Desk.DidDocumentGet(
	context.TODO(),
	"tenant_id",
	&sdkgo.DidDocumentGetRequest{},
)

Response samples

Content type
application/did+ld+json
{
  • "@context": [
    ],
  • "id": "strings",
  • "verificationMethod": [
    ],
  • "authentication": [
    ],
  • "assertionMethod": [
    ],
  • "service": []
}

Receive DIDComm Message.

Receive DIDComm Message.

path Parameters
tenant_id
required
string <uuid>

The ID of the tenant.

Request Body schema: application/didcomm-signed+json
required
string <binary> <application/octet-stream>

Responses

Request samples

Content type
application/didcomm-signed+json
"string"

Response samples

Content type
application/problem+json
Example
{
  • "type": "/bad-request",
  • "title": "string",
  • "status": 100,
  • "detail": "string",
  • "errors": [
    ],
  • "instance": "http://example.com"
}

DIDComm Message

The API to manage DIDComm messages.

Search for DIDComm Messages.

Search for DIDComm Messages with extended filters capabilities.

Authorizations:
ApiKey
Request Body schema: application/json
required
Array of objects or null (DidcommMessageFilter) <= 4 items

The filter to apply to the search.

Array of objects or null (DidcommMessageSort) <= 4 items

The sort order to apply to the search.

Responses

Request samples

Content type
application/json
{
  • "filter": [
    ],
  • "sort": [
    ]
}

Response samples

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

Send a DIDComm Message.

Send a DIDComm Message to a recipient.

Authorizations:
ApiKey
header Parameters
Idempotency-Key
string [ 32 .. 256 ] characters [a-zA-Z0-9-]{32,256}

From Zalando RESTful API Guidelines - models/headers-1.0.0.yaml. The Idempotency-Key is a free identifier created by the client to identify a request. It is used by the service to identify repeated request to ensure idempotent behavior by sending the same (or a similar) response without executing the request a second time.

Clients should be careful as any subsequent requests with the same key may return the same response without further check. Thus, it is recommended to use a UUID version 4 (random) or any other random string with enough entropy to avoid collisions.

Keys expire after 24 hours. Clients are responsible to stay within this limit, if they require idempotent behavior.

See [API Guideline Rule #181][api-230] for further details.

[api-230]: https://opensource.zalando.com/restful-api-guidelines/#230.

Request Body schema: application/json
required
required
object (DIDCommMessageSend)

The request to send a DIDComm message.

object

The annotations of the resource.

object

The labels of the resource.

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "annotations": {
    },
  • "labels": {
    }
}

Response samples

Content type
application/vnd.truvity.didcomm-message+json;version=1
{
  • "kind": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "etag": "string",
  • "revision": 1,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "labels": {
    },
  • "data": {
    },
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Get the latest version of DIDComm Message.

Get the latest version of DIDComm Message.

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

The ID of the resource.

header Parameters
If-None-Match
string

The ETag of the latest version of the resource.

Responses

Request samples 

import (
	context "context"
	option "github.com/truvity/sdk-go/option"
	sdkgo "github.com/truvity/sdk-go"
	sdkgoclient "github.com/truvity/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.DidcommMessages.DidcommMessageLatest(
	context.TODO(),
	"id",
	&sdkgo.DidcommMessageLatestRequest{},
)

Response samples

Content type
application/vnd.truvity.didcomm-message+json;version=1
{
  • "kind": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "etag": "string",
  • "revision": 1,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "labels": {
    },
  • "data": {
    },
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Delete DIDComm Message.

Delete DIDComm Message's resource.

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

The primary and unique identifier of the resource (inside tenant) according to RFC 4122.

header Parameters
Idempotency-Key
string [ 32 .. 256 ] characters [a-zA-Z0-9-]{32,256}

From Zalando RESTful API Guidelines - models/headers-1.0.0.yaml. The Idempotency-Key is a free identifier created by the client to identify a request. It is used by the service to identify repeated request to ensure idempotent behavior by sending the same (or a similar) response without executing the request a second time.

Clients should be careful as any subsequent requests with the same key may return the same response without further check. Thus, it is recommended to use a UUID version 4 (random) or any other random string with enough entropy to avoid collisions.

Keys expire after 24 hours. Clients are responsible to stay within this limit, if they require idempotent behavior.

See [API Guideline Rule #181][api-230] for further details.

[api-230]: https://opensource.zalando.com/restful-api-guidelines/#230.

If-Match
required
string

From Zalando RESTful API Guidelines - models/headers-1.0.0.yaml. The If-Match header field is used to declare a list of identifiers that are required to match the current resource version identifier in at least one position as a pre-condition for executing the request on the server side. This behavior is used to validate and reject optimistic updates, by checking if the resource version a consumer has based his changes on is outdated on arrival of the change request to prevent lost updates.

If the pre-condition fails the server will respond with status code 412 (Precondition Failed). See RFC 9110 Section 13.1.1 as well as [API Guideline Rule #182][api-182] for further details.

[api-182]: https://opensource.zalando.com/restful-api-guidelines/#182.

Responses

Request samples 

import (
	context "context"
	option "github.com/truvity/sdk-go/option"
	sdkgo "github.com/truvity/sdk-go"
	sdkgoclient "github.com/truvity/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
err := client.DidcommMessages.DidcommMessageDelete(
	context.TODO(),
	"id",
	&sdkgo.DidcommMessageDeleteRequest{
		IfMatch: "If-Match",
	},
)

Response samples

Content type
application/problem+json
Example
{
  • "type": "/bad-request",
  • "title": "string",
  • "status": 100,
  • "detail": "string",
  • "errors": [
    ],
  • "instance": "http://example.com"
}

Restore DIDComm Message.

Restore DIDComm Message's resource.

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

The primary and unique identifier of the resource (inside tenant) according to RFC 4122.

header Parameters
Idempotency-Key
string [ 32 .. 256 ] characters [a-zA-Z0-9-]{32,256}

From Zalando RESTful API Guidelines - models/headers-1.0.0.yaml. The Idempotency-Key is a free identifier created by the client to identify a request. It is used by the service to identify repeated request to ensure idempotent behavior by sending the same (or a similar) response without executing the request a second time.

Clients should be careful as any subsequent requests with the same key may return the same response without further check. Thus, it is recommended to use a UUID version 4 (random) or any other random string with enough entropy to avoid collisions.

Keys expire after 24 hours. Clients are responsible to stay within this limit, if they require idempotent behavior.

See [API Guideline Rule #181][api-230] for further details.

[api-230]: https://opensource.zalando.com/restful-api-guidelines/#230.

If-Match
required
string

From Zalando RESTful API Guidelines - models/headers-1.0.0.yaml. The If-Match header field is used to declare a list of identifiers that are required to match the current resource version identifier in at least one position as a pre-condition for executing the request on the server side. This behavior is used to validate and reject optimistic updates, by checking if the resource version a consumer has based his changes on is outdated on arrival of the change request to prevent lost updates.

If the pre-condition fails the server will respond with status code 412 (Precondition Failed). See RFC 9110 Section 13.1.1 as well as [API Guideline Rule #182][api-182] for further details.

[api-182]: https://opensource.zalando.com/restful-api-guidelines/#182.

Responses

Request samples 

import (
	context "context"
	option "github.com/truvity/sdk-go/option"
	sdkgo "github.com/truvity/sdk-go"
	sdkgoclient "github.com/truvity/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.DidcommMessages.DidcommMessageRestore(
	context.TODO(),
	"id",
	&sdkgo.DidcommMessageRestoreRequest{
		IfMatch: "If-Match",
	},
)

Response samples

Content type
application/vnd.truvity.didcomm-message+json;version=1
{
  • "kind": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "etag": "string",
  • "revision": 1,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "labels": {
    },
  • "data": {
    },
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Read DIDComm Message's history.

History of the DIDComm Message's resources.

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

The ID of the resource.

header Parameters
If-None-Match
string

The ETag of the latest version of the resource.

Responses

Request samples 

import (
	context "context"
	option "github.com/truvity/sdk-go/option"
	sdkgo "github.com/truvity/sdk-go"
	sdkgoclient "github.com/truvity/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.DidcommMessages.DidcommMessageHistory(
	context.TODO(),
	"id",
	&sdkgo.DidcommMessageHistoryRequest{},
)

Response samples

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

Read the specific version of the DIDComm Message.

Read the specific version of the DIDComm Message's resource.

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

The ID of the resource.

revision
required
integer <int32> [ 1 .. 999999 ]

The revision of the resource.

header Parameters
If-None-Match
string

The ETag of the latest version of the resource.

Responses

Request samples 

import (
	context "context"
	option "github.com/truvity/sdk-go/option"
	sdkgo "github.com/truvity/sdk-go"
	sdkgoclient "github.com/truvity/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.DidcommMessages.DidcommMessageRevision(
	context.TODO(),
	"id",
	1,
	&sdkgo.DidcommMessageRevisionRequest{},
)

Response samples

Content type
application/json
{
  • "kind": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "etag": "string",
  • "revision": 1,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "labels": {
    },
  • "data": {
    },
  • "deleted_at": "2019-08-24T14:15:22Z"
}

DIDs

The API to manage DID Documents.

Return the tenant's DID(did:web) document.

Return the tenant's DID(did:web) document. Comparing to DIDDocumentGet endpoint, this one returns the tenant's DID(did:web) document for the authenticated tenant only.

Authorizations:
ApiKey
header Parameters
If-None-Match
string

From Zalando RESTful API Guidelines - models/headers-1.0.0.yaml. The If-None-Match header field is used to declare a list of identifiers that are required to fail matching all the current resource version identifiers as a pre-condition for executing the request on the server side. This is especially used in conjunction with an * (asterix) that is matching all possible resource identifiers to ensure the initial creation of a resource. Other use cases are possible but rare.

If the pre-condition fails the server will respond with status code 412 (Precondition Failed). See RFC 9110 Section 13.1.2 as well as [API Guideline Rule #182][api-182] for further details.

[api-182]: https://opensource.zalando.com/restful-api-guidelines/#182.

Responses

Request samples 

import (
	context "context"
	option "github.com/truvity/sdk-go/option"
	sdkgo "github.com/truvity/sdk-go"
	sdkgoclient "github.com/truvity/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.Dids.DidDocumentSelfGet(
	context.TODO(),
	&sdkgo.DidDocumentSelfGetRequest{},
)

Response samples

Content type
application/did+ld+json
{
  • "@context": [
    ],
  • "id": "strings",
  • "verificationMethod": [
    ],
  • "authentication": [
    ],
  • "assertionMethod": [
    ],
  • "service": []
}

Draft

The API to manage Drafts.

Create Draft.

Create Draft's resource.

Authorizations:
ApiKey
header Parameters
Idempotency-Key
string [ 32 .. 256 ] characters [a-zA-Z0-9-]{32,256}

From Zalando RESTful API Guidelines - models/headers-1.0.0.yaml. The Idempotency-Key is a free identifier created by the client to identify a request. It is used by the service to identify repeated request to ensure idempotent behavior by sending the same (or a similar) response without executing the request a second time.

Clients should be careful as any subsequent requests with the same key may return the same response without further check. Thus, it is recommended to use a UUID version 4 (random) or any other random string with enough entropy to avoid collisions.

Keys expire after 24 hours. Clients are responsible to stay within this limit, if they require idempotent behavior.

See [API Guideline Rule #181][api-230] for further details.

[api-230]: https://opensource.zalando.com/restful-api-guidelines/#230.

Request Body schema: application/json
required
required
object (DraftCreate)

The schema for creating a draft.

object

The annotations of the resource.

object

The labels of the resource.

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "annotations": {
    },
  • "labels": {
    }
}

Response samples

Content type
application/vnd.truvity.draft+json;version=1
{
  • "kind": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "etag": "string",
  • "revision": 1,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "labels": {
    },
  • "data": {
    },
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Search for Drafts.

Search for Drafts with extended filters capabilities.

Authorizations:
ApiKey
Request Body schema: application/json
required
Array of objects or null (DraftFilter) <= 4 items

The filter to apply to the search.

Array of objects or null (DraftSort) <= 4 items

The sort order to apply to the search.

Responses

Request samples

Content type
application/json
{
  • "filter": [
    ],
  • "sort": [
    ]
}

Response samples

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

Get the latest version of Draft.

Get the latest version of Draft.

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

The ID of the resource.

header Parameters
If-None-Match
string

The ETag of the latest version of the resource.

Responses

Request samples 

import (
	context "context"
	option "github.com/truvity/sdk-go/option"
	sdkgo "github.com/truvity/sdk-go"
	sdkgoclient "github.com/truvity/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.Drafts.DraftLatest(
	context.TODO(),
	"id",
	&sdkgo.DraftLatestRequest{},
)

Response samples

Content type
application/vnd.truvity.draft+json;version=1
{
  • "kind": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "etag": "string",
  • "revision": 1,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "labels": {
    },
  • "data": {
    },
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Update Draft.

Update Draft's resource.

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

The primary and unique identifier of the resource (inside tenant) according to RFC 4122.

header Parameters
Idempotency-Key
string [ 32 .. 256 ] characters [a-zA-Z0-9-]{32,256}

From Zalando RESTful API Guidelines - models/headers-1.0.0.yaml. The Idempotency-Key is a free identifier created by the client to identify a request. It is used by the service to identify repeated request to ensure idempotent behavior by sending the same (or a similar) response without executing the request a second time.

Clients should be careful as any subsequent requests with the same key may return the same response without further check. Thus, it is recommended to use a UUID version 4 (random) or any other random string with enough entropy to avoid collisions.

Keys expire after 24 hours. Clients are responsible to stay within this limit, if they require idempotent behavior.

See [API Guideline Rule #181][api-230] for further details.

[api-230]: https://opensource.zalando.com/restful-api-guidelines/#230.

If-Match
required
string

From Zalando RESTful API Guidelines - models/headers-1.0.0.yaml. The If-Match header field is used to declare a list of identifiers that are required to match the current resource version identifier in at least one position as a pre-condition for executing the request on the server side. This behavior is used to validate and reject optimistic updates, by checking if the resource version a consumer has based his changes on is outdated on arrival of the change request to prevent lost updates.

If the pre-condition fails the server will respond with status code 412 (Precondition Failed). See RFC 9110 Section 13.1.1 as well as [API Guideline Rule #182][api-182] for further details.

[api-182]: https://opensource.zalando.com/restful-api-guidelines/#182.

Request Body schema: application/json
required
required
object (DraftCreate)

The schema for creating a draft.

object

The annotations of the resource.

object

The labels of the resource.

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "annotations": {
    },
  • "labels": {
    }
}

Response samples

Content type
application/vnd.truvity.draft+json;version=1
{
  • "kind": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "etag": "string",
  • "revision": 1,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "labels": {
    },
  • "data": {
    },
  • "deleted_at": "2019-08-24T14:15:22Z"
}