Overview

Every Begini session requires two identifiers: an Integration ID and a Unique ID. Understanding what each one does and how to use them correctly is essential before you integrate.

Integration ID

The Integration ID identifies the specific Begini deployment being used. It controls which assessment configuration, scoring model, branding, and redirect URLs are applied when a session is created.

Each deployment in Beacon has two Integration IDs — one for Test and one for Production. They are found in Beacon → Deployment Centre → select deployment → Test or Production tab.

Important: Your API key should be stored securely at all times. It is used to authenticate all transactions with the Begini platform and must never be exposed in client-side code or source control.

Use the correct Integration ID for your environment. Test Integration IDs cannot handle the same concurrent user volume as Production, and only Production data appears in the Beacon results screen.

Unique ID (UID)

The Unique ID identifies the end user within your system. It is passed when creating a session and returned with the result — this is how you match a Begini output back to the correct customer or application record internally.

Typically this is your existing customer ID or application reference number.

Note: The Deployment Centre defaults to showing Test details. To view Production credentials, switch to the Production tab before copying your Integration ID or API key.

Important: Only Production data appears in the Beacon results screen. The Test Integration ID cannot handle the same volume of concurrent users as Production — do not use it for live traffic.

UID rules

Example valid UIDs

CUST-00123456
APP-2024-987654
ABCDE-12345-CD-01

How they work together

When your system creates a session, it passes both identifiers:

{
  "uid": "CUST-00123456",
  "integration_id": "1234567890987654321"
}

When Begini returns the result — via Beacon or webhook — the uid is included in the response. Your system uses it to match the result to the right internal record.

Common mistakes

• Using a customer's name, email, or national ID as the UID
• Using the Test Integration ID in a production environment
• Reusing the same UID for multiple users
• Not storing the UID in your system before sending the user to the assessment — if you lose the mapping, you cannot match the result back

Next steps

• Creating a Session — how Integration ID and UID are used in the API call
• Integration Overview — end-to-end view of the Begini flow