Employment Hero

Employment Hero Employee Onboarding API

Employee Onboarding

GitHub OpenAPI

Operations 1

POST /api/v2/business/{businessId}/employeeonboarding/initiateselfservice Initiate Employee Self Setup #

Documentation

📖
Documentation
https://api.keypay.com.au/guides/Home.html
📖
APIReference
https://api.keypay.com.au/
📖
APIReference
https://api.keypay.com.au/new-zealand/reference.html
📖
APIReference
https://api.keypay.com.au/united-kingdom/reference.html
📖
APIReference
https://api.keypay.com.au/singapore/reference.html
📖
APIReference
https://api.keypay.com.au/malaysia/reference.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/employment-hero/refs/heads/main/openapi/employment-hero-employeeonboarding-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/employment-hero:employment-hero-employeeonboarding-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

employment-hero-employeeonboarding-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Employment Hero Employee Onboarding API
  version: '1.0'
  description: 'Operations tagged EmployeeOnboarding across 5 of this provider''s published API definitions: employment-hero-payroll-au-swagger.json, employment-hero-payroll-my-swagger.json, employment-hero-payroll-nz-swagger.json, employment-hero-payroll-sg-swagger.json, employment-hero-payroll-uk-swagger.json. Each path carries the servers of the definition it was published in.'
security:
- basic: []
- apiKey: []
- oauth2:
  - read
  - write
- basic: []
- apiKey: []
- oauth2:
  - read
  - write
- basic: []
- apiKey: []
- oauth2:
  - read
  - write
- basic: []
- apiKey: []
- oauth2:
  - read
  - write
- basic: []
- apiKey: []
- oauth2:
  - read
  - write
tags:
- name: EmployeeOnboarding
  description: Employee Onboarding
paths:
  /api/v2/business/{businessId}/employeeonboarding/initiateselfservice:
    post:
      tags:
      - EmployeeOnboarding
      summary: Initiate Employee Self Setup
      description: 'Initiate the Self Setup process for an Employee.

        If the employee has an existing employee record, the id should be specified. If the Email and Mobile provided

        are not the same as those on the employee record, they will be updated.

        If the employee does not yet have an employee record do not specify an id, one will be created with the

        details provided.'
      operationId: AuBusinessEmployeeOnboarding_InitiateSelfService
      parameters:
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/xml:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuInitiateEmployeeOnboardingApiModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/AuInitiateEmployeeOnboardingApiModel'
          text/plain:
            schema:
              $ref: '#/components/schemas/AuInitiateEmployeeOnboardingApiModel'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/AuInitiateEmployeeOnboardingApiModel'
          text/json:
            schema:
              $ref: '#/components/schemas/AuInitiateEmployeeOnboardingApiModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AuInitiateEmployeeOnboardingApiModel'
components:
  schemas:
    AuInitiateEmployeeOnboardingApiModel:
      title: AuInitiateEmployeeOnboardingApiModel
      type: object
      properties:
        employingEntityId:
          format: int32
          title: Nullable<Int32>
          type: integer
          x-title: Nullable<Int32>
        id:
          format: int32
          title: Nullable<Int32>
          type: integer
          x-title: Nullable<Int32>
        title:
          format: int32
          title: Nullable<Int32>
          type: integer
          x-title: Nullable<Int32>
        firstName:
          title: String
          type: string
          x-title: String
        surname:
          title: String
          type: string
          x-title: String
        email:
          title: String
          type: string
          x-title: String
        mobile:
          title: String
          type: string
          x-title: String
        qualificationsRequired:
          title: Boolean
          type: boolean
          x-title: Boolean
        emergencyContactDetailsRequired:
          title: Boolean
          type: boolean
          x-title: Boolean
      additionalProperties: false
    ProblemDetails:
      title: ProblemDetails
      type: object
      properties:
        type:
          title: String
          type: string
          x-title: String
        title:
          title: String
          type: string
          x-title: String
        status:
          format: int32
          title: Nullable<Int32>
          type: integer
          x-title: Nullable<Int32>
        detail:
          title: String
          type: string
          x-title: String
        instance:
          title: String
          type: string
          x-title: String
      additionalProperties:
        title: Object
        x-title: Object
        type: object
    MyInitiateEmployeeOnboardingApiModel:
      title: MyInitiateEmployeeOnboardingApiModel
      type: object
      properties:
        employingEntityId:
          format: int32
          title: Nullable<Int32>
          type: integer
          x-title: Nullable<Int32>
        id:
          format: int32
          title: Nullable<Int32>
          type: integer
          x-title: Nullable<Int32>
        title:
          format: int32
          title: Nullable<Int32>
          type: integer
          x-title: Nullable<Int32>
        firstName:
          title: String
          type: string
          x-title: String
        surname:
          title: String
          type: string
          x-title: String
        email:
          title: String
          type: string
          x-title: String
        mobile:
          title: String
          type: string
          x-title: String
        qualificationsRequired:
          title: Boolean
          type: boolean
          x-title: Boolean
        emergencyContactDetailsRequired:
          title: Boolean
          type: boolean
          x-title: Boolean
      additionalProperties: false
    NzInitiateEmployeeOnboardingApiModel:
      title: NzInitiateEmployeeOnboardingApiModel
      type: object
      properties:
        employingEntityId:
          format: int32
          title: Nullable<Int32>
          type: integer
          x-title: Nullable<Int32>
        onboardingStarterType:
          title: Nullable<OnboardingStarterTypeEnum>
          enum:
          - NewStarterKiwiSaverEligible
          - NewStarterKiwiSaverIneligible
          - ExistingEmployeeKiwiStarterEligible
          - ExistingEmployeeKiwiStarterIneligible
          type: string
        id:
          format: int32
          title: Nullable<Int32>
          type: integer
          x-title: Nullable<Int32>
        title:
          format: int32
          title: Nullable<Int32>
          type: integer
          x-title: Nullable<Int32>
        firstName:
          title: String
          type: string
          x-title: String
        surname:
          title: String
          type: string
          x-title: String
        email:
          title: String
          type: string
          x-title: String
        mobile:
          title: String
          type: string
          x-title: String
        qualificationsRequired:
          title: Boolean
          type: boolean
          x-title: Boolean
        emergencyContactDetailsRequired:
          title: Boolean
          type: boolean
          x-title: Boolean
      additionalProperties: false
    SgInitiateEmployeeOnboardingApiModel:
      title: SgInitiateEmployeeOnboardingApiModel
      type: object
      properties:
        employingEntityId:
          format: int32
          title: Nullable<Int32>
          type: integer
          x-title: Nullable<Int32>
        id:
          format: int32
          title: Nullable<Int32>
          type: integer
          x-title: Nullable<Int32>
        title:
          format: int32
          title: Nullable<Int32>
          type: integer
          x-title: Nullable<Int32>
        firstName:
          title: String
          type: string
          x-title: String
        surname:
          title: String
          type: string
          x-title: String
        email:
          title: String
          type: string
          x-title: String
        mobile:
          title: String
          type: string
          x-title: String
        qualificationsRequired:
          title: Boolean
          type: boolean
          x-title: Boolean
        emergencyContactDetailsRequired:
          title: Boolean
          type: boolean
          x-title: Boolean
      additionalProperties: false
    InitiateEmployeeOnboardingApiModel:
      title: InitiateEmployeeOnboardingApiModel
      type: object
      properties:
        id:
          format: int32
          title: Nullable<Int32>
          type: integer
          x-title: Nullable<Int32>
        title:
          format: int32
          title: Nullable<Int32>
          type: integer
          x-title: Nullable<Int32>
        firstName:
          title: String
          type: string
          x-title: String
        surname:
          title: String
          type: string
          x-title: String
        email:
          title: String
          type: string
          x-title: String
        mobile:
          title: String
          type: string
          x-title: String
        qualificationsRequired:
          title: Boolean
          type: boolean
          x-title: Boolean
        emergencyContactDetailsRequired:
          title: Boolean
          type: boolean
          x-title: Boolean
      additionalProperties: false
  securitySchemes:
    basic:
      type: http
      scheme: basic
      description: Your API key should be the username and the password can be left blank
    apiKey:
      type: apiKey
      in: header
      description: API Key Authentication
    oauth2:
      type: oauth2
      flows:
        implicit:
          scopes:
            read: Read access to protected resources
            write: Write access to protected resources
          authorizationUrl: https://keypay.yourpayroll.com.au/oauth/authorise
      description: OAuth2 Implicit Grant
x-refined-from:
- employment-hero-payroll-au-swagger.json
- employment-hero-payroll-my-swagger.json
- employment-hero-payroll-nz-swagger.json
- employment-hero-payroll-sg-swagger.json
- employment-hero-payroll-uk-swagger.json