26 Jun, 2025

Get started




🚀 Get Started with Vincere Developer Portal


Welcome to the Vincere Developer Portal! This guide walks you through registering, exploring available APIs, subscribing to a plan, configuring consent, and retrieving your API key.



🔑 Step 1: Register an Account

  1. Click Sign Up at the top-right corner.
  2. Fill in your details:

    • Full Name
    • Email Address
    • Password
    • Invite Code — Vincere will provide this if you are part of an organisation with a dedicated API product
    • Access Type — indicate your integration type (e.g. machine to machine, end user app)
    • Visibility:
      • Public — if you are a Vincere partner
      • Private — if you are a Vincere client
    • Organisation:
      • Partners: enter your organisation name (e.g. Elay, HireAra, Wave)
      • Clients: enter your full tenant name (e.g. abc.vincere.io)
    • App Name — the name of the application you are integrating with the API (e.g. web-app, mobile-app)

  3. After submitting, your account may require activation by a Vincere admin. Please allow some time for this process.

🔐 Step 2: Log In

  1. Once your account is activated, return to the Vincere Developer Portal.
  2. Click Login and enter your registered email and password.
  3. You will be redirected to your developer dashboard.

📚 Step 3: Explore Available APIs

  1. From the dashboard, navigate to the Catalogues.
  2. Browse the available APIs and click on any entry to view:

    • Overview — available plans and their details
    • API Specifications

📦 Step 4: Subscribe to an API Plan

  1. Open the Overview tab of your chosen API.
  2. Select a plan and click Access to this plan.
  3. Scroll down to Select an App:

    • If you don't have an app yet, select Create a new app and complete the form.
    • If you need an additional key for an existing tenant and application, select Existing app and choose the corresponding app.

  4. Click Submit request. Approval may take some time.

App Naming Convention: We strongly recommend naming your app in the format [tenant's full domain]#[application name]. For example:

  • headhunter.vincere.io#chatbot
  • jobhunt.vincere.io#mobile

🔑 Step 5: Get Your API Key

Once your subscription is approved:

  1. Hover over your name at the top-right corner and go to My Dashboard → My Apps.
  2. Click the name of the relevant app.
  3. On the app details page, locate the Access and Credentials Info section.
  4. Your API key is labelled as Auth Token — copy and store it securely.

🛡️ Step 6: Create Consent for Your API Key

Before making API requests, consent must be configured in the Vincere Web Application. If you are a client, follow the steps below. If you are a partner, please ask your client to complete this on your behalf.


  1. Log in to the Vincere Web Application as an Administrator.
  2. Navigate to Settings → Marketplace.
  3. On the Marketplace screen, go to the Consent tab.
  4. Click Create Consent and fill in the following fields:

    • App — select the app name you created in Step 4 (e.g. headhunter.vincere.io#chatbot)
    • Representative User — select the user who will be associated with API requests made using this key
    • Scope — check Write:business_tracking_field if you require the ability to create entities on behalf of another user via the API

  5. Click Save.

Note: This consent record links your API key to the correct tenant and user context. Without it, API requests will be rejected regardless of key validity.



✅ Step 7: Start Using the API

You're all set! Include your API key in every request via the following header:

x-api-key: <your API Key>

Recent Posts