VOvopay
Partner Endpoints

partner/onboarding/entities

Changed on

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.

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

Query parameters

EntityTypestring

Comma-separated list of Partner, Account and SubAccount. Absent means all three.

Statusstring

One onboarding status, e.g. Application Pending. The retired Underwriting is read as Underwriting Review.

Keywordstring

Matches part of the entity's name or ID.

Limitinteger

Number of entities to return, 1 to 200. Defaults to 50.

Offsetinteger

Number of entities to skip. Defaults to 0.

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

TotalEntitiesinteger required

Number of onboarding entities across the whole book, ignoring the filters. Always the sum of StageCounts.

Example response

{
  "Success": true,
  "Entities": {
    "0": {
      "EntityType": "SubAccount",
      "EntityID": "acme-sub-1",
      "Name": "Acme Sub One",
      "Status": "Application Pending",
      "StatusDate": "2026-09-21 14:03:11",
      "DateAdded": "2026-09-20 09:12:45",
      "Parent": {
        "EntityType": "Account",
        "EntityID": "acme",
        "Name": "Acme Inc"
      }
    }
  },
  "TotalEntities": 15,
  "PaginationMetaData": {
    "TotalRecords": 15,
    "Limit": 50
  }
}

Changes