Entities

Entities are legal organizations (companies) or natural persons (private individuals) that become part of the Banqup platform upon successful onboarding. Every entity in Banqup has a unique identifier, which will be needed to perform a number of API calls on the Banqup Developer Portal.

📄️ Get my entities

Retrieve current user's accessible entities. <br/> Scope: entity_read

📄️ Get granted permissions

Retrieve all permissions granted on this entity <br/> Scope: entity_read

📄️ Create permission on entity

Create a permission (scope) on this entity to a user (requester) <br/> Scope: onboarding_service

📄️ Get entity by uuid

Retrieve entity by uuid <br/> Scope: entity_read

📄️ Delete permission on entity

Remove requester's permission on entity <br/> Scope: entity_write

📄️ Get current user's spaces on entity

Retrieve all accessible spaces (on this entity) for current user

📄️ Create space

Create a new space with type PERSONAL or BUSINESS <br/> Scope: entity_write

📄️ Get tax information

Retrieve entity's tax information <br/> Scope: entity_read

📄️ Create tax information

Register entity's tax information <br/> Scope: entity_write

📄️ Delete tax information

Delete entity's tax information. Tax information cannot be deleted if its tax registration is still linked to any space.

📄️ Update tax information

Update tax information <br/> Scope: entity_write

📄️ Assign one ore more spaces to a taxRegistration

Assign one ore more spaces to a taxRegistration <br/> Scope: entity_write

📄️ Create tax registration (VAT ID)

Register the tax registration (VAT ID) <br/> Scope: entity_write

📄️ Delete tax registration

Delete tax registration with ID. The tax registration cannot be deleted if still linked to any space

📄️ Update tax registration

Update tax registration with ID <br/> Scope: entity_write

📄️ Unassign one or more spaces from a taxRegistration

Unassign one or more spaces from a taxRegistration <br/> Scope: entity_write