Parameter

Description

Type

Req

fee_id

The ID of the rate plan, which details the fee values that Forte will charge the merchant. [max length = 6]

string

R

source_ip

The IP Address from which the merchant is applying. [max length = 80]

string

R

annual_volume

The anticipated annual volume of the business. [max length = 10]

double

R

average_transaction_amount

The average transaction amount of the business. NOTE: When testing, use this parameter to test success and fail responses. Passing a value greater than 10,000 in this field will trigger an automatic decline in the test environment. [max length = 5]

double

R

market_type

The method by which the business captures the majority of its transactions. Options for this parameter include the following values:

- internet
- phone
- mail
- point_of_sale

string

R

t_and_c_version

The version of Forte's Terms and Conditions provided to the applying merchant. NOTE: This must match the version associated with the Rate Plan (fee_id).

string

R

t_and_c_time_stamp

The date and/or timestamp when the merchant agreed to Forte's Terms and Conditions. [max length = 20] NOTE: The value of this field can be up to one full day in the future. The following formats are supported:

- YYY/MM/DD, MMDDYYYY
- YYYY-MM-            DDTHH:MM:SSZ, YYYYMM-DDTHH:MM:SS

datetime

R

risk_session_id

A random unique code that partners generate on their client form and include in the API request call prior to sending the application (e.g., s3AH5fDIdXjI7y1disbZChw8Qrgl6Bz7uKZLjRrgNhYmu
WApi2FhdhB5wW4MgqknPHx1WR7s4RX1vWs).

The value of the risk_session_id parameter can be up to 128 characters long and can only consist of the following characters:

- Upper and lowercase English letters (a–z or A–Z)
- Digits (0–9)
- Underscore or hyphen (_ or -)

The script that generates the risk_session_id value must be embedded on a page where the user will be for five or more seconds. For profiling to properly occur, the session must run on the applicant's browser for a minimum of five seconds. Additionally, the applicant's browser or front-end software must have javascript enabled. See the note below. [max length = 128bytes]

string

R

maximum_transaction_amount

The maximum allowable amount for a credit card or ACH transaction.

double

O

average_payable_amount

The average amount the merchant disburses in credit transactions (e.g., refunds, payroll, commissions, etc). NOTE: If either the average_payable_amount,maximum_payable_amount, or the monthly_payable_volume parameters are passed, all three parameters become required.

double

C

maximum_payable_amount

The maximum amount the merchant would disburse in a credit transaction (e.g., refunds, payroll, commissions, etc.). NOTE: If either the average_payable_amount,maximum_payable_amount, or the monthly_payable_volume parameters are passed, all three parameters become required.

double

C

monthly_payable_volume

An estimate of the amount the merchant disburses in credit transactions each month (e.g., refunds, payroll, commissions, etc). NOTE: If either the average_payable_amount,maximum_payable_amount, or the monthly_payable_volume parameters are passed, all three parameters become required.

double

C

received_date

The date and time when the application was received.

datetime

--

updated_date

The date and time when the application was last updated.

datetime

--

sales_rep

The name or ID of the sales representative associated with this application.

string

--

location_id

The merchant's location ID that Forte created after enrolling the applicant.

string

--

status

The status of the application. Supported values include the following:

approved - Forte has approved the application and sent the merchant's data to the enrollment queue.
pending - Forte's Credit and Risk Team needs to review the application and may request additional documentation from the merchant.
declined - The application failed one or more automated underwriting checks and Forte has declined to move forward with the merchant. The reason for the decline displays in the decline_reason field.

• enrolled - Merchant has completed enrollment and is ready to process transactions.

• rejected - Forte is unable to verify the identity data of an application or cannot authenticate the banking data or signatures. The reason for the rejected status displays in the rejected_reason dield.

• recalled - The applicant has stopped responding to requests for information from Forte or the Partner. The reason for the recalled status displays in the recalled_reason field.

decline_reason field.

enrrolled -

string

--

decline_reason

The reason for a declined status. Supported values include the following:

- credit_locked
- ssn_mismatch
- tincheck_failure
- identity
- type_of_business
- credit
- reputation

string

--

applicant_organization

The Applicant Organization Object.

object

R

applicant_organization.legal_name

The legal name of the business. The value of this parameter must match the name associated with the merchant's Tax ID Number. [max length = 50].

string

R

applicant_organization.tax_id_number

The Tax ID Number of the business (e.g., TIN, EIN, SSN, etc.). The following formats are supported [max length = 30]:

SSN = XXXXXXXXX, XXX-XX-XXXX
ITIN = 9XXXXXXXX, 9XX-XX-XXXX
EIN = XXXXXXXXX, XX-XXXXXXX

string

R

applicant_organization.legal_structure

The ownership type of the business. Options for this parameter include the following values:

- c_corporation
- government
-  limited_liability_corporation
partnership_general_or_limited
- publicly_held_corporation
- s_corporation
- sole_proprietorship
- tax_exempt_or_non_profit_organization

string

R

applicant_organization.dba_name

The name of the business as it will appear on your customer's statements. The default value for this parameter is the DBA (Doing Business As) Name. [max length = 50].

string

R

applicant_organization.organization_id

The merchant organization ID that Forte created after enrolling the applicant.

string

--

applicant_organization.street_address1

The physical address of the business. This parameter cannot contain P.O. boxes, including paid mailbox services provided by companies like the UPS Store. [max length = 50]

string

R

applicant_organization.locality

The city where the business is located. [max length = 50]

string

R

applicant_organization.region

The state or province where the business is located. [max length = 2]

string

R

applicant_organization.postal_code

The zip/postal code of the business. The following formats are supported [max length = 15]:

XXXXX
XXXXX-XXXX

string

R

applicant_organization.customer_service_phone

The customer service phone number of the business. [max length = 12]

string

R

applicant_organization.website

The website of the business. The value of this parameter must be in www.yourcompanysite.com format. The www prefix is required. Slashes and underscore punctuation are allowed in the URL. [max length = 100]

string

R

applicant_organization.business_type

The type of business. See Forte's list of Business Classification Codes. [max length = 50]

string

R

applicant_organization.bank_account_type

The type of bank account. This bank account can only be a business checking or business savings account; it cannot be the applicant's personal checking or personal savings account. The following values are supported:

- checking
- savings

string

O

applicant_organization.bank_routing_number

The transit routing number (TRN) of the merchant's bank. This field supports both U.S. and Canadian routing numbers. NOTE: A Canadian routing number displayed on a check needs to be reformatted differently for electronic payments. If a check displays a routing number as BBBBB-AAA (where AAA indicates the Financial Institution and BBBBB is the branch), then the routing number must be changed to 0AAABBBBB to process the payment electronically. For example, if a check from an account issued by the Bank of Montreal showed the routing number 00011-001, then that number would need to be reformatted to 000100011 for the payment to be electronically processed. Click here for a directory of Canadian financial institutions. This field is required when creating or updating a new record and can only contain digits. [max length = 9].

string

R

applicant_organization.bank_account_number

The account number (i.e., DDA) of the applicant's business bank account. The value of this parameter can only contain digits. [max length = 17]

string

R

owner

The primary owner object. All applications must include at least one primary owner. This owner must be the controller of the business.

object

R

owner.percentage

Indicates the percentage of the business owned by the primary owner (i.e., maximum ownership percentage = 100). NOTES:

- The sum of owner.percentage, owner_2.percentage, owner_3.percentage, and owner_4.percentage cannot be greater than 100.
- This field is NOT required for the following legal structures:

  -  government
  -  sole_proprietorship
 - publicly_held_corporation

double

R

owner.title

The primary owner’s official title at the company. Supported values include the following:

ceo
cfo
coo
managing_member
general_partner
president
vice_president
treasurer
other

string

R

owner.first_name

The first name of the account owner. [max length = 50]

string

R

owner.last_name

The last name of the account owner. [max length = 50]

string

R

owner.street_address1

The home address of the account owner. [max length = 50]

string

R

owner.locality

The city of the account owner's home address. [max length = 50]

string

R

owner.region

The state or province of the account owner's home address. [max length = 2]

string

R

owner.postal_code

The zip/postal code of the account owner's home address. [max length = 15]

string

R

owner.country

The country code of the account owner's home address NOTE: This field is NOT required for the following legal structures:

government
sole_proprietorship
publicly_held_corporation

[max length = 3]

string

R

owner.citizenship

The country code of the account owner's country of citizenship. NOTE: This field is NOT required for the following legal structures:

government
sole_proprietorship
publicly_held_corporation

[max length=3]

string

R

owner.email_address

The business email of the account owner. This email address cannot be a generic email address or a distribution list. The value of this parameter must be in a valid email format (e.g., john.doe@email.com). [max length = 100]

string

R

owner.mobile_phone

The cell phone number of the account owner. The value of this parameter can be up to 15 characters (with country code).

string

R

owner.last4_ssn

The last four digits of the account owner's Social Security Number (SSN). [max length = 4]

string

R

owner.date_of_birth

The birth date of the account owner in YYYY/MM/DD format. [max length = 10]

date

R

owner_2

The secondary owner object.NOTE: This object is only required for American merchants with additional owner(s) who own at least 25% of the business. Addtionally, do not pass this object for merchants set up in the following legal structures:

government
sole_proprietorship
publicly_held_corporation

object

C

owner_2.percentage

Indicates the percentage of the business owned by the secondary owner. This value must be 25 or greater.

double

C

owner_2.first_name

The first name of the account owner. [max length = 50]

string

C

owner_2.last_name

The last name of the account owner. [max length = 50]

string

C

owner_2.street_address1

The home address of the account owner. [max length = 50]

string

C

owner_2.locality

The city of the account owner's home address. [max length = 50]

string

C

owner_2.region

The state or province of the account owner's home address. [max length = 2]

string

C

owner_2.postal_code

The zip/postal code of the account owner's home address. [max length = 15]

string

C

owner_2.country

The country code of the account owner's home address. [max length=3]

string

C

owner_2.citizenship

The country code of the account owner's country of citizenship. [max length=3]

string

C

owner_2.email_address

The business email of the account owner. This email address cannot be a generic email address or a distribution list. The value of this parameter must be in a valid email format (e.g., john.doe@email.com). [max length = 100]

string

C

owner_2.mobile_phone

The cell phone number of the account owner. The value of this parameter can be up to 15 characters (with country code).

string

C

owner_2.last4_ssn

The last four digits of the account owner's Social Security Number (SSN). [max length = 4]

string

C

owner_2.date_of_birth

The birth date of the account owner in YYYY/MM/DD format. [max length = 10]

date

C

owner_3

The tertiary owner object. NOTE: This object is only required for American merchants with additional owner(s) who own at least 25% of the business. Addtionally, do not pass this object for merchants set up in the following legal structures:

government
sole_proprietorship
publicly_held_corporation

object

C

owner_3.percentage

Indicates the percentage of the business owned by the tertiary owner. This value must be 25 or greater.

double

C

owner_3.first_name

The first name of the account owner. [max length = 50]

string

C

owner_3.last_name

The last name of the account owner. [max length = 50]

string

C

owner_3.street_address1

The home address of the account owner. [max length = 50]

string

C

owner_3.locality

The city of the account owner's home address. [max length = 50]

string

C

owner_3.region

The state or province of the account owner's home address. [max length = 2]

string

C

owner_3.postal_code

The zip/postal code of the account owner's home address. [max length = 15]

string

C

owner_3.country

The country code of the account owner's home address. [max length=3]

string

C

owner_3.citizenship

The country code of the account owner's country of citizenship. [max length=3]

string

C

owner_3.email_address

The business email of the account owner. This email address cannot be a generic email address or a distribution list. The value of this parameter must be in a valid email format (e.g., john.doe@email.com). [max length = 100]

string

C

owner_3.mobile_phone

The cell phone number of the account owner. The value of this parameter can be up to 15 characters (with country code).

string

C

owner_3.last4_ssn

The last four digits of the account owner's Social Security Number (SSN). [max length = 4]

string

C

owner_3.date_of_birth

The birth date of the account owner in YYYY/MM/DD format. [max length = 10]

date

C

owner_4

The quaternary owner object. NOTE: This object is only required for American merchants with additional owner(s) who own at least 25% of the business. Addtionally, do not pass this object for merchants set up in the following legal structures:

government
sole_proprietorship
publicly_held_corporation

object

C

owner_4.percentage

Indicates the percentage of the business owned by the quaternary owner. This value must be 25 or greater.

double

C

owner_4.first_name

The first name of the account owner. [max length = 50]

string

C

owner_4.last_name

The last name of the account owner. [max length = 50]

string

C

owner_4.street_address1

The home address of the account owner. [max length = 50]

string

C

owner_4.locality

The city of the account owner's home address. [max length = 50]

string

C

owner_4.region

The state or province of the account owner's home address. [max length = 2]

string

C

owner_4.postal_code

The zip/postal code of the account owner's home address. [max length = 15]

string

C

owner_4.country

The country code of the account owner's home address. [max length=3]

string

C

owner_4.citizenship

The country code of the account owner's country of citizenship. [max length=3]

string

C

owner_4.email_address

The business email of the account owner. This email address cannot be a generic email address or a distribution list. The value of this parameter must be in a valid email format (e.g., john.doe@email.com). [max length = 100]

string

C

owner_4.mobile_phone

The cell phone number of the account owner. The value of this parameter can be up to 15 characters (with country code).

string

C

owner_4.last4_ssn

The last four digits of the account owner's Social Security Number (SSN). [max length = 4]

string

C

owner_4.date_of_birth

The birth date of the account owner in YYYY/MM/DD format. [max length = 10]

date

C

gateway

The gateway object. Use for gateway-only merchant applications.

object

C

gateway.provider

The processor the gateway-only merchant will use. Supported options include the following:

vantiv
global
vital
firstdata
Elavon
Chase

string

C

gateway.bank_id_number

The banking ID associated with Vantiv, Global, or Vital merchants.

string

C

gateway.merchant_id

The merchant ID associated with Vantiv, Global, or FirstData merchants.

string

C

gateway.terminal_id

The terminal ID associated with Global, Vital, or FirstData merchants.

string

C

gateway.agent

The Agent number associated with Vital merchants.

string

C

gateway.chain

The Chain number associated with Vantiv or Vital merchants.

string

C

gateway.store

The Store number associated with Vantiv or Vital merchants.

string

C

gateway.terminal

The Terminal number associated with Vital merchants.

string

C