Grant Banqup permissions

To have access to Banqup data and APIs, developers need to be granted additional permissions by the legal representative of the entity (or by somebody with the same rights).
The recipe below provides instructions on how to grant these permissions. This process requires actions from both the developer and the legal representative and uses as an example the common scenario of granting space permissions, which can be applied to other permission types, as needed.

For more information about the high level process of integrating Banqup APIs, refer to the Getting started guide.

Step 1: Get access token (by developer and legal representative)

To authenticate API calls, generate a bearer token using user credentials. If you require user credentials, please contact Banqup.

Step 2: Get requester Id (by developer)

Next, share the requester Id with the legal representative of the the space where you or the app (whoever is the requester) need to be granted access.
This can be:

• the app Id if the application for which the app credentials were created needs access to the space.
• the user Id if you as a user need access to the space.

App Id

The app Id is a unique identifier of the app you created on the Developer Portal.

User Id

The user Id was created when you onboarded in Banqup.

Endpoint: /solution/business/v1/users/me

View documentation

curl --location 'https://{{serverURL}}/solution/business/v1/users/me' \
--header 'Authorization: Bearer YOUR_TOKEN'

Successful response:

The subject value is the user Id.

{
    "firstName": "Taylor",
    "lastName": "Morgan",
    "email": "taylor.morgan@pinegroveinn.com",
    "subject": "4d9a54fc-17e4-4c7a-9c5e-b3ee5cf924f1",
    "status": "ACTIVE"
}

Step 3: Get space Id (by legal representative)

Endpoint: /entitystore/v1/spaces

View documentation

curl -L 'https://{{serverURL}}/entitystore/v1/spaces' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer YOUR TOKEN'

Successful response:

Copy the space Id value below to use in the next step.

{
  "spaces": [
        {
            "id": "bbb56d99-2106-46be-9907-3992b97895df",
            "name": "Pine Grove Inn BV",
            "type": "BUSINESS",
            "segment": "SME",
            "region": "eu",
            "entityId": "742c04f4-5813-4fc4-a294-c3b63e0bb953"
        }
  ]
}

Step 4: Grant permission (by legal representative)

Endpoint: /entitystore/v1/spaces/{spaceId}/permissions

Request body: View documentation

• requester: The user Id or app Id.
• permission: The name of the permission: e.g. space_read, space_write. Perform the request separately for each permission.

Path parameter:

• spaceId

curl --location 'https://{{serverURL}}/entitystore/v1/spaces/bbb56d99-2106-46be-9907-3992b97895df/permissions' \
--header 'Content-Type: application/json' \
--data '{
  "requester": "4d9a54fc-17e4-4c7a-9c5e-b3ee5cf924f1",
  "permission": "space_read"
}'

Successful response:

{
  "requester": "4d9a54fc-17e4-4c7a-9c5e-b3ee5cf924f1",
  "id": "7aaec031-dba8-47a2-a0ad-2103ede03758",
  "scope": "space_read",
  "granted": true
}