Skip to main content
GET
/
embedded-banking
/
v1
/
organization
/
summary
Get a summary of organization data for the authenticated user's organization hierarchy.
curl --request GET \
  --url https://api.sandbox.tesouro.com/embedded-banking/v1/organization/summary \
  --header 'Authorization: Bearer <token>'
{
  "applications": {
    "complete": 123,
    "draft": 123,
    "submitted": 123,
    "total": 123
  },
  "bankAccounts": {
    "total": 123
  },
  "externalBankAccounts": {
    "failed": 123,
    "total": 123,
    "unverified": 123,
    "verified": 123
  },
  "organizations": [
    {
      "accountCount": 123,
      "name": "<string>",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "userCount": 123,
      "uniqueReference": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Returns organization summary.

Summary response for the Admin Portal endpoint. Contains aggregated counts for applications, bank accounts, and external bank accounts.

applications
object
required

Summary of bank account applications by status.

bankAccounts
object
required

Summary of bank accounts by status.

externalBankAccounts
object
required

Summary of external bank accounts by verification status.

organizations
object[]
required

Per-organization details including name, account count, and user count.