Parties [POST]

The POST request to the /parties endpoint can be used to create a new party in the Participant Registry.

The POST request to the /parties is an OPTIONAL endpoint. For more information on OPTIONAL specifications, see functional requirements per role.

Create new party

post

Used to programmatically create a participant. To create a party as part of the iSHARE Framework, at minimum the following claims MUST be provided: - x509Certificate or idpAssertion - frameworkCompliance - frameworkAgreement - frameworkRole. For all roles except for Service Consumer and Entitled Party an x509Certificate claim is required. Service Consumer and Entitled Party MUST either provide a x509Certificate claim or idpAssertion claim if authenticating via Identity Provider.

Authorizations
AuthorizationstringRequired

OAuth 2.0 authorization based on bearer token. MUST contain “Bearer “ + access token value. Must be provided if restricted endpoints are needed.

Body
idstringRequired

Primary identifier (did:ishare) of the party.

Example: did:ishare:EU.NL.NTRNL-12345678
namestringRequired

Name of the party.

Example: Example Corporation
alsoKnownAsstring[]Optional

Array of registered party ids of the party with which the party is also identified. Optional, because a party could be identified with only its did:ishare (in the 'id' property).

Example: ["did:ishare:EU.NL.NTRNL-12345678","did:ebsi:LEIXG-724500AZSGBRY55MNS59","did:web:example.com","CoC:123456789"]
Responses
200Success
application/json
post
/parties
200Success

Request model

The request must be passed as JWT. The JSON model in the JWT is as follows.

  • id String. Required Primary identifier (iSHARE-ID) of the party.

  • name String. Required Name of the party.

  • alsoKnownAs Array of strings. Array of registered party ids of the party with which the party is also identified. Optional, because a party could be identified with only its iSHARE-ID (in the 'id' property).

  • claims Array of objects. Required Array of claims for the party. Refer to Claim models for an overview of available claims. In the POST request the id and registrarId fields may be omitted, as they will be provided by the Participant Registry. To create a party as part of the iSHARE Framework, at minimum the following claims MUST be provided:

    • x509Certificate or idpAssertion

    • frameworkCompliance

    • frameworkAgreement

    • frameworkRole

    For all roles except for Service Consumer and Entitled Party an x509Certificate claim is required. Service Consumer and Entitled Party MUST either provide a x509Certificate claim or idpAssertion claim if authenticating via Identity Provider.

Example request

Response model

The response will be equal to the response of the GET request for retrieving a single party. Please refer to the response model as defined here.

Example response

Please also refer to the example response under the GET request definition.

PreviousParties [OPTIONS]NextParties (single party) [GET]

Last updated