partner/onboarding/application

Partner portal Onboarding Tracker drawer. 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

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

string
required

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

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json