Recipients

Verify Recipient

Look a Peppol address up in the SMP and report what the participant behind it is registered to receive.

POST
/api/v1/verify

Look a Peppol address up in the SMP and report what the participant behind it is registered to receive. Use it before sending to check that an address exists and to see its document types. A lookup that fails, including for an address that is not registered at all, 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 reports that company's document types, without SMP or endpoint fields; any other address is looked up on the production network, as the send endpoint does.

Authorization

AuthorizationBasic <token>

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" \  -H "Content-Type: application/json" \  -d '{    "peppolAddress": "string"  }'
{  "success": true,  "isValid": true,  "smpUrl": "string",  "serviceMetadataReferences": [    "string"  ],  "smpHostnames": [    "string"  ],  "supportedDocuments": [    {      "certificateExpiry": "string",      "docTypeId": "string",      "name": "string",      "serviceEndpoint": "string",      "serviceProvider": "string",      "technicalContact": "string"    }  ],  "companyName": "string",  "countryCode": "string"}