Learn

Participants

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
SecuritybearerAuth
Request
path Parameters
ecosystemId
required
string <uuid>

The UUID of the ecosystem

Example: 87880d7e-a4d0-462e-8383-3f1e5e16865d
query Parameters
limit
number [ 1 .. 1000 ]
Default: 100

Range size of the list, default 100

Example: limit=2
cursor
string

Starting point for the list

Example: cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h
Responses
200

Participants retrieved

400

Bad Request. The request was malformed or missing required parameters.

404

Not Found. The specified resource was not found.

get/v1/ecosystems/{ecosystemId}/participants
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "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
    • 



SecuritybearerAuth 
Request 
path Parameters
ecosystemId
required
string <uuid> 
The UUID of the ecosystem


 
 Example:  87880d7e-a4d0-462e-8383-3f1e5e16865d
Request Body schema: application/json
required
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 formats. Each participant must have at least one defined credential format, and for each credential format a participant can define exactly one unique identifier.


    

  • Credentials are only valid in the ecosystem if they include an identifier of an issuer that is a participant in the ecosystem.
    • 

  • Verification requests are only valid in the ecosystem if they include an identifier of a verifier that is a participant in the ecosystem.
    • 



 
isIssuer
boolean
 Default:  false
Indicates whether the participant is an issuer in the ecosystem (true) or not (false). When set to false, the participant will not be able to issue any valid credential types, even if it is added to an issuer policy. The default value is false, as this assigns the least privileges to the new participant.


 
isVerifier
boolean
 Default:  false
Indicates whether the created participant is a verifier in the ecosystem (true) or not (false). When set to false, the participant will not be able to verify any valid credential types, even if it is added to a verifier policy. The default value is false, as this assigns the least privileges to the new participant.


 
isIssuerConstrained
boolean
 Default:  true
Indicates whether the created participant is constrained to only issue specific types of valid credentials (true) or not (false). When set to false, the issuer can issue all valid credential types defined within the ecosystem, even if it is added to a more limited issuer policy. The default value is true, as this assigns the least privileges to the new participant.


 
isVerifierConstrained
boolean
 Default:  true
Indicates whether the created participant is constrained to only verify specific types of valid credentials (true) or not (false). When set to false, the verifier can verify all valid credential types defined within the ecosystem, even if it is added to a more limited verifier policy. The default value is true, as this assigns the least privileges to the new participant.


 
status
string
 Default:  "Inactive"
Indicates whether the participant is active or inactive. Only active participants are included in the ecosystem policy.


 Enum: "Active" "Inactive"  
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 country value in the PEM certificate associated with the mobile identifier of this participant.


 
stateOrProvince
string
The state or province in which the participant is based, in ISO 3166-2 subdivision code format. When provided, must match the stateOrProvinceName value in the PEM certificate associated with the mobile identifier of this participant.


 
Array of objects
Contact details associated with the participant.


 
Responses 
201
Participant created


400
Bad Request. The request was malformed or missing required parameters.


404
Not Found. The specified resource was not found.


500
Internal Server Error. An unexpected error occurred.


post/v1/ecosystems/{ecosystemId}/participants
Request samples 
application/json
{
  • "name": "My Participant",
  • "identifiers": {
    },
  • "isIssuer": false,
  • "isVerifier": false,
  • "isIssuerConstrained": true,
  • "isVerifierConstrained": true,
  • "status": "Active",
  • "country": "US",
  • "stateOrProvince": "US-AL",
  • "contacts": [
    ]
}
Response samples 
application/json
{
  • "id": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58",
  • "ecosystemId": "87880d7e-a4d0-462e-8383-3f1e5e16865d",
  • "name": "My Participant",
  • "identifiers": {
    },
  • "isIssuer": false,
  • "isVerifier": false,
  • "isIssuerConstrained": true,
  • "isVerifierConstrained": true,
  • "status": "Active",
  • "country": "US",
  • "stateOrProvince": "US-AL",
  • "contacts": [
    ]
}
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
    • 



SecuritybearerAuth 
Request 
path Parameters
ecosystemId
required
string <uuid> 
The UUID of the ecosystem


 
 Example:  87880d7e-a4d0-462e-8383-3f1e5e16865d
participantId
required
string <uuid> 
The UUID of the participant


 
 Example:  a24e391a-c27f-4b6e-9805-1ee7e03f3c58
Responses 
200
Participant retrieved


400
Bad Request. The request was malformed or missing required parameters.


404
Not Found. The specified resource was not found.


get/v1/ecosystems/{ecosystemId}/participants/{participantId}
Request samples 
Response samples 
application/json
{
  • "id": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58",
  • "ecosystemId": "87880d7e-a4d0-462e-8383-3f1e5e16865d",
  • "name": "My Participant",
  • "identifiers": {
    },
  • "isIssuer": false,
  • "isVerifier": false,
  • "isIssuerConstrained": true,
  • "isVerifierConstrained": true,
  • "status": "Active",
  • "country": "US",
  • "stateOrProvince": "US-AL",
  • "contacts": [
    ]
}
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
    • 



SecuritybearerAuth 
Request 
path Parameters
ecosystemId
required
string <uuid> 
The UUID of the ecosystem


 
 Example:  87880d7e-a4d0-462e-8383-3f1e5e16865d
participantId
required
string <uuid> 
The UUID of the participant


 
 Example:  a24e391a-c27f-4b6e-9805-1ee7e03f3c58
Request Body schema: application/json
required
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 formats. Each participant must have at least one defined credential format, and for each credential format a participant can define exactly one unique identifier.


    

  • Credentials are only valid in the ecosystem if they include an identifier of an issuer that is a participant in the ecosystem.
    • 

  • Verification requests are only valid in the ecosystem if they include an identifier of a verifier that is a participant in the ecosystem.
    • 



 
isIssuer
boolean
 Default:  false
Indicates whether the participant is an issuer in the ecosystem (true) or not (false). When set to false, the participant will not be able to issue any valid credential types, even if it is added to an issuer policy. The default value is false, as this assigns the least privileges to the new participant.


 
isVerifier
boolean
 Default:  false
Indicates whether the created participant is a verifier in the ecosystem (true) or not (false). When set to false, the participant will not be able to verify any valid credential types, even if it is added to a verifier policy. The default value is false, as this assigns the least privileges to the new participant.


 
isIssuerConstrained
boolean
 Default:  true
Indicates whether the created participant is constrained to only issue specific types of valid credentials (true) or not (false). When set to false, the issuer can issue all valid credential types defined within the ecosystem, even if it is added to a more limited issuer policy. The default value is true, as this assigns the least privileges to the new participant.


 
isVerifierConstrained
boolean
 Default:  true
Indicates whether the created participant is constrained to only verify specific types of valid credentials (true) or not (false). When set to false, the verifier can verify all valid credential types defined within the ecosystem, even if it is added to a more limited verifier policy. The default value is true, as this assigns the least privileges to the new participant.


 
status
string
 Default:  "Inactive"
Indicates whether the participant is active or inactive. Only active participants are included in the ecosystem policy.


 Enum: "Active" "Inactive"  
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 country value in the PEM certificate associated with the mobile identifier of this participant.


 
stateOrProvince
string
The state or province in which the participant is based, in ISO 3166-2 subdivision code format. When provided, must match the stateOrProvinceName value in the PEM certificate associated with the mobile identifier of this participant.


 
Array of objects
Contact details associated with the participant.


 
Responses 
200
Participant updated


400
Bad Request. The request was malformed or missing required parameters.


404
Not Found. The specified resource was not found.


500
Internal Server Error. An unexpected error occurred.


put/v1/ecosystems/{ecosystemId}/participants/{participantId}
Request samples 
application/json
{
  • "name": "My Participant",
  • "identifiers": {
    },
  • "isIssuer": false,
  • "isVerifier": false,
  • "isIssuerConstrained": true,
  • "isVerifierConstrained": true,
  • "status": "Active",
  • "country": "US",
  • "stateOrProvince": "US-AL",
  • "contacts": [
    ]
}
Response samples 
application/json
{
  • "id": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58",
  • "ecosystemId": "87880d7e-a4d0-462e-8383-3f1e5e16865d",
  • "name": "My Participant",
  • "identifiers": {
    },
  • "isIssuer": false,
  • "isVerifier": false,
  • "isIssuerConstrained": true,
  • "isVerifierConstrained": true,
  • "status": "Active",
  • "country": "US",
  • "stateOrProvince": "US-AL",
  • "contacts": [
    ]
}
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
    • 



SecuritybearerAuth 
Request 
path Parameters
ecosystemId
required
string <uuid> 
The UUID of the ecosystem


 
 Example:  87880d7e-a4d0-462e-8383-3f1e5e16865d
participantId
required
string <uuid> 
The UUID of the participant


 
 Example:  a24e391a-c27f-4b6e-9805-1ee7e03f3c58
Responses 
204
Participant deleted


400
Bad Request. The request was malformed or missing required parameters.


404
Not Found. The specified resource was not found.


delete/v1/ecosystems/{ecosystemId}/participants/{participantId}
Request samples 
Response samples 
application/json
{
  • "code": "string",
  • "type": "string",
  • "message": "string",
  • "details": [
    ]
}
➔ Next to Credential types