Sign in
v2
Forms App
AWS

Create Preliminary Participant Endpoint

Creates a preliminary Lead participant from step 1 (participant details) form data.

Called by the forms app after the participant details step is successfully submitted, before the form is fully completed. This ensures a participant record exists in the database with status="Lead" and status_category="Form in progress" as soon as a user starts filling in their details.

The participant ID is stored in the form_request processing_outcomes so that form_completion_background_task skips re-creation and instead updates the existing record.

Not valid for bank_details_form requests — those are pre-linked to an existing entity and must never create new participants.

post/api/v2/aws/forms-app/create-preliminary-participant

Request body

form_request_idstring uuid required
plan_manager_idstring uuid required
first_namestring nullable
middle_namestring nullable
last_namestring nullable
date_of_birthstring nullable
phone_numberstring nullable
contact_emailstring nullable
address_line_1string nullable
address_line_2string nullable
citystring nullable
statestring nullable
postcodestring nullable
ndis_numberstring nullable

Response

Successful Response

Changes