API Reference

The advertiser object

Attributes

Id integer

Unique identifier for the managed advertiser (or brand) account.

Name string

Name of the managed advertiser (or brand) account.

Description string

Brief overview describing the business of the managed advertiser ( or brand) account.

State enum

Current activity state of the managed advertiser (or brand) account.

Possible enum values
ACTIVEAccount is currently active with a live partner program.
PENDINGAccount is currently pending — typically indicates the account is still being onboarded.
INCOMPLETEAccount information is incomplete and blocking it from launching to a Pending or Active state.
DECLINEDAccount has been declined by impact.com — contact us via our support channel to learn more.
EXPIREDAccount has expired — contact us via our support channel to learn more.
DELINQUENTAccount has been marked as delinquent, usually for non-payment. Contact us via our support channel to learn more.

Website string

Listed website for the managed advertiser (or brand) account.

AddressLine1 string

First line of the listed address for the managed advertiser (or brand) account.

AddressLine2 string

Second line of the listed address for the managed advertiser (or brand) account.

City string

Listed city of the address for the managed advertiser (or brand) account.

CountryState string

If available, the listed country state for the managed advertiser (or brand) account.

PostalCode string

Listed postal code (i.e., ZIP Code) for the managed advertiser (or brand) account.

Country enum

Two-letter country code (specified in ISO 3166-1 alpha 2) for the managed advertiser (or brand) account.

IndirectTaxJurisidiction enum

If the advertiser (or brand) is registered for indirect tax, this is the two-letter country code (specified in ISO 3166-1 alpha 2) that they're registered in.

VatRegistered boolean

Returns true if the country specified in IndirectTaxJurisdiction levies a value-added tax that the managed advertiser (or brand) account is registered for, otherwise returns false.

OrganizationType enum

Organization type for the managed advertiser (or brand) 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

TaxId string

Typically used for US-based accounts, a unique identifier (e.g., an Employer Identification Number) for the managed advertiser (or brand) account.

IndirectTaxNumber string

Typically used for accounts outside of the US, a unique identifier used for VAT, GST, or HST registration for the managed advertiser (or brand) account.

Timezone enum

Listed time zone (specified in tz database name format) of the managed advertiser (or brand) account.

Currency currency

Three-letter ISO 4217 currency code of the managed advertiser (or brand) account default currency.

PhoneNumber integer

Listed phone number to contact the managed advertiser (or brand).

DateCreated datetime

Date and time (in ISO 8601 format) when the managed advertiser (or brand) account was created.

FinancialSetup enum

Specifies the financial setup of the managed advertiser (or brand) account.

Possible enum values
AGENCY_FUNDEDAccount is funded by your organization (i.e., you pay impact.com on behalf of the brand).
BILLED_BY_IRAccount is funded by the brand (i.e., impact.com bills the advertiser directly for their SaaS fees)
NO_RELATIONSHIPimpact.com has no established relationship on the financial setup of the managed advertiser (or _brand_) account.

AgencyOfRecord boolean

If true, you can purchase advertising space on behalf of the managed advertiser (or brand) account; otherwise false.

RestAccountURL string

Direct URL link to access the managed advertiser (or brand) account via the impact.com Brand API.

Uri string

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

{
  "Id": "987654",
  "Name": "Acme Partner Program",
  "Description": "Acme sells a wide variety of consumer goods.",
  "State": "ACTIVE",
  "Website": "https://www.example.com",
  "AddressLine1": "123 Quincy Street",
  "AddressLine2": "",
  "City": "Los Angeles",
  "CountryState": "CALIFORNIA",
  "PostalCode": "93305",
  "Country": "US",
  "IndirectTaxJurisdiction": "",
  "VatRegistered": "false",
  "OrganizationType": "CORP",
  "TaxId": "",
  "IndirectTaxNumber": "",
  "Timezone": "America/Los_Angeles",
  "Currency": "USD",
  "PhoneNumber": "8085550100",
  "DateCreated": "2021-03-31T17:56:23-07:00",
  "FinancialSetup": "BILLED_BY_IR",
  "AgencyOfRecord": "false",
  "RestAccountURL": "<AccountSID>:<AuthToken>>@api.impact.com/Advertisers/<AccountSID>",
  "Uri": "/Agencies/<AccountSID>/Advertisers/987654"
}