Skip to main content
API docs by Redocly

Sovrin - Decentralized Identity Platform Rest API (v1)

Download OpenAPI specification:Download

Decentralized Identity Platform Rest API

Sovrin Decentralized Identity Platform Allows you to issue,manage and verify decentralized identities & verifiable credentials.

DIDs

DID Management

getDIDConfiguration

Get DID configuration

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "context": "string",
  • "linkedDids": [
    ]
}

getDIDJSON

Get DID JSON

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{ }

getDIDsList

List all DIDs

Authorizations:
OAuth2ClientCredentials
query Parameters
limit
integer or null <uint64> >= 0

Number of items per page

page
integer or null <uint64> >= 0

Page number

Responses

Response samples

Content type
application/json
{
  • "dids": [
    ],
  • "limit": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

createDID

Create a DID

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
method
required
string (KeyMethod)
Enum: "KEY" "WEB"

Key Method

required
object

Options

Responses

Request samples

Content type
application/json
{
  • "method": "KEY",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "did": "string",
  • "id": "string",
  • "metadata": {
    },
  • "registrationStatus": "string"
}

getDIDById

Get DID details

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "did": "string",
  • "metadata": {
    },
  • "registrationStatus": "COMPLETED"
}

Delete a DID

Deletes a DID and all associated metadata including the Private keys from the platform and KMS. For ledger-based DIDs the public DID Document will still be available. For did:web you can remove the did.json from your hosted domain.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

Custom Domains

Custom Domains Mapping Management

getListOfDomains

List all custom domains.

Authorizations:
OAuth2ClientCredentials
query Parameters
limit
integer or null <uint64> >= 0

The number of items to return in a page

page
integer or null <uint64> >= 0

The page number to return

Responses

Response samples

Content type
application/json
{
  • "domains": [
    ],
  • "limit": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

createDomain

Create a new custom domain.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
domain
required
string

Domain

name
required
string

Name

Responses

Request samples

Content type
application/json
{
  • "domain": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "domain": "string",
  • "id": "string",
  • "isVerified": true,
  • "name": "string",
  • "verificationToken": "string",
  • "verifiedAt": "2019-08-24T14:15:22Z"
}

getDomainById

Get a custom domain details by id.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

updateDomain

Update a custom domain.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
name
required
string

The domain name to be updated

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "domain": "string",
  • "id": "string",
  • "isVerified": true,
  • "name": "string",
  • "verificationToken": "string",
  • "verifiedAt": "2019-08-24T14:15:22Z"
}

deleteDomain

Delete a custom domain.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

updateDomain

Verify a custom domain.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

Mobile Credentials

Mobile Credentials Management

signMobileCredential

Sign a credential

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
documentSignerId
string or null

document signer id

required
object (SignRequestPayload)

payload for signing credentials

Responses

Request samples

Content type
application/json
{
  • "documentSignerId": "string",
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "decoded": {
    },
  • "encoded": "string"
}

removeMobileCredentialsMetadata

Remove credential metadata

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

getMobileCredentialsIacas

List all iacas

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{ }

createMobileCredentialsIaca

Create an iaca

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
object (CreateIacaRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

getMobileCredentialsDocumentSigners

List all document signers

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{ }

createMobileCredentialsDocumentSigner

Create a document signer

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
object (CreateDocumentSignerRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

getMobileCredentialDocumentSigner

Get document signer details

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{ }

updateMobileCredentialsDocumentSigner

Update a document signer

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
object (UpdateDocumentSignerRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

deleteMobileCredentialsDocumentSigner

Delete a document signer

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

getMobileCredentialSchemas

List all schemas

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{ }

createMobileCredentialSchema

Create a schema

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
object (CreateSchemaRequest2)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

getMobileCredentialSchema

Get schema details

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{ }

updateMobileCredentialSchema

Update a schema

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
object (UpdateSchemaRequest2)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

deleteMobileCredentialSchema

Delete a schema

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

Web Semantic Credentials

Web Semantic Credentials Management

signWebSemanticCredential

Sign a credential

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
required
object (SignWebSemanticCredentialRequestPayload)

Payload object

proofType
required
string (CredentialProofType)
Enum: "Ed25519Signature2018" "BbsSignature2022"

Proof type for the credential. Issuer DID must contain a key that supports the corresponding signing capability.

revocable
required
boolean

Flag to indicate if the credential needs to support revocation.

tag
required
string

An optional tag to filter by, will not be part of the issued credential

Responses

Request samples

Content type
application/json
{
  • "payload": {
    },
  • "proofType": "Ed25519Signature2018",
  • "revocable": true,
  • "tag": "string"
}

Response samples

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

verifyWebSemanticCredentials

Verify a credential

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
required
object (Credential)

To supply a value for this field, you can find it by looking up the credential attribute from the response body of the sign endpoint.

required
(Context (URI (URI (string)) or Context (object))) or (Array of Contexts (URI (URI (string)) or objects)) (Contexts)
(OneOrMany_for_Schema (Schema (object) or Array of OneOrMany_for_Schema (objects))) or null
Status (object) or null
required
CredentialSubject (object) or Array of OneOrMany_for_CredentialSubject (objects) (OneOrMany_for_CredentialSubject)
(OneOrMany_for_Evidence (Evidence (object) or Array of OneOrMany_for_Evidence (objects))) or null
VCDateTime (object) or null
(StringOrURI (StringOrURI (string) or URI (URI (string)))) or null
VCDateTime (object) or null
(Issuer (URI (URI (string)) or ObjectWithId (object))) or null
(OneOrMany_for_Proof (Proof (object) or Array of OneOrMany_for_Proof (objects))) or null
(OneOrMany_for_RefreshService (RefreshService (object) or Array of OneOrMany_for_RefreshService (objects))) or null
Array of objects or null (TermsOfUse)
required
OneOrMany_for_String (string) or Array of OneOrMany_for_String (strings) (OneOrMany_for_String)
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "reason": [
    ],
  • "verified": true
}

listWebSemanticCredentials

List all credentials

Authorizations:
OAuth2ClientCredentials
query Parameters
limit
integer or null <uint64> >= 0

Limit

page
integer or null <uint64> >= 0

Page

tag
string or null

Tag

type
string or null

Type

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "limit": 0,
  • "total_count": 0,
  • "total_pages": 0
}

getWebSemanticCredentialDetails

Get credential details

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "additional_types": [
    ],
  • "claim_mappings": {
    },
  • "claim_source_id": "string",
  • "context": "string",
  • "credential_branding": {
    },
  • "description": "string",
  • "expires_in": {
    },
  • "id": "string",
  • "issuer": {
    },
  • "name": "string",
  • "persist": true,
  • "proof_type": "string",
  • "revocable": true,
  • "type": "string"
}

deleteWebSemanticCredential

Delete a credential

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

getWebSemanticRevocationStatus

Get revocation status

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

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

setWebSemanticRevocationStatus

Set revocation status

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
is_revoked
required
boolean

Is revoked

Responses

Request samples

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

Response samples

Content type
application/json
{ }

webSemanticRevocationStatusNotification

Revocation status notification

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
object (RevocationStatusNotificationRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

getWebSemanticCredentialRevocationList

Get Revocation List

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "credential": {
    },
  • "credential_id": "string",
  • "id": "string",
  • "org_did_id": "string",
  • "updated_at": "2019-08-24T14:15:22Z"
}

getWebSemanticPresentationTemplatesLists

List all presentation templates

Authorizations:
OAuth2ClientCredentials
query Parameters
limit
integer or null <uint64> >= 0

No of records on each page

page
integer or null <uint64> >= 0

No of pages to fetch

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "limit": 0,
  • "total_count": 0,
  • "total_pages": 0
}

createWebSemanticPresentationTemplate

Create a presentation template

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required

Represents the request structure when creating a presentation template, specifying the domain, name, and a query structure for dynamic content.

domain
required
string

The domain associated with the presentation template.

name
required
string

The name of the presentation template.

required
object

A hashmap representing the query structure for dynamic content in the presentation template.

Responses

Request samples

Content type
application/json
{
  • "domain": "string",
  • "name": "string",
  • "query": {
    }
}

Response samples

Content type
application/json
{
  • "domain": "string",
  • "id": "string",
  • "name": "string",
  • "query": {
    }
}

getWebSemanticPresentationTemplate

Get a presentation template details

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "domain": "string",
  • "id": "string",
  • "name": "string",
  • "query": {
    }
}

updateWebSemanticPresentationTemplate

Update a presentation template

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
domain
required
string

The domain associated with the presentation template.

id
string or null

Identifier associated with the presentation template to be updated.

name
required
string

The name of the presentation template.

required
object

A hashmap representing the query structure for dynamic content in the presentation template.

Responses

Request samples

Content type
application/json
{
  • "domain": "string",
  • "id": "string",
  • "name": "string",
  • "query": {
    }
}

Response samples

Content type
application/json
{
  • "domain": "string",
  • "id": "string",
  • "name": "string",
  • "query": {
    }
}

deleteWebSemanticPresentationTemplate

Delete a presentation template

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

createWebSemanticPresentationTemplate

Create a presentation request

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
domain
required
string

The domain associated with the presentation template.

name
required
string

The name of the presentation template.

required
object

A hashmap representing the query structure for dynamic content in the presentation template.

Responses

Request samples

Content type
application/json
{
  • "domain": "string",
  • "name": "string",
  • "query": {
    }
}

Response samples

Content type
application/json
{
  • "domain": "string",
  • "id": "string",
  • "name": "string",
  • "query": {
    }
}

verifyWebSemanticPresentationTemplate

Verify a presentation

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required

Represents a request structure for verifying a presentation, including the presentation data, an optional challenge string, and an optional domain.

challenge
string or null

Optional challenge string for additional verification.

domain
string or null

Optional domain information for context during verification.

required
object (Presentation)

The presentation data to be verified.

Responses

Request samples

Content type
application/json
{
  • "challenge": "string",
  • "domain": "string",
  • "presentation": {
    }
}

Response samples

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

convertLinkedData

Convert linked data

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
required
object or object (LinkedData)
required
object (ConvertLinkedDataOptions)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": null,
  • "metadata": {
    }
}

getWebSemanticCredentialTemplateLists

List all templates

Authorizations:
OAuth2ClientCredentials
query Parameters
limit
integer or null <uint64> >= 0

Optional limit specifying the maximum number of credential templates per page.

page
integer or null <uint64> >= 0

Optional page number for pagination.

type
string or null

Optional filter by type for specific credential templates.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "limit": 0,
  • "total_count": 0,
  • "total_pages": 0
}

createWebSemanticCredentialTemplate

Create a web semantic credential template

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required

Represents the request structure when creating a credential template, providing details such as name, description, type, additional types, contexts, issuer information, proof type, credential branding, claim mappings, revocable status, claim source identifier, and expiration details.

additional_types
required
Array of strings

Additional types associated with the credential template.

object or null

Optional mapping of claim names to their corresponding values in the credential template.

claim_source_id
string or null

Optional identifier of the claim source associated with the credential template.

contexts
any

Optional JSON value representing the contexts associated with the credential template.

CredentialBranding2 (object) or null

Optional branding information associated with the credential template.

description
string or null

Optional description providing additional information about the credential template.

CredentialExpiry (object) or null

Optional expiration details associated with the credential template.

required
object (CredentialTemplateIssuer)

Issuer details associated with the credential template.

name
required
string

Name of the credential template.

proof_type
string or null

Optional proof type associated with the credential template.

revocable
required
boolean

Flag indicating whether the credential template is revocable.

type
required
string

Type of the credential template.

Responses

Request samples

Content type
application/json
{
  • "additional_types": [
    ],
  • "claim_mappings": {
    },
  • "claim_source_id": "string",
  • "contexts": null,
  • "credential_branding": {
    },
  • "description": "string",
  • "expires_in": {
    },
  • "issuer": {
    },
  • "name": "string",
  • "proof_type": "string",
  • "revocable": true,
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "additional_types": [
    ],
  • "claim_mappings": {
    },
  • "claim_source_id": "string",
  • "contexts": null,
  • "credential_branding": {
    },
  • "description": "string",
  • "expires_in": {
    },
  • "id": "string",
  • "issuer": {
    },
  • "name": "string",
  • "proof_type": "string",
  • "revocable": true,
  • "type": "string"
}

getWebSemanticCredentialTemplate

Get web semantic credential template details

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "additional_types": [
    ],
  • "claim_mappings": {
    },
  • "claim_source_id": "string",
  • "contexts": null,
  • "credential_branding": {
    },
  • "description": "string",
  • "expires_in": {
    },
  • "id": "string",
  • "issuer": {
    },
  • "name": "string",
  • "proof_type": "string",
  • "revocable": true,
  • "type": "string"
}

updateWebSemanticCredentialTemplate

Update a web semantic credential template

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
additional_types
required
Array of strings

Additional types associated with the credential template.

object or null

Optional mapping of claim names to their corresponding values in the credential template.

claim_source_id
string or null

Optional identifier of the claim source associated with the credential template.

contexts
any

Optional JSON value representing the contexts associated with the credential template.

CredentialBranding2 (object) or null

Optional branding information associated with the credential template.

description
string or null

Optional description providing additional information about the credential template.

CredentialExpiry (object) or null

Optional expiration details associated with the credential template.

required
object (CredentialTemplateIssuer)

Issuer details associated with the credential template.

name
required
string

Name of the credential template.

proof_type
string or null

Optional proof type associated with the credential template.

revocable
required
boolean

Flag indicating whether the credential template is revocable.

type
required
string

Type of the credential template.

Responses

Request samples

Content type
application/json
{
  • "additional_types": [
    ],
  • "claim_mappings": {
    },
  • "claim_source_id": "string",
  • "contexts": null,
  • "credential_branding": {
    },
  • "description": "string",
  • "expires_in": {
    },
  • "issuer": {
    },
  • "name": "string",
  • "proof_type": "string",
  • "revocable": true,
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "additional_types": [
    ],
  • "claim_mappings": {
    },
  • "claim_source_id": "string",
  • "contexts": null,
  • "credential_branding": {
    },
  • "description": "string",
  • "expires_in": {
    },
  • "id": "string",
  • "issuer": {
    },
  • "name": "string",
  • "proof_type": "string",
  • "revocable": true,
  • "type": "string"
}

deleteWebSemanticCredentialTemplate

Delete a web semantic credential template

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

Compact Credentials

Compact Credentials Management

signCompactCredential

Sign/Create a Credential

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
required
object (CompactCredentialPayload)

The payload of the credential (CompactCredentialSignRequest)

revocable
required
boolean

revocable flag

Responses

Request samples

Content type
application/json
{
  • "payload": {
    },
  • "revocable": true
}

Response samples

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

verifyCompactCredential

Verify a Credential

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
assert_expiry
boolean or null

The assert expiry flag

assert_not_before
boolean or null

The assert not before flag

check_revocation
boolean or null

The revocation flag

payload
required
string

A compact credential encoded payload

trusted_issuers
Array of strings or null

The issuers of the credential

Responses

Request samples

Content type
application/json
{
  • "assert_expiry": true,
  • "assert_not_before": true,
  • "check_revocation": true,
  • "payload": "string",
  • "trusted_issuers": [
    ]
}

Response samples

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

getCompactCredentials

Get Credentials

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{ }

getCompactCredentialById

Get a Credential

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{ }

deleteCompactCredentialById

Delete a Credential

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

getCompactCredentialRevocationStatus

Get Revocation Status

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

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

setCompactCredentialRevocationStatus

Set Revocation Status

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
object (SetRevocationStatusRequest2)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

getCompactCredentialRevocationLists

Get Revocation Lists

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{ }

getCompactCredentialRevocationListById

Get Revocation List

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{ }

getCompactCredentialQRCode

Get QR Code

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
object (QrcodeRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{}

getCompactSchemas

Get Schemas

Authorizations:
OAuth2ClientCredentials
query Parameters
limit
integer or null <uint64> >= 0

page size

page
integer or null <uint64> >= 0

page no

type
string or null

The type of the template

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "templates": [
    ],
  • "total_count": 0,
  • "total_pages": 0
}

createCompactCredentialTemplate

Create a Template

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
claim_source_id
string or null

Claim Source ID

required
object

Credential Mappings

ExpirationObject (object) or null

Optional field that specifies how long after issuance credentials generated using this configuration will expire.

revocable
boolean or null

revocable flag

type
required
string

Type for the credential, must be unique across credential configurations for the tenant, cannot contain whitespace, and must not be VerifiableCredentia

Responses

Request samples

Content type
application/json
{
  • "claim_source_id": "string",
  • "credential_mappings": {
    },
  • "expiration": {
    },
  • "revocable": true,
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "claim_source_id": "string",
  • "credential_mappings": {
    },
  • "expiration": {
    },
  • "id": "string",
  • "revocable": true,
  • "type": "string"
}

getCompactCredentialTemplateById

Get a Template

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "claim_source_id": "string",
  • "credential_mappings": {
    },
  • "expiration": {
    },
  • "id": "string",
  • "revocable": true,
  • "type": "string"
}

updateCompactCredentialTemplate

Update a template

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
claim_source_id
string or null

Claim Source ID

required
object

Credential Mappings

ExpirationObject (object) or null

Optional field that specifies how long after issuance credentials generated using this configuration will expire.

revocable
boolean or null

revocable flag

type
required
string

Type for the credential, must be unique across credential configurations for the tenant, cannot contain whitespace, and must not be VerifiableCredentia

Responses

Request samples

Content type
application/json
{
  • "claim_source_id": "string",
  • "credential_mappings": {
    },
  • "expiration": {
    },
  • "revocable": true,
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "claim_source_id": "string",
  • "credential_mappings": {
    },
  • "expiration": {
    },
  • "id": "string",
  • "revocable": true,
  • "type": "string"
}

deleteCompactCredentialTemplateById

Delete a Template

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

createCompactCredentialPdf

Create a Credential PDF

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
object (CreateCredentialPdfRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{}

getCompactCredentialPdfTemplates

Get PDF Templates

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{ }

createCompactCredentialPdfTemplate

Create a PDF Template

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
object (CreatePdfTemplateRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "fields": [
    ],
  • "file_name": "string",
  • "fonts": [
    ],
  • "id": "string",
  • "metadata": {
    },
  • "name": "string"
}

getCompactCredentialPdfTemplateById

Get a PDF Template

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "fields": [
    ],
  • "file_name": "string",
  • "fonts": [
    ],
  • "id": "string",
  • "metadata": {
    },
  • "name": "string"
}

updateCompactCredentialPdfTemplate

Update a PDF Template

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
object (UpdatePdfTemplateRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "fields": [
    ],
  • "file_name": "string",
  • "fonts": [
    ],
  • "id": "string",
  • "metadata": {
    },
  • "name": "string"
}

deleteCompactCredentialPdfTemplateById

Delete a PDF Template

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

Compact Semantic Credentials

Compact Semantic Credentials

Sign a credential

Sign a credential

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
object (SignCredentialRequest3)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Verify a credential

Verify a credential

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
object (VerifyCredentialRequest3)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Get a list of credentials

Get a list of credentials

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{ }

Get a credential

Get a credential

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{ }

Delete a credential

Delete a credential

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

Get the revocation status of a credential

Get the revocation status of a credential

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{ }

Set the revocation status of a credential

Set the revocation status of a credential

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
object (SetRevocationStatusRequest3)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Get a list of revocation lists

Get a list of revocation lists

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{ }

Get a revocation list

Get a revocation list

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{ }

Get a QR code

Get a QR code

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
payload
required
string
width
integer or null <uint32> >= 0

Responses

Request samples

Content type
application/json
{
  • "payload": "string",
  • "width": 0
}

Response samples

Content type
application/json
{}

Get a list of schemas

Get a list of schemas

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{ }

Create a schema

Create a schema

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
object (CreateSchemaRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Get a schema

Get a schema

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{ }

Update a schema

Update a schema

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
object (UpdateSchemaRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Delete a schema

Delete a schema

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

Create a credential PDF

Create a credential PDF

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
object (CreateCredentialPdfRequest2)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Get a list of PDF templates

Get a list of PDF templates

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{ }

Create a PDF template

Create a PDF template

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
object (CreatePdfTemplateRequest2)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Get a PDF template

Get a PDF template

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{ }

Update a PDF template

Update a PDF template

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
object (UpdatePdfTemplateRequest2)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Delete a PDF template

Delete a PDF template

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

DIDComm Messaging

DIDComm Messaging

getListOfInboxes

List all inboxes

Authorizations:
OAuth2ClientCredentials
query Parameters
limit
integer or null <uint64> >= 0

Number of items per page

page
integer or null <uint64> >= 0

Page number

Responses

Response samples

Content type
application/json
{
  • "inboxes": [
    ],
  • "limit": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

createInbox

Create an inbox

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
name
required
string

Inbox name

Responses

Request samples

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

Response samples

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

Get inbox details

Get inbox details

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

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

updateInbox

Update an inbox

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
name
required
string

Inbox name

Responses

Request samples

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

Response samples

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

deleteInbox

Delete an inbox

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

listDIDs

List all DIDs

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

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

registerDID

Register a DID

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
did
required
string

DID

jwt
string or null

JWT

Responses

Request samples

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

Response samples

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

unregisterDID

Unregister a DID

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

getListOfMessages

List all messages

Authorizations:
OAuth2ClientCredentials
query Parameters
limit
integer or null <uint64> >= 0
page
integer or null <uint64> >= 0

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "messages": [
    ],
  • "totalCount": 0,
  • "totalPages": 0
}

getMessage

Get a message

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "id": "string",
  • "inboxId": "string",
  • "payload": "string"
}

deleteMessage

Delete a message

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

signCredential

Sign credential

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
didUrl
required
string

DID URL of the signer

payload
required
any

Payload to sign

Responses

Request samples

Content type
application/json
{
  • "didUrl": "string",
  • "payload": null
}

Response samples

Content type
application/json
{
  • "did": "string",
  • "didUrl": "string",
  • "payload": null,
  • "signerPublicJwk": null,
  • "verified": true
}

verifyCredential

Verify credential

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
jws
required
string

JWS of the credential

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "did": "string",
  • "didUrl": "string",
  • "payload": null,
  • "signerPublicJwk": null,
  • "verified": true
}

encryptCredentials

Encrypt credentials

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
payload
required
any

Payload to encrypt

recipientDidUrls
required
Array of strings

DID URLs of the recipients

senderDidUrl
required
string

DID URL of the sender

Responses

Request samples

Content type
application/json
{
  • "payload": null,
  • "recipientDidUrls": [
    ],
  • "senderDidUrl": "string"
}

Response samples

Content type
application/json
{
  • "jwe": {
    }
}

decryptCredentials

Decrypt credentials

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
jwe
required
string

JWE of the encrypted payload

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "payload": null,
  • "recipientDidUrl": "string",
  • "senderDidUrl": "string",
  • "senderPublicJwk": null
}

sendMessage

Send message

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
message
required
any

DID URL of the recipient

to
required
string

DID URL of the sender

Responses

Request samples

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

Response samples

Content type
application/json
{ }

Webhooks

Webhooks

getWebhooks

List all webhooks

Authorizations:
OAuth2ClientCredentials
query Parameters
limit
integer or null <uint64> >= 0

The number of items to return per page

page
integer or null <uint64> >= 0

The page number to return

required
string or string or string (WebhookStatus)

The status of the webhooks to return

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "totalCount": 0,
  • "totalPages": 0,
  • "webhooks": [
    ]
}

createWebhook

Create a webhook

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
events
required
Array of strings

The webhook events

secret
required
string

The webhook secret

url
required
string

The webhook URL

Responses

Request samples

Content type
application/json
{
  • "events": [
    ],
  • "secret": "string",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "events": [
    ],
  • "id": "string",
  • "secret": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "url": "string"
}

getWebhook

Get a webhook

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "events": [
    ],
  • "id": "string",
  • "secret": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "url": "string"
}

updateWebhook

Update a webhook

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
events
Array of strings or null

The webhook events

secret
string or null

The webhook secret

url
string or null

The webhook URL

Responses

Request samples

Content type
application/json
{
  • "events": [
    ],
  • "secret": "string",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "events": [
    ],
  • "id": "string",
  • "secret": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "url": "string"
}

deleteWebhook

Delete a webhook

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

getWebhooks

Get the list of webhooks

Authorizations:
OAuth2ClientCredentials
query Parameters
limit
integer or null <uint64> >= 0
page
integer or null <uint64> >= 0

Responses

Response samples

Content type
application/json
{}

Authentication

getOAuthAccessToken

Authorization endpoint for gaining token used for API requests

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
clientId
required
string

The client id of the application

clientSecret
required
string

The client secret of the application

grantType
required
string

The grant type of the application

scope
string or null

The scope of the application

Responses

Request samples

Content type
application/json
{
  • "clientId": "string",
  • "clientSecret": "string",
  • "grantType": "string",
  • "scope": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "expires_in": 0,
  • "token_type": "string"
}

Logs

getListOfLogs

Returns a list of Logs for the tenant.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
categories
required
Array of strings

The ids of users.

dateFrom
required
string <date-time>

The ids of users.

dateTo
required
string <date-time>

The ids of users.

ids
required
Array of strings

The ids of logs.

requestIds
required
Array of strings

The ids of requests.

types
required
Array of strings

The ids of users.

Responses

Request samples

Content type
application/json
{
  • "categories": [
    ],
  • "dateFrom": "2019-08-24T14:15:22Z",
  • "dateTo": "2019-08-24T14:15:22Z",
  • "ids": [
    ],
  • "requestIds": [
    ],
  • "types": [
    ]
}

Response samples

Content type
application/json
{
  • "category": "string",
  • "data": "string",
  • "id": "string",
  • "metadata": "string",
  • "timestamp": "string",
  • "type": "string"
}

OIDC Bridge

indexOidcVerifier

Returns a list of all OIDC Verifiers in the Tenant.

Authorizations:
OAuth2ClientCredentials
query Parameters
limit
integer or null <uint64> >= 0

The number of items to return per page

page
integer or null <uint64> >= 0

The page number to return

Responses

Response samples

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

createOidcVerifier

Create a new OIDC Credential Verifier for this tenant.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
required
Array of objects (ClaimMappings)

Claim Mappings

include_presentation
required
boolean

Include Presentation

presentation_template_id
required
string

Presentation Template ID

verifier_did
required
string

The DID of the Verifier

Responses

Request samples

Content type
application/json
{
  • "claim_mappings": [
    ],
  • "include_presentation": true,
  • "presentation_template_id": "string",
  • "verifier_did": "string"
}

Response samples

Content type
application/json
{}

getOidcVerifier

Retrieve an OIDC Verifier by providing a Verifier ID.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "claimMappings": [
    ],
  • "id": "string",
  • "includePresentation": true,
  • "presentationTemplateId": "string",
  • "verifierDid": "string"
}

updateOidcVerifier

Update an OIDC Credential Verifier.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
required
Array of objects (ClaimMappings)

Claim Mappings

include_presentation
required
boolean

Include Presentation

presentation_template_id
required
string

Presentation Template ID

verifier_did
required
string

The DID of the Verifier

Responses

Request samples

Content type
application/json
{
  • "claim_mappings": [
    ],
  • "include_presentation": true,
  • "presentation_template_id": "string",
  • "verifier_did": "string"
}

Response samples

Content type
application/json
{
  • "claimMappings": [
    ],
  • "id": "string",
  • "includePresentation": true,
  • "presentationTemplateId": "string",
  • "verifierDid": "string"
}

deleteOidcVerifier

Removes an OIDC Verifier by providing a Verifier ID.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

getOpenIdConfiguration

The OpenId Connect /token endpoint is used to obtain the access_token and id_token by presenting a valid authorization code

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
required
object or object (TokenEndpointRequest)
One of
required
object (InitialTokenRequest)
clientId
required
string

The client_id obtained during the application registration process.

clientSecret
required
string

The client_secret obtained during the application registration process.

code
required
string

The authorization code received from the authorization server.

grantType
required
string

The grant_type parameter must be set to "authorization_code".

redirectUri
required
string

The redirect_uri parameter must be set to the same value as was used in the initial authorization request.

Responses

Request samples

Content type
application/json
{
  • "tokenEndpointRequest": {
    }
}

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "expiresIn": 0,
  • "idToken": "string",
  • "refreshToken": "string",
  • "tokenType": "string"
}

getListOfOidcVerifierClient

Returns a list of all OIDC Verifier Clients in the Tenant.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
limit
integer or null <uint64> >= 0

The number of items to return per page

page
integer or null <uint64> >= 0

The page number to return

Responses

Request samples

Content type
application/json
{
  • "limit": 0,
  • "page": 0
}

Response samples

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

createOidcVerifierClient

The Create Client endpoint accepts OpenID Connect standard registration parameters.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
applicationType
required
string

The application type of the Client

grantTypes
required
Array of strings

The grant types of the Client

idTokenSignedResponseAlg
required
string

The id token signed response alg of the Client

logoUri
required
string

The logo URI of the Client

name
required
string

The name of the Client

redirectUris
required
Array of strings

The redirect URIs of the Client

responseTypes
required
Array of strings

The response types of the Client

tokenEndpointAuthMethod
required
string

The token endpoint auth method of the Client

Responses

Request samples

Content type
application/json
{
  • "applicationType": "string",
  • "grantTypes": [
    ],
  • "idTokenSignedResponseAlg": "string",
  • "logoUri": "string",
  • "name": "string",
  • "redirectUris": [
    ],
  • "responseTypes": [
    ],
  • "tokenEndpointAuthMethod": "string"
}

Response samples

Content type
application/json
{}

getOidcVerifierClient

Retrieve an OIDC Verifier Client by providing a Client ID.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "applicationType": "string",
  • "grantTypes": [
    ],
  • "id": "string",
  • "idTokenSignedResponseAlg": "string",
  • "logoUri": "string",
  • "name": "string",
  • "redirectUris": [
    ],
  • "responseTypes": [
    ],
  • "secret": "string",
  • "tokenEndpointAuthMethod": "string"
}

updateOidcVerifierClient

Updates an OIDC Verifier Client by providing a Client ID.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
applicationType
required
string

The application type of the Client

grantTypes
required
Array of strings

The grant types of the Client

idTokenSignedResponseAlg
required
string

The id token signed response alg of the Client

logoUri
required
string

The logo URI of the Client

name
required
string

The name of the Client

redirectUris
required
Array of strings

The redirect URIs of the Client

responseTypes
required
Array of strings

The response types of the Client

tokenEndpointAuthMethod
required
string

The token endpoint auth method of the Client

Responses

Request samples

Content type
application/json
{
  • "applicationType": "string",
  • "grantTypes": [
    ],
  • "idTokenSignedResponseAlg": "string",
  • "logoUri": "string",
  • "name": "string",
  • "redirectUris": [
    ],
  • "responseTypes": [
    ],
  • "tokenEndpointAuthMethod": "string"
}

Response samples

Content type
application/json
{
  • "applicationType": "string",
  • "grantTypes": [
    ],
  • "id": "string",
  • "idTokenSignedResponseAlg": "string",
  • "logoUri": "string",
  • "name": "string",
  • "redirectUris": [
    ],
  • "responseTypes": [
    ],
  • "secret": "string",
  • "tokenEndpointAuthMethod": "string"
}

deleteOidcVerifierClient

Removes an OIDC Verifier Client by providing a Client ID.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

openidConfiguration

The standard OpenID Connect Well Known configuration metadata endpoint.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

Authentication Provider

listAuthenticationProvider

Returns a list of all Authentication Providers.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
limit
integer or null <uint64> >= 0
page
integer or null <uint64> >= 0

Responses

Request samples

Content type
application/json
{
  • "limit": 0,
  • "page": 0
}

Response samples

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

createAuthenticationProvider

Returns a list of all Authentication Providers.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
claims_to_persist
Array of strings or null
client_id
required
string
client_secret
required
string
forwarded_request_parameters
Array of strings or null
scope
Array of strings or null
object or null
token_endpoint_auth_method
string or null
url
string or null

Responses

Request samples

Content type
application/json
{
  • "claims_to_persist": [
    ],
  • "client_id": "string",
  • "client_secret": "string",
  • "forwarded_request_parameters": [
    ],
  • "scope": [
    ],
  • "static_request_parameters": {
    },
  • "token_endpoint_auth_method": "string",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "claims_to_persist": [
    ],
  • "client_id": "string",
  • "client_secret": "string",
  • "forwarded_request_parameters": [
    ],
  • "id": "string",
  • "redirect_url": "string",
  • "scope": [
    ],
  • "static_request_parameters": {
    },
  • "token_endpoint_auth_method": "string",
  • "url": "string"
}

getAuthenticationProvider

Retrieve an Authentication Provider by providing an ID.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "claims_to_persist": [
    ],
  • "client_id": "string",
  • "client_secret": "string",
  • "forwarded_request_parameters": [
    ],
  • "id": "string",
  • "redirect_url": "string",
  • "scope": [
    ],
  • "static_request_parameters": {
    },
  • "token_endpoint_auth_method": "string",
  • "url": "string"
}

updateAuthenticationProvider

Update an Authentication Provider.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
claims_to_persist
Array of strings or null
client_id
required
string
client_secret
required
string
forwarded_request_parameters
Array of strings or null
scope
Array of strings or null
object or null
token_endpoint_auth_method
string or null

Responses

Request samples

Content type
application/json
{
  • "claims_to_persist": [
    ],
  • "client_id": "string",
  • "client_secret": "string",
  • "forwarded_request_parameters": [
    ],
  • "scope": [
    ],
  • "static_request_parameters": {
    },
  • "token_endpoint_auth_method": "string"
}

Response samples

Content type
application/json
{
  • "claims_to_persist": [
    ],
  • "client_id": "string",
  • "client_secret": "string",
  • "forwarded_request_parameters": [
    ],
  • "id": "string",
  • "redirect_url": "string",
  • "scope": [
    ],
  • "static_request_parameters": {
    },
  • "token_endpoint_auth_method": "string",
  • "url": "string"
}

deleteAuthenticationProvider

Deletes an Authentication Provider.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

getOpenIDConfiguration

Retrieve an existing OpenID Configuration for your tenant.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "claims": [
    ],
  • "disabled": true,
  • "secret": "string",
  • "session_timeout_in_sec": 0,
  • "url": "string"
}

updateOpenIDConfiguration

Update an already existing OpenID Configuration for your tenant.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
claims
required
Array of strings
disabled
required
boolean
session_timeout_in_sec
required
integer <uint64> >= 0
url
required
string

Responses

Request samples

Content type
application/json
{
  • "claims": [
    ],
  • "disabled": true,
  • "session_timeout_in_sec": 0,
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "claims": [
    ],
  • "disabled": true,
  • "secret": "string",
  • "session_timeout_in_sec": 0,
  • "url": "string"
}

Users

searchUsers

Search users that match the provided criteria for this tenant.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
required
object (AuthenticationProviderRequest)

Authentication Provider filter. All properties are optional.

required
object

Sample claims to be used on matching the users. Nestsed objects are supported. Text values must be an exact match.

limit
integer or null <uint64> >= 0

limit

page
integer or null <uint64> >= 0

page

Responses

Request samples

Content type
application/json
{
  • "authenticationProvider": {
    },
  • "claims": {
    },
  • "limit": 0,
  • "page": 0
}

Response samples

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

retrieveListOfUsers

Returns a list of all Users.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
limit
integer or null <uint64> >= 0

limit

page
integer or null <uint64> >= 0

page

Responses

Request samples

Content type
application/json
{
  • "limit": 0,
  • "page": 0
}

Response samples

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

retrieveUser

Retrieve a User by providing an ID.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

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

updateUser

Updates a User by providing an ID.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

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

getUserCredentials

Returns a list of all Credential references for a User.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

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

requestAutherization

This endpoint is used to request authorization from the user for access to the requested resources.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "detail": "string",
  • "errors": null,
  • "instance": "868cf2e9-bd6d-4bac-96ba-2b08120d8cf9",
  • "status": 0,
  • "title": "string",
  • "type": "string"
}

exchangeCredentials

This endpoint is used to exchange an authorization code for an access token

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
clientId
required
string

The client ID

code
required
string

The code

codeVerifier
required
string

The code verifier

grantType
required
string

The grant type

redirectUri
required
string

The redirect URI

Responses

Request samples

Content type
application/json
{
  • "clientId": "string",
  • "code": "string",
  • "codeVerifier": "string",
  • "grantType": "string",
  • "redirectUri": "string"
}

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "expiresIn": 0,
  • "scope": "string",
  • "tokenType": "string"
}

issuerVerifiableCredentials

This endpoint is used to issue a verifiable credential to a subject.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
required
object or object or object or object (IssueVerificationRequestTypes)
One of
required
object (Object1)
required
object (CredentialDefination)

credential defination

format
required
string

format

required
object (Proof2)

proof

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "credential": {
    },
  • "format": "string"
}

createOpenIdConfiguration

This endpoint is used to create an OpenID credential issuance offer URI.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
credentials
required
Array of strings

credentials

required
object (RequestedParameters)

requested parameters

Responses

Request samples

Content type
application/json
{
  • "credentials": [
    ],
  • "requestedParameters": {
    }
}

Response samples

Content type
application/json
"string"

openIdCredentialMetadata

The standard OpenID4VCI Connect Well Known credential issuer metadata endpoint for your tenant.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "authorizationEndpoint": "string",
  • "codeChallengeMethodsSupported": [
    ],
  • "credentialEndpoint": "string",
  • "credentialIssuer": "string",
  • "credentialsSupported": {
    },
  • "grantTypesSupported": [
    ],
  • "issuer": "string",
  • "mdocIacasUri": "string",
  • "responseModesSupported": [
    ],
  • "responseTypesSupported": [
    ],
  • "scopesSupported": [
    ],
  • "tokenEndpoint": "string"
}

Environments

getEnvironments

Retrieves a list of all available environments.

Authorizations:
OAuth2ClientCredentials
query Parameters
limit
integer or null <uint64> >= 0

The number of items to retrieve per page. (default: 10)

page
integer or null <uint64> >= 0
Default: null

The page number to retrieve. (default: 1)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "limit": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Tenants

getTenants

Retrieves a list of all available tenants.

Authorizations:
OAuth2ClientCredentials
query Parameters
limit
integer or null <uint64> >= 0

The number of items to retrieve per page.

page
integer or null <uint64> >= 0

The page number to retrieve.

Responses

Response samples

Content type
application/json
{
  • "inboxes": [
    ],
  • "limit": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

createTenant

Creates a new tenant in the requested environment.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
environmentId
required
string

The environment the tenant is in.

name
string or null

The name of the tenant.

subdomain
required
string

The subdomain of the tenant.

Responses

Request samples

Content type
application/json
{
  • "environmentId": "string",
  • "name": "string",
  • "subdomain": "string"
}

Response samples

Content type
application/json
{}

getTenant

Retrieves a tenant by ID

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

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

deleteTenant

Deletes a tenant by ID.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

getTenantClients

Retrieves a list of client credentials in the requested tenant.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

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

deleteEcosystemParticipant

Deletes a participant in the requested ecosystem by its ID.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

Ecosystems

getListOfEcosystems

Retrieves a list of ecosystems.

Authorizations:
OAuth2ClientCredentials
query Parameters
limit
integer or null <uint64> >= 0

limit per page

page
integer or null <uint64> >= 0

page number

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "limit": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

createEcosystem

Creates an ecosystem.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
name
required
string

Ecosystem Name

Responses

Request samples

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

Response samples

Content type
application/json
{}

getEcosystem

Retrieves an ecosystem by its ID.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

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

updateEcosystem

Updates an ecosystem by its ID.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

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

deleteEcosystem

Deletes a ecosystem by ID.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

getListOfEcosystemParticipants

Retrieves a list of participants from the requested ecosystem.

Authorizations:
OAuth2ClientCredentials
query Parameters
limit
integer or null <uint64> >= 0

limit per page

page
integer or null <uint64> >= 0

page number

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "limit": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

createEcosystemParticipant

Creates a participant in the requested ecosystem.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
required
object (EcosystemParticipantIdentifiers)

Participant Identifiers

isIssuer
required
boolean

Is Issuer

isIssuerConstrained
required
boolean

Is Issuer Constrained

isVerifier
required
boolean

Is Verifier

isVerifierConstrained
required
boolean

Is Verifier Constrained

name
required
string

Participant Name

Responses

Request samples

Content type
application/json
{
  • "identifiers": {
    },
  • "isIssuer": true,
  • "isIssuerConstrained": true,
  • "isVerifier": true,
  • "isVerifierConstrained": true,
  • "name": "string"
}

Response samples

Content type
application/json
{}

getEcosystemParticipant

Retrieves a participant from the requested ecosystem by its ID.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "limit": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

updateEcosystemParticipant

Updates a participant in the requested ecosystem by its ID.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

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

getListOfEcosystemCredentials

Retrieves a list of credentials from the requested ecosystem.

Authorizations:
OAuth2ClientCredentials
query Parameters
limit
integer or null <uint64> >= 0

limit per page

page
integer or null <uint64> >= 0

page number

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "limit": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

createEcosystemCredential

Creates a new credential in the requested ecosystem.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
name
required
string

Credential Name

profile
required
string

Profile

type
required
string

Credential Type

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "profile": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{}

getEcosystemCredential

Retrieves a credential from the requested ecosystem by its ID.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "ecosystemId": "string",
  • "id": "string",
  • "name": "string",
  • "profile": "string",
  • "type": "string"
}

deleteEcosystemCredential

Deletes a credential in the requested ecosystem by its ID.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

getEcosystemIssuer

Retrieves an ecosystem issuer policy by its ID.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "credentials": [
    ],
  • "participants": [
    ],
  • "policyModifiedAt": "2019-08-24T14:15:22Z"
}

createEcosystemIssuer

Creates an issuer policy for the requested participant in the requested ecosystem.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
credentialId
required
string

Credential ID

Responses

Request samples

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

Response samples

Content type
application/json
{}

deleteEcosystemIssuer

Deletes an issuer policy for the requested participant in the requested ecosystem by its ID.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

getEcosystemVerifier

Retrieves an ecosystem verifier policy by its ID.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "credentials": [
    ],
  • "participants": [
    ],
  • "policyModifiedAt": "2019-08-24T14:15:22Z"
}

createEcosystemVerifier

Creates an verifier policy for the requested participant in the requested ecosystem.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
credentialId
required
string

Credential ID

Responses

Request samples

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

Response samples

Content type
application/json
{}

deleteEcosystemVerifier

Deletes an verifier policy for the requested participant in the requested ecosystem by its ID.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

Claim Source

getClaimSourceList

Returns a list of all claim sources configured on your tenant.

Authorizations:
OAuth2ClientCredentials
query Parameters
limit
integer or null <uint64> >= 0

No of records on each page

page
integer or null <uint64> >= 0

No of pages to fetch

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "limit": 0,
  • "total_count": 0,
  • "total_pages": 0
}

createClaimSource

Create a new claim source for your tenant.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required

Represents a request to create a new claim source

required
object or object (Authorization)
name
required
string

Claim source description

request_method
required
string

The method sovrin api will use to query the claims source. Both GET and POST are supported, with GET used by default. When using POST as a request method, all requestParameters must be included in the request body in JSON format.

required
object

Request parameters to be included in the request to your server. Must supply mapFrom and/or defaultValue.

url
required
string

Base url for the claims source. Must not contain query parameters. Port and fragment parameters will be dropped. URL must use https and have a valid public TLD. Unicode will be converted to ASCII.

Responses

Request samples

Content type
application/json
{
  • "authorization": {
    },
  • "name": "string",
  • "request_method": "string",
  • "request_parameters": {
    },
  • "url": "string"
}

Response samples

Content type
application/json
{}

getClaimSource

Retrieve an existing claim source by providing its Claim Source ID.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "authorization": {
    },
  • "id": "string",
  • "name": "string",
  • "org_id": "string",
  • "request_method": "string",
  • "request_parameters": {
    },
  • "url": "string"
}

updateClaimSource

Update an existing claim source by providing its Claim Source ID.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required

Represents a request to update an existing claim source

required
object or object (Authorization)
name
required
string

Claim source description

request_method
string or null

Method used to query claim source

required
object

Request parameters to be included in the request to your server. Must supply mapFrom and/or defaultValue.

url
required
string

Base url for the claims source. Must not contain query parameters. Port and fragment parameters will be dropped. URL must use https and have a valid public TLD. Unicode will be converted to ASCII.

Responses

Request samples

Content type
application/json
{
  • "authorization": {
    },
  • "name": "string",
  • "request_method": "string",
  • "request_parameters": {
    },
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "authorization": {
    },
  • "id": "string",
  • "name": "string",
  • "org_id": "string",
  • "request_method": "string",
  • "request_parameters": {
    },
  • "url": "string"
}

deleteClaimSource

Delete an existing claim source by providing its Claim Source ID.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

Help

getHelpArticles

Get the list of Help Articles

Authorizations:
OAuth2ClientCredentials
query Parameters
limit
integer or null <uint64> >= 0
page
integer or null <uint64> >= 0

Responses

Response samples

Content type
application/json
{}

getHelpCategory

Get the Help Category

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

getHelpArticlesByCategory

Get a Help Article in a category

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

Blog Categories

Get all blog categories

Get all blog categories

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

Create a blog categories

Create a blog categories

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
description
required
string
name
required
string
slug
required
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "slug": "string"
}

Response samples

Content type
application/json
{}

Get a blog category by slug

Get a blog category by slug

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

Update a blog category by slug

Update a blog category by slug

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
description
required
string
name
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{}

Delete a blog category by slug

Delete a blog category by slug

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

Blog Posts

Get all blog posts

Get all blog posts

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

Create a blog post

Create a blog post

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
author_id
required
string
category_id
required
string
content
required
string
excerpt
required
string
image
string or null
is_published
required
integer <int8>
slug
required
string
title
required
string

Responses

Request samples

Content type
application/json
{
  • "author_id": "string",
  • "category_id": "string",
  • "content": "string",
  • "excerpt": "string",
  • "image": "string",
  • "is_published": 0,
  • "slug": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{}

Update a blog post

Update a blog post

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

Delete a blog post

Delete a blog post

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

Update a blog post

Update a blog post

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
author_id
required
string
category_id
required
string
content
required
string
excerpt
required
string
image
string or null
is_published
required
integer <int8>
title
required
string

Responses

Request samples

Content type
application/json
{
  • "author_id": "string",
  • "category_id": "string",
  • "content": "string",
  • "excerpt": "string",
  • "image": "string",
  • "is_published": 0,
  • "title": "string"
}

Response samples

Content type
application/json
{}

Legal Policies

getLegalPolicies

List all legal policies

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

createLegalPolicy

Create a legal policy

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
content
required
string
name
required
string
slug
required
string
title
required
string

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "name": "string",
  • "slug": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{}

Organization

createOrganization

Create a new organization

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
address
required
string
city
required
string
country
required
string
duns_number
string or null
email
required
string
name
required
string
phone
required
string
registration_number
required
string
state
required
string
website
string or null <uri>
zip_code
required
string

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "city": "string",
  • "country": "string",
  • "duns_number": "string",
  • "email": "string",
  • "name": "string",
  • "phone": "string",
  • "registration_number": "string",
  • "state": "string",
  • "website": "http://example.com",
  • "zip_code": "string"
}

Response samples

Content type
application/json
{}

getOrganizationDetails

Get the details of an organization

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

OAuth2 Clients

getOAuth2Clients

Get the list of OAuth2 Clients

Authorizations:
OAuth2ClientCredentials
query Parameters
limit
integer or null <uint64> >= 0
page
integer or null <uint64> >= 0

Responses

Response samples

Content type
application/json
{}

createOAuth2Client

Create a new OAuth2 Client

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
description
required
string
name
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{}

getOAuth2ClientDetails

Get the details of an OAuth2 Client

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

updateOAuth2Client

Update an OAuth2 Client

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
name
string or null
reset_secret
required
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "reset_secret": true
}

Response samples

Content type
application/json
{}

deleteOAuth2Client

Delete an OAuth2 Client

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{}

User

Register a new user

Register a new user

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
email
required
string
first_name
required
string
last_name
required
string
middle_name
string or null
password
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "middle_name": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{}

Login a user

Login a user

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
email
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{}