Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Timezone
string

A Timezone ID. If not specified, defaults to ETC/UTC. Documented here: Timezones

Body

application/json
homeAddress
object
required

The address sub-element of the employer element contains all data pertaining to an employer's physical address.

workAddresses
object[]
required
Required array length: 1 - 10 elements
nexus
string[]

States and territories

lockInLetters
string[]

States and territories

interstateEmployee
boolean
includePreviewForms
boolean
useAddressSuggestion
boolean

Response

OK

errors
object[]
warnings
string[]
forms
object[]
previewForms
object[]
locationData
object[]