Direct Integration API

(0 reviews)

RelatedPerson

Sample Request

{
    "Package": {
        "Content": {
            "Application": {
                "RelatedPerson": [
                    {
                        "Contact": {
                            "@x_Address": "aca611351c8b",
                            "@PreferredContact": "Email",
                            "@Email": "email@email.com",
                            "HomePhone": {
                                "@CountryCode": "64",
                                "@NewZealandDialingCode": "01",
                                "@Number": "78"
                            },
                            "WorkPhone": {
                                "@CountryCode": "64",
                                "@NewZealandDialingCode": "01",
                                "@Number": "78"
                            },
                            "Mobile": {
                                "@CountryCode": "64",
                                "@NewZealandDialingCode": "01",
                                "@Number": "78"
                            }
                        },
                        "PersonName": {
                            "@FirstName": "RP FirstName0",
                            "@Surname": "RP Surname0",
                            "@NameTitle": "Mr",
                            "@MiddleNames": "MiddleNames",
                            "@KnownAs": "KnownAs"
                        },
                        "@UniqueID": "uRelatedCompanyCP"
                    }
                ]
            }
        }
    }
}

Detailed description of each field:

Field Name	Description	Type	Path	Required	Enumerations
RelatedPerson	A person that is not an applicant but has a role in some aspect of the application	array	Package.Content.Application.RelatedPerson
Contact	Contains contact details for the trust applicant	object	Package.Content.Application.RelatedPerson.Contact
@x_Address	The mailing address of the company	string	Package.Content.Application.RelatedPerson.Contact.x_Address
@PreferredContact	The preferred method for contacting this applicant	string	Package.Content.Application.RelatedPerson.Contact.PreferredContact	Yes	Email,Work Phone, Home Phone, Work Phone
@Email	An email address for the trust	string	Package.Content.Application.RelatedPerson.Contact.Email	Yes,if preferedcontact is Email
HomePhone	A home phone number for the related party	object	Package.Content.Application.RelatedPerson.Contact.HomePhone
@CountryCode	Captures the international dialing code for the country in which the fixed phone number is located, e.g. \"61\" for Australia. Maximum length is 3 digits	string	Package.Content.Application.RelatedPerson.Contact.HomePhone.CountryCode		64
@NewZealandDialingCode	The Area Code prefix for a New Zealand telephone number	string	Package.Content.Application.RelatedPerson.Contact.HomePhone.NewZealandDialingCode		01, 011, 020, 021, 022, 023, 024, 025, 026, 027, 028, 029, 03, 04, 05, 050, 0508, 06, 07, 070, 08, 080, 0800, 09, 090, 1, 50
@Number	The local-dial number. For local rate, free call, satellite or similar special non-overseas numbers where the area or dialing code is not otherwise available, the full phone number. Required, allowed once only	string	Package.Content.Application.RelatedPerson.Contact.HomePhone.Number
Mobile	A mobile number for the related party	object	Package.Content.Application.RelatedPerson.Contact.Mobile
@CountryCode	Captures the international dialing code for the country in which the fixed phone number is located, e.g. \"61\" for Australia. Maximum length is 3 digits	string	Package.Content.Application.RelatedPerson.Contact.Mobile.CountryCode		64
@NewZealandDialingCode	The Area Code prefix for a New Zealand telephone number	string	Package.Content.Application.RelatedPerson.Contact.Mobile.NewZealandDialingCode		01, 011, 020, 021, 022, 023, 024, 025, 026, 027, 028, 029, 03, 04, 05, 050, 0508, 06, 07, 070, 08, 080, 0800, 09, 090, 1, 50
@Number	The local-dial number. For local rate, free call, satellite or similar special non-overseas numbers where the area or dialing code is not otherwise available, the full phone number. Required, allowed once only	string	Package.Content.Application.RelatedPerson.Contact.Mobile.Number	Yes
WorkPhone	A work phone number for the related party	object	Package.Content.Application.RelatedPerson.Contact.WorkPhone
@CountryCode	Captures the international dialing code for the country in which the fixed phone number is located, e.g. \"61\" for Australia. Maximum length is 3 digits	string	Package.Content.Application.RelatedPerson.Contact.WorkPhone.CountryCode		64
@NewZealandDialingCode	The Area Code prefix for a New Zealand telephone number	string	Package.Content.Application.RelatedPerson.Contact.WorkPhone.NewZealandDialingCode		01, 011, 020, 021, 022, 023, 024, 025, 026, 027, 028, 029, 03, 04, 05, 050, 0508, 06, 07, 070, 08, 080, 0800, 09, 090, 1, 50
@Number	The local-dial number. For local rate, free call, satellite or similar special non-overseas numbers where the area or dialing code is not otherwise available, the full phone number. Required, allowed once only	string	Package.Content.Application.RelatedPerson.Contact.WorkPhone.Number
ContactPerson	Contains information for the contact person for the trust	object	Package.Content.Application.RelatedPerson.Contact.ContactPerson
@x_ContactPerson	A contact person for the trust	string	Package.Content.Application.RelatedPerson.Contact.ContactPerson.x_ContactPerson	Yes
PersonName	The name of the person applicant	object	Package.Content.Application.RelatedPerson.PersonName
@NameTitle	The name title this person uses when they are formally addressed	string	Package.Content.Application.RelatedPerson.PersonName.NameTitle	Yes
@FirstName	A person's first name	string	Package.Content.Application.RelatedPerson.PersonName.FirstName	Yes
@MiddleNames	A person's other name. Also referred to as their 'middle name'. For example - where someone's name is Frederick Joseph Gilbert - 'Joseph' would be considered their other name	string	Package.Content.Application.RelatedPerson.PersonName.MiddleNames
@Surname	A person's surname	string	Package.Content.Application.RelatedPerson.PersonName.Surname	Yes
@KnownAs	The familiar name, nickname or preferred name by which the person wishes to be known	string	Package.Content.Application.RelatedPerson.PersonName.KnownAs
@UniqueID	System assigned unique identifier	string	Package.Content.Application.RelatedPerson.UniqueID	Yes

RelatedPerson

Sample Request

Detailed description of each field:

Reviews