v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Contacts
Get a contact

Retrieves a specified contact.
get/contacts/{id}
Path parameters

idstring uuid required
Response

When request is successful. Returns a 'Contact' object.
hrefstring nullable
relationstring nullable
methodstring nullable
idstring nullable
Unique identifier of the contact.
externalSystemIdstring nullable
External system id for the contact.
versionIdstring nullable
Version id of the record.
isDeletedboolean
Returns true if the contact is deleted.
lastUpdatedinteger
Last updated timestamp.
Example response

{
  "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "externalSystemId": "EXT01",
  "versionId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "person": {
    "title": "Mr",
    "firstName": "John",
    "middleName": "Michael",
    "lastName": "Smith",
    "nameSuffix": "PhD",
    "customName": "Johnny",
    "residentialAddress": {
      "careOf": "John Smith",
      "buildingLevel": "Level 1",
      "unitNumber": "10",
      "unitType": "Suite",
      "streetNumber": "100",
      "streetName": "Broad",
      "streetType": "Street",
      "addressLine1": "Level 1/10",
      "addressLine2": "100 Broad Street",
      "city": "Chicago",
      "state": "IL",
      "zipCode": "60606",
      "locality": "Dunkirk",
      "county": "New York",
      "country": "United States",
      "poBox": {
        "careOf": "John Smith",
        "poBoxType": "Locked Bag",
        "poBoxNumber": "12345",
        "city": "Chicago",
        "state": "IL",
        "zipCode": "60606"
      }
    },
    "mailingAddress": {
      "careOf": "John Smith",
      "buildingLevel": "Level 1",
      "unitNumber": "10",
      "unitType": "Suite",
      "streetNumber": "100",
      "streetName": "Broad",
      "streetType": "Street",
      "addressLine1": "Level 1/10",
      "addressLine2": "100 Broad Street",
      "city": "Chicago",
      "state": "IL",
      "zipCode": "60606",
      "locality": "Dunkirk",
      "county": "New York",
      "country": "United States",
      "poBox": {
        "careOf": "John Smith",
        "poBoxType": "Locked Bag",
        "poBoxNumber": "12345",
        "city": "Chicago",
        "state": "IL",
        "zipCode": "60606"
      }
    },
    "phone": {
      "areaCode": "555",
      "number": "1234567"
    },
    "phone2": {
      "areaCode": "555",
      "number": "1234567",
      "extension": "103"
    },
    "fax": {
      "areaCode": "555",
      "number": "1234567"
    },
    "cell": {
      "areaCode": "555",
      "number": "1234567"
    },
    "email": "john.smith@brown.com",
    "notes": "Prefers to answer work phone.",
    "occupation": "Bookkeeper",
    "gender": "Male",
    "maritalStatus": "Single",
    "specialNeeds": "Wheelchair access",
    "birthDate": "1980-07-01",
    "birthPlace": "Chicago",
    "birthState": "Illinois",
    "birthCountry": "USA",
    "identificationNumberType": "Passport",
    "identificationNumber": "PP123456789",
    "birthFirstName": "James",
    "birthMiddleName": "Thomas",
    "birthLastName": "Jones",
    "previousNames": "Jane Smith",
    "passportDetails": {
      "passportNumber": "AB123456",
      "passportIssueDate": "2010-08-01",
      "passportExpireDate": "2030-08-01",
      "passportIssueCountry": "USA",
      "passportIssueAuthority": "HM Passport Office"
    },
    "deathDetails": {
      "deathDate": "2020-08-01",
      "deathDateFrom": "2020-08-01",
      "deathDateTo": "2020-08-01",
      "deathPlace": "Chicago",
      "deathState": "IL",
      "deathCountry": "USA",
      "deathCounty": "San Bernardino County"
    },
    "citizenshipDetails": {
      "countryOfCitizenship": "USA",
      "nationality": "American",
      "languageOfInterpreter": "French"
    },
    "executionOptions": {
      "poaType": "Enduring",
      "poaDate": "2023-05-15",
      "attorneyName": "Jane Doe",
      "address": {
        "careOf": "John Smith",
        "buildingLevel": "Level 1",
        "unitNumber": "10",
        "unitType": "Suite",
        "streetNumber": "100",
        "streetName": "Broad",
        "streetType": "Street",
        "addressLine1": "Level 1/10",
        "addressLine2": "100 Broad Street",
        "city": "Chicago",
        "state": "IL",
        "zipCode": "60606",
        "locality": "Dunkirk",
        "county": "New York",
        "country": "United States",
        "poBox": {
          "careOf": "John Smith",
          "poBoxType": "Locked Bag",
          "poBoxNumber": "12345",
          "city": "Chicago",
          "state": "IL",
          "zipCode": "60606"
        }
      },
      "executionType": "PowerOfAttorney",
      "poaVoiDetails": {
        "isCompleted": true,
        "completedDateTime": "2024-01-15T10:30:00Z",
        "reference": "12345678",
        "source": "InfoTrackID",
        "status": "Complete"
      }
    },
    "voiDetails": {
      "isCompleted": true,
      "completedDateTime": "2024-01-15T10:30:00Z",
      "reference": "12345678",
      "source": "InfoTrackID",
      "status": "Complete"
    }
  },
  "company": {
    "name": "Brown LLC",
    "type": "Corporation",
    "phone": {
      "areaCode": "555",
      "number": "1234567"
    },
    "fax": {
      "areaCode": "555",
      "number": "1234567"
    },
    "email": "contact@brown.com",
    "website": "https://www.brownllc.com",
    "notes": "Construction company",
    "abn": "1234567890",
    "registeredAddress": {
      "careOf": "John Smith",
      "buildingLevel": "Level 1",
      "unitNumber": "10",
      "unitType": "Suite",
      "streetNumber": "100",
      "streetName": "Broad",
      "streetType": "Street",
      "addressLine1": "Level 1/10",
      "addressLine2": "100 Broad Street",
      "city": "Chicago",
      "state": "IL",
      "zipCode": "60606",
      "locality": "Dunkirk",
      "county": "New York",
      "country": "United States",
      "poBox": {
        "careOf": "John Smith",
        "poBoxType": "Locked Bag",
        "poBoxNumber": "12345",
        "city": "Chicago",
        "state": "IL",
        "zipCode": "60606"
      }
    },
    "companyNumberType": "ACN",
    "companyNumber": "234567890",
    "doingBusinessAsName": "Brown Holdings",
    "tradingAs": "Trading As",
    "tradingName": "Brown Trading Co",
    "mailingAddress": {
      "careOf": "John Smith",
      "buildingLevel": "Level 1",
      "unitNumber": "10",
      "unitType": "Suite",
      "streetNumber": "100",
      "streetName": "Broad",
      "streetType": "Street",
      "addressLine1": "Level 1/10",
      "addressLine2": "100 Broad Street",
      "city": "Chicago",
      "state": "IL",
      "zipCode": "60606",
      "locality": "Dunkirk",
      "county": "New York",
      "country": "United States",
      "poBox": {
        "careOf": "John Smith",
        "poBoxType": "Locked Bag",
        "poBoxNumber": "12345",
        "city": "Chicago",
        "state": "IL",
        "zipCode": "60606"
      }
    },
    "businessAddress": {
      "careOf": "John Smith",
      "buildingLevel": "Level 1",
      "unitNumber": "10",
      "unitType": "Suite",
      "streetNumber": "100",
      "streetName": "Broad",
      "streetType": "Street",
      "addressLine1": "Level 1/10",
      "addressLine2": "100 Broad Street",
      "city": "Chicago",
      "state": "IL",
      "zipCode": "60606",
      "locality": "Dunkirk",
      "county": "New York",
      "country": "United States",
      "poBox": {
        "careOf": "John Smith",
        "poBoxType": "Locked Bag",
        "poBoxNumber": "12345",
        "city": "Chicago",
        "state": "IL",
        "zipCode": "60606"
      },
      "dxAddress": {
        "number": "376",
        "exchange": "DX",
        "state": "NSW"
      }
    },
    "executionOptions": {
      "person1": {
        "name": "John Smith",
        "address": {
          "careOf": "John Smith",
          "buildingLevel": "Level 1",
          "unitNumber": "10",
          "unitType": "Suite",
          "streetNumber": "100",
          "streetName": "Broad",
          "streetType": "Street",
          "addressLine1": "Level 1/10",
          "addressLine2": "100 Broad Street",
          "city": "Chicago",
          "state": "IL",
          "zipCode": "60606",
          "locality": "Dunkirk",
          "county": "New York",
          "country": "United States",
          "poBox": {
            "careOf": "John Smith",
            "poBoxType": "Locked Bag",
            "poBoxNumber": "12345",
            "city": "Chicago",
            "state": "IL",
            "zipCode": "60606"
          }
        },
        "personType": "Director",
        "selectedOfficeHeld": "Director",
        "voiDetails": {
          "isCompleted": true,
          "completedDateTime": "2024-01-15T10:30:00Z",
          "reference": "12345678",
          "source": "InfoTrackID",
          "status": "Complete"
        }
      },
      "person2": {
        "name": "John Smith",
        "address": {
          "careOf": "John Smith",
          "buildingLevel": "Level 1",
          "unitNumber": "10",
          "unitType": "Suite",
          "streetNumber": "100",
          "streetName": "Broad",
          "streetType": "Street",
          "addressLine1": "Level 1/10",
          "addressLine2": "100 Broad Street",
          "city": "Chicago",
          "state": "IL",
          "zipCode": "60606",
          "locality": "Dunkirk",
          "county": "New York",
          "country": "United States",
          "poBox": {
            "careOf": "John Smith",
            "poBoxType": "Locked Bag",
            "poBoxNumber": "12345",
            "city": "Chicago",
            "state": "IL",
            "zipCode": "60606"
          }
        },
        "personType": "Director",
        "selectedOfficeHeld": "Director",
        "voiDetails": {
          "isCompleted": true,
          "completedDateTime": "2024-01-15T10:30:00Z",
          "reference": "12345678",
          "source": "InfoTrackID",
          "status": "Complete"
        }
      },
      "sealType": "WithSeal",
      "executionType": "JointDirectors"
    }
  },
  "trust": {
    "name": "Trinity Trust",
    "status": "as Trustee of",
    "trustNumber": "12345678",
    "executedDate": "1980-07-01",
    "phone": {
      "areaCode": "555",
      "number": "1234567"
    },
    "fax": {
      "areaCode": "555",
      "number": "1234567"
    },
    "address": {
      "careOf": "John Smith",
      "buildingLevel": "Level 1",
      "unitNumber": "10",
      "unitType": "Suite",
      "streetNumber": "100",
      "streetName": "Broad",
      "streetType": "Street",
      "addressLine1": "Level 1/10",
      "addressLine2": "100 Broad Street",
      "city": "Chicago",
      "state": "IL",
      "zipCode": "60606",
      "locality": "Dunkirk",
      "county": "New York",
      "country": "United States",
      "poBox": {
        "careOf": "John Smith",
        "poBoxType": "Locked Bag",
        "poBoxNumber": "12345",
        "city": "Chicago",
        "state": "IL",
        "zipCode": "60606"
      }
    },
    "trustees": [
      {
        "Name": "John Smith",
        "Type": "Individual"
      },
      {
        "Name": "Smithfield Steel",
        "Type": "Company"
      }
    ]
  },
  "groupOfPeople": {
    "residentialAddress": {
      "careOf": "John Smith",
      "buildingLevel": "Level 1",
      "unitNumber": "10",
      "unitType": "Suite",
      "streetNumber": "100",
      "streetName": "Broad",
      "streetType": "Street",
      "addressLine1": "Level 1/10",
      "addressLine2": "100 Broad Street",
      "city": "Chicago",
      "state": "IL",
      "zipCode": "60606",
      "locality": "Dunkirk",
      "county": "New York",
      "country": "United States",
      "poBox": {
        "careOf": "John Smith",
        "poBoxType": "Locked Bag",
        "poBoxNumber": "12345",
        "city": "Chicago",
        "state": "IL",
        "zipCode": "60606"
      }
    },
    "mailingAddress": {
      "careOf": "John Smith",
      "buildingLevel": "Level 1",
      "unitNumber": "10",
      "unitType": "Suite",
      "streetNumber": "100",
      "streetName": "Broad",
      "streetType": "Street",
      "addressLine1": "Level 1/10",
      "addressLine2": "100 Broad Street",
      "city": "Chicago",
      "state": "IL",
      "zipCode": "60606",
      "locality": "Dunkirk",
      "county": "New York",
      "country": "United States",
      "poBox": {
        "careOf": "John Smith",
        "poBoxType": "Locked Bag",
        "poBoxNumber": "12345",
        "city": "Chicago",
        "state": "IL",
        "zipCode": "60606"
      }
    },
    "name": "John Smith & Jane Citizen"
  },
  "isDeleted": true,
  "lastUpdated": 637847425252027400,
  "tags": [
    {
      "type": "Custom"
    }
  ]
}