Welcome to our new Vignette ID Developer Portal documentation!
Vignette ID API Documentation
How to start

How To start

We offer three types of integration:

  • API — a fully flexible and customizable integration through our REST API.
  • Web Widget — an embeddable JavaScript widget that handles the entire purchase flow with just a few lines of code.
  • Iframe — the quickest and simplest setup via an iframe block, ready in minutes on both desktop and mobile.

A short registration form must be completed before integration, regardless of which option you choose.

  1. Fill the partner form

    Fill out the partner form on the website – Become Partner Partner Form

    Once the form is submitted, we create your partner account and issue your SANDBOX and PRODUCTION API keys — you will access them in the Partner Panel in the next steps.

  2. Login to Partner Panel portal

    Log in to the partner panel with the email you specified – Partner Panel

    If you are a business owner and you have a developer who will perform the integration, add him in the Profile -> Settings -> Members

    Add Member

  3. Select type of integration

    Please navigate to the corresponding tab in Partner Panel based on the integration type you’ve selected and follow the relevant documentation provided:

    API documentation you can find on this link - API Integration 📄

    Widget documentation you can find here - Widget Integration 📄

    Iframe documentation you can find here - Iframe Integration 📄

  4. Configure webhook & redirect URLs

    In the Partner Panel open Profile → For Developers and set up how you receive order updates and where customers return after payment:

    • Webhook URL — we notify you on every order status change (CREATED, COMPLETED, FAILED, REFUNDED). Details — Webhooks 📄
    • Success redirect URL / Error redirect URL — where the customer is redirected after a successful or cancelled payment.

    Your SANDBOX and PRODUCTION API keys live in this same section — make sure you use the correct one. More details — Partner Panel 📄

  5. Generate your draft cooperation agreement

    Open the Revenue Calculator 🧮, choose your configuration (payment model and revenue share) and download the pre-filled draft cooperation agreement. Your selections are summarised in Annex 1 — Selected Configuration.

    The draft must be reviewed and confirmed by both parties before signing — the figures are not final until agreed.

  6. Pay the Security Deposit

    Before going live, pay the refundable Security Deposit shown in the Revenue Calculator for your chosen payment model:

    • EUR 1,000 — when Vignette ID acts as the payment processor (covers End-User refunds we process on your behalf).
    • EUR 3,000 — when you collect retail payments directly.

    The deposit is fully refundable and returned on termination of the cooperation.

  7. Your production API key is activated 🎉

    Congratulations! Once the deposit is received and the agreement is signed, your PRODUCTION API key is activated and you are ready to serve real orders.

Last modified on
HomeOrder Flow