VerifiMeVerifiMe Developer Portal
Concepts

Organisation Code

Your unique identifier for customer onboarding configuration

An organisation code is a unique identifier assigned to your organisation by VerifiMe during onboarding. You pass it as the code parameter in POST /v1/user/invite to associate new customers with your organisation.

What It Controls

Each organisation code carries configuration that applies to all invites created with it:

SettingDescription
Workflow typeWhich verification flows are available to customers
Redirect URLFallback destination shown as a "Return to [your company]" button after data entry
StatusActive or Inactive - only active codes can be used to create invites

Workflow Types

The workflow type determines what entity types customers can verify through this code.

TypeDescription
DEFAULTCustomers can verify as any supported entity type
INDIVIDUAL_ONLYCustomers can only verify as individuals
ORGANISATION_ONLYIndividual identity is still required; customer then proceeds directly to organisation verification (company, trust, partnership, sole trader)

The workflow type is configured by your VerifiMe account manager during onboarding.

Multiple Organisation Codes

By default, each organisation receives one code. If your application requires different workflow types or configurations for different customer flows, additional organisation codes can be provisioned upon request. Contact your VerifiMe account manager.

Redirect URL

After a customer completes data entry, the VerifiMe confirmation screen shows a "Return to [your company]" button. The URL the button navigates to is resolved in this order:

  1. The callbackUrl from customerContext on the invite call (per-invite override)
  2. The static return URL configured on your organisation code (fallback)

If neither is set, no button is shown.

Per-invite override

Pass callbackUrl in the customerContext object on POST /v1/user/invite to set a different destination per invite; for example, to carry a session-specific query parameter:

{
  "customerContext": {
    "callbackUrl": "https://app.example.com/verify/done?ref=abc123"
  }
}

Allowed redirect origins

The per-invite callbackUrl is validated against the allowed redirect origins list on your organisation code. If the origin is not registered, the callbackUrl is not used and resolution falls back to the organisation code's static return URL. If neither is configured, no button is shown.

The static return URL on the organisation code is not subject to the allow-list.

To add or update allowed redirect origins, contact your VerifiMe account manager.

Setup

Your organisation code and its redirect URL are configured by your VerifiMe account manager during onboarding. You will receive:

  • Your organisation code (e.g. ZEG69SIEL7AP)
  • The workflow type configured for your use case
  • A redirect URL if requested

For changes to any configuration, contact support@verifime.com.

On this page