PUT

/Person

When to Use

  • Update person details including tax residency and contact information
  • Modify sophisticated investor or PEP status classifications
  • Update identity documents and verification details
  • Change person information for cross-entity relationship management

Prerequisites

  • Valid Bearer token with person update permissions
  • Current person record retrieved for complete DTO

Considerations

  • Complete DTO Required: PUT replaces entire record - retrieve current data via GET first
  • Communication Uniqueness: Email addresses must be unique across entire platform
  • Array Replacement: Address and Communication arrays completely replaced - include all to retain
  • Tax Security: TFN changes trigger ATO verification and encryption processes
  • Compliance Impact: Status changes may trigger enhanced monitoring or reporting obligations
  • Relationship Dependencies: Cannot update persons with active transaction history or complex BizEntity links

Description

Updates an existing person record by completely replacing it with the provided data. This is a full replacement operation - all fields must be provided, including those that haven't changed. Missing fields will be set to null.

Advanced Resource: Person records can be updated independently via this endpoint or managed through BizEntity operations. Use this endpoint for direct person modifications, cross-entity updates, or compliance-driven corrections.

Important: Full Replacement

PUT operations completely replace the existing record. To retain existing values:

  1. First GET the current person record
  2. Modify only the fields you want to change
  3. Send the complete updated record via PUT

Required Headers - See Authentication

HeaderValueDescription
Authorization{accessToken}Bearer token for API access
Version2.0API version identifier
Content-Typeapplication/jsonContent type for request body

Request Body

Parameter Type Required Description
PersonID >
integer
The 7G system identifier for the person to update. Required for record identification and cannot be modified.
externalPersonId
 string
Optional
Your external identifier. Can be updated if needed but must remain unique across your system. Use for dual-ID integration.
firstName
 string
Optional
Given name as it appears on government-issued identification. Critical for identity verification and regulatory compliance.
middleName
 string
Optional
Middle name or additional given names if applicable. Include for complete legal identity.
lastName >
string
Family name as it appears on government-issued identification. Critical for identity verification and regulatory compliance.
description
 string
Optional
Additional descriptive information about the person's role, background, or special circumstances relevant to investment services.
abn
 string
Optional
11-digit Australian Business Number if person operates as sole trader. Required for business income tax reporting and GST obligations.
birthCountryCode
 string
Optional
ISO 2-letter country code of birth country. Important for CRS/FATCA reporting and determining tax residency status.
crsfatcaParticipationID >
integer
CRS/FATCA participation classification. Critical for international tax reporting and compliance with global tax information exchange agreements.
customerCode
 string(50)
Optional
Customer reference code or number.
dateOfBirth >
string (date)
Date of birth in YYYY-MM-DD format. Should not change unless correcting data entry errors. Critical for compliance and identity verification.
driversLicenseIssueCountryCode >
string(2)
Country code of driver's license issuing authority.
driversLicenseNumber
 string(20)
Optional
Driver's license number if applicable.
gender
 string(1)
Optional
Gender code: M=Male, F=Female, X=Other/Not specified.
identificationTypeID
 integer
Optional
Primary identification document type reference. Links to lookup table for passport, driver's license, national ID, etc. Critical for AML/KYC verification.
identificationValue
 string(50)
Optional
Number or value of the identification document.
isDirectorOfCorporateTrustee
 boolean
Optional
Indicates if person serves as director of corporate trustee for SMSF or managed investment schemes. Updates trigger enhanced compliance monitoring and fiduciary duty obligations.
isPEP
 boolean
Optional
Politically Exposed Person classification for enhanced due diligence. Changes trigger compliance review and may require enhanced monitoring procedures.
isSophisticatedInvestor
 boolean
Optional
Sophisticated investor status under Australian Corporations Act. Changes affect access to wholesale investment products and disclosure requirements.
isTrustee
 boolean
Optional
Indicates if this person acts as a trustee for SMSF, family trust, or managed investment schemes. Updates trigger enhanced compliance monitoring and fiduciary responsibilities.
pepDescription >
string(500)
Description of PEP status and role if applicable.
legalGuardianTitleID >
integer
Title ID for legal guardian (required for minors). Links to lookup table for Mr, Mrs, Ms, Dr, etc.
legalGuardianFirstName >
string(100)
Legal guardian's first name (required for minors).
legalGuardianMiddleName
 string(100)
Optional
Legal guardian's middle name if applicable.
legalGuardianLastName >
string(100)
Legal guardian's last name (required for minors).
passportIssueCountryCode >
string(2)
Country code of passport issuing authority.
passportNumber
 string(20)
Optional
Passport number if applicable.
salutation
 string(50)
Optional
Name the person prefers to be called.
sharePercentage
 short
Optional
Ownership percentage (0-100) for entities where applicable.
sophisticatedInvestorCertificateDate >
string (date)
Certification date for sophisticated investor status in YYYY-MM-DD format. Updates must maintain currency for wholesale product access.
taxationCountryCode
 string
Optional
Primary tax residency country (ISO 2-letter code). Changes determine main tax obligations and may trigger CRS/FATCA reporting updates.
taxationCountryCode2
 string
Optional
Secondary tax residency country for dual tax residents. Changes trigger additional CRS/FATCA reporting obligations and compliance procedures.
taxationCountryCode3
 string
Optional
Third tax residency country for complex multi-jurisdiction tax residents. Changes require enhanced CRS reporting and compliance monitoring.
taxationCountryTIN
 string(50)
Optional
Tax Identification Number for primary tax residency country.
taxationCountryTIN2
 string(50)
Optional
Tax Identification Number for secondary tax residency country.
taxationCountryTIN3
 string(50)
Optional
Tax Identification Number for third tax residency country.
taxationCountryNoTINReason
 string(200)
Optional
Reason for not having TIN in primary tax residency country.
taxationCountryNoTINReason2
 string(200)
Optional
Reason for not having TIN in secondary tax residency country.
taxationCountryNoTINReason3
 string(200)
Optional
Reason for not having TIN in third tax residency country.
taxationFileNumber >
string
Australian Tax File Number (encrypted in storage). Changes may trigger ATO verification and compliance reviews.
tradingName
 string(200)
Optional
Business or trading name if the person operates as a sole trader.
taxOfficeTypeID
 integer
Optional
Tax authority type identifier for primary tax jurisdiction. Links to lookup table for ATO, IRS, HMRC, etc.
tin
 string(100)
Optional
Tax Identification Number for foreign tax jurisdictions.
titleID
 integer
Optional
Person's title reference (1=Mr, 2=Mrs, 3=Ms, 4=Dr, etc.). Used for formal correspondence and client communications.
addresses
> List<AddressDTO>...
Optional
Complete address collection for individual. Full replacement of existing addresses - include all addresses to retain. Residential address strongly recommended for compliance.
communications
> List<CommunicationDTO>...
Optional
Complete communication methods for individual. Full replacement of existing communications - include all methods to retain. Email communication recommended for investment operations.
PersonID
integer
The 7G system identifier for the person to update. Required for record identification and cannot be modified.
externalPersonId
string
Optional
Your external identifier. Can be updated if needed but must remain unique across your system. Use for dual-ID integration.
firstName
string
Optional
Given name as it appears on government-issued identification. Critical for identity verification and regulatory compliance.
middleName
string
Optional
Middle name or additional given names if applicable. Include for complete legal identity.
lastName
string
Family name as it appears on government-issued identification. Critical for identity verification and regulatory compliance.
description
string
Optional
Additional descriptive information about the person's role, background, or special circumstances relevant to investment services.
abn
string
Optional
11-digit Australian Business Number if person operates as sole trader. Required for business income tax reporting and GST obligations.
birthCountryCode
string
Optional
ISO 2-letter country code of birth country. Important for CRS/FATCA reporting and determining tax residency status.
crsfatcaParticipationID
integer
CRS/FATCA participation classification. Critical for international tax reporting and compliance with global tax information exchange agreements.
customerCode
string(50)
Optional
Customer reference code or number.
dateOfBirth
string (date)
Date of birth in YYYY-MM-DD format. Should not change unless correcting data entry errors. Critical for compliance and identity verification.
driversLicenseIssueCountryCode
string(2)
Country code of driver's license issuing authority.
driversLicenseNumber
string(20)
Optional
Driver's license number if applicable.
gender
string(1)
Optional
Gender code: M=Male, F=Female, X=Other/Not specified.
identificationTypeID
integer
Optional
Primary identification document type reference. Links to lookup table for passport, driver's license, national ID, etc. Critical for AML/KYC verification.
identificationValue
string(50)
Optional
Number or value of the identification document.
isDirectorOfCorporateTrustee
boolean
Optional
Indicates if person serves as director of corporate trustee for SMSF or managed investment schemes. Updates trigger enhanced compliance monitoring and fiduciary duty obligations.
isPEP
boolean
Optional
Politically Exposed Person classification for enhanced due diligence. Changes trigger compliance review and may require enhanced monitoring procedures.
isSophisticatedInvestor
boolean
Optional
Sophisticated investor status under Australian Corporations Act. Changes affect access to wholesale investment products and disclosure requirements.
isTrustee
boolean
Optional
Indicates if this person acts as a trustee for SMSF, family trust, or managed investment schemes. Updates trigger enhanced compliance monitoring and fiduciary responsibilities.
pepDescription
string(500)
Description of PEP status and role if applicable.
legalGuardianTitleID
integer
Title ID for legal guardian (required for minors). Links to lookup table for Mr, Mrs, Ms, Dr, etc.
legalGuardianFirstName
string(100)
Legal guardian's first name (required for minors).
legalGuardianMiddleName
string(100)
Optional
Legal guardian's middle name if applicable.
legalGuardianLastName
string(100)
Legal guardian's last name (required for minors).
passportIssueCountryCode
string(2)
Country code of passport issuing authority.
passportNumber
string(20)
Optional
Passport number if applicable.
salutation
string(50)
Optional
Name the person prefers to be called.
sharePercentage
short
Optional
Ownership percentage (0-100) for entities where applicable.
sophisticatedInvestorCertificateDate
string (date)
Certification date for sophisticated investor status in YYYY-MM-DD format. Updates must maintain currency for wholesale product access.
taxationCountryCode
string
Optional
Primary tax residency country (ISO 2-letter code). Changes determine main tax obligations and may trigger CRS/FATCA reporting updates.
taxationCountryCode2
string
Optional
Secondary tax residency country for dual tax residents. Changes trigger additional CRS/FATCA reporting obligations and compliance procedures.
taxationCountryCode3
string
Optional
Third tax residency country for complex multi-jurisdiction tax residents. Changes require enhanced CRS reporting and compliance monitoring.
taxationCountryTIN
string(50)
Optional
Tax Identification Number for primary tax residency country.
taxationCountryTIN2
string(50)
Optional
Tax Identification Number for secondary tax residency country.
taxationCountryTIN3
string(50)
Optional
Tax Identification Number for third tax residency country.
taxationCountryNoTINReason
string(200)
Optional
Reason for not having TIN in primary tax residency country.
taxationCountryNoTINReason2
string(200)
Optional
Reason for not having TIN in secondary tax residency country.
taxationCountryNoTINReason3
string(200)
Optional
Reason for not having TIN in third tax residency country.
taxationFileNumber
string
Australian Tax File Number (encrypted in storage). Changes may trigger ATO verification and compliance reviews.
tradingName
string(200)
Optional
Business or trading name if the person operates as a sole trader.
taxOfficeTypeID
integer
Optional
Tax authority type identifier for primary tax jurisdiction. Links to lookup table for ATO, IRS, HMRC, etc.
tin
string(100)
Optional
Tax Identification Number for foreign tax jurisdictions.
titleID
integer
Optional
Person's title reference (1=Mr, 2=Mrs, 3=Ms, 4=Dr, etc.). Used for formal correspondence and client communications.
addresses
> List<AddressDTO>...
Optional
Complete address collection for individual. Full replacement of existing addresses - include all addresses to retain. Residential address strongly recommended for compliance.
communications
> List<CommunicationDTO>...
Optional
Complete communication methods for individual. Full replacement of existing communications - include all methods to retain. Email communication recommended for investment operations.

Compliance Considerations

Certain changes may trigger compliance reviews:

  • Name Changes: May require marriage certificate, deed poll, or court order
  • Tax Residency: Changes to CRS/FATCA status trigger reporting obligations
  • Deceased Status: Initiates estate management procedures
  • Email Changes: Must be updated in communications array and requires verification for security

Example Requests

json
{
  "personID": 12345,
  "externalPersonId": "EXT-PERSON-001",
  "firstName": "John",
  "middleName": "William",
  "lastName": "Smith-Jones",
  "description": "Senior financial advisor and SMSF trustee - updated",
  "abn": "12345678901",
  "birthCountryCode": "AUS",
  "crsfatcaParticipationID": 1,
  "customerCode": "CUST-001-UPDATED",
  "dateOfBirth": "1975-03-15",
  "driversLicenseIssueCountryCode": "AUS",
  "driversLicenseNumber": "DL123456789",
  "gender": "M",
  "identificationTypeID": 1,
  "identificationValue": "DL123456789",
  "isDirectorOfCorporateTrustee": true,
  "isPEP": false,
  "isSophisticatedInvestor": true,
  "isTrustee": true,
  "pepDescription": null,
  "legalGuardianTitleID": null,
  "legalGuardianFirstName": null,
  "legalGuardianMiddleName": null,
  "legalGuardianLastName": null,
  "passportIssueCountryCode": "AUS",
  "passportNumber": "A12345678",
  "salutation": "John",
  "sharePercentage": 30,
  "sophisticatedInvestorCertificateDate": "2024-01-15",
  "taxationCountryCode": "AUS",
  "taxationCountryCode2": "US",
  "taxationCountryCode3": "GB",
  "taxationCountryTIN": "123456789",
  "taxationCountryTIN2": "US123456789",
  "taxationCountryTIN3": "GB123456789",
  "taxationCountryNoTINReason": null,
  "taxationCountryNoTINReason2": null,
  "taxationCountryNoTINReason3": null,
  "taxationFileNumber": "123456789",
  "tradingName": "Smith-Jones Consulting",
  "taxOfficeTypeID": 1,
  "tin": "US123456789",
  "titleID": 2,
  "addresses": [
    {
      "addressID": 456,
      "addressTypeID": 1,
      "aboveAddressLine": "456 New Street",
      "addressLine": "Unit 10",
      "suburb": "Melbourne",
      "postcode": "3000",
      "stateCode": "VIC",
      "countryCode": "AUS",
      "externalAddressId": null,
      "externalBizEntityId": null,
      "externalPersonId": "EXT-PERSON-001",
      "externalOrganisationId": null,
      "personID": 12345,
      "bizEntityID": 0,
      "organisationID": 0
    }
  ],
  "communications": [
    {
      "communicationID": 789,
      "externalCommunicationId": null,
      "communicationTypeID": 1,
      "name": "0412999888",
      "bizEntityID": 0,
      "externalBizEntityId": null,
      "personID": 12345,
      "externalPersonId": "EXT-PERSON-001",
      "organisationID": 0,
      "externalOrganisationId": null
    },
    {
      "communicationID": 790,
      "externalCommunicationId": null,
      "communicationTypeID": 2,
      "name": "john.smith-jones@example.com",
      "bizEntityID": 0,
      "externalBizEntityId": null,
      "personID": 12345,
      "externalPersonId": "EXT-PERSON-001",
      "organisationID": 0,
      "externalOrganisationId": null
    }
  ]
}

Response Examples

json
{
  "result": true,
  "message": "Person updated successfully",
  "recordCount": 1,
  "data": [
    {
      "personID": 12345,
      "externalPersonId": "EXT-PERSON-001",
      "firstName": "John",
      "middleName": "William",
      "lastName": "Smith-Jones",
      "description": "Senior financial advisor and SMSF trustee - updated",
      "abn": "12345678901",
      "birthCountryCode": "AUS",
      "crsfatcaParticipationID": 1,
      "customerCode": "CUST-001-UPDATED",
      "dateOfBirth": "1975-03-15",
      "driversLicenseIssueCountryCode": "AUS",
      "driversLicenseNumber": "DL123456789",
      "gender": "M",
      "identificationTypeID": 1,
      "identificationValue": "DL123456789",
      "isDirectorOfCorporateTrustee": true,
      "isPEP": false,
      "isSophisticatedInvestor": true,
      "isTrustee": true,
      "pepDescription": null,
      "legalGuardianTitleID": null,
      "legalGuardianFirstName": null,
      "legalGuardianMiddleName": null,
      "legalGuardianLastName": null,
      "passportIssueCountryCode": "AUS",
      "passportNumber": "A12345678",
      "salutation": "John",
      "sharePercentage": 30,
      "sophisticatedInvestorCertificateDate": "2024-01-15",
      "taxationCountryCode": "AUS",
      "taxationCountryCode2": "US",
      "taxationCountryCode3": "GB",
      "taxationCountryTIN": "***456789",
      "taxationCountryTIN2": "US***56789",
      "taxationCountryTIN3": "GB***56789",
      "taxationCountryNoTINReason": null,
      "taxationCountryNoTINReason2": null,
      "taxationCountryNoTINReason3": null,
      "taxationFileNumber": "***456789",
      "tradingName": "Smith-Jones Consulting",
      "taxOfficeTypeID": 1,
      "tin": "US***56789",
      "titleID": 2,
      "addresses": [
        {
          "addressID": 456,
          "addressTypeID": 1,
          "aboveAddressLine": "456 New Street",
          "addressLine": "Unit 10",
          "suburb": "Melbourne",
          "postcode": "3000",
          "stateCode": "VIC",
          "countryCode": "AUS",
          "externalAddressId": null,
          "externalBizEntityId": null,
          "externalPersonId": "EXT-PERSON-001",
          "externalOrganisationId": null,
          "personID": 12345,
          "bizEntityID": 0,
          "organisationID": 0
        }
      ],
      "communications": [
        {
          "communicationID": 789,
          "externalCommunicationId": null,
          "communicationTypeID": 1,
          "name": "0412999888",
          "bizEntityID": 0,
          "externalBizEntityId": null,
          "personID": 12345,
          "externalPersonId": "EXT-PERSON-001",
          "organisationID": 0,
          "externalOrganisationId": null
        },
        {
          "communicationID": 790,
          "externalCommunicationId": null,
          "communicationTypeID": 2,
          "name": "john.smith-jones@example.com",
          "bizEntityID": 0,
          "externalBizEntityId": null,
          "personID": 12345,
          "externalPersonId": "EXT-PERSON-001",
          "organisationID": 0,
          "externalOrganisationId": null
        }
      ]
    }
  ]
}
GET Get Persons POST Create Person DELETE Delete Person PUT Update Address PUT Update Communication