Verify Document Support
Check whether a Peppol address is registered to receive one specific document type, optionally under one specific process.
Check whether a Peppol address is registered to receive one specific document type, optionally under one specific process. Use it before sending a document type the recipient may not accept. A lookup that fails, including an address that is registered but not for this document type, is not an error: the response is { isValid: false } with no further fields. In a playground that is not connected to the Peppol Test Network, an address that belongs to a company in the same playground is checked against that company's document types, and the response has no SMP or endpoint fields; any other address is checked against the production network, as the send endpoint does.
Basic API key authentication. Create a new API key and secret in the Recommand dashboard.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/api/v1/verify-document-support" \ -H "Content-Type: application/json" \ -d '{ "peppolAddress": "0208:987654321", "documentType": "urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1" }'{ "success": true, "isValid": true, "smpUrl": "string", "serviceProvider": "string", "serviceEndpoint": "string", "technicalContact": "string", "certificateExpiry": "string"}