Returns the entity to which the authenticated user belongs. This endpoint requires an entity user access token. The user must have a role with the entity.read permission.
To get an entity by using a partner access token, use GET /entities/{entity_id} instead.
Related endpoints:
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Successful Response
A schema for a response after creation of an entity of different types
UUID entity ID
UTC datetime
UTC datetime
An address description of the entity
A set of metadata describing an organization
record status, 'active' by default
active, inactive A type for an organization
"organization"An official email address of the entity
An object containing the entity logo URL and other image details, or null if the entity does not have a logo.
{
"id": "753fbb53-2347-4f47-9bbe-21c9b68b81a1",
"created_at": "2025-03-11T13:13:24.841010Z",
"file_type": "entity-logo",
"name": "logo.png",
"region": "eu-central-1",
"md5": "07098e3581e0d599c15121f5634ea124",
"mimetype": "image/png",
"url": "https://bucketname.amazonaws.com/path/to/logo-image.png",
"size": 63643,
"previews": [],
"pages": []
}A phone number of the entity
100(Germany only) The name of the local district court (Amtsgericht) where the entity is registered. Required if registration_number is provided.
1 - 100"Amtsgericht Charlottenburg"
(Germany only) The entity's commercial register number (Handelsregisternummer) in the German Commercial Register, if available.
1 - 100"HRB 202324"
The entity's taxpayer identification number or tax ID. This field is required for entities that are non-VAT registered.
30A website of the entity
1 - 2083