---
title: "partner/onboarding/entities"
method: GET
path: "/partner/onboarding/entities"
tags: ["Partner Endpoints"]
---

# partner/onboarding/entities

`GET /partner/onboarding/entities`

## Request

- Base URL: `https://earthnode-dev.vopay.com/api/v2`
- URL: `https://earthnode-dev.vopay.com/api/v2/partner/onboarding/entities`
- Auth: none declared

Partner portal Onboarding Tracker. Returns the entities in the partner's book that are still onboarding, one page at a time, newest first, with stage counts over the whole book. The book is the partner's accounts and sub-accounts and, when the partner may create partners, its child partners (one level) and their accounts and sub-accounts. Onboarding means a status in the onboarding pipeline; entities with no status are left out. Requires a partner portal session (bearer token) of an Admin or Viewer user and the AccountOnboardingFormAccess permission.

## Query parameters

- `EntityType` string
- `Status` string
- `Keyword` string
- `Limit` integer
- `Offset` integer

## Response `200`

- object
  - `Success` boolean, required: True if the request was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed
  - `Entities` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items.
    - `0` object
      - `EntityType` 'Partner' | 'Account' | 'SubAccount', required: Partner (a child partner), Account, or SubAccount (an account with a parent account).
      - `EntityID` string, required: The account ID, or the child partner's partner account ID.
      - `Name` string, required: Account name, or the child partner's name.
      - `Status` string, required: Current onboarding status. Entities carrying the retired Underwriting status report Underwriting Review.
      - `StatusDate` string, nullable, required: When the entity entered its current status (latest onboarding history entry for it), YYYY-MM-DD HH:MM:SS. Null when no onboarding history entry exists for the current status.
      - `DateAdded` string, nullable, required: When the entity was created, YYYY-MM-DD HH:MM:SS. Entities are sorted by it, newest first. Null only for a legacy partner with no creation date.
      - `Parent` object, nullable, required: A sub-account's parent account when that account is in the partner's book; otherwise, for an account or sub-account under a child partner, that child partner. Null for a direct entity: the partner's own account or sub-account whose parent is outside the book, or a child partner.
        - `EntityType` 'Partner' | 'Account' | 'SubAccount', required: Account, SubAccount or Partner.
        - `EntityID` string, required: The parent's account ID (for a partner, its partner account ID).
        - `Name` string, required: The parent's name.
  - `StageCounts` object, required: Number of onboarding entities per status across the whole book, ignoring the filters and pagination. Every onboarding status is present, in pipeline order, including those with a count of 0.
    - `Pre-Application Check` integer, required: Number of entities in the Pre-Application Check status.
    - `Agreement Pending` integer, required: Number of entities in the Agreement Pending status.
    - `Document Review` integer, required: Number of entities in the Document Review status.
    - `Account Review and Validation` integer, required: Number of entities in the Account Review and Validation status.
    - `Manager Approval` integer, required: Number of entities in the Manager Approval status.
    - `Application Pending` integer, required: Number of entities in the Application Pending status.
    - `Underwriting Review` integer, required: Number of entities in the Underwriting Review status, including those that still carry the retired Underwriting status.
    - `Third Party Review` integer, required: Number of entities in the Third Party Review status.
    - `Finance Review` integer, required: Number of entities in the Finance Review status.
    - `Credit Risk Review` integer, required: Number of entities in the Credit Risk Review status.
    - `Account Provisioning` integer, required: Number of entities in the Account Provisioning status.
    - `Certification Pending` integer, required: Number of entities in the Certification Pending status.
    - `Pending Sandbox Approval` integer, required: Number of entities in the Pending Sandbox Approval status.
  - `TotalEntities` integer, required: Number of onboarding entities across the whole book, ignoring the filters. Always the sum of StageCounts.
  - `PaginationMetaData` object, required: Pagination metadata
    - `TotalRecords` integer, required: Number of entities matching the filters.
    - `Offset` integer, required: The offset applied.
    - `Limit` integer, required: The limit applied.

## Changes

- **2026-11-03** `71f251deb318`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/vopay/apis/accounts/changes/partner/onboarding/entities/get.md)

---

[API](https://skmtc.dev/vopay/apis/accounts.md) - [All operations](https://skmtc.dev/vopay/apis/accounts/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/accounts/revisions/71f251deb318?raw)