GET

/Communication

When to Use

Pre-Distribution Validation: Verify investor email addresses before distribution notifications to prevent bounce-backs
Compliance Audit Trail: Retrieve communication history for CRS/FATCA reporting and AML/KYC documentation
External System Synchronization: Look up communications using ExternalCommunicationId for CRM integration and contact management
Transaction Notification Setup: Verify phone numbers before SMS-based transaction confirmations
Contact Information Verification: Validate communication methods before regulatory correspondence

Common Scenarios

Single Record Lookup: Use CommunicationID for direct access to a specific communication record
External Integration: Use ExternalCommunicationId when synchronizing with external systems
Contact Verification: Retrieve communication details to validate contact information before sending messages
Audit Trail: Access communication record details for compliance and audit purposes

Prerequisites

Valid Bearer token with communication read permissions
Either CommunicationID or ExternalCommunicationId to identify the record
Understanding of communication types: 1=Email, 2=Phone, 3=Mobile, 4=Fax

Considerations

Single Record Only: This endpoint retrieves one communication record at a time
Exclusive Ownership: Each communication record can belong to ONE BizEntity, Person, or Organisation (not multiple)
Native IDs (CommunicationID) provide better performance than external IDs
Communication records cannot be shared between different entities

Description

Retrieves a single communication record by its unique identifier. Returns complete communication information including type classification, contact value (email, phone, etc.), and the entity it belongs to.

Advanced Resource: Communication records are typically created and managed through BizEntity operations, but can be accessed independently via this endpoint for verification, synchronization, or compliance notification purposes.

Communication Classification

Communication types determine validation rules and uniqueness constraints:

Email Addresses: Must be globally unique, validated for RFC 5322 format
Phone Numbers: Support international formats with country codes (e.g., +61)
Mobile Numbers: Preferred for two-factor authentication and urgent notifications
Fax Numbers: Legacy support for regulatory document delivery

Refer to Common/Lookup endpoint (Category: CommunicationType) for current type classifications.

Entity Relationships

A communication record will belong to exactly one of the following:

BizEntity (via BizEntityID)
Person (via PersonID)
Organisation (via OrganisationID)

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
`CommunicationID` >	integer	> Conditional...	The unique system identifier for the communication record. Provide this to retrieve a specific communication by its internal ID.
`ExternalCommunicationId` >	string	> Conditional...	The external system identifier for the communication record. Use this when integrating with external systems that maintain their own ID references.

CommunicationID

integer

> Conditional...

The unique system identifier for the communication record. Provide this to retrieve a specific communication by its internal ID.

ExternalCommunicationId

string

> Conditional...

The external system identifier for the communication record. Use this when integrating with external systems that maintain their own ID references.

Example Requests

bash

# Get a communication record by internal ID
curl -X GET https://api.7g.com.au/Communication?CommunicationID=12345 \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

# Get a communication record by external ID
curl -X GET "https://api.7g.com.au/Communication?ExternalCommunicationId=EXT-COMM-001" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

Response Examples

json

{
  "result": true,
  "message": null,
  "recordCount": 1,
  "data": {
    "communicationID": 12345,
    "externalCommunicationId": "EXT-COMM-001",
    "communicationTypeID": 1,
    "name": "john.smith@example.com",
    "bizEntityID": 789,
    "externalBizEntityId": "EXT-BIZ-456",
    "personID": null,
    "externalPersonId": null,
    "organisationID": null,
    "externalOrganisationId": null
  }
}