Global

<b>BETA:</b> Returns an identity

get/sites/{site-identifier}/global/identities/{identity-identifier}

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/global/identities/{identity-identifier}
  • Auth: OAuth 2 (authorization code, authorization URL https://api.supermate.com.au/oauth/v1/authorize, token URL https://api.supermate.com.au/oauth/v1/token, scopes: actuarial_write, audit_read, audit_write, client_access_grant, contactevents_read, contactevents_write, default, documents_read, documents_write, fund:investments_read, fund:members_read, fund:members_write, fund:transactions_read, fund:transactions_write, fund_read, fund_write, security:domains_write, security:policies_write, security:users_invite, site:accounting-notes_write, site:asset-categories_write, site:auditor_write, site:branding_write, site:datafeed-config_write, site:identity_write, site:letters_write, site:policies_write, site:reporting_write, sites_read, superstream:config_write)

Path parameters

site-identifierstring required

The GUID that identifies a site

identity-identifierstring required

The GUID that identifies an identity

Response

Success

IdentityGUIDstring
Codestring
Namestring
ABNstring
ACNstring
TaxAgentNumberstring
ASICAgentNumberstring
TaxReturnSoftwarestring
USIstring
IncorporationDatestring date
CompanyTypestring
DeregistrationDatestring date

Example response

{
  "CompanyType": "Special Purpose Company",
  "RoleType": [
    "TAX_AGENT",
    "ADMINISTRATOR",
    "ASIC_REGISTERED_AGENT"
  ],
  "Contact": {
    "Title": "Miss",
    "GivenNames": "Emily",
    "Surname": "Taylor",
    "Salutation": "Dear",
    "EmailAddress1": "emilytaylor@gmail.com"
  },
  "Address": {
    "StreetAddress": {
      "StreetName": "Elizabeth",
      "StreetType": "STREET",
      "Suburb": "BRISBANE CITY",
      "State": "QLD",
      "Country": "Australia"
    },
    "PostalAddress": {
      "Line1": "LOCKED BAG 13101",
      "Suburb": "Archerfield",
      "State": "QLD",
      "Country": "Australia"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.