What Fields Are Available for Isp’s 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 (Company or Individual)
  • FullName (FullName can be used instead of the name fields below if your form doesn’t support, or have, pre-parsed names)
  • 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 clients data.

Transaction

  • TransactionType
  • Amount
  • FinancialAccount
  • TransactionMethod
  • BudgetCategory
  • NoteForCompliance
  • NoteForInternal
  • RecurringFrequency — example monthly or one-time
  • RecurringLength
  • NameOnCard
  • PartialCardNumber
  • Company — second address for billing purposes (optional)
  • Line1
  • Line2
  • City
  • State
  • ReportingCode — Expenses only

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

Flags (optional/repeatable)

  • FlagName

Flags must be added into your ISP account before trying to submit them via our API.

Related Information