Skip to main content

People API - Initiations

Initiations can be created via API requests using the People API Subscription.  To use this functionality, tick the Allow Authorization Create from Existing Assignment checkbox on Authorization Config

Updated over 2 weeks ago

Initiations can be created via API requests using the People API Subscription.

To use this functionality, tick the Allow Authorization Create from Existing Assignment checkbox on Authorization Configuration page at the company level under the Portal Configuration menu item.

Initiation_-_Allow_Authorization_Creation_from_Existing_Assignment_tickbox.pngAllow Authorization Create from Existing Assignment tickbox

Initiation API

At a high level, the process to create Initiations overlaps with the process to create Assignments with related information like Assignment Dependents or Spouse/Domestic Partner, since creating related records requires an Assignment ID.

The following steps are an example of the sequence of steps that need to happen to create an Initiation:

  1. Create an Assignment using the Assignment Endpoint. There is now an optional meta attribute that can be provided to flag the Assignment as the basis for an Initiation and will be used in the last step to finalize the creation of the Initiation. This needs to be set as "true", like in the example below:

    API Initiation script set to true
  2. Create any related records such as Assignment Dependent, Spouse/Domestic Partner, Compensation information, as these all require the Assignment ID that will be returned when the Assignment is successfully created.

  3. When all related records have been successfully created, a request to a newly available endpoint needs to be made to finalize the creation of the Initiation. This endpoint optionally accepts the ID of an Authorization Configuration Template as well as the ID for an Authorization Coordinator.

Replace {assignmentId} with the ID of the Assignment, with a request like the below:

API Link

API Initiation script sample

Note that by passing the "isAuthorization" flag in the initial Assignment request, the Assignment will be created as Inactive, and will not be marked as Active until the Initiation is Approved.

Did this answer your question?