Dokumentace API

Visual integration in your app

Put Peppol status directly next to company information (name, registration number, billing profile) so users can verify recipient readiness at a glance.

You can also add affiliateId (obtained in the application) to join the affiliate program.

Preview of badges

micro

mini

small

large

Variant options

  • micro: icon only, minimal footprint in dense tables.
  • mini: icon + label, compact for list rows.
  • small: preferred default near company name, expands to details on hover.
  • large: full detail card for dedicated profile sections.

Large preview

Large variant contains detailed registration information and is suitable for profile-like cards.

Behavior summary

  • Use one shared script include for any number of badges on a page.
  • Call pepposhShowBadge for each target with the needed variant.
  • Clicking badge opens detail in https://app.pepposch.eu/lookup/{peppolId}.

Parameters and allowed values

  • countryCode: 2-letter country code, for example CZ.
  • rn: company registration number.
  • euVatId: optional EU VAT identifier, for example CZ05574617.
  • peppolId: optional direct Peppol ID lookup, for example 5599:123.
  • affiliateId: optional affiliate identifier from your account, for example afp_123456.
  • targetId: DOM element id where badge should render.
  • variant: micro, mini, small, large.
  • loading: show (default), hide, space.
    show = animated placeholder (large uses visible compact loading card), space = transparent reserved area.
  • error: show (default), hide, space.
  • registered: show (default), hide, space.
  • unregistered: show (default), hide, space.

Example use (single badge)

<div id="partner-peppol-badge"></div>

<script src="https://peppol.dativery.com/cdn/peppol-badge.js"></script>
<script>
  pepposhShowBadge({
    countryCode: "CZ",
    rn: "05574617",
    affiliateId: "afp_123456",
    targetId: "partner-peppol-badge",
    variant: "small",
    loading: "show",
    error: "show",
    registered: "show",
    unregistered: "show"
  })
</script>

Example use (peppolId)

<div id="partner-peppol-id-badge"></div>

<script src="https://peppol.dativery.com/cdn/peppol-badge.js"></script>
<script>
  pepposhShowBadge({
    peppolId: "5599:123",
    affiliateId: "afp_123456",
    targetId: "partner-peppol-id-badge",
    variant: "mini"
  })
</script>

Example use (micro)

<div id="badge-micro"></div>

<script src="https://peppol.dativery.com/cdn/peppol-badge.js"></script>
<script>
  pepposhShowBadge({
    countryCode: "CZ",
    rn: "12345678",
    targetId: "badge-micro",
    variant: "micro"
  })
</script>

Example use (mini)

<div id="badge-mini"></div>

<script src="https://peppol.dativery.com/cdn/peppol-badge.js"></script>
<script>
  pepposhShowBadge({
    countryCode: "CZ",
    rn: "12345678",
    targetId: "badge-mini",
    variant: "mini"
  })
</script>

Example use (small)

<div id="badge-small"></div>

<script src="https://peppol.dativery.com/cdn/peppol-badge.js"></script>
<script>
  pepposhShowBadge({
    euVatId: "CZ12345678",
    targetId: "badge-small",
    variant: "small"
  })
</script>

Example use (large)

<div id="badge-large"></div>

<script src="https://peppol.dativery.com/cdn/peppol-badge.js"></script>
<script>
  pepposhShowBadge({
    countryCode: "CZ",
    rn: "12345678",
    targetId: "badge-large",
    variant: "large"
  })
</script>