Skip to content
ObraXRAY Business

Embed - technical docs

There are two ways to show ObraXRAY on your site. The affiliate seal is free, neutral and shares revenue with you. The keyed widget, paid, shows the full risk inside your product. Both are a block of HTML and a script, without touching the rest of the page.

Affiliate embed (free)#

The affiliate seal is free to integrate. It shows your users that a risk pre-analysis of the construction company is available and sends them to the report on ObraXRAY. When someone buys, we share the revenue with you. It never shows a score, risk colour or verdict: it's an invitation to check, not a seal of approval.

Two formats

Pick the format for the space you have on your site.

Card

A compact block for a company profile, with the pre-analysis button.

Preview
<div data-obx-nif="514566680"
     data-obx-key="obx_pk_..."
     data-obx-variant="card"></div>

Inline seal

For lists and tables, next to a company name. Takes little space.

Preview
<div data-obx-nif="514566680"
     data-obx-key="obx_pk_..."
     data-obx-variant="seal"></div>

Install

Ask us for your affiliate key (obx_pk_...), tied to your domain. Then paste the block wherever you like, with the company NIF, and load the script once per page. Works on any site or CMS.

<div data-obx-nif="514566680" data-obx-key="obx_pk_..." data-obx-variant="card"></div>
<script src="https://obraxray.com/embed/v1/obx-embed.js" async></script>

Attribution and revenue share

Every click on the seal goes to the report with a ?ref carrying your partner id. A 60-day cookie is set on ObraXRAY; if the user buys within that window, the commission is yours. We handle the calculation and the payout, you manage nothing.

Neutral by design

On your site the seal only shows this, and never a score, risk traffic light, verdict or detailed signals:

  • The ObraXRAY logo, with a verification shield
  • “Check this construction company”
  • “Preliminary analysis based on official public sources”
  • A button to open the full pre-analysis on ObraXRAY

Keyed embed (paid)#

For companies that want to show the full risk, score and signals, inside their own product (construction due diligence in your flow). It's part of ObraXRAY Business and uses an embed key from your plan. In most cases it makes more sense via the API, with your own interface.

Three variants, from the most compact to the most detailed. The key is tied to your domain and your plan.

summaryrecommended · single line

A bar with the verdict and the risk colour. Fits almost anywhere.

Preview
<div data-obx-nif="514566680"
     data-obx-key="obx_pk_..."
     data-obx-variant="summary"></div>

compactsmall seal

A minimal seal with the verdict, for dense tables and lists.

Preview
<div data-obx-nif="514566680"
     data-obx-key="obx_pk_..."
     data-obx-variant="compact"></div>

detailedcard

A card with the score, the main signals and the date of the last analysis.

Preview
<div data-obx-nif="514566680"
     data-obx-key="obx_pk_..."
     data-obx-variant="detailed"></div>

Configuration#

Attributes on the seal's <div>:

  • data-obx-nifThe NIF of the construction company to analyse. Required.
  • data-obx-keyYour embed key (obx_pk_...), which we issue and limit to your domain. Required.
  • data-obx-variantseal or card for affiliate; summary, compact or detailed for paid. Affiliate keys are always forced to the neutral variants.
  • data-obx-langLocale for the labels: "pt" (default) or "en". Falls back to the closest <html lang>.

Domain allowlist#

Each key is limited to the domains you authorise with us. A request from any other domain is refused, so the key is useless to anyone else even though it's visible in the HTML.

Limits#

Each key has default usage limits, generous for normal use on a site. If you need more volume, talk to us and we'll adjust.

Privacy#

The seal sets no cookies on your site and does not track your users. The attribution cookie belongs to ObraXRAY (first-party there) and is only written when the user clicks through to the report.

Contact#

To request your affiliate key or the keyed embed, write to [email protected] or talk to us.