Get onboarding details by employee HRIS profile ID | Deel

import requests
url = "https://api.letsdeel.com/rest/v2/onboarding/tracker/hris_profile/150f635e-fae1-4b9d-9f86-768bbbac3698"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "data": {
    "profile": {
      "name": "John Doo",
      "email": "test@email.com",
      "country": "CA",
      "last_login": "2021-07-14T22:00:00+00:00",
      "previously_onboarded": true
    },
    "stepper": [
      {
        "data": {
          "emails": [
            {
              "meta": {
                "type": "CONTRACTOR_INVITE_SIGN_UP",
                "email": "test@email.com",
                "sent_at": "2021-07-14T22:00:00+00:00"
              }
            }
          ],
          "next_reminder_date": "2021-07-14T22:00:00+00:00"
        },
        "type": "REMINDER_SENT",
        "completed_at": "2021-07-14T22:00:00+00:00"
      }
    ],
    "summary": [
      {
        "data": {
          "country": "CA",
          "timezone": "Europe/Brussels",
          "has_withdraw_methods": true
        },
        "name": "Contract start date",
        "type": "START_DATE",
        "value": "2021-07-14T22:00:00+00:00"
      }
    ],
    "contract": {
      "id": "PzpYaren",
      "oid": "PzpYaren",
      "name": "Contract Name",
      "status": "in_progress",
      "created_at": "2021-07-14T22:00:00+00:00",
      "first_sign": "client",
      "completion_date": "2021-07-14T22:00:00+00:00",
      "client_signed_at": "2021-07-14T22:00:00+00:00",
      "employee_agreement": {
        "status": "AwaitingEmployeeSignature",
        "version_hash": "cdf4f572eb13a5eaf46d"
      },
      "contractor_signed_at": "2021-07-14T22:00:00+00:00",
      "invited_contractor_email": "test@email.com"
    },
    "progress": {
      "status": "ACTIVE",
      "reference_date": "2021-07-14T22:00:00+00:00",
      "subject_to_overdue": true,
      "reference_date_timezone": "Europe/Brussels",
      "is_action_required_from_client": true
    },
    "checklist": {
      "steps": [
        {
          "type": "sign_up_to_deel",
          "label": "Create contractor account",
          "status": "done",
          "completed_at": "2021-07-14T22:00:00+00:00",
          "reject_reason": "<p>Please submit the correct document for Form 145</p>"
        }
      ]
    },
    "hiring_type": "contractor",
    "hris_profile": {
      "oid": "150f635e-fae1-4b9d-9f86-768bbbac3698",
      "name": "John Doo",
      "email": "test@email.com",
      "work_email": "test@email.com"
    }
  }
}

Use this endpoint to retrieve a comprehensive overview of a worker’s onboarding status, including their profile details, contract status, and checklist progress. Token scopes: contracts:read, people:read

Authentication

AuthorizationBearer

Authentication

Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE'

## Authentication Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. ``` curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` ### Generating Access Tokens 1. Navigate to **Apps & Perks > Developer Center**. 2. Click on the “Generate New Token” button. 3. In the popup, click “Generate Token” button to generate a new token. Your newly generated token is visible on the screen. 4. Make sure to copy and save your token once is generated. You won't be able to see it again!

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

hris_profile_idstringRequired

The unique identifier of the employee HRIS profile.

Response

Onboarding overview

dataobject or null

Authentication

Authentication

Path parameters

Response

Errors

Authentication