---
title: "List entities in the network"
method: GET
path: "/network"
tags: ["Network"]
---

# List entities in the network

`GET /network`

Returns a list of VASP entities in the network. Supports filtering by various criteria including sandbox mode, verification status, and search queries. Results are paginated and can be ordered by different fields.

## Query parameters

- `q` string
- `emailDomain` string
- `chainalysisName` string
- `hasAdmin` string
- `badge` 'super_vasp' | 'verified' | 'in_network' | 'claimed'
- `jurisdictions` string
- `page` string
- `per_page` string
- `order` string
- `fields` string
- `all` string
- `listingType` 'exclude_subsidiaries' | 'all' | 'exclude_gateways'
- `includeUncheckedEntities` string
- `includeActiveSendersOnly` string
- `includeActiveReceiversOnly` string
- `regulatoryStatus` 'Regulated' | 'Not Regulated' | 'Exempt' | 'Pending'
- `leiValidity` 'unspecified' | 'valid' | 'invalid'
- `status` TransferStatus[]
- `listing` 'sandbox' | 'non-sandbox'

## Response `200`

Entity list retrieved successfully

- object
  - `vasps` object[], required
    - `did` string
    - `name` string, nullable
    - `subsidiaries` object[]
      - `did` string
      - `name` string, nullable
      - `subsidiaries` object[]
        - `did` string
        - `name` string, nullable
        - `subsidiaries` unknown
        - `subsidiaryOf` string, nullable
        - `jurisdictions` string, nullable
        - `parentGateway` object
          - `did` string, required
          - `name` string, required
        - `adminEmails` string, nullable
        - `logo` string, nullable — Base64 encoded logo
        - `website` string, nullable
        - `otherNames` string[], nullable
        - `legalName` string, nullable
        - `legalStructure` string, nullable
        - `yearFounded` union
          - number
          - string
        - `incorporationCountry` string, nullable
        - `identificationType` string, nullable
        - `identificationCountry` string, nullable
        - `businessNumber` string, nullable
        - `isRegulated` string, nullable
        - `regulatoryAuthorities` unknown
        - `division` unknown
        - `addressLine1` string, nullable
        - `addressLine2` string, nullable
        - `street` string, nullable
        - `number` string, nullable
        - `unit` string, nullable
        - `city` string, nullable
        - `postCode` string, nullable
        - `state` string, nullable
        - `country` string, nullable
        - `certificates` string, nullable — Must be stringified/JSON.parse
        - `description` string, nullable
        - `verificationStatus` 'UNVERIFIED' | 'VERIFIED' | 'PENDING' | 'ARCHIVED' | 'DELETED', nullable
        - `emailDomains` string, nullable — Must be stringified/JSON.parse
        - `travelRule_OPENVASP` string, nullable
        - `travelRule_SYGNA` string, nullable
        - `travelRule_TRISA` string, nullable
        - `travelRule_TRUST` string, nullable
        - `travelRule_TRP` string, nullable
        - `travelRule_notabene` string, nullable
        - `vasp_categories` string, nullable
        - `created_at` string, nullable
        - `updated_at` string, nullable
        - `hasAdmin` boolean, nullable
        - `isNotabeneCustomer` boolean, nullable
        - `testPhoneNumber` string, nullable
        - `autoEnableWhenUserJoins` boolean, nullable
        - `logo_filename` string, nullable
        - `logo_updated_at` string, nullable
        - `chainalysis_name` string, nullable
        - `badges` string[], nullable
        - `isSandbox` boolean, nullable
        - `identificationNumber` string, nullable
        - `hqStreet` string, nullable
        - `hqNumber` string, nullable
        - `hqUnit` string, nullable
        - `hqPostcode` string, nullable
        - `hqRegion` string, nullable
        - `hqCity` string, nullable
        - `hqCountry` string, nullable
      - `subsidiaryOf` string, nullable
      - `jurisdictions` string, nullable
      - `parentGateway` object
        - `did` string, required
        - `name` string, required
      - `adminEmails` string, nullable
      - `logo` string, nullable — Base64 encoded logo
      - `website` string, nullable
      - `otherNames` string[], nullable
      - `legalName` string, nullable
      - `legalStructure` string, nullable
      - `yearFounded` union
        - number
        - string
      - `incorporationCountry` string, nullable
      - `identificationType` string, nullable
      - `identificationCountry` string, nullable
      - `businessNumber` string, nullable
      - `isRegulated` string, nullable
      - `regulatoryAuthorities` unknown
      - `division` unknown
      - `addressLine1` string, nullable
      - `addressLine2` string, nullable
      - `street` string, nullable
      - `number` string, nullable
      - `unit` string, nullable
      - `city` string, nullable
      - `postCode` string, nullable
      - `state` string, nullable
      - `country` string, nullable
      - `certificates` string, nullable — Must be stringified/JSON.parse
      - `description` string, nullable
      - `verificationStatus` 'UNVERIFIED' | 'VERIFIED' | 'PENDING' | 'ARCHIVED' | 'DELETED', nullable
      - `emailDomains` string, nullable — Must be stringified/JSON.parse
      - `travelRule_OPENVASP` string, nullable
      - `travelRule_SYGNA` string, nullable
      - `travelRule_TRISA` string, nullable
      - `travelRule_TRUST` string, nullable
      - `travelRule_TRP` string, nullable
      - `travelRule_notabene` string, nullable
      - `vasp_categories` string, nullable
      - `created_at` string, nullable
      - `updated_at` string, nullable
      - `hasAdmin` boolean, nullable
      - `isNotabeneCustomer` boolean, nullable
      - `testPhoneNumber` string, nullable
      - `autoEnableWhenUserJoins` boolean, nullable
      - `logo_filename` string, nullable
      - `logo_updated_at` string, nullable
      - `chainalysis_name` string, nullable
      - `badges` string[], nullable
      - `isSandbox` boolean, nullable
      - `identificationNumber` string, nullable
      - `hqStreet` string, nullable
      - `hqNumber` string, nullable
      - `hqUnit` string, nullable
      - `hqPostcode` string, nullable
      - `hqRegion` string, nullable
      - `hqCity` string, nullable
      - `hqCountry` string, nullable
    - `subsidiaryOf` string, nullable
    - `jurisdictions` string, nullable
    - `parentGateway` object
      - `did` string, required
      - `name` string, required
    - `adminEmails` string, nullable
    - `logo` string, nullable — Base64 encoded logo
    - `website` string, nullable
    - `otherNames` string[], nullable
    - `legalName` string, nullable
    - `legalStructure` string, nullable
    - `yearFounded` union
      - number
      - string
    - `incorporationCountry` string, nullable
    - `identificationType` string, nullable
    - `identificationCountry` string, nullable
    - `businessNumber` string, nullable
    - `isRegulated` string, nullable
    - `regulatoryAuthorities` unknown
    - `division` unknown
    - `addressLine1` string, nullable
    - `addressLine2` string, nullable
    - `street` string, nullable
    - `number` string, nullable
    - `unit` string, nullable
    - `city` string, nullable
    - `postCode` string, nullable
    - `state` string, nullable
    - `country` string, nullable
    - `certificates` string, nullable — Must be stringified/JSON.parse
    - `description` string, nullable
    - `verificationStatus` 'UNVERIFIED' | 'VERIFIED' | 'PENDING' | 'ARCHIVED' | 'DELETED', nullable
    - `emailDomains` string, nullable — Must be stringified/JSON.parse
    - `travelRule_OPENVASP` string, nullable
    - `travelRule_SYGNA` string, nullable
    - `travelRule_TRISA` string, nullable
    - `travelRule_TRUST` string, nullable
    - `travelRule_TRP` string, nullable
    - `travelRule_notabene` string, nullable
    - `vasp_categories` string, nullable
    - `created_at` string, nullable
    - `updated_at` string, nullable
    - `hasAdmin` boolean, nullable
    - `isNotabeneCustomer` boolean, nullable
    - `testPhoneNumber` string, nullable
    - `autoEnableWhenUserJoins` boolean, nullable
    - `logo_filename` string, nullable
    - `logo_updated_at` string, nullable
    - `chainalysis_name` string, nullable
    - `badges` string[], nullable
    - `isSandbox` boolean, nullable
    - `identificationNumber` string, nullable
    - `hqStreet` string, nullable
    - `hqNumber` string, nullable
    - `hqUnit` string, nullable
    - `hqPostcode` string, nullable
    - `hqRegion` string, nullable
    - `hqCity` string, nullable
    - `hqCountry` string, nullable
  - `pagination` object
    - `page` number
    - `per_page` number
    - `order` string
    - `total` number

## Other responses

- `400` — Bad Request - The server could not process the request due to a client error.
- `401` — Unauthorized - Authentication information is missing or invalid.
- `403` — Forbidden - The server understood the request but refuses to authorize it.
- `404` — Not Found - The requested resource could not be found.
- `409` — Conflict - The request could not be completed due to a conflict with the current state of the resource.
- `500` — Internal Server Error - An unexpected condition was encountered on the server.

---

[API](https://skmtc.net/notabene/apis/notabene-api.md) · [All operations](https://skmtc.net/notabene/apis/notabene-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/notabene/notabene-api/versions/70056745a433/schema)