Skip to content
Invoro Docs

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.

By default the lookup runs in fast mode: it tries only the most likely candidates (an explicit Peppol ID, or the VAT scheme matching a detected country code) and returns on the first hit. Set extended=true to brute-force every configured endpoint scheme (slower, but useful when the participant uses a non-VAT identifier).

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
object
query
required

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

string
extended

When true, also tries every configured endpoint scheme as a fallback and collects all matches instead of returning on the first hit. Defaults to false.

boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

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>
extended_search_available
required

Whether additional candidates exist that were not tried in this fast lookup. Re-issue with extended=true to check them.

boolean
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
additional_info
required

Free-form additional information about the entity.

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

422

Section titled “422 ”

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>