Skip To Content

Developer Documenation: Partner Equipment Finance API – Application Submit

Json request structure

  1. Submit your request in POST
  2. Headers need to include:
    1. Content-Type : application/json
    2. x-api-key : Your API Key
    3. Authorization : Basic Auth
      1. With your username & password base64 encoded
  3. Body must be as an array which should be formatted as shown in the jQuery, javascript and PHP examples to the right

Testing

For initial testing and setup we recommend using postman as your platform to ensure you are preparing and formatting your requests properly. Once you have your structure setup correctly we’ve prepared some basic examples to the right for you to start with while using testdevportal.

Legend

While testing, please use testdevportal. When ready for production, be sure change it to devportal.

These highlighted areas you see in the examples to the right represent the variables which will need to be filled with your data. These are sensitive so ensure you are loading them from a remote and secure source.

Some fields are optional. Please see the Field Details for more information about this. If values are not present/Optional please pass empty (" ") value to field name.

If you have a document to upload please be sure to convert your file to base64 before uploading.

jQuery(function( $ ) {

	// These variables should be populated from a remote & secure source
	var partnerId = '8042971FIOMIQAY',
		partnerReferenceId = 'CD1911270045',
		PartnerCustomerUniqueID : 'Test123PartnerCustomer8UniqueID7',
		username = '********',
		password = '********',
		xApiKey = '********-********-********-********-********',
		requri = 'https://testdevportal.marlincapitalsolutions.com:8077/ws/rest/partnerefapi/createPartnerEfApi/';

	createEFapply( partnerId, partnerReferenceId, username, password, xApiKey, requri );

	function createEFapply( partnerId, partnerReferenceId, username, password, xApiKey, requri ) {

		var jsonRequest = {
				'PartnerId': partnerId,
				'Partner Reference ID': partnerReferenceId,
                                'PartnerCustomerUniqueID' : PartnerCustomerUniqueID,
				'Dealer Number': '',
				'businessDetails': {
					'Legal Business Name': 'test bnameHVL',
					'Business Tax ID': '631234445',
					'DBA Name': 'Company Inc',
					'Business Type': 'Partnership',
					'Business Start Month': '07',
					'Business Start Year': '1969',
					'Business Address Line 1': '121 brace rd',
					'Business Address Line 2': 'Test Address2',
					'City': 'cherry hill',
					'State': 'NJ',
					'Zipcode': '08340',
					'Business Phone': '8568469508',
					'Business Email': '[email protected]',
					'Contact Name': 'test coneuy',
					'Contact Phone': '8568469544',
					'CCAN': '',
					'CCID': '',
					'Billing Address Line 1': '7736 Green Valley Rd',
					'Billing Address Line 2': '',
					'Billing Address City': 'Wyncote',
					'Billing Address State': 'PA',
					'Billing Address Zip': '19095',
					'Phone Type': 'Mobile'
				},
				'equipmentFinanceDetails': {
					'Total Equipment Cost': '25000',
					'equipmentDetails': [{
						'Equipment Cost': '7000',
						'Equipment Quantity': '1',
						'Equipment Condition': 'New',
						'Equipment Type': 'GPS Units',
						'Equipment Description': 'desc1 test',
						'Make': '',
						'Type': '',
						'Year': '',
						'Mileage': '',
						'VIN': '',
						'Sleeper Day Cab': '',
						'Model': ''
					},
						{
							'Equipment Cost': '13000',
							'Equipment Quantity': '2',
							'Equipment Condition': 'Used',
							'Equipment Type': 'Titled Vehicles (General)',
							'Equipment Description': 'desc2',
							'Make': 'Wabash',
							'Type': 'Trailer',
							'Year': '2010',
							'Mileage': '250,001 - 500,000',
							'VIN': 'qwertyu09876554321',
							'Sleeper Day Cab': 'No',
							'Model': 'Model2'
						},
						{
							'Equipment Cost': '5000',
							'Equipment Quantity': '3',
							'Equipment Condition': 'New',
							'Equipment Type': 'GPS Units',
							'Equipment Description': 'desc3',
							'Make': '',
							'Type': '',
							'Year': '',
							'Mileage': '',
							'VIN': '',
							'Sleeper Day Cab': '',
							'Model': ''
						}],
					'dealerInfo': {
						'Equipment Dealer Contact': 'efapi test',
						'Equipment Dealer Email': '[email protected]'
					},
					'pgDetails': [{
						'Guarantor Name': 'test efpg',
						'Guarantor Address Line 1': '428 Yale Dr',
						'Guarantor Address Line 2': '',
						'Guarantor City': 'Hampton',
						'Guarantor State': 'VA',
						'Guarantor Zipcode': '23666',
						'Guarantor Social Security Number': '666369221',
						'Guarantor Email': '[email protected]',
						'Guarantor Phone': '3198051444'
					},
						{
							'Guarantor Name': 'test pg',
							'Guarantor Address Line 1': '770 Broadway',
							'Guarantor Address Line 2': '',
							'Guarantor City': 'New York',
							'Guarantor State': 'NY',
							'Guarantor Zipcode': '10003',
							'Guarantor Social Security Number': '999999999',
							'Guarantor Email': '[email protected]',
							'Guarantor Phone': '3198051474'
						}
					],
					'equipmentAddress': {
						'Equipment Address Line 1': '1210 Brace Rd',
						'Equipment Address Line 2': 'Line2',
						'Equipment City': 'Medford',
						'Equipment State': 'NJ',
						'Equipment Zipcode': '08055'
					},
					'Payment Frequency': 'Monthly',
					'Term Requested': '',
					'Purchase Option': '',
					'Number Of Payments': '',
					'Comments': ''
				},
				'Contract Type': '',
				'documentDetails': [{
					'Attachment': 'Document Title',
					'fileDataEncoded': 'Base 64 encoded file here',
					'fileExtension': 'docx',
					'Document Type': 'CR - Misc',
					'Description': 'Bank statement uploaded'
				}]

			},
			jsonHeaders = {
				'Authorization': 'Basic ' + btoa( username + ':' + password ),
				'x-api-key': xApiKey
			};

		$.ajax( {

			type: 'POST',
			url: requri,
			headers: jsonHeaders,
			data: JSON.stringify( jsonRequest ),
			contentType: 'application/json',

			success: function( json ) {

				if ( 'true' === json[ 'Status' ] ) {

					// Good response, now to do something with it.
					console.log( 'success' );
					console.log( json );

				} else if ( false === json[ 'Status' ] ) {

					console.log( 'successful connection but no data in the response' );
					console.log( json[ 'Message' ] );

				} else {

					console.log( 'successful connection but we have an unexpected response' );
					console.log( json );

				}

			}, // End Success

			error: function( json ) {

				// Something has happened with the communication and we need to do something here.
				console.log( 'error with connection' );
				console.log( json );

			} // End Error

		} ); // End Ajax

	} // End callEFStatus

}); // End Jquery
// These variables should be populated from a remote & secure source
var partnerId = '8042971FIOMIQAY',
	partnerReferenceId = 'CD1911270045',
	PartnerCustomerUniqueID : 'Test123PartnerCustomer8UniqueID7',
	username = '********',
	password = '********',
	xApiKey = '********-********-********-********-********',
	requri = 'https://testdevportal.marlincapitalsolutions.com:8077/ws/rest/partnerefapi/createPartnerEfApi/',
	data = {
		'PartnerId': partnerId,
		'Partner Reference ID': partnerReferenceId,
                'PartnerCustomerUniqueID' : PartnerCustomerUniqueID,
		'Dealer Number': '',
		'businessDetails': {
			'Legal Business Name': 'test bnameHVL',
			'Business Tax ID': '631234445',
			'DBA Name': 'Company Inc',
			'Business Type': 'Partnership',
			'Business Start Month': '07',
			'Business Start Year': '1969',
			'Business Address Line 1': '121 brace rd',
			'Business Address Line 2': 'Test Address2',
			'City': 'cherry hill',
			'State': 'NJ',
			'Zipcode': '08340',
			'Business Phone': '8568469508',
			'Business Email': '[email protected]',
			'Contact Name': 'test coneuy',
			'Contact Phone': '8568469544',
			'CCAN': '',
			'CCID': '',
			'Billing Address Line 1': '7736 Green Valley Rd',
			'Billing Address Line 2': '',
			'Billing Address City': 'Wyncote',
			'Billing Address State': 'PA',
			'Billing Address Zip': '19095',
			'Phone Type': 'Mobile'
		},
		'equipmentFinanceDetails': {
			'Total Equipment Cost': '25000',
			'equipmentDetails': [{
				'Equipment Cost': '7000',
				'Equipment Quantity': '1',
				'Equipment Condition': 'New',
				'Equipment Type': 'GPS Units',
				'Equipment Description': 'desc1 test',
				'Make': '',
				'Type': '',
				'Year': '',
				'Mileage': '',
				'VIN': '',
				'Sleeper Day Cab': '',
				'Model': ''
			},
				{
					'Equipment Cost': '13000',
					'Equipment Quantity': '2',
					'Equipment Condition': 'Used',
					'Equipment Type': 'Titled Vehicles (General)',
					'Equipment Description': 'desc2',
					'Make': 'Wabash',
					'Type': 'Trailer',
					'Year': '2010',
					'Mileage': '250,001 - 500,000',
					'VIN': 'qwertyu09876554321',
					'Sleeper Day Cab': 'No',
					'Model': 'Model2'
				},
				{
					'Equipment Cost': '5000',
					'Equipment Quantity': '3',
					'Equipment Condition': 'New',
					'Equipment Type': 'GPS Units',
					'Equipment Description': 'desc3',
					'Make': '',
					'Type': '',
					'Year': '',
					'Mileage': '',
					'VIN': '',
					'Sleeper Day Cab': '',
					'Model': ''
				}],
			'dealerInfo': {
				'Equipment Dealer Contact': 'efapi test',
				'Equipment Dealer Email': '[email protected]'
			},
			'pgDetails': [{
				'Guarantor Name': 'test efpg',
				'Guarantor Address Line 1': '428 Yale Dr',
				'Guarantor Address Line 2': '',
				'Guarantor City': 'Hampton',
				'Guarantor State': 'VA',
				'Guarantor Zipcode': '23666',
				'Guarantor Social Security Number': '666369221',
				'Guarantor Email': '[email protected]',
				'Guarantor Phone': '3198051444'
			},
				{
					'Guarantor Name': 'test pg',
					'Guarantor Address Line 1': '770 Broadway',
					'Guarantor Address Line 2': '',
					'Guarantor City': 'New York',
					'Guarantor State': 'NY',
					'Guarantor Zipcode': '10003',
					'Guarantor Social Security Number': '999999999',
					'Guarantor Email': '[email protected]',
					'Guarantor Phone': '3198051474'
				}
			],
			'equipmentAddress': {
				'Equipment Address Line 1': '1210 Brace Rd',
				'Equipment Address Line 2': 'Line2',
				'Equipment City': 'Medford',
				'Equipment State': 'NJ',
				'Equipment Zipcode': '08055'
			},
			'Payment Frequency': 'Monthly',
			'Term Requested': '',
			'Purchase Option': '',
			'Number Of Payments': '',
			'Comments': ''
		},
		'Contract Type': '',
		'documentDetails': [{
			'Attachment': 'Document Title',
			'fileDataEncoded': 'Base 64 encoded file here',
			'fileExtension': 'docx',
			'Document Type': 'CR - Misc',
			'Description': 'Bank statement uploaded'
		}]

	};

var xhr = new XMLHttpRequest();
xhr.open("POST", requri);

xhr.setRequestHeader('Accept', 'application/json' );
xhr.setRequestHeader('Authorization', 'Basic ' + btoa( username + ':' + password ) );
xhr.setRequestHeader('x-api-key', xApiKey );
xhr.setRequestHeader('Content-Type', 'application/json' );

xhr.onreadystatechange = function() {
	if ( xhr.readyState === 4 ) {

		var respCode = xhr.status,
			respData = xhr.responseText;

		if ( 200 === respCode ) {
			// Good response, now to do something with it.
			var jsonArr = JSON.parse( respData ),
				respStatus = jsonArr[ 'Status' ],
				respMessage = jsonArr[ 'Message' ];

			if ( true === respStatus ) {

				// Good response, now to do something with it.
				console.log( 'success' );
				console.log( respMessage );

			} else if ( false === respStatus ) {

				console.log( 'successful connection but no data in the response' );
				console.log( respMessage );

			} else {

				console.log( 'successful connection but we have an unexpected response' );
				console.log( respData )

			}


		} else {
			// We did not get a good response status
			console.log('bad response code');
			console.log( responseCode );
			console.log( respData );
		}
	}
};
<?php

// These variables should be populated from a remote & secure source
$url                  = 'https://testdevportal.marlincapitalsolutions.com:8077/ws/rest/partnerefapi/createPartnerEfApi/';
$partner_id           = '8042971FIOMIQAY';
$partner_reference_id = 'CD1911270045';
$PartnerCustomerUniqueID : 'Test123PartnerCustomer8UniqueID7',
$username             = '********';
$password             = '********';
$x_api_key            = '********-********-********-********-********';

$data = [
	'PartnerId'                  => $partner_id,
	'Partner Reference ID'       => $partner_reference_id,
	'PartnerCustomerUniqueID' : $PartnerCustomerUniqueID,
	'Dealer Number'              => '',
	'businessDetails'            => [
		'Legal Business Name'     => 'test bnameHVL',
		'Business Tax ID'         => '631234445',
		'DBA Name'                => 'Company Inc',
		'Business Type'           => 'Partnership',
		'Business Start Month'    => '07',
		'Business Start Year'     => '1969',
		'Business Address Line 1' => '121 brace rd',
		'Business Address Line 2' => 'Test Address2',
		'City'                    => 'cherry hill',
		'State'                   => 'NJ',
		'Zipcode'                 => '08340',
		'Business Phone'          => '8568469508',
		'Business Email'          => '[email protected]',
		'Contact Name'            => 'test coneuy',
		'Contact Phone'           => '8568469544',
		'CCAN'                    => '',
		'CCID'                    => '',
		'Billing Address Line 1'  => '7736 Green Valley Rd',
		'Billing Address Line 2'  => '',
		'Billing Address City'    => 'Wyncote',
		'Billing Address State'   => 'PA',
		'Billing Address Zip'     => '19095',
		'Phone Type'              => 'Mobile'
	],
	'equipmentFinanceDetails'    => [
		'Total Equipment Cost' => '25000',
		'equipmentDetails'     => [
			[
				'Equipment Cost'        => '7000',
				'Equipment Quantity'    => '1',
				'Equipment Condition'   => 'New',
				'Equipment Type'        => 'GPS Units',
				'Equipment Description' => 'desc1 test',
				'Make'                  => '',
				'Type'                  => '',
				'Year'                  => '',
				'Mileage'               => '',
				'VIN'                   => '',
				'Sleeper Day Cab'       => '',
				'Model'                 => ''
			],
			[
				'Equipment Cost'        => '13000',
				'Equipment Quantity'    => '2',
				'Equipment Condition'   => 'Used',
				'Equipment Type'        => 'Titled Vehicles (General)',
				'Equipment Description' => 'desc2',
				'Make'                  => 'Wabash',
				'Type'                  => 'Trailer',
				'Year'                  => '2010',
				'Mileage'               => '250,001 - 500,000',
				'VIN'                   => 'qwertyu09876554321',
				'Sleeper Day Cab'       => 'No',
				'Model'                 => 'Model2'
			],
			[
				'Equipment Cost'        => '5000',
				'Equipment Quantity'    => '3',
				'Equipment Condition'   => 'New',
				'Equipment Type'        => 'GPS Units',
				'Equipment Description' => 'desc3',
				'Make'                  => '',
				'Type'                  => '',
				'Year'                  => '',
				'Mileage'               => '',
				'VIN'                   => '',
				'Sleeper Day Cab'       => '',
				'Model'                 => ''
			]
		],
		'dealerInfo'           => [
			'Equipment Dealer Contact' => 'efapi test',
			'Equipment Dealer Email'   => '[email protected]'
		],
		'pgDetails'            => [
			[
				'Guarantor Name'                   => 'test efpg',
				'Guarantor Address Line 1'         => '428 Yale Dr',
				'Guarantor Address Line 2'         => '',
				'Guarantor City'                   => 'Hampton',
				'Guarantor State'                  => 'VA',
				'Guarantor Zipcode'                => '23666',
				'Guarantor Social Security Number' => '666369221',
				'Guarantor Email'                  => '[email protected]',
				'Guarantor Phone'                  => '3198051444'
			],
			[
				'Guarantor Name'                   => 'test pg',
				'Guarantor Address Line 1'         => '770 Broadway',
				'Guarantor Address Line 2'         => '',
				'Guarantor City'                   => 'New York',
				'Guarantor State'                  => 'NY',
				'Guarantor Zipcode'                => '10003',
				'Guarantor Social Security Number' => '999999999',
				'Guarantor Email'                  => '[email protected]',
				'Guarantor Phone'                  => '3198051474'
			]
		],
		'equipmentAddress'     => [
			'Equipment Address Line 1' => '1210 Brace Rd',
			'Equipment Address Line 2' => 'Line2',
			'Equipment City'           => 'Medford',
			'Equipment State'          => 'NJ',
			'Equipment Zipcode'        => '08055'
		],
		'Payment Frequency'    => 'Monthly',
		'Term Requested'       => '',
		'Purchase Option'      => '',
		'Number Of Payments'   => '',
		'Comments'             => ''
	],
	'Contract Type'              => '',
	'documentDetails'            => [
		[
			'Attachment'      => 'Document Title',
			'fileDataEncoded' => 'Base 64 encoded file here',
			'fileExtension'   => 'docx',
			'Document Type'   => 'CR - Misc',
			'Description'     => 'Bank statement uploaded'
		]
	]

];

$curl = curl_init( $url );
curl_setopt( $curl, CURLOPT_URL, $url );
curl_setopt( $curl, CURLOPT_POST, true );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );

$headers = array(
	'Accept: application/json',
	'Content-Type: application/json',
	'Authorization: Basic ' . base64_encode( $username . ':' . $password ),
	'x-api-key: ' . $x_api_key,
);
curl_setopt( $curl, CURLOPT_HTTPHEADER, $headers );

$json_data = json_encode( $data );

curl_setopt( $curl, CURLOPT_POSTFIELDS, $json_data );

// FOR DEBUGGNIG ONLY!! DO NOT USE IN PRODUCTION
curl_setopt( $curl, CURLOPT_SSL_VERIFYHOST, false );
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER, false );
// END DEBUGGING

$resp = json_decode( curl_exec( $curl ) );
curl_close( $curl );

if ( isset( $resp->Status ) ) {
	// We have a response lets confirm what it is and go from there.
	if ( 'true' == $resp->Status ) {
		// Good response, now to do something with it.
		var_dump( 'successful connection' );
		var_dump( $resp );
	} elseif ( false == $resp->Status ) {
		var_dump( 'successful connection but no data in the response' );
		var_dump( $resp );
	} else {
		var_dump( 'successful connection but we have an unexpected response' );
		var_dump( $resp );
	}
} else {
	var_dump( 'Bad response, no status detected' );
	var_dump( $resp );
}
JSON Field Name Required/Optional Required to pass Optonal parameter Format Sample Values Default Values Comments
PartnerId Required(Either Partner Id /Dealer Number is Required) String 8042971FIOMIQAY
Dealer Number Required(Either Partner Id /Dealer Number is Required) String 855331.7237
Partner Reference ID Optional String CD1911130624
PartnerCustomerUniqueID Optional No String(Alphanumeric Values) Partner12Customer8UniqueID ( max length should be 50)
businessDetails Object
Legal Business Name Required String Business@123 ( max length should be 50)
Business Tax ID Optional No String (9 digit Numeric value) 123645987(max length 9),The Tax ID field should accept only 9-digit numeric numbers,No special characters are allowed,No letters allowed It is a required field in UDA/PUDA/HKF
DBA Name Optional No String DBA@123 ( max dbalength should be 50)
Business Type Required String Partnership(Any one from default values) Sole proprietorship
Partnership
Corporation
Limited Liability Company (LLC)
Business Start Month Optional No String Any one from default values based on the Month as "01"-"12" JAN = "01",
FEB = "02",
MAR = "03",
APR = "04",
MAY = "05",
JUNE = "06",
JULY = "07",
AUG = "08",
SEP = "09",
OCT = "10",
NOV = "11",
DEC = "12"
It is a required field in UDA/PUDA/HKF in New business scenerio.But optional for confirm business
Business Start Year Optional No String 2015(Max length of 4) Business year field is Optional it should accecpt Blank field values.
If Business year with 2 digits then system should through validation message "Business Start Year should be 4 digits , Business Start Year should be between 1750 and the current year"
If Business year less than 1750 then system should through validation message "Business Start Year should be 4 digits , Business Start Year should be between 1750 and the current year"
It is a required field in UDA/PUDA/HKF in New business scenerio.But optional for confirm business
Business Address Line 1 Required String(Alphanumeric Values) 1234 Market St
Business Address Line 2 Optional No String(Alphanumeric Values) Line 2
City Required String Philadelphia
State Required String Any one state code from default value based on the state.
(Max length 2)
AL, AK, AZ, AR, CA, CO, CT, DE, DC, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY
Zipcode Required String 12345(Max length of 5)
Business Phone Required String (10 digit Numeric Value) 1122334455(Max length of 10)
Business Email Required String -Valid email Format [email protected] It is a required field in UDA/PUDA/HKF/EF API Documentaion.
Made but made optional for validation
Contact Name Required String - Letters Only ( A- Z) Two Words (i.e; required first name and last name, letters only a-z and A-Z), FirstName (max length 40), LastName (max length 80) It is a required field in UDA/PUDA/HKF/EF API Documentaion.
Made but made optional for validation
Contact Phone Required String(10 digit Numeric Value) 1122334455(Max length of 10) It is a required field in UDA/PUDA/HKF/EF API Documentaion.
Made but made optional for validation
CCAN Optional No String(7 digit Numeric Value) 1234567(Max length of 7)
CCID Optional No String(7 Digit Alpha Numeric Value) C234567(Max length of 7)
Billing Address Line 1 Optional No String(Alphanumeric Values) 1234 Market St Not in UDA/PUDA/HKF
Billing Address Line 2 Optional No String(Alphanumeric Values) Line 2
Billing Address City Optional No String Philadelphia
Billing Address State Optional No String Any one state code from default value based on the state.
(Max length 2)
AL, AK, AZ, AR, CA, CO, CT, DE, DC, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY
Billing Address Zip Optional No String 12345(Max length of 5)
Phone Type Required String Mobile(any one of the default values) Mobile,Other
equipmentFinanceDetails Object
Total Equipment Cost Required String 50000 Sum of all equipment costs.
equipmentDetails Array Max of three Equipment Details can be added
Equipment Cost Required String 1500
Equipment Quantity Required String 1 1 to 99
Equipment Condition Required String New (any one of the default values) Used, New, Refurbished
Equipment Type Required String GPS Units "ATM's", "Audio / Visual Equipment (General)", "Automotive Equipment (General)", "Commercial & Industrial Equipment - Air Compressors", "Commercial & Industrial Equipment - Commercial Cleaning", "Commercial & Industrial Equipment - Fork Lifts", "Commercial & Industrial Equipment (General)", "Computer Hardware (General)", "Computer Software (General)", "Construction Equipment (General)", "Energy Management", "Fitness Equipment", "GPS Units", "HVAC Equipment", "Intangibles", "Leasehold Improvements", "Medical Equipment - Dental Implant Systems", "Medical Equipment - Medical Lasers", "Medical Equipment (General)", "Musical Instruments", "Office Equipment - Copiers", "Office Equipment (General)", "Office Furniture", "Photography (General)", "Playground Equipment", "Point of Sale (PoS) Equipment", "Printing Equipment", "Restaurant Equipment (General)", "Restricted Assets", "Security Systems - CCTV", "Security Systems (General)", "Signage - Customized", "Signage - Non Customized", "Telecom Equipment - VOIP", "Telecom Equipment (General)", "Titled Vehicles (General)", "Titled Vehicles -Dump Trucks", "Titled Vehicles -Trailers"
Equipment Description Required String Test
Make Required if Equipment Type = Titled Vehicles no String Ford 'GMC',
'Chevrolet',
'Ford',
'Freightliner',
'International',
'Isuzu',
'Kenworth',
'Mack',
'Peterbilt',
'Sterling',
'Volvo',
'Western Star',
'Other',
'GreatDane',
'Wabash',
'Fontaine',
'XLSpecialized',
'Ranco',
'Utility',
'Vanguard',
'Ram',
'Trailer',
'Hino'
Type Required if Equipment Type = Titled Vehicles No String Light Duty Light Duty',
'Medium Duty',
'Heavy Duty',
'Trailer'
Year Required if Equipment Type = Titled Vehicles No String 2015 (Value : 1996 - Present year )
Mileage Required if Equipment Type = Titled Vehicles No String 0 - 100,000 '0 - 100,000',
'100,001 - 250,000',
'250,001 - 500,000',
'500,001 - 750,000',
'750,000+'
VIN Optional String(Alphanumeric Values) 12advg89rthjesR14 (Max Field length is 17)
Sleeper Day Cab Required if Equipment Type = Titled Vehicles No String Yes Yes/No
Model Required if Equipment Type = Titled Vehicles No String TestModel
dealerInfo Object
Equipment Dealer Contact Optional No String Two Words (i.e; required first name and last name, letters only a-z and A-Z), FirstName (max length 40), LastName (max length 80)
Equipment Dealer Email Optional No String -Valid email Format [email protected]
pgDetails Array Max two pgDetails allowed
Guarantor Name Optional No String Two Words (i.e; required first name and last name, letters only a-z and A-Z), FirstName (max length 40), LastName (max length 80) Required for Business Type = Sole Proprietorship or if Guarantor is added. Optional for other Business Types in PUDA.
UDA/HKF - Required if guarantor is added.
Guarantor Address Line 1 Optional No String(Alphanumeric Values) 1234 Market St
Guarantor Address Line 2 Optional No String(Alphanumeric Values) Line 2
Guarantor City Optional No String Philadelphia
Guarantor State Optional No String Any one state code from default value based on the state.
(Max length 2)
AL, AK, AZ, AR, CA, CO, CT, DE, DC, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY
Guarantor Zipcode Optional No String 12345(Max length of 5)
Guarantor Social Security Number Optional No String (9 Digit Numeric value) 123456789(Max length of 9)
Guarantor Email Optional No String -Valid email Format [email protected]
Guarantor Phone Optional No String(10 digit Numeric Value) 1122334455(Max length of 10)
equipmentAddress Object
Equipment Address Line 1 Optional No String(Alphanumeric Values) 1234 Market St
Equipment Address Line 2 Optional No String(Alphanumeric Values) Line 2
Equipment City Optional No String Philadelphia
Equipment State Optional No String Any one state code from default value based on the state.
(Max length 2)
AL, AK, AZ, AR, CA, CO, CT, DE, DC, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY
Equipment Zipcode Optional No String 12345(Max length of 5)
Payment Frequency Required String Annually ( Pass any one the default values) Annually, Monthly, Quarterly
Number Of Payments Optional No String
Term Requested Optional No String
Purchase Option Optional No String Customer Owned', 'FMV', '1.00 Out', 'Assign Resid No Renewal', 'Assigned Residual', 'PUT', 'Guaranteed Residual'
Comments Optional No String
Contract Type Optional No String TL
LP
CS
RL
XX
RA
LL
TS
IN
LN
LC
documentDetails Array Max three documentDetails allowed
Attachment Optional - [Required if document is included in the request] No String Test document Name of the attached doc Documents are included in EF API only .Not in UDA/PUDA/HKF
fileDataEncoded Optional - [Required if document is included in the request] No String UEsDBBQABgAIAAAAIQCSZC2eZQEAAJ0FAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAACAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAC0lMtOwzAQRfdI/EPkLUrcskAINe2CxxIqUT7AtSethV+yp6+/Z9K0EUKlEbTdREpm7j13rIwHo7U12RJi0t6VrF/0WAZOeqXdrGQfk5f8nmUJhVPCeAcl20Bio+H11WCyCZAyUrtUsjlieOA8yTlYkQofwFGl8tEKpNc440HITzEDftvr3XHpHYLDHGsPNhw8QSUWBrPnNX1ukkQwiWWPTWPNKpkIwWgpkOp86dQPSr4jFKTc9qS5DumGGhg/SKgrvwN2ujc6mqgVZGMR8VVY6uIrHxVXXi4sKYvjNgdy+qrSElp97Rail5ASnbk1RVuxQrt9/l9zJNwYSOdP0fh24wGRBJcIsHPujLCC6fvFUnwz7wxSEXcipgbOH6O17gyBtIHQPPsn59jaHENS5zj6kGij4z/G3q9src5p4AAR9fG/riWS9cnzQX0bKFB/ZctFQm9Pxjc2B+B8e7kOvwAAAP//AwBQSwMEFAAGAAgAAAAhAJlVfgX+AAAA4QIAAAsACAJfcmVscy8ucmVscyCiBAIooAACAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACskk1LAzEQhu+C/yHMvTvbKiLS3V5E6E1k/QFDMvuBmw+Sqbb/3iiKLtS1hx4zeefJM0PWm70d1SvHNHhXwbIoQbHT3gyuq+C5eVjcgkpCztDoHVdw4ASb+vJi/cQjSW5K/RCSyhSXKuhFwh1i0j1bSoUP7PJN66MlycfYYSD9Qh3jqixvMP5mQD1hqq2pIG7NFajmEPgUtm/bQfO91zvLTo48gbwXdobNIsTcH2XI06iGYsdSgfH6MZcTUghFRgMeN1qdbvT3tGhZyJAQah953ucjMSe0POeKpokfmzcfDZqv8pzN9Tlt9C6Jt/+s5zPzrYSTj1m/AwAA//8DAFBLAwQUAAYACAAAACEA1mSzUfQAAAAxAwAAHAAIAXdvcmQvX3JlbHMvZG9jdW1lbnQueG1sLnJlbHMgogQBKKAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACskstqwzAQRfeF/oOYfS07fVBC5GxKIdvW/QBFHj+oLAnN9OG/r0hJ69BguvByrphzz4A228/BineM1HunoMhyEOiMr3vXKnipHq/uQRBrV2vrHSoYkWBbXl5sntBqTkvU9YFEojhS0DGHtZRkOhw0ZT6gSy+Nj4PmNMZWBm1edYtyled3Mk4ZUJ4wxa5WEHf1NYhqDPgftm+a3uCDN28DOj5TIT9w/4zM6ThKWB1bZAWTMEtEkOdFVkuK0B+LYzKnUCyqwKPFqcBhnqu/XbKe0y7+th/G77CYc7hZ0qHxjiu9txOPn+goIU8+evkFAAD//wMAUEsDBBQABgAIAAAAIQBrNGaOVQIAADQHAAARAAAAd29yZC9kb2N1bWVudC54bWyklU1v2zAMhu8D9h8M3VPFbtJ2RpMCWT/Qw4Ci7c6DIsu2EEsUJCVu9utH+SPO1qFImottiuLDV6JEX9+8qSraCOsk6BmJz8YkEppDJnUxIz9f70dXJHKe6YxVoMWMbIUjN/OvX67rNAO+VkL7CBHapbXhM1J6b1JKHS+FYu5MSW7BQe7POCgKeS65oDXYjCbjeNx8GQtcOIf5vjO9YY50OP52GC2zrMbgAJxQXjLrxdvAiI+GTOk3evUvSL1fGhih0ZmDVcyjaQuqmF2tzQi5hnm5lJX0W0SOL3oMzMja6rRDjHZSQkjaSulefYQ9JG8bctuVo8lIrahQA2hXSrPbU/VZGjrLHrL5aBEbVfXzahNPTjsQt21VBuAh8rtSqqpV/jExHh9QkYDYRRwi4e+cvRLFpB4Sf2pr9jY3nh4HSN4BLpw4DjHtENRt1XA1alOcVuUHC2sz0ORptEe92rFCvzqC1Z2W/RPsThPzUjKDV1nx9LHQYNmyQkVY+wjLFzUViMItIXPspkvItuFtojrFbpw9z8gYy3aeLBakH7oVOVtXPngm5/Hl3X0TacPDz1+F89GuJyfXNAyGZ+NfAqxCf3rx2NiQJzOkBLBmCkX9eoAF4ytC9+fe6Ww3kzYoE9xOcP9k/yOzkV+8/EYX3pM4SSZNhhK/p1eThhEm/GAh2ANe53jSTrGyKP1gLsF7UINdiXzPWwqWCWyMl0lj5gB+zyzWvjG7dBwqh6POMC7aOc0w7tODlWF5ldTiSXqOKs8v+nW2S2w+27rQ4Xc3/wMAAP//AwBQSwMEFAAGAAgAAAAhAAe3QKokBgAAjxoAABUAAAB3b3JkL3RoZW1lL3RoZW1lMS54bWzsWU2LGzcYvhf6H4a5Ox7bM/5Y4g3jsZ202U1CdpOSozwjzyjWjIwk764JgZKceikU0tJDA731UEoDDTT00h+zkNCmP6KSxmOPbLlLug6E0jWs9fG8rx69r/RI47l67SzF1gmkDJGsa9euOLYFs5BEKIu79r3jYaVtW4yDLAKYZLBrzyGzr+1//NFVsMcTmEJL2GdsD3TthPPpXrXKQtEM2BUyhZnoGxOaAi6qNK5GFJwKvymu1h2nWU0BymwrA6lwe3s8RiG0jqVLe79wPsDiX8aZbAgxPZKuoWahsNGkJr/YnAWYWicAd20xTkROj+EZty0MGBcdXdtRf3Z1/2p1aYT5FtuS3VD9LewWBtGkruxoPFoauq7nNv2lfwXAfBM3aA2ag+bSnwKAMBQzzbmUsV6v0+t7C2wJlBcNvvutfqOm4Uv+Gxt435MfDa9AedHdwA+HwSqGJVBe9AwxadUDV8MrUF5sbuBbjt93WxpegRKMsskG2vGajaCY7RIyJviGEd7x3GGrvoCvUNXS6srtM75traXgIaFDAVDJBRxlFp9P4RiEAhcAjEYUWQcoTsTCm4KMMNHs1J2h0xD/5cdVJRURsAdByTpvCtlGk+RjsZCiKe/anwqvdgny+tWr8ycvz5/8ev706fmTnxdjb9rdAFlctnv7w1d/Pf/c+vOX798++9qMZ2X8m5++ePPb7//knmu0vnnx5uWL199++cePzwxwn4JRGX6MUsisW/DUuktSMUHDAHBE383iOAGobOFnMQMZkDYG9IAnGvrWHGBgwPWgHsf7VMiFCXh99lAjfJTQGUcG4M0k1YCHhOAeocY53ZRjlaMwy2Lz4HRWxt0F4MQ0drCW5cFsKtY9MrkMEqjRvINFykEMM8gt2UcmEBrMHiCkxfUQhZQwMubWA2T1ADKG5BiNtNW0MrqBUpGXuYmgyLcWm8P7Vo9gk/s+PNGRYm8AbHIJsRbG62DGQWpkDFJcRh4AnphIHs1pqAWccZHpGGJiDSLImMnmNp1rdG8KmTGn/RDPUx1JOZqYkAeAkDKyTyZBAtKpkTPKkjL2EzYRSxRYdwg3kiD6DpF1kQeQbU33fQS1dF+8t+8JGTIvENkzo6YtAYm+H+d4DKByXl3T9RRlF4r8mrx770/ehYi+/u65WXN3IOlm4GXE3KfIuJvWJXwbbl24A0Ij9OHrdh/MsjtQbBUD9H/Z/l+2//OyvW0/716sV/qsLvLFdV25Sbfe3ccI4yM+x/CAKWVnYnrRUDSqijJaPipME1FcDKfhYgpU2aKEf4Z4cpSAqRimpkaI2cJ1zKwpYeJsUM1G37IDz9JDEuWttVrxdCoMAF+1i7OlaBcnEc9bm63VY9jSvarF6nG5ICBt34VEaTCdRMNAolU0XkBCzWwnLDoGFm3pfisL9bXIith/FpA/bHhuzkisN4BhJPOU2xfZ3XmmtwVTn3bdML2O5LqbTGskSstNJ1FahgmI4HrzjnPdWaVUoydDsUmj1X4fuZYisqYNONNr1qnYcw1PuAnBtGuPxa1QFNOp8MekbgIcZ1075ItA/xtlmVLG+4AlOUx15fNPEYfUwigVa72cBpytuNXqLTnHD5Rcx/nwIqe+ykmG4zEM+ZaWVVX05U6MvZcEywqZCdJHSXRqjfCM3gUiUF6rJgMYIcaX0YwQLS3uVRTX5GqxFbVfzVZbFOBpAhYnSlnMc7gqL+mU5qGYrs9Kry8mM4plki596l5sJDtKornlAJGnplk/3t8hX2K10n2NVS7d61rXKbRu2ylx+QOhRG01mEZNMjZQW7Xq1HZ4ISgNt1ya286IXZ8G66tWHhDFvVLVNl5PkNFDsfL74ro6w5wpqvBMPCMExQ/LuRKo1kJdzrg1o6hrP3I83w3qXlBx2t6g4jZcp9L2/EbF97xGbeDVnH6v/lgEhSdpzcvHHornGTxfvH1R7RtvYNLimn0lJGmVqHtwVRmrNzC1+vY3MBYSkXnUrA87jU6vWek0/GHF7ffalU7Q7FX6zaDVH/YDr90ZPratEwV2/UbgNgftSrMWBBW36Uj67U6l5dbrvtvy2wPXf7yItZh58V2EV/Ha/xsAAP//AwBQSwMEFAAGAAgAAAAhAOtDYIzKAwAAGwoAABEAAAB3b3JkL3NldHRpbmdzLnhtbLRW227bOBB9X2D/QdDzKrrYzkWoU9R2tE0RbxeV+wGURNlEeANJ2XEX++87pMTIaYrC3aJPpubMnBnOjX7z9onRYI+VJoLPw/QiCQPMa9EQvp2HnzdFdB0G2iDeICo4nodHrMO3t7//9uaQa2wMqOkAKLjOWT0Pd8bIPI51vcMM6QshMQewFYohA59qGzOkHjsZ1YJJZEhFKDHHOEuSy3CgEfOwUzwfKCJGaiW0aI01yUXbkhoPP95CneO3N1mJumOYG+cxVphCDILrHZHas7H/ywbgzpPsv3eJPaNe75AmZ1z3IFTzbHFOeNZAKlFjraFAjPoACR8dT18RPfu+AN/DFR0VmKeJO51GPvsxguwVwaXGP0YxGyhifWT4yRNpek5KeuiBVAqpvuGGfLA6v99yoVBFIRzISwBXC1x04S10+RchWHDIJVY1lBpGJEnC2AKQYNGWBhkMsJaYUjczNcUIaA/5ViEG3e4lzqbBLeqo2aCqNEKC0h5B9FfZQFnvkEK1waqUqAa2peBGCer1GvGXMEuYHAWFHSzcHI2nsp9JsOCIwX1ezNlaNNhG1ilyfuKtgfOezk5dfu1IwA5RpMEbm8fSHCkuIPiSfMHvePOh04YAo5u2n4jgewFgbj1/hMpvjhIXGJkO0vSLnLlKFJTINVFKqHveQG/8MmekbbECBwR6bQ3tQ5Q4uDy/x6iB1f2TfuPTNoKHoNH+8EkI41WTZDpJr+6KPlKLjkiaTbLF4lvIaBM/c7Pcrsq/lT/ZRglYb7FErFIEBWu7TGOrUanHBeEerzAMNT5Fyq7yYBT1gGaI0gImyQNuvFjeEC1XuHVnukZqO/IOGuqbUpjaD89cdgtg9acSnezRg0KybwCvkk6ngyXh5oEwL9ddVXorDmvoBOp483GvXJ7G9BxyA4V0g/SAXEM4Xcyjz+XQMFSVtth4jaTse6bapvOQku3OpLbMBr4aeHPdR7XNBixzWNZj7gPV9magPRxGWeZlJ3oTL5uMsqmXTUfZzMtmo+zSyy6tbAfTqmB1PkL7+qOVt4JSccDN+xF/JeqToHdI4lW/WaG9RC8YVq0O9jl+gr2NG2Lgr4wkDUNPdo1nl9Z80KboKDrzQtdiVlm+ZGiQQX5wXhi7Fv8qFrvxawLtWB5ZNS7yiz5wSjQMu4Sdb4Ty2B8OS6d5I+p7mCQ49Y/E5KZYLif9lKUz91aYDTT5I9T9E24XSONmwLzprDf956ookmK1uo6W2XUSTW9mq+i6WBTRYvXu7u7mZnl3tcz+HYbU/6u7/Q8AAP//AwBQSwMEFAAGAAgAAAAhAEtZ7V24AQAAPAUAABIAAAB3b3JkL2ZvbnRUYWJsZS54bWzckt9q2zAUxu8Heweh+8ayE6edqVPWroHB2MVoH0BRZFtUf4yOEjdvvyPZyaCh0NzsojYY6fukn44+n9u7V6PJXnpQztY0nzFKpBVuq2xb0+en9dUNJRC43XLtrKzpQQK9W339cjtUjbMBCO63UBlR0y6EvsoyEJ00HGaulxbNxnnDA059mxnuX3b9lXCm50FtlFbhkBWMLemE8R+huKZRQv5wYmekDWl/5qVGorPQqR6OtOEjtMH5be+dkAB4Z6NHnuHKnjD54gxklPAOXBNmeJmpooTC7TlLI6P/AcrLAMUZYAnyMkQ5ITI4GPlKiRHVz9Y6zzcaSXglglWRBKar6WeSobLcoP3Atdp4lYyeWwcyR2/PdU1ZwdasxG98F2wevzSLC0XHPcgIGReyUW64UfpwVGFQAKPRqyC6o77nXsXSRgtUi8YONqymj4yx4vt6TUclx+qisri+n5QinpWeb5MyPyksKiJx0jQfOSJxTmvwzGxM4CyJJ2UkkN9yIH+c4fadRAq2xCRKzCMmM78oEZ+4Fyfy+DaR65vyvyQy9Qb5pdouvNshsS8+aYdMA1j9BQAA//8DAFBLAwQUAAYACAAAACEAk3bWSRgBAABAAgAAFAAAAHdvcmQvd2ViU2V0dGluZ3MueG1slNHBSgMxEAbgu+A7hNzbbIstsnRbEKl4EUF9gDSdbYOZTMikbuvTO65VES/tLZNkPuZnZos9BvUGmT3FRo+GlVYQHa193DT65Xk5uNaKi41rGyhCow/AejG/vJh1dQerJyhFfrISJXKNrtHbUlJtDLstoOUhJYjy2FJGW6TMG4M2v+7SwBEmW/zKB18OZlxVU31k8ikKta13cEtuhxBL328yBBEp8tYn/ta6U7SO8jplcsAseTB8eWh9/GFGV/8g9C4TU1uGEuY4UU9J+6jqTxh+gcl5wPgfMGU4j5gcCcMHhL1W6Or7TaRsV0EkiaRkKtXDei4rpVQ8+ndYUr7J1DFk83ltQ6Du8eFOCvNn7/MPAAAA//8DAFBLAwQUAAYACAAAACEAX5Ygw9wBAADjAwAAEAAIAWRvY1Byb3BzL2FwcC54bWwgogQBKKAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACck99v2yAQx98n7X+weG+wo66aIkI1pZry0K2R4rbPDJ9tNAwIaNTsr99hJy7Z+lQ/3S++fLg7s9vXQRcH8EFZsybVoiQFGGkbZbo1eay/X30lRYjCNEJbA2tyhEBu+edPbOetAx8VhAIlTFiTPka3ojTIHgYRFpg2mGmtH0RE13fUtq2ScGflywAm0mVZ3lB4jWAaaK7cLEgmxdUhflS0sTLxhaf66FCPsxoGp0UE/jOd1IzOAVbbKHStBuAlhmeH7UQHgVeMTgZ7tr4JfMnoZLBNL7yQEVvHq2tGM5d9c04rKSL2lP9Q0ttg21g8jKBFOs5oXsIQfg/yxat4TBC5y+6VmTAmA7G86Lxw/Ylt9theCg0bfDZvhQ7A6FuAbUGkke6ESnyHuDqAjNYXQf3BoS5J8UsESM1ak4PwSphIprLJGW3tQvS8VlGj9uyPZl6W2+o6QU7GZeHojAxoX9KNN4SHFt8W34GtctiRYULNcHKy8x3/qG7s4IQ58u3mvqhB9sZq2+Hu4SBPmdT53+HR1fYu7cmpp5fBbAmeVez3Tsg0rC/5OmQJtscoNDjfeURzgG3xQV4neTxrOmjONf8n0oI9Tf8sr24WJX7jRp1juBfzz8T/AgAA//8DAFBLAwQUAAYACAAAACEAn+aUEioLAABTcAAADwAAAHdvcmQvc3R5bGVzLnhtbLydXXPbuhGG7zvT/8DRVXuRyPJn4jnOGduJa0/jHJ/Iaa4hErJQg4TKj9jury8AUhLkJSguuPWVLVH7AMSLF8CCpPTb78+pjH7xvBAqOxtN3u+NIp7FKhHZw9nox/3Vuw+jqChZljCpMn42euHF6PdPf/3Lb0+nRfkieRFpQFacpvHZaFGWy9PxuIgXPGXFe7XkmT44V3nKSv0yfxinLH+slu9ilS5ZKWZCivJlvL+3dzxqMHkfiprPRcw/q7hKeVba+HHOpSaqrFiIZbGiPfWhPak8WeYq5kWhTzqVNS9lIltjJocAlIo4V4Wal+/1yTQ1sigdPtmz/6VyAzjCAfYB4LjgOMRRgxgXLyl/HkVpfHrzkKmczaQm6VOKdK0iCx590momKv7M56ySZWFe5nd587J5Zf9cqawsoqdTVsRC3OtaaFQqNPX6PCvESB/hrCjPC8FaDy7MP61H4qJ03r4QiRiNTYnFf/XBX0yejfb3V+9cmhpsvSdZ9rB6j2fvfkzdmjhvzTT3bMTyd9NzEzhuTqz+65zu8vUrW/CSxcKWw+Yl1x11crxnoFIYX+wffVy9+F6ZFmZVqZpCLKD+u8aOQYvr/qt787Q2lT7K519V/MiTaakPnI1sWfrNHzd3uVC5Ns7Z6KMtU7855am4FknCM+eD2UIk/OeCZz8Knmze//PKdv7mjVhVmf7/4GRie4Eski/PMV8aK+mjGTOafDMB0ny6EpvCbfh/VrBJo0Rb/IIzM55Ek9cIW30UYt9EFM7ZtjOrV+duP4Uq6OCtCjp8q4KO3qqg47cq6OStCvrwVgVZzP+zIJEl/Lk2IiwGUHdxPG5EczxmQ3M8XkJzPFZBczxOQHM8HR3N8fRjNMfTTRGcUsW+Xuh09gNPb+/m7p4jwri7p4Qw7u4ZIIy7e8AP4+4e38O4u4fzMO7u0TuMu3uwxnPrpVZ0o22WlYNdNleqzFTJo5I/D6exTLNskkXDM5Mez0lOkgBTj2zNRDyYFjP7encPsSYNn89Lk85Fah7NxUOV69x8aMV59otLnSVHLEk0jxCY87LKPS0S0qdzPuc5z2JO2bHpoCYTjLIqnRH0zSV7IGPxLCFuvhWRZFBYd2idPy+MSQRBp05ZnKvhVVOMbHz4KorhbWUg0UUlJSdifaPpYpY1PDewmOGpgcUMzwwsZnhi4GhG1UQNjailGhpRgzU0onar+ydVuzU0onZraETt1tCGt9u9KKUd4t1Vx6T/3t2lVGZbfHA9puIhY3oBMHy6afZMozuWs4ecLReR2ZVux7rnjC3nQiUv0T3FnLYmUa3rbRe51Gctsmp4g27RqMy15hHZa80jMtiaN9xit3qZbBZo1zT5zLSala2mtaRepp0yWdUL2uFuY+XwHrYxwJXICzIbtGMJevA3s5w1clKMfJtaDq/YhjXcVq9HJdLqNUiCWkoVP9IMw9cvS57rtOxxMOlKSameeEJHnJa5qvuaa/l9K0kvy39JlwtWCJsrbSH6T/WrC+rRLVsOPqE7yURGo9uXdykTMqJbQVzf336N7tXSpJmmYWiAF6osVUrGbHYC//aTz/5OU8FznQRnL0Rne060PWRhl4JgkqlJKiEi6WWmyATJHGp5/+QvM8XyhIZ2l/P6HpaSExGnLF3Wiw4Cb+lx8UmPPwSrIcv7F8uF2ReiMtU9CczZNiyq2b95PHyo+6Yikp2hP6rS7j/apa6NpsMNXyZs4YYvEayaenow/ZfgZLdww092C0d1speSFYXwXkIN5lGd7opHfb7Dk7+Gp6TK55Wka8AVkKwFV0CyJlSySrOC8owtj/CELY/6fAm7jOURbMlZ3j9ykZCJYWFUSlgYlQwWRqWBhZEKMPwOHQc2/DYdBzb8Xp0aRrQEcGBU/Yx0+ie6yuPAqPqZhVH1Mwuj6mcWRtXPDj5HfD7Xi2C6KcZBUvU5B0k30WQlT5cqZ/kLEfKL5A+MYIO0pt3lam4eblBZfRM3AdLsUUvCxXaNoxL5J5+RVc2wKOtFsCPKpFSKaG9tM+HYyO1713aF2Sc5BlfhTrKYL5RMeO45J3+szpen9WMZr6tvq9Fr2/OreFiU0XSx3u13Mcd7OyNXCftW2O4C29r8ePU8S1vYLU9Ela4qCh+mOD7oH2x79Fbw4e7gzUpiK/KoZyQs83h35GaVvBV50jMSlvmhZ6T16VZklx8+s/yxtSOcdPWfdY7n6XwnXb1oHdxabFdHWke2dcGTrl60ZZXoPI7N1QKoTj/P+OP7mccfj3GRn4Kxk5/S21d+RJfBvvNfwszsmEHTlre+ewKM+3YR3Wvk/LNS9b791gWn/g913eiFU1bwqJVz0P/C1dYo42/H3sONH9F73PEjeg9AfkSvkcgbjhqS/JTeY5Mf0XuQ8iPQoxWcEXCjFYzHjVYwPmS0gpSQ0WrAKsCP6L0c8CPQRoUItFEHrBT8CJRRQXiQUSEFbVSIQBsVItBGhQswnFFhPM6oMD7EqJASYlRIQRsVItBGhQi0USECbVSIQBs1cG3vDQ8yKqSgjQoRaKNCBNqodr04wKgwHmdUGB9iVEgJMSqkoI0KEWijQgTaqBCBNipEoI0KESijgvAgo0IK2qgQgTYqRKCNWj9qGG5UGI8zKowPMSqkhBgVUtBGhQi0USECbVSIQBsVItBGhQiUUUF4kFEhBW1UiEAbFSLQRrUXCwcYFcbjjArjQ4wKKSFGhRS0USECbVSIQBsVItBGhQi0USECZVQQHmRUSEEbFSLQRoWIrv7ZXKL03WY/we96eu/Y73/pqqnUd/dRbhd10B+1qpWf1f9ZhAulHqPWBw8PbL7RDyJmUii7Re25rO5y7S0RqAuff1x2P+Hj0gd+6VLzLIS9Zgrgh30jwZ7KYVeXdyNBknfY1dPdSLDqPOwafd1IMA0edg261perm1L0dASCu4YZJ3jiCe8arZ1w2MRdY7QTCFu4a2R2AmEDd43HTuBRZAbn19FHPdvpeH1/KSB0dUeHcOIndHVLqNVqOIbG6Cuan9BXPT+hr4x+AkpPLwYvrB+FVtiPCpMa2gwrdbhR/QSs1JAQJDXAhEsNUcFSQ1SY1HBgxEoNCVipwwdnPyFIaoAJlxqigqWGqDCp4VSGlRoSsFJDAlbqgROyFxMuNUQFSw1RYVLDxR1WakjASg0JWKkhIUhqgAmXGqKCpYaoMKlBloyWGhKwUkMCVmpICJIaYMKlhqhgqSGqS2q7i7IlNUphJxy3CHMCcROyE4gbnJ3AgGzJiQ7MlhxCYLYEtVppjsuWXNH8hL7q+Ql9ZfQTUHp6MXhh/Si0wn5UmNS4bKlN6nCj+glYqXHZkldqXLbUKTUuW+qUGpct+aXGZUttUuOypTapwwdnPyFIaly21Ck1LlvqlBqXLfmlxmVLbVLjsqU2qXHZUpvUAydkLyZcaly21Ck1LlvyS43LltqkxmVLbVLjsqU2qXHZkldqXLbUKTUuW+qUGpct+aXGZUttUuOypTapcdlSm9S4bMkrNS5b6pQaly11Su3JlsZPWz/AZNj29830h8uXJTffwe08MJPU30HaXAS0H7xJ1j+UZIJNTaLmJ6mat22FmwuGdYk2EBYVL3RZcfPtSZ6imm9BXT/GY78D9XXBnq9KtRXZNMHq002Tbi6F1p/buuzZWe/SNHlHna0knW1Uq+ar4MemG+6qoa7PTNY/2qX/uckSDXhqfrCqrmnyzGqUPn7Jpbxl9afV0v9RyedlfXSyZx+af3V8Vn//mzc+twOFFzDerkz9svnhME97198I31zB9nZJ44aW5ra3Uwxt6U3dVv8Vn/4HAAD//wMAUEsDBBQABgAIAAAAIQDgtMtbdQEAAAEDAAARAAgBZG9jUHJvcHMvY29yZS54bWwgogQBKKAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACMklFPwjAQgN9N/A9L30dXIEaXMRI1PElCIkbjW20PKGxd0x4M/r3dxoaLmPh21/v69XptMj3mWXAA61ShJ4QNIhKAFoVUej0hb8tZeE8Ch1xLnhUaJuQEjkzT25tEmFgUFha2MGBRgQu8SbtYmAnZIJqYUic2kHM38IT2xVVhc44+tWtquNjxNdBhFN3RHJBLjpxWwtB0RnJWStEpzd5mtUAKChnkoNFRNmD0wiLY3F3dUFd+kLnCk4GraFvs6KNTHViW5aAc1ajvn9GP+ctrfdVQ6WpWAkiaSBGjwgzShF5CH7n91xYENstd4mNhgWNh04Xd4+agLN8GC26VF2uparolqtnv4FQWVjrv6WUek+CEVQb9izan9BY8nXGHc//EKwXy8fTXgb/Baq+Fg6r+SspqokuT8+CbJkEGfmBxM9628j56el7OSDqM2EPIhiEbLxmLx6M4ij6rPnv7L8L83MD/jeO+sRU0o+p/2vQbAAD//wMAUEsDBBQABgAIAAAAIQCz1AOWPwEAAJICAAATAAgBZG9jUHJvcHMvY3VzdG9tLnhtbCCiBAEooAABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAALSSsW7CMBCG90p9h8i7sWMSQlASVBJoK3VggK7IcRyIlNhRzqFFVd+9RpRShi6tOp7u9P3f6S6avja1s5cdVFrFyB1Q5EgldFGpbYzWqwUeIwcMVwWvtZIxOkhA0+T2Jlp2upWdqSQ4FqEgRjtj2gkhIHay4TCwbWU7pe4abmzZbYkuy0rITIu+kcoQRumIiB6MbnD7hUMn3mRvfosstDjawfPq0FpeEn3CD07ZmKqI0Vvmp1nmUx+zeZhil7ozHA7DANMxpWzG0kV4N39HTnscZshRvLGrryrTw/36MbPEvZnU7QuYLvGLIKAe45h7RY69kns4ZHmJc8pKj49oIcIgIpf5iJxt/ug1PHs9pE+btOY+bLLRldqC1yD/Jdv7lm2jASp7BW7sD10JXMyWfV674icXcnmm5AMAAP//AwBQSwECLQAUAAYACAAAACEAkmQtnmUBAACdBQAAEwAAAAAAAAAAAAAAAAAAAAAAW0NvbnRlbnRfVHlwZXNdLnhtbFBLAQItABQABgAIAAAAIQCZVX4F/gAAAOECAAALAAAAAAAAAAAAAAAAAJ4DAABfcmVscy8ucmVsc1BLAQItABQABgAIAAAAIQDWZLNR9AAAADEDAAAcAAAAAAAAAAAAAAAAAM0GAAB3b3JkL19yZWxzL2RvY3VtZW50LnhtbC5yZWxzUEsBAi0AFAAGAAgAAAAhAGs0Zo5VAgAANAcAABEAAAAAAAAAAAAAAAAAAwkAAHdvcmQvZG9jdW1lbnQueG1sUEsBAi0AFAAGAAgAAAAhAAe3QKokBgAAjxoAABUAAAAAAAAAAAAAAAAAhwsAAHdvcmQvdGhlbWUvdGhlbWUxLnhtbFBLAQItABQABgAIAAAAIQDrQ2CMygMAABsKAAARAAAAAAAAAAAAAAAAAN4RAAB3b3JkL3NldHRpbmdzLnhtbFBLAQItABQABgAIAAAAIQBLWe1duAEAADwFAAASAAAAAAAAAAAAAAAAANcVAAB3b3JkL2ZvbnRUYWJsZS54bWxQSwECLQAUAAYACAAAACEAk3bWSRgBAABAAgAAFAAAAAAAAAAAAAAAAAC/FwAAd29yZC93ZWJTZXR0aW5ncy54bWxQSwECLQAUAAYACAAAACEAX5Ygw9wBAADjAwAAEAAAAAAAAAAAAAAAAAAJGQAAZG9jUHJvcHMvYXBwLnhtbFBLAQItABQABgAIAAAAIQCf5pQSKgsAAFNwAAAPAAAAAAAAAAAAAAAAABscAAB3b3JkL3N0eWxlcy54bWxQSwECLQAUAAYACAAAACEA4LTLW3UBAAABAwAAEQAAAAAAAAAAAAAAAAByJwAAZG9jUHJvcHMvY29yZS54bWxQSwECLQAUAAYACAAAACEAs9QDlj8BAACSAgAAEwAAAAAAAAAAAAAAAAAeKgAAZG9jUHJvcHMvY3VzdG9tLnhtbFBLBQYAAAAADAAMAAIDAACWLAAAAAA= Base 64 encoded string
fileExtension Optional - [Required if document is included in the request] No String pdf uploaded file type extension
Document Type Optional - [Required if document is included in the request] No String CR - Misc(any one of the default value) CR - Credit Application
CR - Invoice/Quote/Proposal
CR - Bank Statements
CR - Financial Statements
CR - Misc
Description Optional - [Required if document is included in the request] No String Bank document uploaded
Sample Request JSON

       {
		'PartnerId': 8042971FIOMIQAY,
		'Partner Reference ID': CD1911270045,
		'Dealer Number': '',
		'businessDetails': {
			'Legal Business Name': 'test bnameHVL',
			'Business Tax ID': '631234445',
			'DBA Name': 'Company Inc',
			'Business Type': 'Partnership',
			'Business Start Month': '07',
			'Business Start Year': '1969',
			'Business Address Line 1': '121 brace rd',
			'Business Address Line 2': 'Test Address2',
			'City': 'cherry hill',
			'State': 'NJ',
			'Zipcode': '08340',
			'Business Phone': '8568469508',
			'Business Email': '[email protected]',
			'Contact Name': 'test coneuy',
			'Contact Phone': '8568469544',
			'CCAN': '',
			'CCID': '',
			'Billing Address Line 1': '7736 Green Valley Rd',
			'Billing Address Line 2': '',
			'Billing Address City': 'Wyncote',
			'Billing Address State': 'PA',
			'Billing Address Zip': '19095',
			'Phone Type': 'Mobile'
		},
		'equipmentFinanceDetails': {
			'Total Equipment Cost': '25000',
			'equipmentDetails': [{
				'Equipment Cost': '7000',
				'Equipment Quantity': '1',
				'Equipment Condition': 'New',
				'Equipment Type': 'GPS Units',
				'Equipment Description': 'desc1 test',
				'Make': '',
				'Type': '',
				'Year': '',
				'Mileage': '',
				'VIN': '',
				'Sleeper Day Cab': '',
				'Model': ''
			},
				{
					'Equipment Cost': '13000',
					'Equipment Quantity': '2',
					'Equipment Condition': 'Used',
					'Equipment Type': 'Titled Vehicles (General)',
					'Equipment Description': 'desc2',
					'Make': 'Wabash',
					'Type': 'Trailer',
					'Year': '2010',
					'Mileage': '250,001 - 500,000',
					'VIN': 'qwertyu09876554321',
					'Sleeper Day Cab': 'No',
					'Model': 'Model2'
				},
				{
					'Equipment Cost': '5000',
					'Equipment Quantity': '3',
					'Equipment Condition': 'New',
					'Equipment Type': 'GPS Units',
					'Equipment Description': 'desc3',
					'Make': '',
					'Type': '',
					'Year': '',
					'Mileage': '',
					'VIN': '',
					'Sleeper Day Cab': '',
					'Model': ''
				}],
			'dealerInfo': {
				'Equipment Dealer Contact': 'efapi test',
				'Equipment Dealer Email': '[email protected]'
			},
			'pgDetails': [{
				'Guarantor Name': 'test efpg',
				'Guarantor Address Line 1': '428 Yale Dr',
				'Guarantor Address Line 2': '',
				'Guarantor City': 'Hampton',
				'Guarantor State': 'VA',
				'Guarantor Zipcode': '23666',
				'Guarantor Social Security Number': '666369221',
				'Guarantor Email': '[email protected]',
				'Guarantor Phone': '3198051444'
			},
				{
					'Guarantor Name': 'test pg',
					'Guarantor Address Line 1': '770 Broadway',
					'Guarantor Address Line 2': '',
					'Guarantor City': 'New York',
					'Guarantor State': 'NY',
					'Guarantor Zipcode': '10003',
					'Guarantor Social Security Number': '999999999',
					'Guarantor Email': '[email protected]',
					'Guarantor Phone': '3198051474'
				}
			],
			'equipmentAddress': {
				'Equipment Address Line 1': '1210 Brace Rd',
				'Equipment Address Line 2': 'Line2',
				'Equipment City': 'Medford',
				'Equipment State': 'NJ',
				'Equipment Zipcode': '08055'
			},
			'Payment Frequency': 'Monthly',
			'Term Requested': '',
			'Purchase Option': '',
			'Number Of Payments': '',
			'Comments': ''
		},
		'Contract Type': '',
		'documentDetails': [{
			'Attachment': 'Document Title',
			'fileDataEncoded': 'Base 64 encoded file here',
			'fileExtension': 'docx',
			'Document Type': 'CR - Misc',
			'Description': 'Bank statement uploaded'
		}]

	}

Sample Response JSON

{
    "Status": "true",
    "Message": "Success"
}
HTTP Method POST
Development Environment
URL https://testdevportal.marlincapitalsolutions.com:8077/ws/rest/partnerefapi/createPartnerEfApi/
Headers
content-type application/json
x-api-key
Authorization
Type : Basic Auth Username: Devportal UID
Password: Devportal PWD
Production Environment
URL https://devportal.marlincapitalsolutions.com:8077/ws/rest/partnerefapi/createPartnerEfApi/
Headers
content-type application/json
x-api-key
Authorization
Type : Basic Auth Username: PROD Devportal UID
Password: PROD Devportal PWD