POST /parties/{partyId}/claims

POST /parties/{partyId}/claims

A ParticipantRegistry can add a dataspaceRole claim to parties they create and manage in the DSGO central participant registry, with a POST to the /parties/{partyId}/claims endpoint. This dataspaceRole can only be a legal Service Consumer or a Service Rights Holder.

The central participant registry MUST support a POST call to a /parties/{partyId}/claims endpoint.

Request

Authorization

An access token is used in POST calls to the /parties/{partyId}/claims endpoint. For more information, see Access Token.

The central participant registry MUST validate that a POST call to a /parties/{partyId}/claims endpoint includes the “Authorization" header according to RFC 6750 and includes a valid access token

The central participant registry MUST validate that the HTTP body of a POST request to the /parties/{partyId}/claims endpoint contains the attributes as defined in the table below, formatted as JSON

Attribute

 

Type

Description

Attribute

 

Type

Description

type

Required

String

MUST be dataspaceRole

dataspaceId

Required

String

MUST be EU.DS.NL.DSGO

roleId

Required

String

MUST be the role. Enum with values ServiceConsumer, ServiceRightsHolder

title

Required

String

MUST be the title of the data space role. Enum with values Service Consumer, Service Rights Holder

registrarId

Required

String

Primary Identifier (iSHARE DID) of the ParticipantRegistry that manages the claim.

loa

Required

string

MUST be not-applicable

compliancyVerified

Required

string

MUST be not-applicable

legalAdherence

Required

string

MUST be no*

 status

Required

String

MUST be Pending *

 startDate

Required

String

MUST be null *

 endDate

Required

String

Date and time which states when the adherence status ends. May be null

* When the party has signed the DSGO framework agreement, the central participant registry changes the following attributes:

  • legalAdherence to yes

  • status to Active

  • startDate to the date of activation

 

> Authorization: Bearer IIeDIrdnYo2ngwDQYJKoZIhvcNAQELBQAwSDEZMBcGA1UEAwwQaVNIQ POST /parties Content-Type: application/json { "type": "dataspaceRole", "dataspaceId": "EU.DS.NL.DSGO", "roleId": "ServiceRightsHolder", "title": "Service Rights Holder", "registrarId": "did:ishare:EU.NL.NTRNL-00000001", // De ParticipantRegistry die de rol toevoegt. "loa": "not-applicable", "compliancyVerified": "not-applicable", "legalAdherence": "no", "status": "Pending", "startDate": "", "endDate": "", }

Responses

201 Created

If successful, the response contains data providing the created claim information in a claimToken. The claimToken is a signed JWT, which contains the claims as defined in the iSHARE JWT, and additionally contains a claim object as defined here.

The trust framework catalogue MUST include a claimToken including a claim object in a response to a successful POST call to the /parties/{partyId}/claims endpoint

< Content-Type: application/json { "claimToken": "eyJ4NWMiOlsiTUlJRWlEQ0NBbkNnQXdJQkFnSUllRElyZG5ZbzJuZ3dEUVlKS29aSWh2Y05BUUVMQlFBd1NERVpNQmNHQTFVRUF3d1FhVk5JUVZKRlZHVnpkRU5CWDFSTVV6RU5NQXNHQTFVRUN3d0VWR1Z6ZERFUE1BMEdBMVVFQ2d3R2FWTklRVkpGTVFzd0NRWURWUVFHRXdKT1REQWVGdzB4T1RBeU1UVXhNVFEyTlRoYUZ3MHlNVEF5TVRReE1UUTJOVGhhTUVreEhEQWFCZ05WQkFNTUUybFRTRUZTUlNCVFkyaGxiV1VnVDNkdVpYSXhIREFhQmdOVkJBVVRFMFZWTGtWUFVra3VUa3d3TURBd01EQXdNREF4Q3pBSkJnTlZCQVlUQWs1TU1JSUJJakFOQmdrcWhraUc5dzBCQVFFRkFBT0NBUThBTUlJQkNnS0NBUUVBMFJvb2hlUEwwMk52NEJaVEoza3A3bktzaHNtanJjcjhNQmFBaFFwWlpBc2dUQWxtUWlDVFBtM2M4cVlQcU4rVHVnZ0ZXQ05uKzlXNTRDNVVHcXNJd3RYVGszWWV4QXdaNG9qUlJ0bzhsMUhQRFZBUzZXdlc3NEFDTlpsRWdHd2pyQ0d5MitNNVFQN083d0IwVDZvRkJvZlJ3SFpHemdidFNiU1FodXF3VXhmMEdaSTh4QWwyL0dUSDI1VmZwOVQ3MUpFcG9aOWtzUDNDSWk1QkhrbGJUNUdLeEVPRmZkTU11cFg3bVduTlFiTHh1UXBBdEdDdW9yR2ZQRkU3RjVldkUxem9wd2NlQTVGc0UxTGFCUnF0K0VPcFBJbVNhalIwMmJjaEs5alM2bllFV3MvRlpHTHRKYWxsNUwzU25aTTZPaFd4TStsS0d6Rkt3NVRJWE45RE13SURBUUFCbzNVd2N6QU1CZ05WSFJNQkFmOEVBakFBTUI4R0ExVWRJd1FZTUJhQUZCWTg1eURwMXBUdkgrV2k4Ymo4dnVyZkxEZUJNQk1HQTFVZEpRUU1NQW9HQ0NzR0FRVUZCd01CTUIwR0ExVWREZ1FXQkJSZndpalQ3NWRJS1BsRkMvQ3RSRHFVS1g5VE5qQU9CZ05WSFE4QkFmOEVCQU1DQmFBd0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dJQkFLNFBXVHEvZHF0Vm0rNFdDZDFLUUo0dGorbjRjY0lBWUxETXFZU0JKc042UTJjdE1SQy8rK3lNL293UEhCcmlUendXL2pvQXBOUGVaaDFJVFRnU3phMzhtM2h4b0RxMXV4NkhWR3lLNVFDUW9qRmRsZWM3dE9IbG1jYnV5VjRDRXlNWmJHK3lMbVZESTNxNTNWQVBnV3ZLSWkyUlVwc1BOdzJsbzZINjZ2SE5wNWZpcEIvdEU0Q0RsYS9UYU41MWxOM2xYT3c0bHRiWmJ6YmQ2TXhJbEVDUWZKSDVlUHJpcGFrSmhuaVZrWnZRVmthS0FlcFNYMGFEWUxPcFFRbmV0RFdab1ZKS0FzR0VMM0hMaWhxWXNEejcvQlQzRHdUMEtDNSs5OGdqR1p3dkx3ZXRKOTZLWFRBRTUwMmYzak95UDdERDZ1SytKS2d2UVp5dkk1L0V1cDBUdE5sUmZKeThhZDhweCszOG9JeEdBbGJzS29XbXowb2FNR0MrbFZHTlAyTTQ4TTdWa3RCVHB5bXF4Vnd0VGt2TVBqWldIS2xYdDJXMzNtTktHakpTOTVJNXZxT0tQV1NTc1dkSlJZSkNsbUVybWlkTlczMWxXQVZQcjFpU1M0SlhEdllQTENQNDRhNGVkMEdhV1pSdi9iK0QyK1FVZ09iOFN6bWpQdmYvMkdOdHFXUmR5WXRYWjl2eDAzNGkrWEYveWU4c2lOK1grd0ZIdFJ1bXRzd2Irc2NRZjRmVTZNaktCS1VzUERBUkFHakhqNXhIQkRqcTg0bmpHdVFjbDBoYlMzK1pTVjROcWtKSVVzMkxVdDlFdjFYN2FCNy85NUVYQWNnTlhkM0tQVm0zcDhORDc1QXFNMEZHUUVhUXlPd3FLY3FUQ2xKQ3VmR3NVWTRzN3JXUiJdLCJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJFVS5FT1JJLk5MMDAwMDAwMDAwIiwic3ViIjoiRVUuRU9SSS5OTDAwMDAwMDAwMCIsImp0aSI6Ijc3ZTgxNzlmYmZlNjQ2OWViNjRjMDU0ZGEyNmE3N2MzIiwiaWF0IjoxNTg5MjgyMTEyLCJleHAiOjE1ODkyODIxNDIsImF1ZCI6IkVVLkVPUkkuTkwwMDAwMDAwMDEiLCJwYXJ0eV9pbmZvIjp7InBhcnR5X2lkIjoiRVUuRU9SSS5OTDAwMDAwMDAwNCIsInBhcnR5X25hbWUiOiJBc2tNZUFueXRoaW5nIEF1dGhvcml6YXRpb24gUmVnaXN0cnkiLCJhZGhlcmVuY2UiOnsic3RhdHVzIjoiQWN0aXZlIiwic3RhcnRfZGF0ZSI6IjIwMTgtMDQtMjZUMDA6MDA6MDAiLCJlbmRfZGF0ZSI6IjIwMjAtMDctMjVUMDA6MDA6MDAifSwiY2VydGlmaWNhdGlvbnMiOlt7InJvbGUiOiJBdXRob3Jpc2F0aW9uUmVnaXN0cnkiLCJzdGFydF9kYXRlIjoiMjAxOC0wMS0wNFQwMDowMDowMCIsImVuZF9kYXRlIjoiMjAyMC0wMi0wMlQwMDowMDowMCIsImxvYSI6M31dLCJjYXBhYmlsaXR5X3VybCI6Imh0dHBzOi8vYXIuaXNoYXJldGVzdC5uZXQvY2FwYWJpbGl0aWVzIn19.U2nIhL2600VX1uaMdJ_uUJky_Q8WSSRDKcbmeYrL_GGHifptwlB00uwj1uWmbUbd5KlYIYio-lPX1BwMzYmVXLC6ZydkI7kIsdQypiSEXGT6U2KIlTO2EyF3CU6EY6iBzuVtvyupbDVPkKzDVh8thE5cepCS_FAsZZvxYXfeWGjVoKRpHtAIGq8reTIgEE_9w-p6Toa970ERJ01Lcn3xpDPp-FNLobmMa_mM6Vn4m6WjvMxr77coO54GDJ6FM70egChiBHJSjUGqDaBUgebdAFh3AQ8TfYJntka9DiNVFiY5Y_HqecBmKW_DiokT40DiljXEhRy6YVLSHjxOKa81TQ" } Decoded claimToken payload : { "iss": "did:ishare:EU.NL.NTRNL-63202158", "sub": "did:ishare:EU.NL.NTRNL-63202158", "jti": "77e8179fbfe6469eb64c054da26a77c3", "iat": 1589282112, "exp": 1589282142, "aud": "did:ishare:EU.NL.NTRNL-00000001", "claim": { "type": "dataspaceRole", "dataspaceId": "EU.DS.NL.DSGO", "roleId": "ServiceRightsHolder", "title": "Service Rights Holder", "registrarId": "did:ishare:EU.NL.NTRNL-00000001", // This role is managed by a different ParticipantRegistry in the DSGO. "loa": "not-applicable", "compliancyVerified": "not-applicable", "legalAdherence": "no", "status": "Active", "startDate": "2025-05-01T00:00:00.000Z", "endDate": "", "id": "1624717e-414d-40ed-8c18-21f1528ff9ac" } }

400 Bad Request

When Authorization header is provided, but the token format is invalid (for example, not Bearer). Additionally, a 400 should be returned when the provided access token is valid, but the request body content is invalid.

401 Unauthorized

When Authorization header is either missing, invalid or the access token has already expired.

403 Forbidden

When client is authenticated but not allowed to perform the action