Skip to main content
GET
/
api
/
public
/
onboarding

​
Onboarding Tasks

Returns the current onboarding checklist for the authenticated customer. Tasks include items like completing their profile, adding directors, setting mail preferences, identity checks, or setting up e-invoicing. Used to display onboarding progress on the dashboard.

​
Authentication

Requires a valid customer bearer token.

​
Response

Returns an array of OnBoardingTask objects with completion status.

​
Task Fields

FieldTypeDescription
CoworkerIdnumberNumeric identifier for the customer the task belongs to
GroupIdstringUUID that groups related tasks together (e.g. all virtual office tasks share the same group)
TypestringThe onboarding category. See Task Types below
ActionstringThe specific action required. See Task Actions below
CompletedbooleanWhether the customer has completed this task

​
Task Types

ValueDescription
VirtualOfficeVirtual office setup tasks (directors, mail, recipients)
IdentityCheckIdentity verification tasks
DeferredRequiredFieldRequired profile fields that must be completed later
CompleteProfilePersonal profile completion
CompleteTeamProfileTeam profile completion
UnpaidInvoicesOutstanding invoices that need payment
PendingDeliveryPending mail or package deliveries
EInvoicingElectronic invoicing setup

​
Task Actions

ValueApplicable Type(s)Description
AddDirectorsVirtualOfficeAdd company directors to the virtual office
AddRecipientsVirtualOfficeAdd mail recipients for the virtual office
SetMailPreferencesVirtualOfficeConfigure mail handling preferences
StartIdentityChecksIdentityCheckInitiate identity verification
CompleteIdentityChecksIdentityCheck, VirtualOfficeFinish all identity verification steps
CompleteProfileCompleteProfileFill in all required profile fields
PublishProfileCompleteProfileMake the member profile visible in the directory
CompleteTeamProfileCompleteTeamProfileFill in all required team profile fields
AddEInvoicingDetailsEInvoicingAdd electronic invoicing details

​
Examples

​
Fetch onboarding tasks

GET /api/public/onboarding
Authorization: Bearer {token}

​
Response — Virtual office tasks (mixed completion)

[
  {
    "CoworkerId": 4706,
    "GroupId": "ad1d8608-9b95-454a-9a1c-944980f7eca5",
    "Type": "VirtualOffice",
    "Action": "AddDirectors",
    "Completed": true
  },
  {
    "CoworkerId": 4706,
    "GroupId": "ad1d8608-9b95-454a-9a1c-944980f7eca5",
    "Type": "VirtualOffice",
    "Action": "CompleteIdentityChecks",
    "Completed": true
  },
  {
    "CoworkerId": 4706,
    "GroupId": "ad1d8608-9b95-454a-9a1c-944980f7eca5",
    "Type": "VirtualOffice",
    "Action": "SetMailPreferences",
    "Completed": false
  }
]

​
Response — Identity check tasks

[
  {
    "CoworkerId": 4706,
    "GroupId": "b2e4f910-3c78-4d1a-a5ef-82710dc3b6f1",
    "Type": "IdentityCheck",
    "Action": "StartIdentityChecks",
    "Completed": false
  },
  {
    "CoworkerId": 4706,
    "GroupId": "b2e4f910-3c78-4d1a-a5ef-82710dc3b6f1",
    "Type": "IdentityCheck",
    "Action": "CompleteIdentityChecks",
    "Completed": false
  }
]

​
Response — Multiple task types

[
  {
    "CoworkerId": 4706,
    "GroupId": "ad1d8608-9b95-454a-9a1c-944980f7eca5",
    "Type": "VirtualOffice",
    "Action": "AddDirectors",
    "Completed": false
  },
  {
    "CoworkerId": 4706,
    "GroupId": "ad1d8608-9b95-454a-9a1c-944980f7eca5",
    "Type": "VirtualOffice",
    "Action": "SetMailPreferences",
    "Completed": true
  },
  {
    "CoworkerId": 4706,
    "GroupId": "ad1d8608-9b95-454a-9a1c-944980f7eca5",
    "Type": "VirtualOffice",
    "Action": "AddRecipients",
    "Completed": true
  },
  {
    "CoworkerId": 4706,
    "GroupId": "b2e4f910-3c78-4d1a-a5ef-82710dc3b6f1",
    "Type": "IdentityCheck",
    "Action": "StartIdentityChecks",
    "Completed": false
  },
  {
    "CoworkerId": 4706,
    "GroupId": "b2e4f910-3c78-4d1a-a5ef-82710dc3b6f1",
    "Type": "IdentityCheck",
    "Action": "CompleteIdentityChecks",
    "Completed": false
  },
  {
    "CoworkerId": 4706,
    "GroupId": "f1a2b3c4-5678-9def-abcd-ef0123456789",
    "Type": "CompleteProfile",
    "Action": "CompleteProfile",
    "Completed": false
  },
  {
    "CoworkerId": 4706,
    "GroupId": "f1a2b3c4-5678-9def-abcd-ef0123456789",
    "Type": "EInvoicing",
    "Action": "AddEInvoicingDetails",
    "Completed": false
  }
]

​
Response — No pending tasks

[]

​
TypeScript Integration

import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.onboarding.tasks)

​
Types

import type { OnBoardingTask, OnBoardingTasks } from '@/types/endpoints/OnBoardingTasks'
import { eOnBoardingType, eOnBoardingAction } from '@/types/endpoints/OnBoardingTasks'