Resolve organisation by domain

GET

/v2/organisation/check

• Staging
• Development

Returns the organisation details when the domain is registered in this tenant. Returns 404 when no organisation matches the domain.

Authorizations

• X-API-Key
• X-API-Secret

Parameters

Query Parameters

domain

required

string

acme.localhost

Organisation domain to verify for registration.

Responses

200

Organisation matching the domain.

object

organisationId

required

Organisation ID

string format: uuid

123e4567-e89b-12d3-a456-426614174000

name

required

Name of the organisation

string

Acme Corp

slug

required

Slug of the organisation

string

acme-corp

domains

required

Organisation domains

Array<string>

[
  "acme.example.com"
]

keycloakSynced

required

Whether organisation is synced in Keycloak

boolean

true

colors

Brand colors

object

light

required

Light mode colors

object

primary

required

Primary brand color in hex format

string

#0147FF

secondary

required

Secondary brand color in hex format

string

#8EA8FF

dark

required

Dark mode colors

object

primary

required

Primary brand color in hex format

string

#0147FF

secondary

required

Secondary brand color in hex format

string

#8EA8FF

logo

Brand logos

object

light

required

Light mode logo assets

object

img

required

Brand image asset URL/path

string

blob/public/org/acme/logo-light.png

symbol

required

Brand symbol asset URL/path

string

blob/public/org/acme/symbol-light.png

dark

required

Dark mode logo assets

object

img

required

Brand image asset URL/path

string

blob/public/org/acme/logo-light.png

symbol

required

Brand symbol asset URL/path

string

blob/public/org/acme/symbol-light.png

favicon

Favicon asset URL/path

string

blob/public/org/acme/favicon.png

dapp

Optional dapp customizations

object

style

Dapp style customizations

object

loginLogoWidth

Login logo width in pixels

number

navigationLogoWidth

Navigation logo width in pixels

number

navigationTopLogoWidth

Top navigation logo width in pixels

number

verificationBankName

Verification bank name

string

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error