Interview

Request new onboarding for integrations

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

post/omni/b2b/onboarding/request-new

Request

Base URL
https://demo-api.incodesmile.com
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/incode/apis/incode-omni-api/docs/omni/b2b/onboarding/request-new/post.ts
A function with typed inputs. Its response is checked against the schema.

api-versionstring required

integrationReferencestring required

Integration reference for the onboarding request.

loginHintstring

User login hint.

applicantIdstring

Existing applicant id.

namestring

Applicant name.

meetingLinkstring

Meeting link.

linkValidityInMinutesinteger

Link validity in minutes.

urlstring

Generated onboarding URL.

interviewIdstring

Interview identifier.

No recorded changes to this operation across all 1 revision of this API.