GET
/person
Usage Notes
When
- Retrieve person by personID or externalPersonId
- Verify person details before transaction processing or entity updates
- Access person data for cross-entity relationship queries
Requirements
- PersonID or ExternalPersonId to identify the record
Notes
- Returns complete person data with nested addresses and communications arrays
- PersonID provides faster lookup than ExternalPersonId
- Tax File Numbers returned in masked format (***456789)
Description
Retrieves a person record with all identity fields, nested addresses, and communications. Supports lookup by native personID or externalPersonId for cross-system queries.
Required Headers - See Authentication
| Header | Value | Description |
|---|---|---|
| Authorization | {accessToken} | Bearer token for API access |
| Version | 2.0 | API version identifier |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
PersonID |
integer | The 7G system identifier for the person to retrieve. Preferred for performance and direct system lookup. | |
ExternalPersonId |
string | Your external identifier for the person to retrieve. Use when you cannot store 7G's native PersonID. |
PersonID
The 7G system identifier for the person to retrieve. Preferred for performance and direct system lookup.
ExternalPersonId
Your external identifier for the person to retrieve. Use when you cannot store 7G's native PersonID.
Example Requests
bash
# Get person by PersonID (recommended for performance)
curl -X GET "https://api.7g.com.au/person?PersonID=12345" \
-H "Authorization: {accessToken}" \
-H "Version: 2.0"
# Get person by ExternalPersonId (for external system integration)
curl -X GET "https://api.7g.com.au/person?ExternalPersonId=EXT-PERSON-001" \
-H "Authorization: {accessToken}" \
-H "Version: 2.0"Response Examples
json
{
"result": true,
"message": null,
"recordCount": 1,
"data": [
{
"personID": 12345,
"externalPersonId": "EXT-PERSON-001",
"firstName": "John",
"middleName": "William",
"lastName": "Smith",
"description": "Senior financial advisor and trustee",
"abn": "12345678901",
"birthCountryCode": "AUS",
"crsfatcaParticipationID": 1,
"customerCode": "CUST-001",
"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": 25,
"sophisticatedInvestorCertificateDate": "2024-01-15",
"taxationCountryCode": "AUS",
"taxationCountryCode2": "US",
"taxationCountryCode3": null,
"taxationCountryTIN": "***456789",
"taxationCountryTIN2": "US***56789",
"taxationCountryTIN3": null,
"taxationCountryNoTINReason": null,
"taxationCountryNoTINReason2": null,
"taxationCountryNoTINReason3": null,
"taxationFileNumber": "***456789",
"tradingName": "Smith Consulting",
"taxOfficeTypeID": 1,
"tin": "US***56789",
"titleID": 1,
"addresses": [
{
"addressID": 456,
"addressTypeID": 1,
"aboveAddressLine": "123 Main Street",
"addressLine": null,
"suburb": "Sydney",
"postcode": "2000",
"stateCode": "NSW",
"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": "0412345678",
"bizEntityID": 0,
"externalBizEntityId": null,
"personID": 12345,
"externalPersonId": "EXT-PERSON-001",
"organisationID": 0,
"externalOrganisationId": null
},
{
"communicationID": 790,
"externalCommunicationId": null,
"communicationTypeID": 2,
"name": "john.smith@example.com",
"bizEntityID": 0,
"externalBizEntityId": null,
"personID": 12345,
"externalPersonId": "EXT-PERSON-001",
"organisationID": 0,
"externalOrganisationId": null
}
]
}
]
}