-
Email
email -
The email address that can be used for electronic correspondence with the individual
Required: True
Datatype: string
Expected number: 1
-
Phone number(s)
phone-numbers -
One or more telephone numbers to contact individual
Required: True
Datatype: object
Expected number: 1 or more
-
Phone number
number -
A phone number
Required: False
Datatype: string
Expected number: 1
-
Contact priority
contact-priority -
The priority of a number
Required: False
Datatype: enum
Expected number: 1
-
module: applicant-contact
Applicant contact details
Telephone number and email address of the applicant.
Fields
-
Applicant reference
applicant-reference -
Reference to match contact details to a named individual from the applicant details component
Required: True
Datatype: string
Expected number: 1
-
Contact details
contact-details -
A structured object containing contact information for an individual. This component is required for planning in principle (PiP) applications and optional for other application types. Contains email and phone contact information.
Required: True
Datatype: object
Expected number: 1
Rules
- applicant-reference must match a reference from the applicant details component
- At least one phone number must have contact-priority set to primary