API ReferenceEmployers

Create an employer

Creates an employer.

Headers

AuthorizationstringRequired

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

Idempotency-KeystringOptional

Unique key to ensure idempotent requests. If the same key is used for multiple identical & successful requests, the same response will be returned. Read more here

Request

This endpoint expects an object.
legal_namestringRequired

Legal name of the company. NOTE: This field will be normalized according to our internal formatting rules.

legal_addressobjectRequired
contactobjectRequired
registration_numberstring or nullOptional

Company registration number. NOTE: This field will be normalized according to our internal formatting rules.

Response

OK
idstringformat: "er_.+"
legal_namestring
legal_addressobject
contactobject
platform_idstring or nullformat: "pt_.+"
statusenum or null
Allowed values:
registration_numberstring or null
offboard_onstring or nullformat: "date-time"
objectstring or null
The object type

Errors