This article includes the following topics:
**Note: Click on any topic to be taken directly to that section.
Field Name = Value
Some Field Names may need to be specific depending on the posting instructions of the destination system.
Basic Contact Information
firstname = First Name
lastname = Last Name
ssn = SSN
dob = Date Of Birth
address1 = Address 1
address2 = Address 2
city = City
state = State
zip = Zip
email = Email
externalid = External ID
campaign = Campaign
workphone = Work Phone
homephone = Home Phone
cellphone = Cell Phone
Co-Applicant Information
To pass Co-Applicant data via Webhook, both the Primary applicant, and Co-applicant fields must be present on the Webhook. These fields also must match verbatim between the sending and receiving accounts custom fields. On the receiving ends Data Source, the Primary applicant data field must be mapped. (co-app fields will not be visible and won't need to be mapped).
Example Webhook setup:
Data Source Mapping:
System Fields
_coapp_firstname = {COFIRSTNAME} *In order to create a co-applicant from a data source it must include the first name.
_coapp_lastname = {COLASTNAME}
_coapp_ssn = {COSSN}
_coapp_address = {COADDRESS}
_coapp_city = {COCITY}
_coapp_state = {COSTATE}
_coapp_zip = {COZIP}
_coapp_email = {COEMAIL}
_coapp_cellphone = {COPHONE3}
_coapp_homephone = {COPHONE}
_coapp_dob = {CODOB}
Co-Applicant Custom Fields
_coapp_(customfield) = {CCF:Custom Field}
Examples:
_coapp_employer = {CCF:Employer}
_coapp_position = {CCF:Position}
_coapp_dlnumber = {CCF:DL Number}
_coapp_maidenname = {CCF:Maiden Name}
Creditor Information
cred1_name = {C1_NAME}
cred1_debt = {C1_AMT}
cred1_accountnum = {C1_ACCT}
cred1_accounttype = {C1_TYPE}
cred1_collection_name = {C1_COLLECTION_NAME}
cred1_currentpay = {C1_CURRENTPMT}
cred1_whose_debt = {C1_HOLDER}
cred1_current_amount = {C1_AMT}
cred1_current_payment = {C1_CURRENTPMT}
cred1_lastpayment =
cred1_notes=
Banking Information
bank_name - {BANKNAME}
account_num - {ACCOUNTNUM}
routing_num - {ROUTINGNUM}
account_name - {NAMEONACCT}
account_type - {ACCTTYPE}
Credit Card Information
cc_name - {CC_NAME}
cc_type - {CC_TYPE}
cc_number - {CC_NUMFULL}
cc_exp_mo - {CC_EXP_MO}
cc_exp_yr = {CC_EXP_YR}
Enrollment Plans
__plan_data = {EP_DATA} (plan saved on contacts file)
plan_id={if '{PLAN_ID}' = 'RECEIVING ACCOUNT PLAN ID'}POSTING ACCOUNT PLAN ID{endif}
Documents
__copydocs = {ACCTID}-{ID}-{UPLOAD_DOC_IDS} (only docs in uploaded docs section)
{GATEWAY_AUTH} and {UPLOADED_DOCS}
Assigned To User
assigned_to = Assigned To (both names in each account must be IDENTICAL)
Assigned To Company
__update_primaryco_assignment = Company Name or Company ID (located in Admin > Companies page)
Enrollment Folders
submitfile = 1 (puts client in submitted file folder)
returnfile = 1 (puts client in returned file folder)
Budget Fields
{RECEIVING ACCOUNT BUDGET FIELD} = {POSTING ACCOUNT BUDGET FIELD}
A contact's budget field can be set through a data source from a webform. To do so, be sure to use the tag&{FIELD_TAG}=5300.20 - inclusive of the {}.
Notes
lastnote = {LASTNOTE} (post last note on clients file - must map to ‘Create New Note’ in receiving company datasource)
Update Record
updaterecord = {EXTERNALID} or {ID}
Stage
Stage = (Receiving Accounts Stage)
Status
Status = (Receiving Accounts Status)
To post documents along with the contact submission you will need to pass the following key=value pairs in your request.
You can submit up to 30 documents in a single request using the field name convention below.
&doc1_data=### BASE64 ENCODED FILE CONTENTS ###
&doc1_name=### TITLE OF THE DOCUMENT
&doc1_desc=### OPTIONAL DESCRIPTION ###
&doc1_type=### VALID DOCUMENT TYPE ID (SEE ATTACHED) ####
&doc2_data=
&doc2_name=
&doc2_desc=
&doc3_data=
&doc....
Alternatively, if you do not cannot post base64 encoded file contents you can provide a publicly accessible URL to retrieve the document from.
E.G
&doc1_url=https://www.somedomain.com/pathtofile.pdf
&doc1_name=Bank Statements.pdf
&doc1_type=3
To post Debt ID with the contact submission you will need to pass the following key=value pairs in your request.
Field name convention outlined below.
left side / right side
cred1_id ={C1_ID}
cred2_id ={C2_ID}
cred3_id ={C3_ID}
To add or remove creditors via webhook between systems, you will need to pass the following key=value pairs in your request. Field name convention outlined below.
cred1_enrolled = {if '{C1_IS_ENROLLED}' != 'Yes'}false{endif}
cred2_enrolled = {if '{C2_IS_ENROLLED}' != 'Yes'}false{endif}
cred3_enrolled = {if '{C3_IS_ENROLLED}' != 'Yes'}false{endif}