What Fields Are Available for API Submissions?
ISPolitical supports submissions of online donations and other data via a rest API using /basic access authentication/.
Submissions will return a success or failure and a unique ID per account.
For example:
{ "id":20, "success":true}
This is a list of possible fields to include in a submission:
Entity
- EntityType (Individual, Company, Political Committee, Labor Union, or Organization)
- FullName (FullName can be used instead of the name fields below if your form doesn’t support, or have, pre-parsed names. All organization types should use FullName)
- NamePrefix
- FirstName
- MiddleName
- LastName
- NameSuffix
- Nickname
- Occupation
- Employer
- AddressType
- Company
- Line1
- Line2
- City
- State
- ZipCode
- Notes
- Source (a page descriptor)
Source is included in the email that is sent and is logged for ISP developer review as needed. It has no impact on the client’s data.
Transaction
- TransactionType
- Amount
- FinancialAccount
- TransactionMethod
- BudgetCategory
- NoteForCompliance
- NoteForInternal
- RecurringFrequency — free-form text, generally monthly or one-time
- RecurringLength
- NameOnCard
- PartialCardNumber
- Company — this and the next few fields are for an optional second address for billing purposes
- Line1
- Line2
- City
- State
- ReportingCode — generally only used for expenses
-
UniqueIdentifier — not required but valuable in avoiding accidental duplication of transactions.
The ISP API supports the following transaction types:
- Monetary Contribution
- Expense
- Refunded Contribution
- Inkind Contribution
- Deposits (See our help file on deposits and the API.)
If not provided, transactions will be assumed to be Monetary Contributions.
Amounts should generally be sent via API as a positive number, including for expenses. If sent as a negative number, it will be interpreted as a reversal, such as a void or bounce.
Emails (optional/repeatable)
- EmailAddress
- OptIn (boolean)
ISP will automatically filter out known common fake email addresses during the import process. For example: noreply@noreply.com and test@test.com.
Phones (optional/repeatable)
- PhoneNumber
- Extension
- PhoneType
Addresses (optional/repeatable)
- AddressType
- Company
- Line1
- Line2
- City
- State
- ZipCode
Communications (optional/repeatable)
- CommunicationType
- Text
- Date (optional)
- Time (optional)
Communications submitted without a date will automatically use the date/time the communication was received in Pacific Time.
Flags (optional/repeatable)
- FlagName
Flags must be added into your ISP account before trying to submit them via our API.
Sources (optional/repeatable)
- Name
- Value
Sources do not get imported into entity records but can be used for marketing analytics through the API details report. Sources are completely ad-hoc and any values can be sent through. They are typically used for UTM parameters and similar needs.
PoliticalCommittee (optional)
This should only be used with Entity Type Political Committee
- CommitteeType (eg: Candidate Committee)
- IdNumber
- Jurisdiction (Federal, State, or Local)
- DateQualified
- EIN
- JurisdictionDescription (eg: Los Angeles)
- Party
- Controlled (true/false)
- Sponsored (true/false)
