API Reference

The account object

The account object represents an impact.com brand account, which is made up of attributes that describe the account (and your company). Some attributes may be empty if no information was provided.

Attributes

CompanyName string

Brand name for the account; usually the legal name of the company.

Website string

Official website URL for the brand or company.

PrimaryPhoneNumber string

Primary domestic contact number for the account.

PrimaryPhoneNumberCountry enum

Two-letter ISO 3166-1 alpha-2 country code representing the country of the primary phone number.

Timezone enum

Timezone used for the account. View supported timezones.

Currency currency

Three-letter ISO 4217 code representing the account's default currency appearing in the dashboard, finances, and reports.

RegisteredForIndirectTax boolean

Whether the account is registered for indirect tax, such as VAT, GST, or HST.

IndirectTaxNumber string

Unique identifier used for VAT, GST, or HST registration.

OrganizationType enum

Organization type for the account. Available options will vary depending on the country that the business is registered in.

Possible enum values
NONP_GOVNon-Profit/Government, United States
CORPC Corporation, United States
SOLE_INDIndividual/Sole Proprietor, United States
LLC_LLP_LLSLimited Liability Company / Limited Liability Partnership / S Corporation, United States
TRUSTTrust company, United States
SOLE_TRDSole Trader, Non-US
PARTNERSPartnership, Non-US
LLCLimited Liability Company, Non-US
LLPLimited Liability Partnership, Non-US
COMPANYCompany, Non-US
GOVERNMENTGovernment, Non-US
OTHEROther classification, All countries

EinSsnForeignTaxId string

Employer Identification Number for the account, or in some cases, the Social Security Number (SSN) of the company owner, or a Tax ID number for non-US companies.

CorporateAddress object

The primary address for the account.

View child attributes

AddressLine1 string

Address line 1 (address number, street name)

AddressLine2 string

Address line 2 (building, unit, suite, etc. number)

City string

City, district, suburb, town, or village

State string

State or territory

PostalCode string

ZIP or postal code

Country enum

Two-letter country code. See ISO 3166-1 alpha-2.

BillingAddress object

The billing address for the account.

View child attributes

AddressLine1 string

Address line 1 (address number, street name)

AddressLine2 string

Address line 2 (building, unit, suite, etc. number)

City string

City, district, suburb, town, or village

State string

State or territory

PostalCode string

ZIP or postal code

Country enum

Two-letter country code. See ISO 3166-1 alpha-2.

FinancialContact object

A financial contact for the account (e.g., CFO).

View child attributes

UserId string

Unique impact.com member account ID for the user.

Name string

The contact's full name.

Email string

The contact's email address.

WorkPhoneNumber string

Financial contact's work phone number.

WorkPhoneNumberCountry enum

Two-letter country code for the work phone number. See ISO 3166-1 alpha-2.

CellPhoneNumber string

Financial contact's cellphone number.

CellPhoneNumberCountry enum

Two-letter country code for the cell phone number. See ISO 3166-1 alpha-2.

Uri string

The unique reference to this object in the impact.com API.

More attributes

View more attributes

Industry object

The industry that the account most closely associates with.

View child attributes

IndustryId string

Unique identifier for the selected industry.

IndustryName enum

The display name for the selected industry.

SecondaryPhoneNumber string

A secondary domestic contact phone number for the account.

SecondaryPhoneNumberCountry enum

Two-letter country code See ISO 3166-1 alpha-2.

MinimumContactRating string

Minimum amount of star rating (1 lowest, 5 highest) a partner must have to see contact information for the account.

TechnicalContact object

A technical contact for the account (e.g., CTO).

View child attributes

UserId string

Unique impact.com member account ID for the user.

Name string

The contact's full name.

Email string

The contact's email address.

WorkPhoneNumber string

The contact's work phone number.

WorkPhoneNumberCountry enum

Two-letter country code. See ISO 3166-1 alpha-2.

CellPhoneNumber string

The contact's cell phone number.

CellPhoneNumberCountry enum

Two-letter country code. See ISO 3166-1 alpha-2.

SecurityContact object

This person is your company's point of contact for compliance and security policy matters. They handle security- and compliance-related issues for your business.

View child attributes

UserId string

Unique impact.com member account ID for the user.

Name string

The contact's full name.

Email string

The contact's email address.

WorkPhoneNumber string

The contact's work phone number.

WorkPhoneNumberCountry enum

Two-letter country code. See ISO 3166-1 alpha-2.

CellPhoneNumber string

The contact's cell phone number.

CellPhoneNumberCountry enum

Two-letter country code. See ISO 3166-1 alpha-2.

CommercialContact object

A commercial or marketing contact for the account (e.g., CMO).

View child attributes

UserId string

Unique impact.com member account ID for the user.

Name string

The contact's full name.

Email string

The contact's email address.

WorkPhoneNumber string

The contact's work phone number.

WorkPhoneNumberCountry enum

Two-letter country code.See ISO 3166-1 alpha-2.

CellPhoneNumber string

The contact's cell phone number.

CellPhoneNumberCountry enum

Two-letter country code. See ISO 3166-1 alpha-2.

{
  "CompanyName": "Acme Corporation",
  "Industry":   {
    "IndustryId": "",
    "IndustryName": ""
  },
  "Website": "https://www.example.com",
  "PrimaryPhoneNumber": "1235550100",
  "PrimaryPhoneNumberCountry": "US",
  "SecondaryPhoneNumber": "3215550100",
  "SecondaryPhoneNumberCountry": "US",
  "MinimumContactRating": "1",
  "Timezone": "(GMT -08:00) Pacific Time (US & Canada); Tijuana",
  "Currency": "USD",
  "RegisteredForIndirectTax": "false",
  "IndirectTaxNumber": "",
  "OrganizationType": "CORP",
  "EinSsnForeignTaxId": "XXX-XX-678",
  "CorporateAddress":   {
    "AddressLine1": "1640 Riverside Dr.",
    "AddressLine2": "",
    "City": "Hill Valley",
    "State": "CALIFORNIA",
    "PostalCode": "90210",
    "Country": "US"
  },
  "BillingAddress":   {
    "AddressLine1": "742 Evergreen Terrace",
    "AddressLine2": "",
    "City": "Boston",
    "State": "MA",
    "PostalCode": "01001",
    "Country": "US"
  },
  "FinancialContact":   {
    "UserId": "",
    "Name": "Road Runner",
    "Email": "[email protected]",
    "WorkPhoneNumber": "2065550100",
    "WorkPhoneNumberCountry": "US",
    "CellPhoneNumber": "",
    "CellPhoneNumberCountry": ""
  },
  "TechnicalContact":   {
    "UserId": "",
    "Name": "",
    "Email": "",
    "WorkPhoneNumber": "",
    "WorkPhoneNumberCountry": "",
    "CellPhoneNumber": "",
    "CellPhoneNumberCountry": ""
  },
  "CommercialContact":   {
    "UserId": "",
    "Name": "",
    "Email": "",
    "WorkPhoneNumber": "",
    "WorkPhoneNumberCountry": "",
    "CellPhoneNumber": "",
    "CellPhoneNumberCountry": ""
  },
  "Uri": "/Advertisers/<AccountSID>/CompanyInformation"
}

{
    "CompanyName": "Acme Corporation",
    "Industry": {
        "IndustryId": "",
        "IndustryName": ""
    },
    "Website": "www.example.com",
    "PrimaryPhoneNumber": "1235550100",
    "PrimaryPhoneNumberCountry": "US",
    "SecondaryPhoneNumber": "1237770100",
    "SecondaryPhoneNumberCountry": "US",
    "MinimumContactRating": "1",
    "Timezone": "(GMT -07:00) Pacific Time (US & Canada); Tijuana",
    "Currency": "USD",
    "RegisteredForIndirectTax": "false",
    "IndirectTaxNumber": "",
    "OrganizationType": "CORP",
    "EinSsnForeignTaxId": "XXXXX1234",
    "CorporateAddress": {
       "AddressLine1": "1640 Riverside Dr.",
   		 "AddressLine2": "",
	     "City": "Hill Valley",
		   "State": "CALIFORNIA",
	     "PostalCode": "90210",
 		   "Country": "US"
    },
    "BillingAddress": {
		    "AddressLine1": "112 1/2 Beacon St.",
		    "AddressLine2": "",
        "City": "Boston",
        "State": "MASSACHUSETTS",
        "PostalCode": "02116",
        "Country": "US"
    },
    "FinancialContact": {
        "UserId": "",
        "Name": "Olive Yew",
        "Email": "[email protected]",
        "WorkPhoneNumber": "",
        "WorkPhoneNumberCountry": "",
        "CellPhoneNumber": "",
        "CellPhoneNumberCountry": ""
    },
    "TechnicalContact": {
        "UserId": "",
        "Name": "Robin Banks",
        "Email": "[email protected]",
        "WorkPhoneNumber": "",
        "WorkPhoneNumberCountry": "",
        "CellPhoneNumber": "",
        "CellPhoneNumberCountry": ""
    },
    "SecurityContact": {
        "UserId": "",
        "Name": "Carrie Oakey",
        "Email": "[email protected]",
        "WorkPhoneNumber": "",
        "WorkPhoneNumberCountry": "",
        "CellPhoneNumber": "",
        "CellPhoneNumberCountry": ""
    },
    "CommercialContact": {
        "UserId": "",
        "Name": "Earl E. Bird",
        "Email": "[email protected]",
        "WorkPhoneNumber": "",
        "WorkPhoneNumberCountry": "",
        "CellPhoneNumber": "",
        "CellPhoneNumberCountry": ""
    },
    "Uri": "/Advertisers/<AccountSID>/CompanyInformation"
}