External IDs

An external ID is an additional identifier used to reference records, with a maximum length of 256 characters. This ID can be set via the Platform API or in Control Center by external partners. It is used to identify and address key entities of ioki Platform.

The external ID is unique at either the provider or product level. Once an external ID is set for an object in Control Center, it can be modified but not deleted. The only exception is product-scoped external IDs on archived objects.

The following entities can have an external ID:

• Users can have a provider-scoped external ID, which can only be set via the Platform API. A user with an external ID does not need to have a phone number; in this case, ioki Platform relies on the external system to verify the user’s identity.
• Vehicles, stations, and drivers can have a product-scoped external ID. This ID can be set in Control Center or via the Platform API.