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.

📄️ Create a space (v2)

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

📄️ Create permission on entity

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

📄️ Create space

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

📄️ Create tax information

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Register entity's tax information <br/> Scope: entity_write

📄️ Create tax information (v2)

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Register entity's tax information <br/> Scope: entity_write

📄️ Create tax registration (VAT ID)

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

📄️ Delete permission on entity

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

📄️ Delete tax information

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Delete entity's tax information. Tax information cannot be deleted if its tax registration is still linked to any space.

📄️ Delete tax registration

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

📄️ Get current user's spaces on entity

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

📄️ Get entity by uuid

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Retrieve entity by uuid <br/> Scope: entity_read

📄️ Get entity by uuid (v2)

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Retrieve entity by uuid with ISO 20022 addresses. <br/> Scope: entity_read

📄️ Get entity settings

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get entity settings <br/> Scope: entity_read

📄️ Get granted permissions

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

📄️ Get my entities

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Retrieve current user's accessible entities. <br/> Scope: entity_read

📄️ Get tax information

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Retrieve entity's tax information <br/> Scope: entity_read

📄️ Get tax information (v2)

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Retrieve entity's tax information <br/> Scope: entity_read

📄️ List entities (v2)

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> GET list of current user's accessible entities with ISO 20022 addresses. <br/> Scope: entity_read

📄️ Update entity communicationData

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update entity's communication data using JSON patch <br/> Scope: entity_write

📄️ Update entity communicationData (v2)

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update entity's communication data using JSON patch (v2) <br/> Scope: entity_write

📄️ Update entity settings

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update entity's settings using JSON patch <br/> Scope: entity_write

📄️ Update tax information

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update tax information <br/> Scope: entity_write

📄️ Update tax information (v2)

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update tax information <br/> Scope: entity_write

📄️ Update tax registration

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