Forth Pay

Create Client

This endpoint makes it efficient to add a new client, just enter their details, like name, contact info, and any initial settings, and the system will set up the record for you. No manual data entry, just a quick and efficient way to keep client information organized.

Header Parameters

Api-Keystring Required

API Key

Body Parameters

tp_idstring

Your external client reference / ID

file_typestring Required

The type of file for the consumer. One of (DEBT, STUDENT) using capitals

first_namestring Required

The First Name of the consumer being created.

middle_namestring

The Middle Name of the consumer being created.

last_namestring Required

The Last Name of the consumer being created.

business_namestring

The name of the business associated with the consumer being created.

addressstring Required

The Address of the consumer being created.

address2string

Addtional address information for the consumer being created.

citystring Required

The name of the city where the consumer being created lives.

statestring Required

The name of the state where the consumer being created lives.

zipstring Required

The Zip code where the consumer being created lives.

home_phonestring Required

The Home Phone number of the consumer being created.

work_phonestring

The Work Phone number of the consumer being created.

cell_phonestring

The Mobile Phone number of the consumer being created.

emailstring Required

The Email Address of the consumer being created.

ssnstring

The Social Security Number (SSN) of the consumer being created.

date_of_birthstring Required

The Date of Birth (DOB) of the consumer being created.

Response

200

Object

New Consumer Created

Response Attributes

idinteger

createdstring

modifiedstring

tp_idstring

file_typestring

first_namestring Required

middle_namestring

last_namestring Required

business_namestring

addressstring Required

address2string

citystring Required

statestring Required

zipstring Required

home_phonestring Required

work_phonestring

cell_phonestring

emailstring

ssnstring

date_of_birthstring Required

pausedboolean

enrolledboolean

droppedboolean

dropped_datestring

graduated_datestring

iscoappboolean

coapp_idboolean

400

Object

Error - We are unable to create a new client record. Please check all required fields.

Response Attributes

statusobject Required

Show child attributes

Sections

Create Client

Header Parameters

Body Parameters

Response

Response Attributes

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Sections

Create Client

Header Parameters

Body Parameters

ResponseExpand all

Response Attributes

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Response