Party Profile Input

Input representation of the details of the party profile.

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
accountIdStringAccount ID associated with the party profile.Optional61.0
contactIdStringContact ID associated with the party profile.Optional61.0
countryOfBirthStringCountry of birth in the party profile.Optional61.0
countryOf​DomicileStringCountry of domicile in the party profile.Optional61.0
creditScoreDoubleCredit score of the party.Optional61.0
creditScore​ProviderStringName of the agency that provides the credit score of the party.Optional61.0
customFieldsCustom Fields Input[]Custom fields related to the party profile.Optional61.0
dateOfBirthStringDate of birth of the party profile.Optional61.0
employment​IndustryStringEmployment industry of the party specified in the profile.Optional61.0
employmentTypeStringType of employment held by the party.Optional61.0
firstNameStringFirst name of the party in the profile.Optional61.0
fullNameStringFull name of the party profile.Optional61.0
fundSourceStringSource of funds for a party in the profile.Optional61.0
genderStringGender of the party in the profile.Optional61.0
household​AccountIdStringHousehold account that’s associated with the party profile.Optional61.0
isNetWorthHighBooleanIndicates whether the customer has a high net worth (true) or not (false).Optional61.0
isOffBoardedBooleanIndicates whether the party profile was off-boarded (true) or not (false).Optional61.0
lastNameStringLast name of the party in the profile.Optional61.0
lastProfile​ReviewDateStringDate when the party profile was last reviewed.Optional61.0
leadIdStringLead that’s associated with the party profile.Optional61.0
middleNameStringMiddle name of the party in the profile.Optional61.0
nameStringName of the party profile record.Required61.0
nationalityStringNationalities held by the party profile.Optional61.0
nextProfile​ReviewDateStringDate of the next party profile review.Optional61.0
offBoarding​CommentsStringDate of the next party profile review.Optional61.0
offBoarding​ReasonStringReason the party profile was off-boarded.Optional61.0
orchestration​ErrorMessageStringMessage that’s generated when an error occurs during the orchestration.Optional61.0
orchestration​IdStringID of the run-time orchestration.Optional61.0
orchestration​StatusStringStatus of the orchestration.Optional61.0
partyIdentity​VerificationParty Identity Verification Input[]Party identity verification associated with the party profile.Optional61.0
partyProfile​AddressParty Profile Address Input[]Party profile address associated with the party profile.Optional61.0
partyProfile​RiskParty Profile Risk Input[]Party profile risk associated with the party profile.Optional61.0
prefixStringPrefix used by the party.Optional61.0
primaryEmailStringPrimary email address of the party that’s specified in the profile.Optional61.0
primary​IdentificationNameStringName of the primary identification document specified in the profile.Optional61.0
primary​IdentifierStringUnique identifier for the party.Optional61.0
primary​IdentifierTypeStringType of primary identification document defined in the profile.Optional61.0
primaryPhoneStringPrimary phone number of the party that’s specified in the profile.Optional61.0
recordTypeIdStringID of the record type assigned to this object.Optional61.0
relatedParty​ProfileIdStringParty profile record associated with this record.Optional61.0
residentTypeStringType of party residency in the profile.Optional61.0
reviewDecisionStringDecision taken after the party profile review is complete.Optional61.0
stageStringCurrent stage of the party profile.Optional61.0
suffixStringSuffix used by the party.Optional61.0
surnameAtBirthStringParty surname at birth specified in the profile.Optional61.0
taxPayer​Identification​NumberStringTaxpayer identifier that’s used for tax purposes.Optional61.0
taxPayer​Identification​TypeStringType of taxpayer identification used for tax purposes.Optional61.0