DocuSign Template Field Reference¶

This guide documents all available data field labels for auto-populating DocuSign templates through TransactAPI. Use these labels as the Data Label on text fields in your DocuSign templates.

Overview¶

When TransactAPI sends a subscription document for signing, it populates text fields in your DocuSign template by matching the Data Label you assign to each field. Both snake_case (recommended for new templates) and legacy labels are supported.

All recipients receive the same complete set of fields. Whether your template has one signer (PrimaryParty) or two (PrimaryParty + SecondaryParty), every recipient gets identical tab data. DocuSign ignores any labels that don't match fields in your template, so you only need to place the fields you want to display.

Creating Your Template¶

Log in to your DocuSign account connected to TransactAPI
Navigate to Templates and create a new template
Upload your document and add recipients
Set the first recipient role to PrimaryParty (name and email blank)
For joint accounts, add a second recipient with role SecondaryParty
Add Text fields to your template and set the Data Label to one of the field names below
Use the same field names on any recipient — the data is identical across all signers

Field Reference¶

Trade Details¶

Snake Case Label	Legacy Label	Description
`trade_transaction_type`	`transactionType`	Payment type (ACH, Check, Wire, Credit Card, TBD)
`trade_total_amount`	`totalAmount`	Trade total dollar amount (formatted to 2 decimals)
`trade_total_shares`	`totalShares`	Trade unit/share amount (formatted to 4 decimals)
`trade_field_1`	`tradeField1`	Trade custom field 1
`trade_field_2`	`tradeField2`	Trade custom field 2
`trade_field_3`	`tradeField3`	Trade custom field 3

Account Details¶

Snake Case Label	Legacy Label	Description
`account_id`	`accountId`	Account ID
`account_full_name`	`accountFullName`	Full name of the account
`account_type`	`type`	Account type
`account_entity_type`	`entityType`	Account entity type
`account_resident_type`	`residentType`	Account domicile
`account_address_1`	`addressLine1`	Account address line 1
`account_address_2`	`addressLine2`	Account address line 2
`account_city`	`accountcity`	Account city
`account_state`	`accountstate`	Account state
`account_zip`	`accountzip`	Account zip/postal code
`account_country`	`accountcountry`	Account country
`account_phone`	`accountphone`	Account phone number
`account_tax_id`	`taxID`	Account tax identification number
`account_accredited_status`	`accreditedStatus`	Accredited investor status
`account_field_1`	`accountField1`	Account custom field 1
`account_field_2`	`accountField2`	Account custom field 2
`account_field_3`	`accountField3`	Account custom field 3

Primary Party Details¶

Snake Case Label	Legacy Label	Description
`primary_party_first_name`	`partyfirstName`	First name (or entity name for entities)
`primary_party_last_name`	`partylastName`	Last name (blank for entities)
`primary_party_middle_initial`	`partymiddleInitial`	Middle initial
`primary_party_ssn`	`socialSecurityNumber`	Social security number
`primary_party_dob`	`partydob`	Date of birth
`primary_party_email`	`emailAddress`	Email address
`primary_party_email_2`	`emailAddress2`	Email address 2
`primary_party_phone`	`partyphone`	Phone number
`primary_party_phone_2`	`partyphone2`	Phone number 2
`primary_party_address_1`	`partyaddress1`	Address line 1
`primary_party_address_2`	`partyaddress2`	Address line 2
`primary_party_city`	`partycity`	City
`primary_party_state`	`partystate`	State
`primary_party_zip`	`partyzip`	Zip code
`primary_party_country`	`partycountry`	Country
`primary_party_domicile`	`partyDomicile`	Domicile
`primary_party_is_entity`	`isEntity`	Whether party is an entity (Yes/No)
`primary_party_entity_name`	`EntityName`	Entity name (entities only)
`primary_party_is_primary`	`Primary Party`	Always "Yes" for primary party
`primary_party_field_1`	`partyField1`	Custom field 1
`primary_party_field_2`	`partyField2`	Custom field 2
`primary_party_field_3`	`partyField3`	Custom field 3
`primary_party_additional_contact`	`additionalContact`	Additional contact information
`primary_party_household_net_worth`	`householdNetworth`	Total net worth
`primary_party_household_income`	`currentHouseholdIncome`	Current household income

Primary Party Employment Details¶

Snake Case Label	Legacy Label	Description
`primary_party_employer_name`	`partyempName`	Employer name
`primary_party_employer_address_1`	`partyEmpAddress1`	Employer address line 1
`primary_party_employer_address_full`	`empAddress`	Full employer address (concatenated)
`primary_party_employer_city`	`empcity`	Employer city
`primary_party_employer_state`	`partyempState`	Employer state
`primary_party_employer_zip`	`partyempzip`	Employer zip

Secondary Party Details¶

These fields are populated when the account has a secondary (joint) party linked. They are available on all recipients.

Snake Case Label	Legacy Label	Description
`secondary_party_first_name`	`JointFirstName`	First name
`secondary_party_last_name`	`JointLastName`	Last name
`secondary_party_middle_name`	`JointMiddleName`	Middle name
`secondary_party_citizenship`	`JointCitizenship`	Citizenship
`secondary_party_dob`	`JointDOB`	Date of birth
`secondary_party_ssn`	`JointSSN`	Social security number
`secondary_party_address_full`	`JointAddress`	Full address (concatenated)
`secondary_party_phone`	`JointPhone`	Phone number
`secondary_party_email`	`Jointemail`	Email address
`secondary_party_address_1`	`JointAddress1`	Address line 1
`secondary_party_address_2`	`JointAddress2`	Address line 2
`secondary_party_city`	`JointCity`	City
`secondary_party_state`	`JointState`	State
`secondary_party_zip`	`JointZip`	Zip code
`secondary_party_country`	`JointCountry`	Country
`secondary_party_domicile`	—	Domicile
`secondary_party_household_net_worth`	—	Total net worth
`secondary_party_household_income`	—	Current household income
`secondary_party_account_owner`	`jointAccountOwner`	Full name

Offering Details¶

Snake Case Label	Legacy Label	Description
`offering_issue_name`	`issueName`	Name of the offering/issue
`offering_share_price`	`sharePrice`	Unit/share price
`offering_share_class`	`Share Class`	Share class

External Account Details¶

Snake Case Label	Legacy Label	Description
`external_account_number`	`externalAccountNumber`	External account number
`external_account_routing_number`	`externalAccountRoutingNumber`	External account routing number
`external_account_type`	`externalAccountType`	External account type
`external_account_nickname`	`externalAccountNickname`	External account nickname

Bank Details¶

Snake Case Label	Legacy Label	Description
`bank_name`	`bankName`	Bank name
`bank_nickname`	`bankNickname`	Bank nickname
`bank_address_1`	`bankAddress`	Bank address
`bank_address_2`	`bankAddress2`	Bank address line 2
`bank_city`	`bankCity`	Bank city
`bank_state`	`bankState`	Bank state
`bank_zip`	`bankZip`	Bank zip
`bank_country`	`bankCountry`	Bank country
`bank_account_number`	`bankAccountNumber`	Bank account number
`bank_account_name`	`bankAccountName`	Bank account name
`bank_routing_number`	`bankRoutingNumber`	Bank routing number
`bank_swift_code`	`bankSwiftAccount`	SWIFT code
`bank_representative`	`bankRepresentative`	Bank representative
`bank_notes`	`bankNotes`	Notes on the bank
`bank_tags`	`bankTags`	Bank tags
`bank_credit_account_name`	`creditAccountName`	Further credit account name
`bank_credit_account_number`	`creditAccountNumber`	Further credit account number
`bank_is_mailing_address`	`isMailingAddress`	Is mailing address
`bank_ira_custodian_yn`	`IRA Custodian Yes/No`	IRA custodian yes/no
`bank_ira_custodian`	`IRA Custodian`	IRA custodian name
`bank_joint_account_type`	`JointAccountType`	Joint account type
`bank_phone`	`BankPhone`	Bank phone
`bank_comm_pref_account`	`CommPrefAccount`	Communication preference
`bank_jurisdiction_inc`	`JurisdictionInc`	Jurisdiction of incorporation
`bank_formation_date`	`FormationDate`	Formation date

Account Mailing Address¶

Snake Case Label	Legacy Label	Description
`mailing_address_1`	`accountmailingAddressLine1`	Mailing address line 1
`mailing_address_2`	`accountmailingAddressLine2`	Mailing address line 2
`mailing_city`	`accountmailingCity`	Mailing city
`mailing_state`	`accountmailingState`	Mailing state
`mailing_country`	`accountmailingCountry`	Mailing country
`mailing_zip`	`accountmailingZipCode`	Mailing zip code
`mailing_is_mailing_address`	`Is Mailing Address`	Is mailing address flag

Entity Details¶

These fields are populated when the primary party is an entity (partyId starts with "E").

Snake Case Label	Legacy Label	Description
`entity_type`	`Entity Type`	Entity type
`entity_other_type`	`Other Entity Type`	Other entity type
`entity_details`	`Entity Details`	Entity details
`entity_other_details`	`Other Entity Details`	Additional entity details
`entity_ein`	`EIN`	Employer identification number
`entity_jurisdiction_state`	`Jurisdiction State`	State of jurisdiction
`entity_jurisdiction_country`	`Jurisdiction Country`	Country of jurisdiction
`entity_other_id_number`	`Other ID Number`	Other ID number
`entity_other_id_description`	`Other ID Description`	Other ID description
`entity_domicile`	`Entity Domicile`	Entity domicile
`entity_benefit_plan_investor`	`Benefit Plan Investor`	Benefit plan investor status
`entity_exemption_limits`	`ExemptionLimits`	Exemption from limits
`entity_exemption_notes`	`ExemptionNotes`	Exemption notes
`entity_plan_assets`	`Plan Assets Entity`	Plan assets entity status
`entity_political_contribution`	`Political Contribution`	Political contribution
`entity_political_contribution_date`	`Date of Contribution`	Date of contribution
`entity_cftc_nfa`	`CFTC_NFA`	CFTC/NFA status
`entity_cftc_nfa_role`	`CFTC_NFA Role`	CFTC/NFA role
`entity_beneficial_owner_name`	`Beneficial Owner Name`	Beneficial owner name
`entity_beneficial_owner_ssn`	`Beneficial Owner SSN`	Beneficial owner SSN
`entity_plan_assets_limit`	`Plan Assets Limit`	Plan assets limit
`entity_insurance_assets_limit`	`Insurance Assets Limit`	Insurance assets limit
`entity_primary_party_title`	`PrimaryPartyTitle`	Primary party title

Entity Registered Address¶

Snake Case Label	Legacy Label	Description
`entity_registered_address_1`	`EntityRegisteredAddress1`	Registered address line 1
`entity_registered_address_2`	`EntityRegisteredAddress2`	Registered address line 2
`entity_registered_city`	`EntityRegisteredCity`	Registered city
`entity_registered_state`	`EntityRegisteredState`	Registered state
`entity_registered_zip`	`EntityRegisteredZip`	Registered zip
`entity_registered_country`	`EntityRegisteredCountry`	Registered country

Entity Mailing Address¶

Snake Case Label	Legacy Label	Description
`entity_mailing_address_1`	`EntityMailingAddress1`	Mailing address line 1
`entity_mailing_address_2`	`EntityMailingAddress2`	Mailing address line 2
`entity_mailing_city`	`EntityMailingCity`	Mailing city
`entity_mailing_state`	`EntityMailingState`	Mailing state
`entity_mailing_zip`	`EntityMailingZip`	Mailing zip
`entity_mailing_country`	`EntityMailingCountry`	Mailing country

Account Supplemental¶

Snake Case Label	Legacy Label	Description
`account_supp_ai_detail`	`aiDetail`	Accredited investor detail
`account_supp_qp_status`	`qpStatus`	Qualified purchaser status
`account_supp_qp_detail`	`qpDetail`	Qualified purchaser detail
`account_supp_qp_2a51`	`qp2a51`	QP 2(a)(51) status
`account_supp_qib_status`	`qibStatus`	Qualified institutional buyer status
`account_supp_qib_detail`	`qibDetail`	QIB detail
`account_supp_eligible`	`eligible`	Eligible status
`account_supp_new_issue`	`newIssue`	New issue status
`account_supp_new_issue_detail`	`newIssueDetail`	New issue detail
`account_supp_field_1`	`field1`	Supplemental custom field
`account_supp_k1_consent`	`k1consent`	K-1 consent
`account_supp_k2_opt_out`	`k2optOut`	K-2 opt out
`account_supp_k2_opt_out_all`	`k2optoutAll`	K-2 opt out all
`account_supp_k2_opt_out_account`	`k2optoutAccount`	K-2 opt out account
`account_supp_bp_investor`	`bPInvestor`	Benefit plan investor
`account_supp_bp_exemption`	`bPexemption`	Benefit plan exemption
`account_supp_bp_exemption_notes`	`bPexemptionNotes`	Benefit plan exemption notes
`account_supp_bp_plan_assets`	`bPPlanAssets`	Benefit plan assets
`account_supp_employer_name`	`EmployerName`	Employer name
`account_supp_employer_address`	`EmployerAddress`	Employer address
`account_supp_self_employed_retired`	`SelfEmployeedRetired`	Self-employed/retired status
`account_supp_broker_dealer_inv_adv`	`BrokerDealerInvAdv`	Broker-dealer/investment advisor
`account_supp_employee_position`	`EmployeePosition`	Employee position
`account_supp_place_of_birth`	`PlaceofBirth`	Place of birth
`account_supp_passport_num_exp_date`	`PassportNumExpDate`	Passport number and expiration
`account_supp_other_broker_ac`	`OtherBrokerAC`	Other brokerage accounts
`account_supp_bank_references`	`BankReferences`	Bank references
`account_supp_referral`	`Referral`	Referral
`account_supp_bkgd_check_felony`	`BkgdCheckFelony`	Background check - felony
`account_supp_bkgd_check_charged`	`BkgdCheckCharged`	Background check - charged
`account_supp_bkgd_check_sanctioned`	`BkgdCheckSanctioned`	Background check - sanctioned
`account_supp_bkgd_check_bankruptcy`	`BkgdCheckBankruptcy`	Background check - bankruptcy
`account_supp_bkgd_check_license`	`BkgdCheckLicense`	Background check - license
`account_supp_other_occupations`	`OtherOccupations`	Other occupations
`account_supp_gen_solicitation`	`GenSolicitation`	General solicitation
`account_supp_inv_bkgd_yrs`	`InvBkgdYrs`	Investment background - years
`account_supp_inv_bkgd_value`	`InvBkgdValue`	Investment background - value
`account_supp_inv_bkgd_re`	`InvBkgdRE`	Investment background - real estate
`account_supp_inv_bkgd_tax_shelter`	`InvBkgdTaxShelter`	Investment background - tax shelter
`account_supp_inv_bkgd_securities`	`InvBkgdSecurities`	Investment background - securities
`account_supp_inv_bkgd_commodities`	`InvBkgdCommodities`	Investment background - commodities
`account_supp_inv_bkgd_speculative`	`InvBkgdSpeculative`	Investment background - speculative
`account_supp_inv_bkgd_private_inv`	`InvBkgdPrivate Inv`	Investment background - private investments
`account_supp_tax_bracket`	`TaxBracket`	Tax bracket
`account_supp_investment_objectives`	`InvestmentObjectives`	Investment objectives
`account_supp_source_of_funds`	`SourceofFunds`	Source of funds
`account_supp_fatf_bank`	`FATFbank`	FATF bank
`account_supp_fatf_bank_customer`	`FATFbankcustomer`	FATF bank customer
`account_supp_uste`	`USTE`	US tax exempt
`account_supp_qualified_client`	`QualifedClient`	Qualified client
`account_supp_40_pct_subscriber_assets`	`40pctSubscriberAssets`	40% subscriber assets
`account_supp_bank_holding_co`	`BankHoldingCo`	Bank holding company
`account_supp_public_disclosure`	`PublicDisclosure`	Public disclosure
`account_supp_trading_exchange_disclosure`	`Trading-Exchange-Disclosure`	Trading/exchange disclosure
`account_supp_trading_exchange_disclosure_agent`	`Trading-Exchange-Disclosure-Agent`	Trading/exchange disclosure agent
`account_supp_corp_us_tax`	`Corp-USTax`	Corporate US tax
`account_supp_uste_detail`	`USTE-detail`	US tax exempt detail
`account_supp_disregarded`	`Disregarded`	Disregarded entity
`account_supp_disregarded_owner`	`Disregarded-owner`	Disregarded entity owner
`account_supp_non_us_gov`	`nonUS-Gov`	Non-US government
`account_supp_non_us_gov_detail`	`nonUS-Gov-detail`	Non-US government detail
`account_supp_subchapter_s`	`Subchapter-S`	Subchapter S corporation
`account_supp_subchapter_s_detail`	`Subchapter-S-detail`	Subchapter S detail
`account_supp_50_pct_bo_interest`	`50pctBOinterest`	50% beneficial ownership interest
`account_supp_100_partner_limitation`	`100partnerlimitation`	100 partner limitation
`account_supp_ubti`	`UBTI`	Unrelated business taxable income
`account_supp_nominee`	`Nominee`	Nominee
`account_supp_nominee_detail`	`Nominee-detail`	Nominee detail
`account_supp_tax_treaty`	`TaxTreaty`	Tax treaty
`account_supp_tax_treaty_detail`	`TaxTreaty-detail`	Tax treaty detail
`account_supp_greater_2_pct_interest`	`Greater2pctInterest`	Greater than 2% interest
`account_supp_greater_2_pct_interest_detail`	`Greater2pctInterest-detail`	Greater than 2% interest detail
`account_supp_related_subscriber`	`RelatedSubscriber`	Related subscriber
`account_supp_related_subscriber_details`	`RelatedSubscriber-details`	Related subscriber details
`account_supp_other_subscriber_control`	`OtherSubscriberControl`	Other subscriber control
`account_supp_other_subscriber_control_details`	`OtherSubscriberControl-details`	Other subscriber control details
`account_supp_9_8_pct_owner`	`9.8pctOwner`	9.8% owner
`account_supp_9_8_pct_owner_details`	`9.8pctOwner-details`	9.8% owner details
`account_supp_controlled_foreign_corp`	`ControlledForeignCorp`	Controlled foreign corporation
`account_supp_subscriber_is_a_bank`	`SubscriberIsaBank`	Subscriber is a bank
`account_supp_insurance_co`	`InsuranceCo`	Insurance company
`account_supp_insurance_co_detail`	`InsuranceCo-detail`	Insurance company detail
`account_supp_bp_ebp`	`bp-EBP`	Employee benefit plan
`account_supp_bp_plan`	`bp-Plan`	Benefit plan
`account_supp_bp_entity_erisa_assets`	`bp-entity-ERISA-assets`	Entity ERISA assets
`account_supp_bp_erisa_bpi`	`bp-ERISA-BPI`	ERISA benefit plan investor
`account_supp_bp_details`	`bp-details`	Benefit plan details
`account_supp_bp_non_us`	`bp-nonUS`	Benefit plan non-US
`account_supp_bp_plan_other`	`bp-plan-other`	Benefit plan other
`account_supp_bp_plan_other_details`	`bp-plan-other-details`	Benefit plan other details
`account_supp_controlling_person`	`ControllingPerson`	Controlling person
`account_supp_fiduciary`	`Fiduciary`	Fiduciary

Regulation 506(d) Fields¶

Snake Case Label	Legacy Label	Description
`account_506d_applies`	`YN`	506(d) applies (Yes/No)
`account_506d_cat_a`	`A`	Category A
`account_506d_cat_a_detail`	`Adet`	Category A detail
`account_506d_cat_b`	`B`	Category B
`account_506d_cat_b_detail`	`Bdet`	Category B detail
`account_506d_cat_c`	`C`	Category C
`account_506d_cat_c_detail`	`Cdet`	Category C detail
`account_506d_cat_d`	`D`	Category D
`account_506d_cat_d_detail`	`Ddet`	Category D detail
`account_506d_cat_e`	`E`	Category E
`account_506d_cat_e_detail`	`Edet`	Category E detail
`account_506d_cat_f`	`F`	Category F
`account_506d_cat_f_detail`	`Fdet`	Category F detail
`account_506d_cat_g`	`G`	Category G
`account_506d_cat_g_detail`	`Gdet`	Category G detail
`account_506d_cat_h`	`H`	Category H
`account_506d_cat_h_detail`	`Hdet`	Category H detail
`account_506d_cat_i`	`I`	Category I
`account_506d_cat_i_detail`	`Idet`	Category I detail
`account_506d_electronic_consent`	`electronicConsent`	Electronic consent
`account_506d_cat_a_part1`	`APart1`	Category A Part 1
`account_506d_cat_a_detail_part1`	`AdetPart1`	Category A detail Part 1
`account_506d_cat_b_part1`	`BPart1`	Category B Part 1
`account_506d_cat_b_detail_part1`	`BDetPart1`	Category B detail Part 1

Entity Supplemental¶

Snake Case Label	Legacy Label	Description
`entity_supp_tax_year_end_month`	`TaxYEmonth`	Tax year end month
`entity_supp_us_person`	`USPerson`	US person status
`entity_supp_bp_purchaser`	`BPpurchaser`	Benefit plan purchaser
`entity_supp_bp_employers`	`BPemployers`	Benefit plan employers
`entity_supp_bp_affiliates`	`BPaffiliates`	Benefit plan affiliates
`entity_supp_bp_sponsor`	`BPsponsor`	Benefit plan sponsor
`entity_supp_bank_holding_co`	`EntityBankHoldingCo`	Bank holding company
`entity_supp_inv_company_act`	`InvCompanyAct`	Investment Company Act
`entity_supp_inv_company_act_individual_owners`	`InvCompanyAct-individualowners`	Investment Company Act - individual owners
`entity_supp_inv_company_act_entity_owners`	`InvCompanyAct-entityowners`	Investment Company Act - entity owners
`entity_supp_cfius`	`CFIUS`	CFIUS status
`entity_supp_purchaser_rep`	`PurchaserRep`	Purchaser representative
`entity_supp_other_occupations`	`EntityOtherOccupations`	Other occupations
`entity_supp_political_contribution`	`poliCont`	Political contribution
`entity_supp_political_contribution_date`	`poliContDate`	Political contribution date
`entity_supp_cftc`	`CFTC`	CFTC status
`entity_supp_cftc_role`	`CFTCrole`	CFTC role
`entity_supp_beneficial_owner_name`	`boName`	Beneficial owner name
`entity_supp_beneficial_owner_ssn`	`boSSN`	Beneficial owner SSN
`entity_supp_plan_asset_limit`	`planassetLimit`	Plan asset limit
`entity_supp_insurance_asset_limit`	`insassetLimit`	Insurance asset limit
`entity_supp_notes`	`notes`	Notes

Suitability¶

Snake Case Label	Legacy Label	Description
`suitability_pct_liquid_securities`	`accountPctLiquidSecurities`	Liquid securities percentage
`suitability_pct_illiquid_securities`	`accountpctIlliquidSecurities`	Illiquid securities percentage

PPP Application¶

Snake Case Label	Legacy Label	Description
`ppp_avg_monthly_payroll`	`avgMonthlyPayroll`	Average monthly payroll
`ppp_loan_amount`	`LoanAmount`	Loan amount
`ppp_number_jobs`	`numberJobs`	Number of jobs
`ppp_purpose`	`purpose`	Purpose
`ppp_question_1`	`question1`	Question 1
`ppp_question_2`	`question2`	Question 2
`ppp_question_3`	`question3`	Question 3
`ppp_question_4`	`question4`	Question 4
`ppp_question_5`	`question5`	Question 5
`ppp_question_6`	`question6`	Question 6
`ppp_question_7`	`question7`	Question 7

Notes¶

All recipients (PrimaryParty and SecondaryParty) receive the same complete set of fields with the same values.
Both snake_case and legacy labels are always sent. You can use either in your templates.
Entity-specific fields (entity_*, entity_supp_*) are only populated when the primary party is an entity.
Secondary party fields (secondary_party_*) are only populated when a secondary party is linked to the account.
Account supplemental, 506(d), and entity supplemental fields require the corresponding supplemental data to be present on the account.
Legacy labels (e.g. partyfirstName, JointFirstName) are preserved for backward compatibility with existing templates. New templates should use snake_case labels.