Request new onboarding for integrations

Time	Status	User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

Integration Reference

integrationReference: string (required) - Integration reference for the onboarding request.
loginHint: string (length ≥ 1) - User login hint.
applicantId: string - Existing applicant id.
name: string - Applicant name.
meetingLink: string - Meeting link.
linkValidityInMinutes: int32 - Link validity in minutes.
notification: object (required) - Notification configuration

Notification Object

api-version: string (required) - Defaults to 1.0

Response Status Codes

200      OK

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

Curl Example

curl --request POST \
     --url https://demo-api.incodesmile.com/omni/b2b/onboarding/request-new \
     --header 'accept: application/json' \
     --header 'api-version: 1.0' \
     --header 'content-type: application/json' \
     --data '\n{\n  "notification": {\n    "type": "SMS"\n  }\n}\n'

Example Response

application/json
200
400

Updated 3 months ago.