--- title: "partner/onboarding/application" method: GET path: "/partner/onboarding/application" tags: ["Partner Endpoints"] --- # partner/onboarding/application `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 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. ## Query parameters - `EntityType` string, required - `EntityID` string, required ## Response `200` - object - `Success` boolean, required: True if the request was successful, false if it failed - `ErrorMessage` string, 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). - `EntityID` string, required: The account ID, or the child partner's partner account ID. - `Name` string, required: Account name, or the child partner's name. - `Status` string, required: Current status, in any stage. Entities carrying the retired Underwriting status report Underwriting Review. - `LastActivity` string, 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. - `SentDate` string, 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. - `ExpiryDate` string, 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. - `ExtendDays` integer, nullable, required: Days the Extend action adds to the expiry. Null when the entity is not in Application Pending or has no onboarding application. - `LastReminderSentDate` string, 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. - `Recipient` object, nullable, required: The application's admin collaborator, who receives its emails. Null when the entity is not in Application Pending or has no onboarding application. - `FullName` string, nullable, required: The entity's primary contact name when the primary contact's email is the collaborator's (ignoring case), otherwise null. - `Email` string, nullable, required: The collaborator's email. Null only if the onboarding app returned none. - `OnboardingURL` string, 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. - `Progress` integer, nullable, required: Overall completion of the application, 0 to 100. Null when the entity is not in Application Pending or has no onboarding application. - `Forms` object, nullable, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. Null when the entity is not in Application Pending or has no onboarding application. - `0` object - `Identifier` string, nullable, required: The form's template identifier. Null from an onboarding app version that does not report it. - `Name` string, required: The form's name as the onboarding app reports it (English). - `Status` 'Completed' | 'InProgress' | 'NotStarted', required: Completed, InProgress or NotStarted (also for a status the onboarding app does not report). - `CompletedDate` string, nullable, required: When the form was completed, UTC, YYYY-MM-DD HH:MM:SS (the same format as the entity list's dates). Null when it is not completed, or from an onboarding app version that does not report it. - `Documents` object, nullable, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. Null when the entity is not in Application Pending or has no onboarding application. - `0` object - `Identifier` string, nullable, required: The document's template identifier. Null from an onboarding app version that does not report it. - `Name` string, required: The document's name as the onboarding app reports it (English). - `Status` 'Uploaded' | 'Skipped' | 'NotStarted', required: Uploaded, Skipped (the applicant gave a reason instead of a file) or NotStarted. - `Collaborators` object, nullable, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. The people the applicant invited to complete parts of the application, each with the forms and documents assigned to them; the applicant (admin collaborator) is not listed. Null when the entity is not in Application Pending or has no onboarding application. - `0` object - `CollaboratorID` string, required: The collaborator's ID in the onboarding app, for the collaborator Resend action. - `Name` string, required: The collaborator's name. - `Email` string, required: The collaborator's email address. - `Forms` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. The forms assigned to the collaborator. - `0` object - `Identifier` string, nullable, required: The template identifier. Null when the onboarding app does not report it. - `Name` string, required: The name as the onboarding app reports it (English). - `Documents` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. The documents assigned to the collaborator. - `0` object - `Identifier` string, nullable, required: The template identifier. Null when the onboarding app does not report it. - `Name` string, required: The name as the onboarding app reports it (English). - `IDVerifications` object, nullable, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. The verified individuals linked to the entity (signing authorities, key controllers and owners who must verify their identity), oldest first. Null when the entity is not in Application Pending or has no onboarding application. - `0` object - `IndividualID` string, required: The verified individual's ID. - `FullName` string, required: First and last name. - `Roles` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. The roles whose application form (signing authorities, key controller, ownership structure) names the individual's email, in this order. - `0` 'SigningAuthority' | 'KeyController' | 'Owner' - `IsVerified` boolean, required: Whether the individual has verified their identity: TransUnion passed, or all three Onfido captures are completed. - `Link` string, nullable, required: The individual's Onfido verification link, to share with them. Null once verified, or when no link is stored. Redacted from the API log. ## Changes - **2026-11-03** `71f251deb318`: 1 info - endpoint added [Operation history](https://skmtc.dev/vopay/apis/accounts/changes/partner/onboarding/application/get.md) --- [API](https://skmtc.dev/vopay/apis/accounts.md) - [All operations](https://skmtc.dev/vopay/apis/accounts/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/accounts/revisions/71f251deb318?raw)