Forth Pay

Sections

Theme switcher

Generate Document Based on Lookup Key

Header Parameters

Api-Keystring Required

Path Parameters

doc_keystring Required

Unique identifier for the document to be generated, used to specify the lookup key for retrieving the correct document template or data.Body Parameter:

Body Parameters

doc_langstring

Preferred language for the generated document.Body Parameter:

client_idstring

Unique identifier assigned to the client.

firstnamestring Required

First name of the primary individual.Body Parameter:

middlenamestring

Middle name of the primary individual.Body Parameter:

lastnamestring Required

Last name of the primary individual associated with the document.Body Parameter:

ssnstring Required

Social Security Number of the individual.Body Parameter:

date_of_birthstring Required

Date of birth of the primary individual.Body Parameter:

co_firstnamestring

First name of the co-signer or secondary individual involved in the document.Body Parameter:

co_middlenamestring

Middle name of the co-signer or secondary individual.Body Parameter:

co_lastnamestring

Last name of the co-signer or secondary individual.Body Parameter:

co_ssnstring

Social Security Number of the co-signer or secondary individual.Body Parameter:

co_date_of_birthstring

Date of birth of the co-signer or secondary individual.Body Parameter:

addressstring Required

Complete residential address of the individual.

address2string

Additional address line 2 for detailed address information.Body Parameter:

citystring Required

City or locality of the individual's residence or the bank's location.Body Parameter:

statestring Required

State or province where the individual resides or is registered.Body Parameter:

zipstring Required

ZIP or postal code of the individual's residence or mailing address.Body Parameter:

phonestring Required

Primary contact phone number.Body Parameter:

alt_phonestring

Alternative phone number for contact purposes.Body Parameter:

emailstring

Email address for correspondence and notifications.

agent_namestring

Name of the agent or representative associated with the document.Body Parameter:

bank_namestring

Name of the financial institution or bank.Body Parameter:

bank_account_namestring

Name on the bank account, typically the account holder's name.Body Parameter:

bank_account_numstring

The bank account number associated with the financial institution.Body Parameter:

bank_routing_numstring

Routing number of the bank used for transactions.Body Parameter:

bank_account_typestring

Type of bank account (e.g., checking, savings).Body Parameter:

bank_addressstring

Full address of the bank, including street, city, state, and ZIP code.Body Parameter:

bank_statestring

State or province where the bank is located.Body Parameter:

bank_zipstring

ZIP or postal code of the bank's location.Body Parameter:

auth_amountstring
auth_datestring
debit_amountstring
debit_datestring
paymentsarray

Response

200
Object
Successful Response

Response Attributes

statusobject

Show child attributes

responseobject
400
Object
Error Response

Response Attributes

statusobject Required

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

POST

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?