Participant Lookup API

API for PEPPOL participant lookup

To be able to use this API, you need to create an SMP user account. Then create your security token by clicking Settings > Show > Create token.

The Participant Lookup API is handy if you – as a sending Access Point – need to check if a receiver is registered in the PEPPOL network and which documents it is able to receive. You can call the API from within your internal workflow, i.e to find out if to route a particular file to PEPPOL and to which target format to convert a file before even transferring it to PEPPOL.

To lookup a participant you need to provide its complete ReceiverId (also known as participant id or PEPPOL id), such as 0007:5567212047. Please refer to our FAQ for a description of the syntax of a PEPPOL ReceiverId.

Commercial use of the API

The API is an add-on service for which there is a monthly cost. However, it is free to try it out in non-production scenarios for a limited period of time. Please be reminded that if you use the API in production without notifying us we will reset your token without prior notice.

  • JSON
  • XML

Request

A request for participant ID 0007:5567212047 would look like this if you want the response to be in JSON:

curl -X GET -H "Token:dgb055f1crtb03f1dgrdb03f1e" "https://api.galaxygw.com/1.0/smp/smplookup.json?pid=iso6523-actorid-upis::0007:5567212047"

Response

{
		  "participants" : [ {
			"idScheme" : "iso6523-actorid-upis",
			"idType" : "0007",
			"idValue" : "5567212047",
			"responseTime" : 76,
			"endpoint" : [ {
			  "serviceDescription" : "Tickstar TEST AP",
			  "url" : "https://test-ap.galaxygw.com:12781/ap/as2",
			  "technicalContact" : "support@tickstar.com",
			  "technicalInformationUrl" : "www.galaxygw.com/contact",
			  "transportProfile" : "busdox-transport-as2-ver1p0",
			  "smp" : "O=Tickstar AB,CN=SMP_2000000049,C=SE",
			  "expiry" : "2017-04-15 01:59:59 +0200",
			  "apcert" : "O=Tickstar AB, CN=APP_1000000012, C=SE",
			  "supportedDocuments" : [ {
				"commonName" : "PEPPOL Invoice (BIS v2 Profile 4a)",
				"profileCode" : "BII04 - Invoice Only",
				"documentLocalName" : "Invoice",
				"version" : "2.1",
				"documentIdentifier" : "urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:www.cenbii.eu:transaction:biitrns010:ver2.0:extended:urn:www.peppol.eu:bis:peppol4a:ver2.0::2.1",
				"processIdentifier" : "urn:www.cenbii.eu:profile:bii04:ver2.0",
				"url" : "http://B-8614d9986a6975b122c8cba0536ef27f.iso6523-actorid-upis.edelivery.tech.ec.europa.eu/iso6523-actorid-upis%3A%3A0007%3A5567212047/services/busdox-docid-qns%3A%3Aurn%3Aoasis%3Anames%3Aspecification%3Aubl%3Aschema%3Axsd%3AInvoice-2%3A%3AInvoice%23%23urn%3Awww.cenbii.eu%3Atransaction%3Abiitrns010%3Aver2.0%3Aextended%3Aurn%3Awww.peppol.eu%3Abis%3Apeppol4a%3Aver2.0%3A%3A2.1"
			  }, {
				"commonName" : "PEPPOL Invoice (BIS v2 Profile 5a)",
				"profileCode" : "BII05 - Billing",
				"documentLocalName" : "Invoice",
				"version" : "2.1",
				"documentIdentifier" : "urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:www.cenbii.eu:transaction:biitrns010:ver2.0:extended:urn:www.peppol.eu:bis:peppol5a:ver2.0::2.1",
				"processIdentifier" : "urn:www.cenbii.eu:profile:bii05:ver2.0",
				"url" : "http://B-8614d9986a6975b122c8cba0536ef27f.iso6523-actorid-upis.edelivery.tech.ec.europa.eu/iso6523-actorid-upis%3A%3A0007%3A5567212047/services/busdox-docid-qns%3A%3Aurn%3Aoasis%3Anames%3Aspecification%3Aubl%3Aschema%3Axsd%3AInvoice-2%3A%3AInvoice%23%23urn%3Awww.cenbii.eu%3Atransaction%3Abiitrns010%3Aver2.0%3Aextended%3Aurn%3Awww.peppol.eu%3Abis%3Apeppol5a%3Aver2.0%3A%3A2.1"
			  } ]
			} ]
		  } ]
		  

Lookup multiple participants with a single request

You can lookup multiple participant identifiers in the same request by chaining them with ‘&’ like this:

curl -X GET -H "Token:dgb055f1crtb03f1dgrdb03f1e"
"https://api.galaxygw.com/1.0/smp/smplookup.xml?pid=iso6523-actorid-
upis::0007:5567212047&pid=iso6523-actorid-upis::9908:90828477592"

Change the smplookup parameter to ‘json’ or ‘xml’ to get the response in your preferred format.