search

Parties

hashtag
Lists and searches parties

get

Search for participant information from your satellite. Various search parameters are supported as shown below. When results are more then 10 participants, pagination is used in response and each page contains up to 10 participants. Server response is an iSHARE signed JSON Web Token. Please refer to the models 'jwt_header' and 'jwt_payload_party_token' which indicate what the decoded response will look like.

Authorizations
AuthorizationstringRequired

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

Query parameters
active_onlybooleanOptional

Optional parameter used to search by party's "Active" status.

Example: true
namestringOptional

Optional parameter used to search by party's name. Can contain a single * as wildcard.

Example: *Corporation
eoristringOptional

Optional parameter used to search by party's ID (EORI). Can contain a single * as wildcard.

Example: EU.EORI.NL123456789
certified_onlybooleanOptional

Search for parties that play one of the certified roles as defined in iSHARE role framework.

Example: true
date_timestring · date-timeOptional

Search parties with specific adherence date

Example: 2023-01-31T00:00:00.000Z
adherenceStatusstringOptional

Search for parties with adherence status like "Active", "Revoked","Not Active", "Pending"

Example: Active
adherenceStartdatestring · date-timeOptional

Search parties with specific adherence start date

Example: 2023-01-31T00:00:00.000Z
adherenceEnddatestring · date-timeOptional

Search parties with specific adherence end date

Example: 2023-01-31T00:00:00.000Z
registarSatelliteIDstringOptional

Search parties by their registrar satellite's ID (EORI) number

Example: EU.EORI.NL012345678
webSiteUrlstringOptional

Search a party by their website URL

Example: https://www.example.com
companyEmailstringOptional

Search a party by their email ID

Example: [email protected]
companyPhoneinteger · int32Optional

Search a party by their company phone number

publiclyPublishablebooleanOptional

Search parties whose general company contact information is allowed to be published

Example: true
tagsstringOptional

Search parties who match any of the keywords that they have added in their participant information under tags. It is a free text field and can contain any value

Example: mobility
frameworkstringOptional

Search parties based on which framework they were onboarded with. Currently parties can only be registered with "iSHARE" framework

Example: iSHARE
subjectNamestringOptional

Search parties based on the subject name of their PKI (x509) certificates. Usually to find a party who is requesting tokens

Example: SERIALNUMBER=EU.EORI.US000000005,CN=CFMInternational,O=CFMInternational,C=US
rolestringOptional

Search parties based on their roles as defined in iSHARE role framework. Possible roles are ServiceConsumer, ServiceProvider, EntitledParty, AuthorisationRegistry, IdentityProvider, IdentityBroker and iShareSatellite.

Example: ServiceConsumer
loAstringOptional

Search parties based on their level of assurance which is registered in the participant list. Possible values are Low/Substantial/High

Example: Substantial
compliancyVerifiedbooleanOptional

Search parties that have their compliance to framework verified or not.

Example: true
legalAdherencebooleanOptional

Search parties that have signed the appropriate legal agreements and that have been verified during or after onboarding. Parties adhering to legal agreements are legally obliged to adhere to terms of use of data.

Example: true
authorizationRegistryIDstringOptional

Search parties based on their authorisation registry provider. The ID (EORI) of the authorisation registry must be provided in search parameter and this must be listed as authorisation registry in the participant record

Example: EU.EORI.NL000000004
authorizationRegistryNamestringOptional

Search parties based on their authorisation registry provider. The name of the authorisation registry must be provided in search parameter and this must be listed as authorisation registry in the participant record

Example: Askme anything
dataSpaceIDstringOptional

Search parties based on data-spaces they participate in. The ID of the data-space must be provided

Example: EU.DSP.NLLOGISTICS_DLDS
dataSpaceTitlestringOptional

Search parties based on data-spaces they participate in. The name of the data-space must be provided

Example: Dutch Mobility Dataspace
countriesOfOperationstringOptional

Search parties by name of country they list as their country of operation

Example: Belgium
sectorIndustrystringOptional

Search parties by name of sector they list as their sector/industry

Example: Energy
pageinteger · int32Optional

The parties API by default uses pagination. Each page size is fixed at 10 parties per page. When search results into more then 10 parties, the page parameter must be added for next pages

Example: 2
certificate_subject_namestringOptional

Search parties based on the subject name of their PKI (x509) certificates. Usually to find a party who is requesting tokens

Example: SERIALNUMBER=EU.EORI.US000000005,CN=CFMInternational,O=CFMInternational,C=US
Responses
chevron-right
200Success
application/json
parties_tokenstring · application/jwtOptionalExample: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1YyI6WyJNSUlFOWpDQ0E5NmdBd0lCQWdJSVoxUks0YnZmWjZ3d0RRWUpLb1pJaHZjTkFRRUxCUUF3UERFNk1EZ0dBMVVFQXd3eFZFVlRWQ0JwVTBoQlVrVWdSVlVnU1hOemRXbHVaeUJEWlhKMGFXWnBZMkYwYVc5dUlFRjFkR2h2Y21sMGVTQkhOVEFlRncweU16QTVNRGt4TWpJMk5USmFGdzB6TXpBNU1EWXhNakkyTlRGYU1JR0JNU1F3SWdZRFZRUUREQnRwVTBoQlVrVWdWR1Z6ZENCUVNWSWdVMkYwWld4c2FYUmxJREV4SGpBY0JnTlZCQVVURlVWVkxrVlBVa2t1VGt4VVJWTlVVRWxTVTBGVU1URVVNQklHQTFVRUN3d0xWR1Z6ZENCaGJtUWdVVUV4RmpBVUJnTlZCQW9NRFdsVFNFRlNSVlJsYzNSUVNWSXhDekFKQmdOVkJBWVRBazVNTUlJQ0lqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FnOEFNSUlDQ2dLQ0FnRUFwMkwzUGpkTGJLeXRTeHl3UlE5bHlmNHpISkd5WGFMYTNNQkZjbWQyUzBrTklTWWx3aGloSmtFY3hHZWNpRisrVXRZV2tSUXF0eDNTZ3pWeXhjbm1yUHNIR1Q0cTFrSGk3NmFWNVdZbXFNU3RVRUsvWVozSW92MGU1MVVCV2FpeWRNMmsvY2MwQnF4MWlQYUdYT0JoR2lhdTEvN3dxQ29GSDQwN3BoSS9wWWxaMURHZStCOFFyQjNLZi9Mdjh0UCtyc3ZZK3JFMVkrSHZsWkpwVFdqQVU4ZDYzOEx3UXgxMTZXc0YxeFJFOGtkbGJVZEI0SXBOT2RqNEsvV1FhNldVd1I2Y1V4SmJibko4MWdpVm9OTHhQMzExNkwwek1HUlVMa0JFUDN4NUxzZ2djS1U2NFltUDB1Rk0zeEZzRVRQV0JzSkVKemFTVVhuMmNvVlgwdjFmbjZzWXlnVUZPWlpYVXdIeno1Sm53RHBvV3dxUHM4NzdhdGxZQ1dwbzNaRFhQME0wNHJlY1VCb3BDL2ZDcTNSUWQ4Ull5SGJHZktneDIzZ3RPTkloaUZmTkt6emgyUEc2dFdBOEpxejdCbXVhOUszSGdsWEl6cUZsNjhhaUJxNEdwdnh1UWdtUzUrb2hPenpvQktNSm9CYkJXc2l1RDJiaEk1VXc0MWhBbG1kYjZMbEs3MUp6K3cwandXeFhvcVFJYUpqY1RNTndFNHNmRmNTZm9qdk9Eb3h1V3VLS1pzKzZ4azJ6bVpZcDRscEsycFZ0VUMyVXErMjhnVXVnbU1vb1RZa0djWHZoMEpOeURGS3AyYXFWWGZkL0s4NTgxRGJOTWV2Y3FBTXdNbXV3U1JST3Z3bmt2SlBhZGlIQVlwY29WT3hPZlZ2Tm5GR29hOTZIb1o4ZStPOENBd0VBQWFPQnRUQ0JzakFmQmdOVkhTTUVHREFXZ0JSdHhXV0p5OStSVk5GclBMY0NwUzdOaW1pUUhUQW5CZ05WSFNVRUlEQWVCZ2dyQmdFRkJRY0RBZ1lJS3dZQkJRVUhBd1FHQ0NzR0FRVUZCd01CTURjR0NDc0dBUVVGQndFREJDc3dLVEFJQmdZRUFJNUdBUUV3Q0FZR0JBQ09SZ0VFTUJNR0JnUUFqa1lCQmpBSkJnY0VBSTVHQVFZQ01CMEdBMVVkRGdRV0JCVE94aS9PYUlpQ05XZEY4cFZYc3Y0elVRWGVPVEFPQmdOVkhROEJBZjhFQkFNQ0JzQXdEUVlKS29aSWh2Y05BUUVMQlFBRGdnRUJBQ1EzaTI4RU9xcDloMTNodnFPUTFuVHFpNjhkRldFdkFDSFd2OGFvTms4VHVwbWlhTjhpOEJmYnA3SlQyVG1kbG1POTBGTHUvRUlDN1lybWk2UVlhZ1FmNUVhZlFJSUdRMUdwUzZOTS9Qcm9tempEMFJ2eUdQT2RzcGNGSG1YV3c1UFcxc1BjL2F2eFRXU3FIQ1djOFIveU5ZYk56eGxraC9EUXc5N1YzSTB5TVp4aWlkRTNwdzFvRnAwQ1hzb1d6NFVrdU9lRXRPVFlEQU5vV2QrTHNKa011ZFgybWFBUnhBUWlYOUhRWnFVVEFJRjQxbFhFeitCcTFZUVJ3S1BPL0JVS0RmRkp1K2hia2lmQ1pzY0pkUmpRYVV2RXdVWG5YQitlYlNSb0dRRnpaWVhyUVh4YkxUdmxJYXlYL2EyUGV2cDdmZ3psQ1A2STZablNYdTdwRXk0PSIsIk1JSURTRENDQWpDZ0F3SUJBZ0lJU3hSM0ltekcxQmN3RFFZSktvWklodmNOQVFFTEJRQXdKekVsTUNNR0ExVUVBd3djVkVWVFZDQnBVMGhCVWtVZ1JtOTFibVJoZEdsdmJpQmxTVVJCVXpBZUZ3MHhPVEF5TWpJeE1EQTBNekZhRncwek9UQXlNVGN4TURBeU5EbGFNRHd4T2pBNEJnTlZCQU1NTVZSRlUxUWdhVk5JUVZKRklFVlZJRWx6YzNWcGJtY2dRMlZ5ZEdsbWFXTmhkR2x2YmlCQmRYUm9iM0pwZEhrZ1J6VXdnZ0VpTUEwR0NTcUdTSWIzRFFFQkFRVUFBNElCRHdBd2dnRUtBb0lCQVFESEIyQUJRTDd6d21pMXhJa08wYTJxNmpJSmRuM1FBbTBzMWxTZVFldjlGMkYzTTVaOHFpcVFKYXVyTVp5d1pmZE52ZzkrSXFHSE9qRGU2aElodVJ6em9BbzBBYk80TjlPZGYyUkREVTk1Tjd0b0ptQXlDaVlHZ1pmWnQ3QnNLRkllUTZwNkNzZ0tjUlhQaTBmZFhkVlNIcDRiWmZRT1FkY2xNYnRJVGlybkZ0VTA2TlBBaG9ZNjc2WXo5NnhGQUUwem9tNmVNVlBQT0ltMEc4Z2Q0NFhsbmJMMHcwbWNjQ2kyVlVaanZDSUw1OU82MU84dmxWeUxzQnFOTlRDdmY5QzJDTVlhRWF0WFp5ei9sd2dINkpZSHREMHVzWHQvK00wcUtZZTFvZW9MazBaaWNGWlhjazFpUzA5a0ZkZ2dLNUJsTm9kb1dKYURCUnJvNTFXaFkyV25BZ01CQUFHall6QmhNQThHQTFVZEV3RUIvd1FGTUFNQkFmOHdId1lEVlIwakJCZ3dGb0FVbFpNa3lieWhDeks1SE9CRkhLUk8rTUxTUi80d0hRWURWUjBPQkJZRUZHM0ZaWW5MMzVGVTBXczh0d0tsTHMyS2FKQWRNQTRHQTFVZER3RUIvd1FFQXdJQmhqQU5CZ2txaGtpRzl3MEJBUXNGQUFPQ0FRRUFaSDVRanVxK085RnB2NjM3ZzBjRjZuMUlMWUJMejFlTlpqRUIzZG9BZXh2aTVDelN3M29zd0pDU2VkR1czaGgwcUhPVEsyZ0k4M2poMFcyRUFuMmlzRmd3aE1vRzJqZDJZU0ZTa204US8yZU9mYzZNZ0dTQzVzT1RMNzVKN2J5TENvcmRxZC9ONGVhajNFcUtMYVdxN3I3dXN0UDgxUDhFSWx6MEQ4YTdsZmYxRlNvMjNIV1hUV1gyK20ydm9MQUU1bDk3YUdUR1JTMVVieGhQMmpGS1lKOVh6aUtlOU1RSlNaRWxUUThqcWcya1BGa0V4L1hxQVdxbEcxZGwxeXdMSnE1aWVQdksxUjRBWU5JL1liWlFrOXNsajh2K1AvNk03RXRFcnNmMnVJU2dld0xUY1dsMjR4M25HNXhiUVp4clA4bDJqU0dZbU9USW5nS09RU25iZmc9PSIsIk1JSURNekNDQWh1Z0F3SUJBZ0lJQkxVMmNaQVpxTEV3RFFZSktvWklodmNOQVFFTEJRQXdKekVsTUNNR0ExVUVBd3djVkVWVFZDQnBVMGhCVWtVZ1JtOTFibVJoZEdsdmJpQmxTVVJCVXpBZUZ3MHhPVEF5TWpJeE1EQXlORGxhRncwek9UQXlNVGN4TURBeU5EbGFNQ2N4SlRBakJnTlZCQU1NSEZSRlUxUWdhVk5JUVZKRklFWnZkVzVrWVhScGIyNGdaVWxFUVZNd2dnRWlNQTBHQ1NxR1NJYjNEUUVCQVFVQUE0SUJEd0F3Z2dFS0FvSUJBUUNyRFAyRFdYMy9iOHVNYXB6RUJBVFNhNmlaZnZnZ3pJQlVFeGtXRWJHOWUxblZ5L2pRazIwbmZTRk1VbVJUNk5oWWNka1NZTy9XcmtpOVk0RXBDeTF4dlpIcUwrNFk2UzlKTFp3Sjc2MExwWWxlK05hVnU3bWluTVVRY3VvajVuS3pDbHZhemIwMEF4NWdrSlVmUjN2M1g1R1hxUXJrV2F6TXQrazVUTk02VFd1SjMwcU9md3JIeDV2VExtVFVVaWgrQnNHTDNmNUdPczFWVFlJQ05oaVRqTjc0bjJXcXAya1VMV0llKy9YNlJaL2hLc3BhSEdabktEVlR3SSs4Wm1XRmVqdXhBNkRPWDdSc1lMS3ZRTzIxRm1iSUJvU3M5QXp2NTkvUnhXVUpWTU8wV2hEaEtwUWdDR2p3Z1YzMm9mTmRrRmdtZFZ1bHpOUElEMlJOYlRUTEFnTUJBQUdqWXpCaE1BOEdBMVVkRXdFQi93UUZNQU1CQWY4d0h3WURWUjBqQkJnd0ZvQVVsWk1reWJ5aEN6SzVIT0JGSEtSTytNTFNSLzR3SFFZRFZSME9CQllFRkpXVEpNbThvUXN5dVJ6Z1JSeWtUdmpDMGtmK01BNEdBMVVkRHdFQi93UUVBd0lCaGpBTkJna3Foa2lHOXcwQkFRc0ZBQU9DQVFFQWx6YUJWYUZoWm1IOXV4c0xTdjNGa2t4V1Z3QlIxR2hBeHdjSmxWNHgra3FYOHRjaEo0U0RMRXVXUnJGNEROdHZTUjNyNjlLejhlWUk1WHVXMWVHMTJZakdHVmxZaWpkeHJHMUFOekduMnZkbzl2TDdkRUZVRU1LMUFLeFJzdGJUZEU3eXd6SVYvQzYxdzhKcnh3THR0OU9qZFVFVVBIdUdUanV2NW5GQlBkRnpPY3Z1K0RUTWw3M0NKUDJ6ZVpVRmd1ajU1TXNYWTQ1TXJYcmJndCtMSnFVdTRwa0IyYkx1OUZiZVJMV1pKdWtuWVNyVzRmeVFCWjJpK01zR2RpQktRY2YzZkxYanBjaDQ4L3A3U2lUazR1ZmxvQmFxVENsdC9FdFdYRFNtRmN2NFFqQmsxbVVQdTl2eGlrY0hEa0F2SnJPWEdnMGIrM2VJNGE3T1RmQWIxZz09Il19.eyJhdWQiOiJFVS5FT1JJLk5MMDAwMDAwMDAxIiwiZXhwIjoxNzExNDY1NDkzLCJpYXQiOjE3MTE0NjU0NjMsImlzcyI6IkVVLkVPUkkuTkxURVNUUElSU0FUMSIsImp0aSI6IjY3ZGJjMGU3YmFjZDQ1MTA5YjMxZDk2ODAxYWU2MTFlIiwibmJmIjoxNzExNDY1NDYzLCJwYXJ0aWVzX2luZm8iOnsidG90YWxfY291bnQiOjEsInBhZ2VDb3VudCI6MSwiY291bnQiOjEsImRhdGEiOlt7InBhcnR5X2lkIjoiRVUuRU9SSS5OTDAwMDAwMDAwMSIsInBhcnR5X25hbWUiOiJBQkMgVHJ1Y2tpbmciLCJjYXBhYmlsaXR5X3VybCI6IiIsInJlZ2lzdHJhcl9pZCI6IkVVLkVPUkkuTkwwMDAwMDAwMDAiLCJhZGhlcmVuY2UiOnsic3RhdHVzIjoiQWN0aXZlIiwic3RhcnRfZGF0ZSI6IjIwMjQtMDItMTJUMDA6MDA6MDAuMDAwWiIsImVuZF9kYXRlIjoiMjAyNS0wMi0xM1QwMDowMDowMC4wMDBaIn0sImFkZGl0aW9uYWxfaW5mbyI6eyJkZXNjcmlwdGlvbiI6IiIsImxvZ28iOiIiLCJ3ZWJzaXRlIjoiIiwiY29tcGFueV9waG9uZSI6IiIsImNvbXBhbnlfZW1haWwiOiIiLCJwdWJsaWNseV9wdWJsaXNoYWJsZSI6ImZhbHNlIiwiY291bnRyaWVzT2ZPcGVyYXRpb24iOltdLCJzZWN0b3JJbmR1c3RyeSI6W10sInRhZ3MiOiIifSwiYWdyZWVtZW50cyI6W3sidHlwZSI6IlRlcm1zT2ZVc2UiLCJ0aXRsZSI6InR1Iiwic3RhdHVzIjoiQWNjZXB0ZWQiLCJzaWduX2RhdGUiOiIyMDI0LTAyLTEyVDAwOjAwOjAwLjAwMFoiLCJleHBpcnlfZGF0ZSI6IjIwMjUtMDItMTNUMDA6MDA6MDAuMDAwWiIsImhhc2hfZmlsZSI6ImFlMWQ3ZDMwZjVkYjk0OTdmMjFhNzk4NGE4YTZmMzU5IiwiZnJhbWV3b3JrIjoiaVNIQVJFIiwiZGF0YXNwYWNlX2lkIjoiIiwiZGF0YXNwYWNlX3RpdGxlIjoiIiwiY29tcGxhaWFuY3lfdmVyaWZpZWQiOiJubyJ9LHsidHlwZSI6IkFjY2Vzc2lvbkFncmVlbWVudCIsInRpdGxlIjoiYWEiLCJzdGF0dXMiOiJBY2NlcHRlZCIsInNpZ25fZGF0ZSI6IjIwMjQtMDItMTJUMDA6MDA6MDAuMDAwWiIsImV4cGlyeV9kYXRlIjoiMjAyNS0wMi0xM1QwMDowMDowMC4wMDBaIiwiaGFzaF9maWxlIjoiYWUxZDdkMzBmNWRiOTQ5N2YyMWE3OTg0YThhNmYzNTkiLCJmcmFtZXdvcmsiOiJpU0hBUkUiLCJkYXRhc3BhY2VfaWQiOiIiLCJkYXRhc3BhY2VfdGl0bGUiOiIiLCJjb21wbGFpYW5jeV92ZXJpZmllZCI6Im5vIn1dLCJjZXJ0aWZpY2F0ZXMiOlt7InN1YmplY3RfbmFtZSI6IkNOPUFCQyBUcnVja2luZyxTRVJJQUxOVU1CRVI9RVUuRU9SSS5OTDAwMDAwMDAwMSxPVT1UZXN0LE89aVNIQVJFVGVzdCxDPU5MIiwiY2VydGlmaWNhdGVfdHlwZSI6IlBLSW8iLCJlbmFibGVkX2Zyb20iOiIyMDI0LTAyLTEyVDAwOjAwOjAwLjAwMFoiLCJ4NWMiOiJNSUlEMmpDQ0FzS2dBd0lCQWdJSU5xZS9FU1pLYnMwd0RRWUpLb1pJaHZjTkFRRUxCUUF3UERFNk1EZ0dBMVVFQXd3eFZFVlRWQ0JwVTBoQlVrVWdSVlVnU1hOemRXbHVaeUJEWlhKMGFXWnBZMkYwYVc5dUlFRjFkR2h2Y21sMGVTQkhOVEFlRncweU16QXlNalF4TmpVd016VmFGdzB6TXpBeU1qRXhOalV3TXpSYU1HWXhGVEFUQmdOVkJBTU1ERUZDUXlCVWNuVmphMmx1WnpFY01Cb0dBMVVFQlJNVFJWVXVSVTlTU1M1T1REQXdNREF3TURBd01URU5NQXNHQTFVRUN3d0VWR1Z6ZERFVE1CRUdBMVVFQ2d3S2FWTklRVkpGVkdWemRERUxNQWtHQTFVRUJoTUNUa3d3Z2dFaU1BMEdDU3FHU0liM0RRRUJBUVVBQTRJQkR3QXdnZ0VLQW9JQkFRQ1R2c3dLNVFMN3lDZ2twOWJpeDJsNGdwRmtSSFArYW9lRDI1RnNDS25YVWJwSFcvUUFpNi9kT1BHaDZQRlhUYUw0UXJkY1BRSWNva3hVY0dKZ1dGOHJTUWtkRnBYRGFSczFiRzZDVncvblNrUk9vb25iZEFNR2grVUNWNndPenV4RENhVXlzWWgwTU1zWEtydjRsSjBBaDFTVDZvQ01ub1RDVU9UdXFMVWcvVi84NFhkRE4xS2pSNjdwbmcrWVp3cGwyMi9za2RQTzZGRTZtTDIzYUxCei9BT3M1bmZpTWVQK0ZKZmtseG9DZ0RHdjloRTdiUmhLQkNJUXFnWGFpa3dvQnhaRjJGcDkycWUvSzBjL1N4L1EzVGtjdmU4YTZnSklBb1NwaUtSalNsUG9ZbXdMTjc2Yks0M0JEVWlVMU90SnJ2TVp3K3JOVUMxSVVTZXhPR1RMQWdNQkFBR2pnYlV3Z2JJd0h3WURWUjBqQkJnd0ZvQVViY1ZsaWN2ZmtWVFJhenkzQXFVdXpZcG9rQjB3SndZRFZSMGxCQ0F3SGdZSUt3WUJCUVVIQXdJR0NDc0dBUVVGQndNRUJnZ3JCZ0VGQlFjREFUQTNCZ2dyQmdFRkJRY0JBd1FyTUNrd0NBWUdCQUNPUmdFQk1BZ0dCZ1FBamtZQkJEQVRCZ1lFQUk1R0FRWXdDUVlIQkFDT1JnRUdBakFkQmdOVkhRNEVGZ1FVNmg4dTFpWnBobFJlRDRTeGNrWmVOM2NBNFNZd0RnWURWUjBQQVFIL0JBUURBZ2JBTUEwR0NTcUdTSWIzRFFFQkN3VUFBNElCQVFCWSs1WEU4TjBJbStQV2N0ZHR3cjU0NTJCOTJnY3N6eC9UYXBWYk9vVzQrbUdMdEtxRHdraC94UkpOKzV3RmpHVmxoZzJXOVJPRXB1VWNXR2xieCs0OHdRM09CV0dYcGRWZUR2S2FPQTlLSDJ3RGFnbi9BMVRJaUJSN01Td25GTlM2Q1Z1cy9raG5DYU1zZFlsNk9ZSXRpVVA4eEY2WUhBbXRZL2lUM1JBenpWTCtack9JWUI2NnJwMjBPMTlzRVJsYlVSaUZrMzRlRjZMQTc4UjhGQUNOZ0V1R05ybWdraDdobDdHdDVLZ3N5bGlvNlNtejNtNVdBZXFkaGtZNUJWbithNnd4ek83dVJ0WlJIamhGUEk3bGVPS2Q0RWNMWjdVYUJ5YVU0YUN4b3dpTStLNmUvZG92UFp5QnZYa1ZQVjRVSk9MeFBnMkRKVDJldmJ6QTMxVWwiLCJ4NXQjczI1NiI6Ijc3OGU4ODU4MmJjMTVhMWExMTM5M2YxN2RiNWU4Njg5OGE4NDU1ZTNlMzg3NjJiNjMxMDFmOGUzYjg5MmM2ODMifV0sInJvbGVzIjpbeyJyb2xlIjoiU2VydmljZUNvbnN1bWVyIiwic3RhcnRfZGF0ZSI6IjIwMjQtMDItMTJUMDA6MDA6MDAuMDAwWiIsImVuZF9kYXRlIjoiMjAyNS0wMi0xMlQwMDowMDowMC4wMDBaIiwibG9hIjoiIiwiY29tcGxhaWFuY3lfdmVyaWZpZWQiOiJubyIsImxlZ2FsX2FkaGVyZW5jZSI6Im5vIn1dLCJhdXRocmVnaXN0ZXJ5IjpbXX1dfSwic3ViIjoiRVUuRU9SSS5OTFRFU1RQSVJTQVQxIn0.LQLHT6bNzFA7q4wNdyHen0sEFpK51gQrAsJSd8okYRWvBFRizxQcReI2FY2eLAlp99DlrS6W-8dqCpiJO8zse5ua5Xl1a335v5AgklVlLTyK8Xw1ienZWjALu99hou7RMooFTOytuFaZyDJwtumBi0itsGhViR5pU84JKJdm7Z9imeirg4begxu4hhLAajNeci0oUgVCPW13w5tY3wijXUO-jtAB3fX4_jXTKA2Im9Utq00LgSl_o857vEMxM5q-_bWHYYvD1tBwjg-bbYRApdD8DcGgAEwswPg_iBrLB-gtf6Azam1bxv8dXrIL6WH8rjfuy6Ll_58ptoOYYLE3ma6n2JVrO4L9qpa2_hKuK0vjNpEm19AU7ltJRJPkcl3OGqNab2Jexq87nfxchvlWefzcVfD3i7bgZF3tE4VGKn97jlPpFBR-AuD_m_e5Lnt8KU39v3H1UVM4KixgXl86foOf4f6zQNG1whtMWoo54oAWlDhFEEUklWISjGaAlAKoHpdwgEjm0VeAw6blfSBSn0gfP6XPyAVZu4uP2CF6X_JPoGyzQ3M1LDuun2eheEbh2kAehylUWpJ7UxeRs2gO5TFftOjMcGa8a436a-lJkRetYLGwMDlGTl0Kim_SnfAF7ZNpc81bea3U7peUHwi8pg1UuUL9TDzvYV-XHJiF1Cw
get
/parties
200Success
circle-info

Even though all request parameters are optional, at least one parameter should be provided. E.x. if you would like to retrieve all parties, you could use name=* or eori=*.

hashtag
Response model

Decoded parties_token parameters:

The model of the parties_token JWT response is available on the iSHARE OpenAPI documentationarrow-up-right. For convenience the model of the parties_info object, contained within the token, is described below:

  • parties_info Object. Root level. Contains results count and information about the parties.

    • count Integer. Contained in parties_info. Total count of found parties. Since one request returns up to 10 parties, the value helps to understand if more than one page exists.

    • data Array of Objects. Contained in parties_info. Collection of parties.

      • party_id String. Contained in party_info. iSHARE identifier of the party. Should be EORI number.

      • party_name String. Contained in party_info. Name of the party.

      • capability_url

        String. Contained in party_info.

        Capabilities endpoint of the party.

      • registrar_id

        String. Contained in party_info.

        Identifier of the party who registered the participant identified by the party_id attribute above.

      • adherence Object. Contained in party_info. Object which contains status and validity timestamps of the party.

        • status String. Contained in adherence. Status of the party. Available values are Active, Pending, NotActive and Revoked.

        • start_date Timestamp (ISO 8601). Contained in adherence. UTC timestamp which states since when adherence status has established.

        • end_date Timestamp (ISO 8601). Contained in adherence. UTC timestamp which states till when adherence status has established.

      • additional_info

        Object. Contained in party_info.

        Object which contains additional general contact information of the party.

        • description

          String. Contained in additional_info.

          A brief description of the party.

        • logo

          String. Contained in additional_info.

          URL pointing to the endpoint where company logo can be found.

        • website

          String. Contained in additional_info.

          URL pointing to the endpoint where company logo can be found.

        • company_phone

          String. Contained in additional_info.

          General company phone number of the party.

        • company_email

          String. Contained in additional_info.

          General company email id of the party.

        • publicly_publishable

          Boolean. Contained in additional_info.

          Consent to publicly publish the information contained in this object.

        • countries_operation

          Array of Objects. Contained in additional_info.

          An array of ISO names of the countries where the party operates.

        • sector_industry

          Array of Objects. Contained in additional_info.

          An array of GICS based sectors/industry that party serves in.

        • tags

          String. Contained in additional_info.

          An free text field containing keywords relevant for party.

      • agreementsArray of Objects. Contained in data.Object which contains details about contracts including data space contracts that party has agreed and signed to.

        • type

          String. Contained in the object of agreements.

          Type of agreement. Refers to the official type of agreement. For iSHARE following types are available Terms of Use, Accession Agreement, Certified Party Agreement, Satellite Agreement. Additionally, each data space can define their own type and it can be listed here when appropriate data space is chosen.

        • title

          String. Contained in the object of agreements.

          The name of the agreement or agreement file.

        • status

          String. Contained in the object of agreements.

          Status of the agreement. Available values are Draft, Signed, Accepted, Obsolete.

        • sign_date

          Timestamp (ISO 8601). Contained in the object of agreements.

          Date of signature of the agreement.

        • expiry_date

          Timestamp (ISO 8601). Contained in the object of agreements.

          Expiry date of the agreement. For non expiring agreements the end date is far in future.

        • hash_file

          String. Contained in the object of agreements.

          The calculated hash of the agreement file that has been uploaded. Note agreements are not stored in ledger, but only their hash.

        • framework

          String. Contained in the object of agreements.

          The trust framework to which this agreement complies to. Currently, only iSHARE is available.

        • dataspace_id

          String. Contained in the object of agreements.

          The ID of the data space. If specified, party is onboarded in accordance to this data space’s terms and conditions.

        • dataspace_title

          String. Contained in the object of agreements.

          The name of the selected dataspace.

        • complaiancy_verified

          String. Contained in the object of agreements.

          Legal compliance to this agreement has been verified in accordance with the process set in trust framework as we as data space governance. Possible values are Yes, No, Not Applicable.

      • certificates

        Array of Objects. Contained in data.

        Object which contains the details of the PKI/x509 certificates of the party. Either certificates or SPOR must be present.

        • subject_name

          String. Contained in the object of certificates.

          subjectName as encoded in the X.509 certificate which corresponds with the party that is being requested from the iSHARE Satellite. Used by the iSHARE Satellite to match the certificate identifier.

        • certificate_type

          String. Contained in the object of certificates.

          type of certificate.

        • enabled_from

          Timestamp (ISO 8601). Contained in the object of certificates.

          UTC timestamp which states since when certificate is valid.

        • x5c

          String. Contained in the object of certificates.

          The base64 encoded pem format value of the certificate identified by its subject name and fingerprint.

        • x5t#s256

          String. Contained in the object of certificates.

          The SHA256 fingerprint of the certificate.

      • spor

        Array of Objects. Contained in data.

        The signed proof received from recognised issuer (currently eID identity providers) of information about the organisation and the authorised representative of that organisation being authenticated with “High” level of assurance.

        • signed_request

          String. Contained in the object of certifications.

          verifiable credentials of the participant signed by a trusted authority vouching for its authenticity.

      • roles

        Array of Objects. Contained in data.

        Object which contains details about the iSHARE roles of the party. The details include the level of assurance as well as compliance status for each role.

        • role

          String. Contained in the object of roles.

          Role name. Possible roles are ServiceConsumer, ServiceProvider, EntitledParty, AuthorisationRegistry, IdentityProvider, IdentityBroker and iShareSatellite.

        • start_date

          Timestamp (ISO 8601). Contained in the object of roles.

          UTC timestamp which states since when certification is valid.

        • end_date

          Timestamp (ISO 8601). Contained in the object of roles.

          UTC timestamp which states till when certification is valid.

        • loa

          Integer. Contained in the object of roles.

          Certificate’s level of assurance. Available values are 1 (low), 2 (substantial) and 3 (high).

        • compliancy_verified

          Boolean. Contained in the object of roles.

          Compliance requirements of this role has been met by party.

        • legal_adherence

          Boolean. Contained in the object of roles.

          Legal requirements of this role has been met by party including signing of appropriate agreements.

      • auth_registries

        Array of Objects. Contained in data.

        Object which contains details about the authorisation registers that the party uses.

        • name

          String. Contained in the object of auth_registries.

          The name of the authorisation registry provider.

        • id

          String. Contained in the object of auth_registries.

          The Id of the authorisation registry provider.

        • url

          String. Contained in the object of auth_registries.

          The URL pointer specific to the party where authorisations can be queried/checked from.

        • dataspace_id

          String. Contained in the object of auth_registries.

          The id of the data space where the party uses this authorisation registry provider.

          • dataspace_name

            String. Contained in the object of auth_registries.

            The name of the data space corresponding to the data space id.

hashtag
Example request

hashtag
Example response

The response contains an encoded JWT, which looks like this:

After decoding, the example content of the JWT looks like this:

circle-info

Note

This page must be considered part of the iSHARE Trust Framework

PreviousAccess token (M2M)NextParties (single party)

Last updated