Versions Compared

Old Version 27

changes.mady.by.user Bruce Rooke (Deactivated)

Saved on

compared with

New Version Current

changes.mady.by.user Steve Randall

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

FieldDescriptionFormatRequiredField TypeNotes
displayNameThe participants name formatted as defined by the Display Name Format global preference.stringtruefalsedefaultRead-only field. Returned in GET requests.
isCompanyDefines the participant as either a Company or Individual.booleantruedefault
companyNameThe name of the company if the participant is a Company, or the name of the employer if the participant is an Individual.stringfalsedefault
salutationThe Individual's prefix.stringfalsedefault
firstNameThe Individual's first name.string*defaultIf isCompany === false then this field is required.
middleNameThe Individual's middle name.stringfalsedefault
lastNameThe Individual's last name.string*defaultIf isCompany === false then this field is required.
suffixThe Individual's suffix.stringfalsedefault
preferredNameThe Individual's preferred name.stringfalseadditional
physicalAddressLine1The primary field for the physical address of the participant.stringfalsedefault
physicalAddressLine2An optional secondary address field for the physical address.stringfalsedefault
physicalCityThe city portion of the physical address.stringfalsedefault
physicalStateProvinceThe state or province portion of the physical address.stringfalsedefault
physicalPostCodeThe postcode or zip code portion of the physical address.stringfalsedefault
mailingAddressLine1The primary field for the mailing address of the participant.stringfalseadditional
mailingAddressLine2An optional secondary address field for the mailing address.stringfalseadditional
mailingCityThe city portion of the mailing address.stringfalseadditional
mailingStateProvinceThe state or province portion of the mailing address.stringfalseadditional
mailingPostCodeThe postcode or zip code portion of the mailing address.stringfalseadditional
phone1LabelA description of the primary phone number.stringfalsedefault
phone1CountryThe country portion of the primary phone number.integerfalsedefault
phone1AreaThe area code portion of the primary phone number.integerfalsedefault
phone1NumberThe number portion of the primary phone number.stringfalsedefault
phone1NotesA notes field for the primary phone number.stringfalsedefault
phone2LabelA description of the secondary phone number.stringfalseadditional
phone2CountryThe country portion of the secondary phone number.integerfalseadditional
phone2AreaThe area code portion of the secondary phone number.integerfalseadditional
phone2NumberThe number portion of the secondary phone number.stringfalseadditional
phone2NotesA notes field for the secondary phone number.stringfalseadditional
phone3LabelA description of the tertiary phone number.stringfalseadditional
phone3CountryThe country portion of the tertiary phone number.integerfalseadditional
phone3AreaThe area code portion of the tertiary phone number.integerfalseadditional
phone3NumberThe number portion of the tertiary phone number.stringfalseadditional
phone3NotesA notes field for the tertiary phone number.stringfalseadditional
phone4LabelA description of the quaternary phone number.stringfalseadditional
phone4CountryThe country portion of the quaternary phone number.integerfalseadditional
phone4AreaThe area code portion of the quaternary phone number.integerfalseadditional
phone4NumberThe number portion of the quaternary phone number.stringfalseadditional
phone4NotesA notes field for the quaternary phone number.stringfalseadditional
faxThe participant's fax number.stringfalseadditional
smsThe number to use for SMS.stringfalseadditional
emailThe participant's email address.stringfalsedefault
websiteThe participant's web address.stringfalseadditional
occupationThe participant's occupation.stringfalseadditional
taxNumberThe tax number for the Company or Individual. Uses the Tax Number Alias on the Base Participant Type to determine what type of tax this is.stringfalseadditional
birthTimestampThe Individual's Date of Birth.datefalsedefault
deathTimestampThe Individual's Date of Death.datefalseadditional
maritalStatusThe marital status of the Individual.stringfalsedefault
genderThe gender of the Individual.stringtruedefault
modifiedTimestampTimestamp when the record was last modified.timestampfalseadditional
createdTimestampTimestamp when the record was created.timestampfalseadditional
baseParticipantTypeThe base Participant Type for this resource.stringtruelinkMay only have one base type. Not yet implemented
physicalCountryThe associated Countries resource for the country portion of the physical address.stringfalselink
mailingCountryThe associated Countries resource for the country portion of the mailing address.stringfalselink
divisionThe associated Divisions resource for the participant.stringtruelink
billingPreferenceThe associated Billingpreference resource of the participant.stringfalselinkNot Yet Implemented
amlStatusThe status for the AML check for this participant.stringfalsestringMust be one of 'Not started', 'In progress', 'Signed off'.
amlProgressThe percentage of the AML process completed.integerfalseinteger0 to 100.
amlRiskThe AML risk level assigned to this participant.stringfalsestringMust be one of 'Unknown', 'Low', 'Medium', 'High'.
amlNoteSome AML notes.stringfalsestring


Link Templates
IdentifierResourceLocation Template
participants.physicalCountrycountries/countries/{participants.physicalCountry}
participants.mailingCountrycountries/countries/{participants.mailingCountry}
participants.divisiondivisions/divisions/{participants.division}
participants.billingPreferencebillingPreferences/billingPreferences/{participants.billingPreference}

...