Skip to content

Lookup Participant

POST
/peppol/lookup

Look up a participant on the Peppol network via SMP/SML discovery. Accepts a raw identifier (e.g. LU12345678, DE123456789) or a fully-qualified Peppol ID (e.g. 0208:LU12345678). Returns registration status, supported document types, and business card information.

object
query
required

The identifier to look up. Can be a VAT number, fully-qualified Peppol ID (scheme:value), or raw company identifier.

string
Example
0208:LU12345678

Lookup result with participant details.

object
data
required
PeppolLookupResource
object
found
required

Whether any participants were found on the Peppol network.

boolean
query
required

The original search query.

string
candidates_checked
required

List of fully-qualified Peppol IDs that were checked (e.g. 0208:LU12345678).

Array<string>
results
required

Matching participant registrations found on the network.

Array<object>
PeppolLookupResultResource
object
peppol_id
required

Fully-qualified Peppol ID (e.g. 0208:LU12345678).

string
smp_url
required

SMP server URL where participant is registered.

string
document_types
required

Document types the participant can receive.

Array<object>
PeppolDocumentTypeResource
object
id
required

Peppol document type identifier URN.

string
name
required

Human-readable document type name (e.g. Peppol BIS Billing 3.0 Invoice).

string
business_card
required
Any of:
PeppolBusinessCardResource

Business card information from the SMP, if available.

object
entities
required

Registered business entities.

Array<object>
PeppolBusinessEntityResource
object
name
required

Entity name.

string | null
country_code
required

ISO 3166-1 alpha-2 country code.

string | null
geographical_info
required

Geographical information or address.

string | null
website
required

Entity website URL.

string | null
identifiers
required

Additional identifiers (scheme/value pairs).

Array<object>
PeppolIdentifierResource
object
scheme
required

Identifier scheme (e.g. ISO 6523).

string
value
required

Identifier value.

string
contacts
required

Contact details (type, name, phone, email).

Array<object>
PeppolContactResource
object
type
required

Contact type.

string
name
required

Contact name.

string
phone
required

Contact phone number.

string
email
required

Contact email address.

string
looked_up_at
required

ISO 8601 timestamp when this lookup was performed.

string

Validation error.

object
message
required

Errors overview.

string
errors
required

A detailed description of each field that failed validation.

object
key
additional properties
Array<string>