API referenceGroups

Group position

What the group holds, across the entities **you** can already see. A group grants no access. Entities you are not a member of are counted in `hidden` and not described — otherwise filing two companies under one name would quietly let one team read the other's balance. Entities still in KYB have no wallet and appear in `excluded` with the reason, rather than being dropped from the sum. A partial figure presented as a total looks correct, which is what makes it worse than an error.

GET
/api/b/v1/groups/{group_id}/summary

What the group holds, across the entities you can already see.

A group grants no access. Entities you are not a member of are counted in hidden and not described — otherwise filing two companies under one name would quietly let one team read the other's balance.

Entities still in KYB have no wallet and appear in excluded with the reason, rather than being dropped from the sum. A partial figure presented as a total looks correct, which is what makes it worse than an error.

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

Path Parameters

group_id*Group Id
Formatuuid
admin_access_token?string|null

Response Body

application/json

application/json

curl -X GET "https://example.com/api/b/v1/groups/497f6eca-6276-4993-bfeb-53cbbbba6f08/summary"
{  "entities": [    {      "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",      "legal_name": "string",      "country": "string",      "kyb_status": "string",      "kyb_tier": "string",      "balances": [        {          "currency": "string",          "balance_minor": 450000        }      ]    }  ],  "excluded": [    {      "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",      "legal_name": "string",      "kyb_status": "string",      "reason": "no_wallet"    }  ],  "hidden": 0,  "totals": [    {      "currency": "string",      "balance_minor": 450000    }  ]}