Add a work rights check to a form

The Check work rights block lets applicants check their visa with the Department of Home Affairs while they fill in your form. They can't carry on until they've pressed the button, and only you see the visa details.

Before you start

Set up your Home Affairs key first. See Set up work rights checks.

Your form needs questions for the applicant's First name, Surname, Date of birth, Passport number and Passport country. A Middle names question is optional. Use a Date question for the date of birth and a Country question for the passport country.

Steps

1. Open the form in the Form builder.
2. Drag Check work rights from Form fields onto your form, below the name, date of birth and passport questions.
3. Open its settings. Under Answers it checks, Formhub picks the matching questions from their wording. Check each one, and change any that are wrong. If there's no middle name question, choose None on this form.
4. Click Save in the settings window, then Save at the top of the builder.

Put the block in a section shown only to applicants who aren't Australian. See Show or hide questions.

What the applicant sees

The block shows "We'll check:" with their name, date of birth and passport, and a Check my work rights button. It also says they agree to your business checking their visa, and that they only see whether their details matched.

• If Home Affairs matches them, they see "Checked with Home Affairs" and can carry on.
• If there's no match, they can fix their details and try again. After 3 tries they can carry on, and the response is marked Not confirmed.
• If Home Affairs can't be reached, they can carry on, and the response is marked Not checked.
• If they change their details after a match, they must press the button again.

Good to know

• If a question the block needs isn't chosen, the form shows "This form is being prepared" and can't be sent. The block's settings tell you what's missing.
• If your Home Affairs key isn't set up, the block stays hidden on the form.
• In the builder's preview, the button doesn't work. Try it on the live form.
• Results go on the response. See Work rights results.