Onboarding.js will call the onChange handler passed into renderForm when certain events happen within the form.

Event Types

TypeDescription
error_on_file_uploadThere was an error when trying to upload a file.
error_on_loadThere was an error loading the form.
error_on_saveThere was an error while saving the form data.
error_on_submitThere was an error trying to submit the form.
loadedThe form loaded successfully and is ready for input.
savedAll progress has been saved. It would be safe to navigate away from the form.
submittedAll data has been saved and validated. The Firm will now be sent to underwriting.
token_expiredThe onboarding token has expired. You must create a new one and re-render.
token_expires_soonThe onboarding token will expire in 5 or less minutes. The user will want to save their progress so they don’t lose unsaved data.

ChangeEvent

type
string
required

The type of event. This can be one of the types listed above.

errorMessage
string

The error message. Only set if this event is an error type.

onboardingData
object

Object containing all the currently saved data in the form. This will not include data that has been entered but not saved.

tokenExpiresAt
string

An ISO timestamp of the time at which the token will expire.