First Steps

Integration Guide

Roles & Scopes

Client Information Center

BaseUser

Customer

Human-readable explanation specific to this occurrence of the problem

a unique identifier for this particular occurrence of the problem.

The HTTP status code applicable to this problem, expressed as a string value.

Error

Errors

OrganisationAndUserExternalOnboardingRequest

FleetData

True if the role is a client role, false otherwise.

Location

Market

Organisation

OrganisationExportData

Roles applied to a user

OrganisationVerificationInfo

Role

Sector

The id of the organisation to switch to

User

UserEmail

UserId

Andreas Gemke

CIDK/OBID API documentation

market

Get the organisations used by the client filtered by market

Allows onboarding a new organisation (and its admin) in OBID

name

legalForm

streetName

houseNumber

city

country

vatId

Searches for organisations that match the given organisation data

orgId

Get the list of external attributes of the organisation. A key parameter can be provided to filter a specific attribute

 ## Available flags:
  - **block_deletion**: Blocks an organisation from being deleted.
  - **unblock_deletion**: Unblocks an organisation from being deleted. 

Describes the flag to add and other optional fields

Sets the given flag in the specified organisation. For block_deletion, the 'flagUntil' field can be provided. If the field is null the organisation will be flagged indefinitely.

Get the users belonging to the organisation

Get the verification information of the organisation

userId

Get the list of organisations of the user and the roles associated.

official_language

Get the legal forms that are available for the given market

region

Get the markets with the contract languages

id of the organisation to which new be2beClient should belong to

Gets the granted authorities given to an organisation in the scope of Backend to Backend communication

Updates the authorities given to an organisation in the scope of Backend to Backend communication

Get the billing address for the given org id

Get a list of customers for third party provider organisation

Create a customer for third party provider organisation

Delete a customer for third party provider organisation

Update a customer for third party provider organisation

Get fleet ids for the given organisation.

Allows fleeting and updating fleet for the given organisation.

locale

Update user marketing consent for individual brands

Get all roles of user, including client roles

Set all roles of user, including client roles

Overrides all roles of the user in clients

Switch the user active organisation to the one provided.

OBID Documentation