v1

latestOpenAPI 3.0.02026-07-241220330.3 KB

Entity Groups

Get information about an Entity Group

Using an Entity Group's token or external identifier, get information about the Entity Group and its relationships

get/entity-groups/{entity_token_or_external_id}

Response

Success

entity_group_tokenstring

entity_group_namestring

entity_group_type'business' | 'joint_account' | 'membership' | 'merchant'

created_atstring

archived_atstring

entity_group_external_identifiersstring[]

Example response

{
  "entity_group_token": "EG-wnUeDsz7dvC4sbXM9VtA",
  "entity_group_external_identifiers": [
    "087ac67e-17ab-4529-8d1a-a8b2214d305f"
  ],
  "entity_group_name": "Jane's Biscuit Co.",
  "entity_group_type": "business",
  "created_at": "2025-12-17T22:09:00.684Z",
  "archived_at": "null,",
  "entity_group_relationships": [
    {
      "entity_token": "B-v3aBv8wydmqs1h6wTgMI",
      "name": "Jane's Biscuit Co.",
      "type": "business",
      "roles": [
        "primary"
      ],
      "title": null,
      "ownership_percentage": null,
      "relationship_created_at": "2025-12-17T22:09:00.684Z",
      "bank_accounts": []
    },
    {
      "entity_token": "P-lRE0vrgm2840nxlFgzf0",
      "name": "Jane Doe",
      "type": "person",
      "roles": [
        "director",
        "shareholder"
      ],
      "title": "Director of Sales",
      "ownership_percentage": "80",
      "relationship_created_at": "2025-12-17T22:09:00.684Z",
      "bank_accounts": [
        {
          "bank_account_token": "A-3BHSHBnt6E1QpPfkk7xR",
          "external_account_id": "9348234-127391823-283489",
          "account_holder_type": "authorized_user"
        }
      ]
    }
  ]
}