Retrieve participants
Retrieves a list of participants from the requested ecosystem.
Analytic events
- ECOSYSTEM_PARTICIPANT_RETRIEVE_LIST_START
- ECOSYSTEM_PARTICIPANT_RETRIEVE_LIST_SUCCESS
- ECOSYSTEM_PARTICIPANT_RETRIEVE_LIST_FAIL
path Parameters
Participants retrieved
Bad Request. The request was malformed or missing required parameters.
Not Found. The specified resource was not found.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 400
{- "data": [
- {
- "id": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58",
- "ecosystemId": "87880d7e-a4d0-462e-8383-3f1e5e16865d",
- "name": "My Participant",
- "identifiers": {
- "web-semantic": "did:web:example.com",
- "compact-semantic": "did:web:example.com",
- "compact": "did:web:example.com",
- "mobile": [
- "-----BEGIN CERTIFICATE-----\\r\\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\\r\\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\\r\\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\\r\\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\\r\\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\\r\\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\\r\\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\\r\\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\\r\\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\\r\\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\\r\\n-----END CERTIFICATE-----\\r\\n"
]
}, - "isIssuer": false,
- "isVerifier": false,
- "isIssuerConstrained": true,
- "isVerifierConstrained": true,
- "status": "Active",
- "country": "US",
- "stateOrProvince": "US-AL",
- "contacts": [
- {
- "phoneNumber": "012-3456789",
- "address": "Participant address"
}
]
}
], - "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"
}
Create participant
Creates a participant in the requested ecosystem.
Analytic events
- ECOSYSTEM_PARTICIPANT_CREATE_START
- ECOSYSTEM_PARTICIPANT_CREATE_SUCCESS
- ECOSYSTEM_PARTICIPANT_CREATE_FAIL
path Parameters
Request Body schema: application/jsonrequired
name required | string [ 1 .. 50 ] characters Name to easily identify the participant. |
required | object Define the unique identifier that will be used by this participant to issue and/or verify credentials. Participants can have different identifiers for different credential profiles. Each participant must have at least one defined credential profile, and for each credential profile a participant can define exactly one unique identifier.
|
isIssuer | boolean Default: false Indicates whether the participant is an issuer in the ecosystem ( |
isVerifier | boolean Default: false Indicates whether the created participant is a verifier in the ecosystem ( |
isIssuerConstrained | boolean Default: true Indicates whether the created participant is constrained to only issue specific types of valid credentials ( |
isVerifierConstrained | boolean Default: true Indicates whether the created participant is constrained to only verify specific types of valid credentials ( |
status | string Default: "Inactive" Indicates whether the participant is active or inactive. Only active participants are included in the ecosystem policy. |
country | string The country in which the participant is based. When provided, must be a valid Alpha 2 country code as per ISO 3166-1 and match the |
stateOrProvince | string The state or province in which the participant is based, in ISO 3166-2 subdivision code format. When provided, must match the |
Array of objects Contact details associated with the participant. |
Participant created
Bad Request. The request was malformed or missing required parameters.
Not Found. The specified resource was not found.
Internal Server Error. An unexpected error occurred.
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
{- "name": "My Participant",
- "identifiers": {
- "web-semantic": "did:web:example.com",
- "compact-semantic": "did:web:example.com",
- "compact": "did:web:example.com",
- "mobile": [
- "-----BEGIN CERTIFICATE-----\\r\\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\\r\\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\\r\\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\\r\\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\\r\\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\\r\\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\\r\\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\\r\\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\\r\\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\\r\\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\\r\\n-----END CERTIFICATE-----\\r\\n"
]
}, - "isIssuer": false,
- "isVerifier": false,
- "isIssuerConstrained": true,
- "isVerifierConstrained": true,
- "status": "Active",
- "country": "US",
- "stateOrProvince": "US-AL",
- "contacts": [
- {
- "phoneNumber": "012-3456789",
- "address": "Participant address"
}
]
}
- 201
- 400
{- "id": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58",
- "ecosystemId": "87880d7e-a4d0-462e-8383-3f1e5e16865d",
- "name": "My Participant",
- "identifiers": {
- "web-semantic": "did:web:example.com",
- "compact-semantic": "did:web:example.com",
- "compact": "did:web:example.com",
- "mobile": [
- "-----BEGIN CERTIFICATE-----\\r\\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\\r\\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\\r\\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\\r\\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\\r\\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\\r\\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\\r\\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\\r\\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\\r\\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\\r\\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\\r\\n-----END CERTIFICATE-----\\r\\n"
]
}, - "isIssuer": false,
- "isVerifier": false,
- "isIssuerConstrained": true,
- "isVerifierConstrained": true,
- "status": "Active",
- "country": "US",
- "stateOrProvince": "US-AL",
- "contacts": [
- {
- "phoneNumber": "012-3456789",
- "address": "Participant address"
}
]
}
Retrieve participant
Retrieves a participant from the requested ecosystem by its ID.
Analytic events
- ECOSYSTEM_PARTICIPANT_RETRIEVE_START
- ECOSYSTEM_PARTICIPANT_RETRIEVE_SUCCESS
- ECOSYSTEM_PARTICIPANT_RETRIEVE_FAIL
Participant retrieved
Bad Request. The request was malformed or missing required parameters.
Not Found. The specified resource was not found.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 400
{- "id": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58",
- "ecosystemId": "87880d7e-a4d0-462e-8383-3f1e5e16865d",
- "name": "My Participant",
- "identifiers": {
- "web-semantic": "did:web:example.com",
- "compact-semantic": "did:web:example.com",
- "compact": "did:web:example.com",
- "mobile": [
- "-----BEGIN CERTIFICATE-----\\r\\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\\r\\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\\r\\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\\r\\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\\r\\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\\r\\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\\r\\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\\r\\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\\r\\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\\r\\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\\r\\n-----END CERTIFICATE-----\\r\\n"
]
}, - "isIssuer": false,
- "isVerifier": false,
- "isIssuerConstrained": true,
- "isVerifierConstrained": true,
- "status": "Active",
- "country": "US",
- "stateOrProvince": "US-AL",
- "contacts": [
- {
- "phoneNumber": "012-3456789",
- "address": "Participant address"
}
]
}
Update participant
Updates a participant in the requested ecosystem by its ID.
Analytic events
- ECOSYSTEM_PARTICIPANT_UPDATE_START
- ECOSYSTEM_PARTICIPANT_UPDATE_SUCCESS
- ECOSYSTEM_PARTICIPANT_UPDATE_FAIL
path Parameters
Request Body schema: application/jsonrequired
name required | string [ 1 .. 50 ] characters Name to easily identify the participant. |
required | object Define the unique identifier that will be used by this participant to issue and/or verify credentials. Participants can have different identifiers for different credential profiles. Each participant must have at least one defined credential profile, and for each credential profile a participant can define exactly one unique identifier.
|
isIssuer | boolean Default: false Indicates whether the participant is an issuer in the ecosystem ( |
isVerifier | boolean Default: false Indicates whether the created participant is a verifier in the ecosystem ( |
isIssuerConstrained | boolean Default: true Indicates whether the created participant is constrained to only issue specific types of valid credentials ( |
isVerifierConstrained | boolean Default: true Indicates whether the created participant is constrained to only verify specific types of valid credentials ( |
status | string Default: "Inactive" Indicates whether the participant is active or inactive. Only active participants are included in the ecosystem policy. |
country | string The country in which the participant is based. When provided, must be a valid Alpha 2 country code as per ISO 3166-1 and match the |
stateOrProvince | string The state or province in which the participant is based, in ISO 3166-2 subdivision code format. When provided, must match the |
Array of objects Contact details associated with the participant. |
Participant updated
Bad Request. The request was malformed or missing required parameters.
Not Found. The specified resource was not found.
Internal Server Error. An unexpected error occurred.
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
{- "name": "My Participant",
- "identifiers": {
- "web-semantic": "did:web:example.com",
- "compact-semantic": "did:web:example.com",
- "compact": "did:web:example.com",
- "mobile": [
- "-----BEGIN CERTIFICATE-----\\r\\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\\r\\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\\r\\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\\r\\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\\r\\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\\r\\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\\r\\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\\r\\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\\r\\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\\r\\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\\r\\n-----END CERTIFICATE-----\\r\\n"
]
}, - "isIssuer": false,
- "isVerifier": false,
- "isIssuerConstrained": true,
- "isVerifierConstrained": true,
- "status": "Active",
- "country": "US",
- "stateOrProvince": "US-AL",
- "contacts": [
- {
- "phoneNumber": "012-3456789",
- "address": "Participant address"
}
]
}
- 200
- 400
{- "id": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58",
- "ecosystemId": "87880d7e-a4d0-462e-8383-3f1e5e16865d",
- "name": "My Participant",
- "identifiers": {
- "web-semantic": "did:web:example.com",
- "compact-semantic": "did:web:example.com",
- "compact": "did:web:example.com",
- "mobile": [
- "-----BEGIN CERTIFICATE-----\\r\\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\\r\\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\\r\\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\\r\\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\\r\\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\\r\\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\\r\\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\\r\\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\\r\\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\\r\\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\\r\\n-----END CERTIFICATE-----\\r\\n"
]
}, - "isIssuer": false,
- "isVerifier": false,
- "isIssuerConstrained": true,
- "isVerifierConstrained": true,
- "status": "Active",
- "country": "US",
- "stateOrProvince": "US-AL",
- "contacts": [
- {
- "phoneNumber": "012-3456789",
- "address": "Participant address"
}
]
}
Delete participant
Deletes a participant in the requested ecosystem by its ID.
Analytic events
- ECOSYSTEM_PARTICIPANT_DELETE_START
- ECOSYSTEM_PARTICIPANT_DELETE_SUCCESS
- ECOSYSTEM_PARTICIPANT_DELETE_FAIL
Participant deleted
Bad Request. The request was malformed or missing required parameters.
Not Found. The specified resource was not found.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 400
{- "code": "string",
- "message": "string",
- "details": [
- {
- "value": "string",
- "msg": "Invalid value",
- "param": "id",
- "location": "body"
}
]
}