Account contacts

Masking the taxID field

The AccountContact resource has a taxID field which stores the tax ID of the contact. In the Cloud API base configuration, this field is masked in responses so that only the last four digits appear. For example, the following is the response for a GET that retrieves a contact.

{
    "data": {
        "attributes": {
            "displayName": "Ray Newton",
            "taxId": "***-**-6789"
        }
    }
}

For some callers, such as internal or external users, the masking of tax ID may be appropriate as it protects personally identifiable information. For other callers, such as services, this masking may cause a problem as the callers may reference contacts internally using the tax ID.

There are two ways that the taxId field can be unmasked:

• You can configure the field so that it is always unmasked. For information on how to configure this, see the Cloud API Developer Guide.
• You can grant the caller the restunmasktaxid system permission. Any caller who has a role with this permission will get responses with unmasked tax IDs. For information on how to configure this, see the section on API role special permissions in the Cloud API Developer Guide.

Minimum creation criteria

You must specify the following information:

• contactSubtype (typically set to either Person or Company)
• firstName and lastName (for Person contacts)
• companyName (for Company contacts)
• primaryAddress, with at least:
  • addressLine1
  • city
  • state
  • postalCode

For example, the following request creates a new contact for account pc:202.

POST /account/v1/accounts/pc:202/contacts

{
  "data": {
    "attributes": {
        "contactSubtype": "Person",
        "firstName": "Samantha",
        "lastName": "Stewart",
        "primaryAddress": {
          "addressLine1": "2850 S. Delaware St.",
          "city": "San Mateo",
          "postalCode": "94403",
          "state": {
            "code": "CA"
          }
        }
    }
  }
}