Partner Endpoints

partner/onboarding/application/open

Changed on

Partner portal Onboarding Tracker Open action. Returns a login link to the entity's onboarding application that skips the applicant's one-time passcode and carries a live bearer token, so treat it as a credential. The response is sent with Cache-Control: no-store, and the link is left out of the API log and the note. 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, without the link. 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/open

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/partner/onboarding/application/open
  • 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

OnboardingURLstring required

Login link to the onboarding application, skipping the applicant's one-time passcode. It carries a live bearer token: treat it as a credential and never store or share it.

Example response

{
  "Success": true,
  "OnboardingURL": "https://onboarding.vopay.com/?applicationToken=a1b2c3&bearerToken=3f9c2a7e1b"
}

Changes