---
title: "Request new onboarding for integrations"
method: POST
path: "/omni/b2b/onboarding/request-new"
tags: ["Interview"]
---

# Request new onboarding for integrations

`POST /omni/b2b/onboarding/request-new`

This endpoint starts new onboarding session for integration and generates onboarding link.

## Headers

- `api-version` string, required

## Request body

- NewOnboardingB2BRequest
  - `integrationReference` string, required — Integration reference for the onboarding request.
  - `loginHint` string — User login hint.
  - `applicantId` string — Existing applicant id.
  - `name` string — Applicant name.
  - `meetingLink` string — Meeting link.
  - `linkValidityInMinutes` integer — Link validity in minutes.
  - `notification` NotificationDelivery, required
    - `type` 'SMS' | 'EMAIL' | 'URL', required — Notification type, can be SMS, EMAIL or URL.
    - `email` string — Applicant email. Required for notification type EMAIL.
    - `phone` string — Applicant phone. Required for notification type SMS.

## Response `200`

OK

- NewOnboardingResponse
  - `url` string — Generated onboarding URL.
  - `interviewId` string — Interview identifier.

## Other responses

- `400` — Custom error statuses: - 4300: Integration not found by id - 4301: Employee by login factor cannot be found

---

[API](https://skmtc.net/incode/apis/incode-omni-api.md) · [All operations](https://skmtc.net/incode/apis/incode-omni-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/incode/incode-omni-api/versions/30cd6d926ea3/schema)