# Models

## The CompanyInformation object

```json
{"openapi":"3.1.0","info":{"title":"Company Information API","version":"16"},"components":{"schemas":{"CompanyInformation":{"type":"object","properties":{"CompanyName":{"type":"string","description":"The display name for your partner account."},"PrimaryPromotionalMethod":{"$ref":"#/components/schemas/PromotionalMethod","description":"Your primary promotional method, as specified in your account settings."},"PromotionalMethods":{"type":"string","description":"A comma-separated list of all promotional methods associated with your account."},"Website":{"type":"string","description":"The website URL listed on your partner profile."},"Description":{"type":"string","description":"A bio or description of your content and services, visible to brands on your profile."},"LogoImage":{"type":"string","description":"The path to your profile logo or photo."},"ContentAndInterests":{"type":"string","description":"A comma-separated list of tags describing your content categories and interests."},"PrimaryPhoneNumber":{"type":"string","description":"Your primary contact phone number."},"PrimaryPhoneNumberCountry":{"type":"string","description":"Two-letter ISO 3166-1 alpha-2 country code for your primary phone number."},"SecondaryPhoneNumber":{"type":"string","description":"A secondary contact phone number, if provided."},"SecondaryPhoneNumberCountry":{"type":"string","description":"Two-letter ISO 3166-1 alpha-2 country code for your secondary phone number."},"MinimumContactRating":{"type":"string","description":"The minimum star rating (1–5) a brand must have before you can see their contact information."},"Timezone":{"type":"string","description":"The timezone associated with your account."},"Currency":{"type":"string","description":"The three-letter ISO 4217 currency code for your account."},"RegisteredForIndirectTax":{"type":"boolean","description":"Whether your account is registered for indirect tax (e.g., VAT, GST, or HST)."},"IndirectTaxNumber":{"type":"string","description":"Your VAT, GST, or HST registration number, if applicable."},"OrganizationType":{"$ref":"#/components/schemas/OrganizationType","description":"The legal organization type for your account. Available options vary depending on the country your business is registered in."},"EinSsnForeignTaxId":{"type":"string","description":"Your Employer Identification Number (EIN), Social Security Number (SSN), or foreign tax ID."},"DateOfBirth":{"type":"string","format":"date-time","description":"Your date of birth."},"Gender":{"$ref":"#/components/schemas/Gender","description":"Your gender identity."},"Ethnicity":{"$ref":"#/components/schemas/Ethnicity","description":"Your ethnicity."},"ParentalStatus":{"$ref":"#/components/schemas/ParentalStatus","description":"Your parental status."},"RelationshipStatus":{"$ref":"#/components/schemas/RelationshipStatus","description":"Your relationship status."},"Education":{"$ref":"#/components/schemas/Education","description":"Your highest level of education."},"Pronouns":{"$ref":"#/components/schemas/Pronouns","description":"Your preferred pronouns."},"HouseholdIncome":{"$ref":"#/components/schemas/HouseholdIncome","description":"Your annual household income bracket."},"ShippingAddress":{"$ref":"#/components/schemas/Address","description":"Your shipping address."},"CorporateAddress":{"$ref":"#/components/schemas/Address","description":"The primary business address for your account."},"BillingAddress":{"$ref":"#/components/schemas/Address","description":"The billing address for your account."},"FinancialContact":{"$ref":"#/components/schemas/Contact","description":"The financial contact for your account (e.g., CFO). Cannot be updated via API — update this in the impact.com UI."},"TechnicalContact":{"$ref":"#/components/schemas/Contact","description":"The technical contact for your account (e.g., CTO). Cannot be updated via API — update this in the impact.com UI."},"SecurityContact":{"$ref":"#/components/schemas/Contact","description":"The security contact for your account."},"CommercialContact":{"$ref":"#/components/schemas/Contact","description":"The commercial or marketing contact for your account (e.g., CMO). Cannot be updated via API — update this in the impact.com UI."},"Uri":{"type":"string","description":"Unique reference to the company information object in the impact.com API."}}},"PromotionalMethod":{"type":"string","description":"A promotional method used to drive traffic and conversions.","enum":["EMAIL","SEARCH","LOYALTY","COUPON","SYNDICATION_BLOG_NETWORKS","CPA_NETWORK","MOBILE","CONTENT","SHOPPING","SOCIAL_MEDIA_INFLUENCER","SERVICE_PROVIDER","CONSUMER_SOFTWARE","INCENTIVIZED","OFFLINE","OTHER","CASHBACK"]},"OrganizationType":{"type":"string","description":"The legal structure of the organization. Available options vary depending on the country the business is registered in.","enum":["NONP_GOV","CORP","SOLE_IND","LLC_LLP_LLS","TRUST","SOLE_TRD","PARTNERS","LLC","LLP","COMPANY","GOVERNMENT","OTHER"]},"Gender":{"type":"string","description":"The gender identity of the partner.","enum":["Female","Male","Transgender","Non-binary","Genderqueer","None"]},"Ethnicity":{"type":"string","description":"The ethnic background of the partner.","enum":["African_American","American_Indian","Asian","Black","Hispanic","Latino","Middle_Eastern","Multiracial","Native_Hawaiian","Pacific_Islander","South_Asian","White","Other","None"]},"ParentalStatus":{"type":"string","description":"The parental status of the partner.","enum":["Mom","Dad","Grandfather","Grandmother","Other","None"]},"RelationshipStatus":{"type":"string","description":"The relationship status of the partner.","enum":["Married","Not_Married","Separated","Widowed","Divorced","None"]},"Education":{"type":"string","description":"The highest level of education completed.","enum":["Bachelors_Degree","PhD","Masters_Degree","High_School","Some_high_school","Some_college","Other","None"]},"Pronouns":{"type":"string","description":"The preferred pronouns of the partner.","enum":["he_him","she_her","they_them","ey_em","ne_nem","ve_ver","xe_xem","xie_xem","ze_zir","None"]},"HouseholdIncome":{"type":"string","description":"The annual household income bracket of the partner.","enum":["35K","Over_35K","Over_50K","Over_75K","Over_100K","None"]},"Address":{"type":"object","properties":{"AddressLine1":{"type":"string","description":"The first line of the address (street number and name)."},"AddressLine2":{"type":"string","description":"The second line of the address (apartment, suite, unit, etc.)."},"City":{"type":"string","description":"The city, district, suburb, town, or village."},"State":{"type":"string","description":"The state, province, or territory."},"PostalCode":{"type":"string","description":"The ZIP or postal code."},"Country":{"type":"string","description":"Two-letter ISO 3166-1 alpha-2 country code."}}},"Contact":{"type":"object","properties":{"UserId":{"type":"string","description":"The unique impact.com user ID for this contact."},"Name":{"type":"string","description":"The full name of the contact."},"Email":{"type":"string","description":"The email address of the contact."},"WorkPhoneNumber":{"type":"string","description":"The work phone number of the contact."},"WorkPhoneNumberCountry":{"type":"string","description":"Two-letter ISO 3166-1 alpha-2 country code for the work phone number."},"CellPhoneNumber":{"type":"string","description":"The cell phone number of the contact."},"CellPhoneNumberCountry":{"type":"string","description":"Two-letter ISO 3166-1 alpha-2 country code for the cell phone number."}}}}}}
```

## The Address object

```json
{"openapi":"3.1.0","info":{"title":"Company Information API","version":"16"},"components":{"schemas":{"Address":{"type":"object","properties":{"AddressLine1":{"type":"string","description":"The first line of the address (street number and name)."},"AddressLine2":{"type":"string","description":"The second line of the address (apartment, suite, unit, etc.)."},"City":{"type":"string","description":"The city, district, suburb, town, or village."},"State":{"type":"string","description":"The state, province, or territory."},"PostalCode":{"type":"string","description":"The ZIP or postal code."},"Country":{"type":"string","description":"Two-letter ISO 3166-1 alpha-2 country code."}}}}}}
```

## The Contact object

```json
{"openapi":"3.1.0","info":{"title":"Company Information API","version":"16"},"components":{"schemas":{"Contact":{"type":"object","properties":{"UserId":{"type":"string","description":"The unique impact.com user ID for this contact."},"Name":{"type":"string","description":"The full name of the contact."},"Email":{"type":"string","description":"The email address of the contact."},"WorkPhoneNumber":{"type":"string","description":"The work phone number of the contact."},"WorkPhoneNumberCountry":{"type":"string","description":"Two-letter ISO 3166-1 alpha-2 country code for the work phone number."},"CellPhoneNumber":{"type":"string","description":"The cell phone number of the contact."},"CellPhoneNumberCountry":{"type":"string","description":"Two-letter ISO 3166-1 alpha-2 country code for the cell phone number."}}}}}}
```

## The PromotionalMethod object

```json
{"openapi":"3.1.0","info":{"title":"Company Information API","version":"16"},"components":{"schemas":{"PromotionalMethod":{"type":"string","description":"A promotional method used to drive traffic and conversions.","enum":["EMAIL","SEARCH","LOYALTY","COUPON","SYNDICATION_BLOG_NETWORKS","CPA_NETWORK","MOBILE","CONTENT","SHOPPING","SOCIAL_MEDIA_INFLUENCER","SERVICE_PROVIDER","CONSUMER_SOFTWARE","INCENTIVIZED","OFFLINE","OTHER","CASHBACK"]}}}}
```

## The OrganizationType object

```json
{"openapi":"3.1.0","info":{"title":"Company Information API","version":"16"},"components":{"schemas":{"OrganizationType":{"type":"string","description":"The legal structure of the organization. Available options vary depending on the country the business is registered in.","enum":["NONP_GOV","CORP","SOLE_IND","LLC_LLP_LLS","TRUST","SOLE_TRD","PARTNERS","LLC","LLP","COMPANY","GOVERNMENT","OTHER"]}}}}
```

## The Education object

```json
{"openapi":"3.1.0","info":{"title":"Company Information API","version":"16"},"components":{"schemas":{"Education":{"type":"string","description":"The highest level of education completed.","enum":["Bachelors_Degree","PhD","Masters_Degree","High_School","Some_high_school","Some_college","Other","None"]}}}}
```

## The Ethnicity object

```json
{"openapi":"3.1.0","info":{"title":"Company Information API","version":"16"},"components":{"schemas":{"Ethnicity":{"type":"string","description":"The ethnic background of the partner.","enum":["African_American","American_Indian","Asian","Black","Hispanic","Latino","Middle_Eastern","Multiracial","Native_Hawaiian","Pacific_Islander","South_Asian","White","Other","None"]}}}}
```

## The Gender object

```json
{"openapi":"3.1.0","info":{"title":"Company Information API","version":"16"},"components":{"schemas":{"Gender":{"type":"string","description":"The gender identity of the partner.","enum":["Female","Male","Transgender","Non-binary","Genderqueer","None"]}}}}
```

## The HouseholdIncome object

```json
{"openapi":"3.1.0","info":{"title":"Company Information API","version":"16"},"components":{"schemas":{"HouseholdIncome":{"type":"string","description":"The annual household income bracket of the partner.","enum":["35K","Over_35K","Over_50K","Over_75K","Over_100K","None"]}}}}
```

## The ParentalStatus object

```json
{"openapi":"3.1.0","info":{"title":"Company Information API","version":"16"},"components":{"schemas":{"ParentalStatus":{"type":"string","description":"The parental status of the partner.","enum":["Mom","Dad","Grandfather","Grandmother","Other","None"]}}}}
```

## The Pronouns object

```json
{"openapi":"3.1.0","info":{"title":"Company Information API","version":"16"},"components":{"schemas":{"Pronouns":{"type":"string","description":"The preferred pronouns of the partner.","enum":["he_him","she_her","they_them","ey_em","ne_nem","ve_ver","xe_xem","xie_xem","ze_zir","None"]}}}}
```

## The RelationshipStatus object

```json
{"openapi":"3.1.0","info":{"title":"Company Information API","version":"16"},"components":{"schemas":{"RelationshipStatus":{"type":"string","description":"The relationship status of the partner.","enum":["Married","Not_Married","Separated","Widowed","Divorced","None"]}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://integrations.impact.com/partner-api-reference/reference/accounts/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
