PartyProfile

Represents information about the profile of a party, such as a contact, account, or lead. This object is available in API version 56.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

AccountId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The account that’s associated with the party profile.

This field is a relationship field.
Relationship Name: Account
Relationship Type: Lookup
Refers To: Account

BusLicIssAuthorityName

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The name of the business license issuing authority.

BusinessEntityCtryofInc

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the country where the business entity was formed.
Possible values:
- India
- UK
- USA

BusinessEntityCtryofRgstr

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the country where the business entity is registered.
Possible values:
- India
- UK
- USA

BusinessEntityIncDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The incorporation date of the business entity associated with the party profile.

BusinessEntityIncNumber

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The incorporation number of the business entity associated with the party profile.

BusinessEntityName

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The registered name of the business entity associated with the party profile.

BusinessEntityPreviousNames

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Any previous names of the business entity associated with the party profile.

BusinessEntityRgstrDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The registration date of the business entity associated with the party profile.

BusinessEntityRgstrNumber

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The registration number of the business entity associated with the party profile.

BusinessEntityTradeName

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The trading name of the business entity associated with the party profile.

BusinessEntityType

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the type of the business entity associated with the party profile.
Possible values:
- Locally Incorporated Company
- Sole Proprietorship
- Foreign Company
- Limited Partnership
- General Partnership
- Foundations
- Trusts
- LLP
- Ltd.
- Other
- Partnership
- Proprietorship

ContactId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The contact that’s associated with the party profile.

This field is a relationship field.
Relationship Name: Contact
Relationship Type: Lookup
Refers To: Contact

CountryOfDomicile

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the country of domicile in the party profile.
Possible values:
- Australia
- India
- South Africa
- Thailand
- UK
- USA

CountryofBirth

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Specifies the country of birth in the party profile.

CreditScore

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The credit score of the party.

CreditScoreProvider

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the name of the agency that provides the credit score of the party.
Possible values:
- Equifax
- Experian
- TransUnion

CustomerReferenceNumber

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The unique identifier that the bank assigns to the customer associated with the party profile record.

DateOfBirth

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date of birth of the party.

EmploymentIndustry

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the employment industry of the party specified in the profile.
Possible values:
- Banking
- Energy and Utilities
- Government
- Healthcare
- IT
- Mining
- Real Estate

EmploymentType

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the type of employment held by the party.
Possible values:
- Full Time
- Government Employee
- Independent Contractor
- Part Time
- Retired
- Self-Employed
- Student
- Temporary
- Unemployed

FirstName

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The first name of the party in the profile.

FullName

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The full name of the party profile.

FundSource

Type: multipicklist
Properties: Create, Filter, Nillable, Restricted picklist, Update
Description: Specifies the source of funds for a party in the profile.
Possible values:
- Business Income
- Commission
- Government Benefits
- Rental Income
- Salary

Gender

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Specifies the gender of the party in the profile.
Possible values:
- Decline to Specify
- Female
- Male

HouseholdAccountId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The household account that’s associated with the party profile.

This field is a relationship field.
Relationship Name: HouseholdAccount
Relationship Type: Lookup
Refers To: Account

Industry

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Represents the industry in which a business entity operates.
Possible values:
- Finance
- Healthcare
- Logistics
- Manufacturing
- Others
- Technology

IndustryClassificationCode

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The unique code associated with the industry in which a business entity operates.

IsBusEntyListonStockExch

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Specifies whether the business entity is listed on a stock exchange (true) or not (false).
Default value: false

IsFlaggedCustomer

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the customer needs additional scrutiny before issuing a loan.
Default value: false

IsNetWorthHigh

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the customer has a high net worth (true) or not (false).
Default value: false

IsOffBoarded

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the party profile was off-boarded (true) or not (false).
Default value: false

IsVerified

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Specifies the verification status of the party profile.
Possible values:
- Not Verified
- Verification In Progress
- Verified

LastName

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The last name of the party in the profile.

LastProfileReviewDate

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The date when the party profile was last reviewed.

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp for when the current user last viewed a record related to this record.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.

LeadId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The lead that’s associated with the party profile.

This field is a relationship field.
Relationship Name: Lead
Relationship Type: Lookup
Refers To: Lead

LegalEntityIdentifier

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The unique identifier of the business entity used in all financial transactions.

MiddleName

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The middle name of the party in the profile.

Name

Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: The name of the party profile record.

Nationality

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The nationalities held by the party profile.
Possible values:
- Australia
- Canada
- France
- India
- Japan
- New Zealand
- South Africa
- Spain
- Switzerland
- Thailand
- UK
- USA

NextProfileReviewDate

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The date of the next party profile review.

OffBoardingComments

Type: textarea
Properties: Create, Filter, Nillable, Sort, Update
Description: The description about off-boarding of the customer profile.

OffBoardingReason

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The reason the customer profile was off-boarded.

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The ID of the record owner.

This field is a polymorphic relationship field.
Relationship Name: Owner
Relationship Type: Lookup
Refers To: Group, User

Prefix

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The prefix used by the party.

PrimaryEmail

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The primary email address of the party that’s specified in the profile.

PrimaryIdentificationName

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The name of the primary identification document specified in the profile.

PrimaryIdentifier

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The unique identifier for the party.

PrimaryIdentifierType

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Specifies the type of primary identification document defined in the profile.
Possible values:
- Birth Certificate
- Driving License
- Government ID
- Passport

PrimaryPhone

Type: phone
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The primary phone number of the party that’s specified in the profile.

RelatedPartyProfileId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The party profile record associated with this record.

This field is a relationship field.
Relationship Name: RelatedPartyProfile
Relationship Type: Lookup
Refers To: PartyProfile

ResidentType

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the type of party residency in the profile.
Possible values:
- Citizen
- Non Resident
- Temporary Resident

ReviewDecision

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the decision taken after the party profile review is complete.
Possible values:
- Accepted
- On Hold
- Rejected

Stage

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The current stage of the party profile.
Possible values:
- Initiated
- Risk Screening
- Document Validation
- Risk Assessment
- Approval
- Approved
- Rejected
- On Hold

StockExchangeName

Type: multipicklist
Properties: Create, Filter, Nillable, Update
Description: Specifies the name of the stock exchange where the business entity is listed.
Possible values:
- New York Stock Exchange
- NASDAQ
- London Stock Exchange
- Tokyo Stock Exchange

Suffix

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The suffix used by the party.

SurnameAtBirth

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The party surname at birth specified in the profile.

TaxpayerIdentificationNumber

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The taxpayer identifier that’s used for tax purposes.

TaxpayerIdentificationType

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The type of taxpayer identification used for tax purposes.
Possible values:
- SSN
- Taxpayer Identification Number

Type

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the type of the party profile associated with the applicant.
Possible values:
- Business
- Individual

RetirementFundAccountNumber

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The retirement fund account number of the party profile

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

PartyProfileChangeEvent: Change events are available for the object.
PartyProfileFeed: Feed tracking is available for the object.
PartyProfileHistory: History is available for tracked fields of the object.
PartyProfileOwnerSharingRule: Sharing rules are available for the object.
PartyProfileShare: Sharing is available for the object.