Partner Endpoints

partner/onboarding/application/extend

Changed on

Partner portal Onboarding Tracker Extend action. The onboarding app moves the application's expiry to its current expiry day plus 7 days (the application details' ExtendDays), or to 7 days from now when it has already expired, and sends the applicant its Renew email. A submitted application cannot be extended (invalid-action error). The entity must be in the partner's book, in Application Pending, and have an onboarding application: an entity that does not exist, one outside the book and one with no status get the same not-found error as the application details, and one in another stage or without an application gets an invalid-action error. If the onboarding app cannot be reached or fails, the request fails with an integration error. Writes an account note (a partner note for a child partner) naming the portal user. Requires a partner portal session (bearer token) of an Admin user and the AccountOnboardingFormAccess permission; Viewer and Support users are rejected.

post/partner/onboarding/application/extend

Request

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

Request body application/x-www-form-urlencoded

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

ExpiryDatestring required

The day the application now expires, YYYY-MM-DD (UTC), as the application details' ExpiryDate.

Example response

{
  "Success": true,
  "ExpiryDate": "2026-10-22"
}

Changes