Create Onboarding Job

Use this API when your system needs to start an onboarding journey for a candidate and receive the onboarding link immediately in the response.

What you need from OnBo

Your API key must be journey-bound (provisioned for a specific onboarding journey).

How to get your API key ID and secret

1. Sign in to the OnBo dashboard: https://dashboard.idmission.com 
2. Open Journey Settings → Credentials
3. Click Create keys
4. Copy the API key ID and API key secret shown after creation

Store the secret securely — it is shown only once at creation time. Include apiKeyId and apiKeySecret in the JSON request body when calling the API.

Create a separate key per journey if you run multiple onboarding flows.

How it works

Your server                              OnBo Portal API
     |                                         |
     |-- POST https://portal.idmission.com/api/create-onboarding-link ->|
     |   apiKeyId / apiKeySecret (JSON body)   |
     |   candidate fields (name, phone, …)     |
     |<-- onboardingLink, jobId ----------------|
     |                                         |
Your app redirects or messages the user to onboardingLink

1. Your backend calls POST https://portal.idmission.com/api/create-onboarding-link with apiKeyId, apiKeySecret, and candidate details in the JSON body.
2. OnBo validates the API key, derives the journey from the key, and creates the job.
3. The response includes onboardingLink — send it to the candidate or open it in your app.

Quick start

curl -X POST "https://portal.idmission.com/api/create-onboarding-link" \
  -H "Content-Type: application/json" \
  -d '{
    "apiKeyId": "urn:apikeysv1:prod:region:company:YOUR_KEY_UUID",
    "apiKeySecret": "YOUR_API_KEY_SECRET",
    "name": "Jane Doe",
    "phone": "+15551234567",
    "email": "jane@example.com",
    "firstDayOfEmployment": "03/15/2026",
    "channel": ["sms", "email"]
  }'

See Create Onboarding Job API for the full request/response reference, validation rules, and error handling.

Related documentation

• Create Onboarding Job API — full integration reference