Jump to Content
API Reference
Developer ConsoleAPI Status Page

Check whether a recipient is on the Peppol network

get
https://api.wafeq.com/ae/v1/recipients/{participant_id}/reachability

Look up a recipient in the Peppol SML/SMP before sending it a document.

reachable is true when the recipient's SMP publishes a PINT-AE invoice
endpoint, so documents sent to it are delivered over Peppol. When false, it
is not registered and cannot receive documents over Peppol. When error is
set, the lookup reached no verdict and reachable means unknown rather than
unregistered.

The lookup concerns the recipient; x-ae-taxpayer-id names the taxpayer
you act for and needs the invoices:read scope. Sandbox answers from
Sandbox taxpayers and test buyers without querying the Peppol network.

Path Params
stringrequired

Peppol Participant ID of the recipient, 0235:<TIN> for a UAE business.

Headers
string | null
stringrequired

Taxpayer ID (txpay_…). Required with an organization API key (pk_…) for this taxpayer-specific operation, even for one taxpayer. Not a TIN. Optional with a taxpayer access token, which already names its taxpayer.

string | null

Grant ID (tgr_…) to act through, with an organization API key. The request then has exactly that grant's scopes and fails once the grant is revoked. Without it, the key acts through all of the organization's active grants on the taxpayer.

Response

Updated about 2 hours ago

Check whether a recipient is on the Peppol network