VOvopay
Partner Endpoints

partner/onboarding/application

Changed on

Partner portal Onboarding Tracker application details. Returns one entity of the partner's book (an account, a sub-account or a child partner, in any stage) with when its applicant was last active in its onboarding application, and, when it is in Application Pending and has an onboarding application, that application's link status, dates, recipient, login link, progress, forms and documents, read live from the onboarding app. An entity that does not exist, one outside the book and one with no status (not onboarding, so also left out of the entity list) get the same not-found error. If the onboarding app cannot be reached for an entity in Application Pending that has an application, the request fails with an integration error rather than returning null application fields; in any other stage only LastActivity needs the app, and it is returned as null instead. Requires a partner portal session (bearer token) of an Admin or Viewer user and the AccountOnboardingFormAccess permission.

get/partner/onboarding/application

Request

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

Query parameters

EntityTypestring required

Partner, Account or SubAccount, as the entity list returns it.

EntityIDstring required

The entity's EntityID from the entity list: the account ID, or the child partner's partner account ID.

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

EntityType'Partner' | 'Account' | 'SubAccount' required

Partner (a child partner), Account, or SubAccount (an account with a parent account).

EntityIDstring required

The account ID, or the child partner's partner account ID.

Namestring required

Account name, or the child partner's name.

Statusstring required

Current status, in any stage. Entities carrying the retired Underwriting status report Underwriting Review.

LastActivitystring nullable required

When the applicant was last active in the onboarding application, UTC, YYYY-MM-DD HH:MM:SS (the same format as the entity list's dates). Returned in every stage. Null when the applicant has not opened it yet, when the entity has no onboarding application, or, outside Application Pending, when the onboarding app cannot be reached.

LinkStatus'Active' | 'Expired' | 'Submitted' nullable required

Submitted once the application is submitted; otherwise Expired from its expiry time on, else Active. Null when the entity is not in Application Pending or has no onboarding application.

SentDatestring nullable required

When the welcome email was last sent, or when the application was created if it never was, UTC, YYYY-MM-DD HH:MM:SS (the same format as the entity list's dates). Null when the entity is not in Application Pending or has no onboarding application.

ExpiryDatestring nullable required

The day the application expires, YYYY-MM-DD (UTC). Null when the entity is not in Application Pending or has no onboarding application.

ExtendDaysinteger nullable required

Days the Extend action adds to the expiry. Null when the entity is not in Application Pending or has no onboarding application.

LastReminderSentDatestring nullable required

When the last reminder email was sent, UTC, YYYY-MM-DD HH:MM:SS (the same format as the entity list's dates). Null when none was sent. Null when the entity is not in Application Pending or has no onboarding application.

OnboardingURLstring nullable required

The applicant's login link to the onboarding application (the applicant still verifies a one-time passcode). Fetched live, never stored. Null when the entity is not in Application Pending or has no onboarding application.

Progressinteger nullable required

Overall completion of the application, 0 to 100. Null when the entity is not in Application Pending or has no onboarding application.

Example response

{
  "Success": true,
  "EntityType": "Account",
  "EntityID": "acme",
  "Name": "Acme Inc",
  "Status": "Application Pending",
  "LastActivity": "2026-10-05 17:42:10",
  "LinkStatus": "Active",
  "SentDate": "2026-10-01 16:20:00",
  "ExpiryDate": "2026-10-31",
  "ExtendDays": 7,
  "LastReminderSentDate": "2026-10-04 15:00:00",
  "Recipient": {
    "FullName": "Jane Doe",
    "Email": "jane@acme.com"
  },
  "OnboardingURL": "https://onboarding.vopay.com/login?token=...",
  "Progress": 45,
  "Forms": {
    "0": {
      "Identifier": "business_details",
      "Name": "Business Details",
      "Status": "InProgress",
      "CompletedDate": "2026-10-03 18:11:09"
    }
  },
  "Documents": {
    "0": {
      "Identifier": "void_cheque",
      "Name": "Void Cheque",
      "Status": "Uploaded"
    }
  },
  "Collaborators": {
    "0": {
      "CollaboratorID": "5521",
      "Name": "John Smith",
      "Email": "john@example.com",
      "Forms": {
        "0": {
          "Identifier": "business_details",
          "Name": "Business Details"
        }
      },
      "Documents": {
        "0": {
          "Identifier": "void_cheque",
          "Name": "Void Cheque"
        }
      }
    }
  },
  "IDVerifications": {
    "0": {
      "IndividualID": "1842",
      "FullName": "Jane Doe",
      "Roles": {
        "0": "SigningAuthority"
      },
      "Link": "https://eu.onfido.app/l/abc123"
    }
  }
}

Changes