This endpoint starts new onboarding session for integration and generates onboarding link.
API reference, Interview
Request new onboarding for integrations
POST
https://demo-api.incodesmile.com/omni/b2b/onboarding/request-newHeaders
Request body
application/json
Integration reference for the onboarding request.
User login hint.
Existing applicant id.
Id that identifies user in clients external system.
Applicant name.
Meeting link.
Link validity in minutes.
Notification configuration
Notification type, can be SMS, EMAIL or URL.
enum
SMSEMAILURLApplicant email. Required for notification type EMAIL.
Applicant phone. Required for notification type SMS.
Responses
Response body (application/json)
Generated onboarding URL.
Interview identifier.
Response body (application/json)
UTC timestamp in milliseconds
Custom error code or HTTP status code
HTTP status error
Custom error message
Endpoint path
Custom error details