Getting Rates

To get rates a request must be made to the GetRates Method.

Table 1 GetRates Request Signature

Property Name	Type	Required	Description	Example
Credentials	ARCHLogin Object	Y	Your login credentials	ARCHLogin
RateRequest	RateRequest Object	Y	The parameters used for rating	RateRequest

The GetRates method will return the following:

Table 2 GetRates Response Signature

Type	Description	Example
RateResponse Object	An object containing the necessary data to define each rate.	RateResponse

The RateResponse object contains the following properties:

Table 3 RateResponse Object Signature

Property Name	Type	Description	Example
Dealer	Dealer Object	Information about the given dealer.	Dealer
Vehicle	Vehicle Object	The VIN decode for the given vin.	Vehicle
Plans	Array of Plan Object	A collection of plans	Plan

Getting Form Fields

After rates have been retrieved and a rate has been selected to be contracted upon the list of form fields that are specific to the rate will need to be acquired by using the GetFormFields method.

Table 4 GetFormFields Request Signature

Property Name	Type	Required	Description	Example
Credentials	ARCHLogin Object	Y	Your login credentials	ARCHLogin
RateId	Integer	Y	The RateId from the selected rate returned from the GetRates method	123

The GetFormFields method will return the following:

Table 5 GetFormFields Response Signature

Type	Description	Example
Array of FormField objects	A collection of the form fields	FormField

The FormField object contains the following properties:

Table 6 FormField Object Signature

Property Name	Type	Description	Example
IsRequired	Boolean	Your login credentials	True/false
MaxCharacters	Nullable Integer	The maximum allowable amount of characters	10
MinCharacters	Nullable Integer	The minimum allowable amount of characters	3
MaxValue	Nullable Decimal	The maximum allowable value	250.25
MinValue	Nullable Decimal	The minimum allowable value	200.15
Name	String	The name of the field	Favorite Color
ListItems	Array of String	If this is a list type field this will contain the valid list items	Red,Blue,Green
Type	Enum	The type of the field	FieldTypes

Draft PDFs

We provide the ability to acquire a PDF document prior to actually committing the agreement that will show exactly what the final contract documents will look like. This is done by calling GetDraftPdf.

Table 7 GetDraftPdf Request Signature

Property Name	Type	Required	Description	Example
Credentials	ARCHLogin Object	Y	Your login credentials	ARCHLogin
ContractData	ContractSubmitRequest Object	Y	The same data thats submitted when the contract is entered.	ContractSubmitRequest
ShouldHideWatermark	Boolean	Y	Indicates if the watermark should be hidden.	True

The GetDraftPdf method returns the following:

Table 8 GetDraftPdf Response Signature

Type	Description	Example
Array of Pdf Object	All necessary contract documents with the name of the document as the key	Pdf

Inserting a Contract

Once a rate has been selected from the list of rates, the form fields have been retrieved and populated, and (if need be) the draft pdf has been retrieved and looked at the next step is to submit the contract to the system. This requires a call to InsertContract

Table 9 InsertContract Reqeuest Signature

Property Name	Type	Required	Description	Example
Credentials	ARCHLogin Object	Y	Your login credentials	ARCHLogin
Contract	ContractSubmitRequest Object	Y	The data that defines the contract.	ContractSubmitRequest

The InsertContract method returns the following:

Table 10 InsertContract Response Signature

Type	Description	Example
String Array	An array containing the contract code in the first index, and the contract suffix if one was created in the second index.	{1GMABCD23,A}

Getting Contract PDFs

After an agreement is inserted into the system a copy of the contract will probably need to be retrieved. You can get this document, and any other pertinent documents the administrator has set up, by using the GetContractPdf method.

Table 11 GetContractPdf Request Signature

Property Name	Type	Required	Description	Example
Credentials	ARCHLogin Object	Y	Your login credentials	ARCHLogin
ContractNumber	String	Y	The number that ARCH generated and returned to from the InsertContract method.	1GMA13BC
Suffix	String	Y	The suffix that ARCH generated and returned from the InsertContact method. This may be passed in as null if there was no suffix but still is required if there was a suffix to obtain the correct documents.	A

The GetContractPdf method returns the following:

Table 12 GetContractPdf Response Signature

Type	Description	Example
Pdf Object	All necessary contract documents with the name of the document as the key	Pdf

Uploading and Downloading Signed Documents

After contract PDFs have been given to a customer it may be ncessarry to upload one or more signed documents back to ARCH for storage. The methods UploadSignedDocuments and RetrieveSignedDocuemnts can be used to accomplish this functionality.

Uploading Signed Docuements

The upload method does not return anything. Exceptions will indicate an error.

Table 13 UploadSignedPdf Request Signature

Property Name	Type	Required	Description	Example
Credentials	ARCHLogin Object	Y	Your login credentials	ARCHLogin
ContractNumber	String	Y	The number that ARCH generated and returned to from the InsertContract method.	1GMA13BC
Suffix	String	Y	The suffix that ARCH generated and returned from the InsertContact method. This may be passed in as null if there was no suffix but still is required if there was a suffix to obtain the correct documents.	A
ProductCode	String	N	The product code of the product for which the docuemnts are being uploaded. To be used in the case where there are multiple agreements with the same number and suffix for different products	ProVSC
Docuements	Array of SignedDocument objects	Y	The documents being uploaded	SignedDocument

Retrieving Signed Docuements

Table 14 RetrieveSignedDocuments Request Signature

Property Name	Type	Required	Description	Example
Credentials	ARCHLogin Object	Y	Your login credentials	ARCHLogin
ContractNumber	String	Y	The number that ARCH generated and returned to from the InsertContract method.	1GMA13BC
Suffix	String	Y	The suffix that ARCH generated and returned from the InsertContact method. This may be passed in as null if there was no suffix but still is required if there was a suffix to obtain the correct documents.	A
ProductCode	String	N	The product code of the product for which the docuemnts are being uploaded. To be used in the case where there are multiple agreements with the same number and suffix for different products	ProVSC

Table 15 RetrieveSIgnedDocuments Response Signature

Type	Description	Example
Array of SignedDocument objects	The documents being uploaded	SignedDocument

Voiding Contracts

During the course of routine business a deal may fall through or unwind and the contracts may need to be voided. In the event that a contract needs to be voided through the ARCH system then the VoidContract method should be called.

Table 16 VoidContract Request Signature

Property Name	Type	Required	Description	Example
Credentials	ARCHLogin Object	Y	Your login credentials	ARCHLogin
ContractNumber	String	Y	The number that ARCH generated and returned to from the InsertContract method.	1GMA13BC
Suffix	String	Y	The suffix that ARCH generated and returned from the InsertContact method. This may be passed in as null if there was no suffix but still is required if there was a suffix to obtain the correct documents.	A
Reason	String	N	The reason the contract is voided.	Buyers Remorse

The VoidContract method returns the following:

Table 17 VoidContract Response

Type	Description	Example
Int64	The internal ARCH void Id for reference.	2145

Inserting Batches of contracts

It is also possible to transmit batches of contracts. The workflow for the batch contract submit process is a bit different than that of the normal contract submission. A collection of contracts is submitted but no PDF can be generated for these contracts as they are not recognized as valid until they are handled by an ARCH user with the proper authority to bring the contracts In Force. To accomplish batch transmission, use the TransmitBatch service method

Table 18 TransmitBatch Request Signature

Property Name	Type	Required	Description	Example
Credentials	ARCHLogin Object	Y	Your login credentials	ARCHLogin
TransmittalNumber	String	Y	A number that can be used to reference the batch in the transmitter system	20150227-123
Contracts	A collection of ContractSubmitRequest Objects	Y	The contracts being transmitted	ContractSubmitRequest
CashTransactions	A collection of CashTransaction Objects	N	The cash transactions used to pay for the batch	CashTransaction
RemitAmount	Decimal	N	The total monetary amount being sent in for this batch	4334.35

Table 19 TransmitBatch Response Signature

Type	Description	Example
String	The batch number generated by arch used for tracking the batch.	ABC123

Searching for Existing Contracts

To search if a contract exist or to get a list of contracts call the GetContracts service method which accepts the standard login credentials and a ContractSearchData object. It will return a list of Contacts

Table 20 GetContracts Request Signature

Property Name	Type	Required	Description	Example
Credentials	ARCHLogin Object	Y	Your login credentials	ARCHLogin
SearchData	Object	Y	An object that contains the search parameters used to look up contracts	ContractSearchData

Table 21 GetContracts Response Signature

Type	Description	Example
Array of Contract objects	The contracts that matched the search	Contract

Getting Cancel Reasons

Before a cancel quote can be requested a cancel reason will need to be selected. The list of available cancel reasons can be retrieved by calling the GetCancelReasons service method.

Table 22 GetCancelReasons Request Signature

Property Name	Type	Required	Description	Example
Credentials	ARCHLogin Object	Y	Your login credentials	ARCHLogin

Table 23 GetCancelReasons Response Signature

Type	Description	Example
Array of CancelReason Objects	The available reasons	CancelReason

Requesting A Cancel Quote

To request a cancel quote call the RequestCancelQuote method.

Table 24 RequestCancelQuote Request Signature

Property Name	Type	Required	Description	Example
Credentials	ARCHLogin Object	Y	Your login credentials	ARCHLogin
CancelQuoteRequest	Object	Y	Information about the contract the quote is for and the reason why it is being cancelled	CancelQuoteRequest

Table 25 RequestCancelQuote Response Signature

Type	Description	Example
Object	Information on how much money the customer and dealer would receive back.	CancelQuote

Other Object Signatures

Any object not outlined in the document but referenced is described here.

Table 26 ARCHLogin Object Signature

Property Name	Type	Description	Example
EnvironmentName	String	The code for which admin companys environment you are attempting to access.	TEST
DealerNumber	String	The code that the admin company has assigned to the dealer	VSOKABCDE
Username	String	Your Username	TestServiceUser
Password	String	Your Password	S3cureC0mpoundP@ssword

RateRequest

Because of the flexibility of the platform, many of these fields are optional, but if omitted could impact what rates are returned. Additional details about how the different properties impact the response is included in the description below and consumers are encouraged to understand them and ask questions to the TPA for whom they are requesting rates with questions about rates that should or should not be returned.

Table 27 RateRequest Object Signature

Property Name	Type	Description	Example
ProductType	Enum	The type of the product. If supplied this will filter the responses to certain product types. This is a bitwise flag so values can be combined e.g., 1&2 = VSC & GAP	ProductTypes
PurchaseType	Nullable Enum	The purchase type of the vehicle. Plans can have applicable purchase types e.g., New, Used or New & used. If the plan has none set, no value is required. If the plan has one or multiple set, then it must match the one sent in to be returned.	PurchaseTypes
PurchasePrice	Nullable Decimal	The Vehicle purchase price. May effect response based on TPA rate setup	25500.25
FinanceType	Nullable Enum	The Finance Type May effect response based on TPA rate setup	FinanceTypes
InServiceDate	Nullable DateTime	The date the vehicle came under the original manufacturers warranty May effect response based on TPA rate setup	8/21/2014 8:30:52 AM
FinanceAmount	Nullable Decimal	The amount of the vehicle financed. May effect response based on TPA rate setup	5000.25
FinanceLength	Nullable Int	The time (usually in months) of the finance arrangement. May effect response based on TPA rate setup	36
RateDate	Nullable DateTime	The date that the rate should be based on. Rates can be back dated if permission is granted	8/21/2014 8:30:52 AM
MSRP	Decimal	The manufacturers suggested retail price. May effect response based on TPA rate setup	39900
VIN	String	Vehicle Identification Number Required for traditional automotive VIN based rating	JH4TB2H26CC000000
Odometer	Nullable Int	The odometer at rate time May effect response based on TPA rate setup	12000
VehiclePurchase Date	Nullable DateTime	The date the vehicle was purchased. May effect response based on TPA rate setup	2016-02-25
Vehicle	Vehicle Object	To be used for non-VIN based rating and should be left null for VIN based rating.	Vehicle

ContractSubmitRequest

Table 28 ContractSubmitRequest Object Signature

Property Name	Type	Description	Example
PurchasePrice	Decimal	The Contract purchase price	PurchaseTypes
DealerCost	Decimal	The Cost to the dealer as calculated by the consumer of the service. This will be validated against our internal calculations	850.75
CalculatedDealer CostInArch	Boolean	Indicates if SEcureAdmin should handle the calculation of dealer cost.	True
ReducingDeducti bleAmount	Nullalbe Decimal	If the deductible reduces this is what it reduces to.	50.00
DeductibleAmou nt	Decimal	The deductible amount the customer would pay upon initiating a claim. (Not the charge to the customer).	100.00
DeductibleCode	String	The code for the deductible	150DED
FinanceLength	Nullable int	The time (usually in months) of the finance arrangement.	36
FinanceAmount	Nullable Decimal	The amount of the vehicle financed	5000.25
Fields	Dictionary with key of type String and value of type String	A key value pair collection consisting of field codes and their values	{{Favorite Color,Red},{Favorite Ice Cream,Neopolitan}}
FinanceType	Enum	The finance type	FinanceTypes
MSRP	Nullable Decimal	The manufacturers suggested retail price	39900
Odometer	Nullable Int	The odometer at rate time	12000
VehiclePurchaseP rice	Decimal	The Vehicle purchase price	25000
RateId	Int	The RateId from the RateResponse	21545
Customer	Customer Object	The entity buying the contract	Customer

CoBuyer	Customer Object	The Co-Buyer of the contract	Customer
LienHolder	Lienholder Ojbect	The holder of the lien on the vehicle	Lienholder
InServiceDate	Nullable DateTime	The date the vehicle went inservice	2016-02-25
VehiclePurchase Date	Nullable DateTime	The purchase date of the vehicle	2016-02-25
Number	String	The contract number that should be applied (may be overwritten by rules set up by TPA)	2015ABCX
RateDate	DateTime	The date that the rate was retrieved	2016-02-25
SurchargeCodes	Array of String	The surcharge codes that were/are applied to the contract	[COMM,4x4]
VIN	String	The VIN of the vehicle	2GNALAEK3F1120830
PurchaseType	Enum	The purchase type of the vehicle	PurchaseTypes
SoldInDepartmen t	String	The department that the contract/vehicle was sold in	ServiceBay
Vehicle	Vehicle Object	Used for non VIN based rating and should be NULL for VIN based rating	Vehicle
RewardNumber	String	The reward number that should get credit for the sale	DFW123
ExternalUser	String	The user selling the contract	JMenuUser

ContractSubmitRequest (contd)

Table 29 ContractSubmitRequest Object Signature (contd)

Property Name	Type	Description	Example
LienHolder	LienHolder Object	The lienholder on the contract	LienHolder
InServiceDate	Nullable DateTime	The Contract purchase price	PurchaseTypes
Number	String	The contract number. This will be overwritten if the admin has a number generation scheme set up, otherwise if they have it set to mixed mode it will accept this value. If the admin has their contract generation scheme set to manual this value is required	ABC123XYZ
RateDate	Nullable DateTime	The date that the rate should be based on. Rates can be back dated if permission is granted	8/21/2014 8:30:52 AM
SurchargeCodes	Array of String	The surcharge codes including forced surcharges	{4X4,TURBO,COMM}
VIN	String	Vehicle Identification Number	JH4TB2H26CC000000
TermMiles	Nullable Int	The term miles	12
TermMonths	Nullable Int	The term months	12,000

Contract

Table 30 Contract Object Signature

Property Name	Type	Description	Example
ContractId	Int64	The Id of the contract in the SEcureAdmin system.	12544
ContractNumber	String	The contract number	CN234R2016
ContractSuffix	String	The suffix of the contract	A
ProductCode	String	The code used to identify a product	VSCULTRA
Status	Enum	The contract status	ContractStatus
VIN	String	The VIN of the vehicle	JH4TB2H26CC000000
Customer	Object	The Customer that purchased the contrtact	Customer

ContractSearchData

Table 31 ContractSearchData Object Signature

Property Name	Type	Description	Example
ContractNumber	String	The contract number	CN234R2016
ContractSuffix	String	The suffix of the contract	A
ProductCode	String	The code used to identify a product	VSCULTRA
VIN	String	The VIN of the vehicle	JH4TB2H26CC000000

CancelQuoteRequest

Table 32 CancelQuoteRequest Object Signature

Property Name	Type	Description	Example
CancelDate	DateTime	The date the contract would be cancelled	2016-02-18
ContractId	Int64	The Id of the contract in the SEcureAdmin system.	12544
ContractNumber	String	The contract number	CN234R2016
ContractSuffix	String	The suffix of the contract	A
ProductCode	String	The code used to identify a product	VSCULTRA
Odometer	Int32	The odometer of the vehicle at time of cancel	33949
CancelReasonCod e	String	The code that corresponds to the selected cancel reason	CMV

CancelQuote

Table 33 ContractSearchData Object Signature

Property Name	Type	Description	Example
CancelFee	Decimal	The fee applied to the cancel	22.25
CustomerRefund	Decimal	The refund to the customer	22.25
DealerProfitRefu nd	Decimal	The profit returnd from the dealer	122.25
TotalDays	Nullable Int32	The total days the term was valid for	256
TotalMiles	Nullable Int32	The total miles the term was valid for	25000
DaysUsed	Nullable Int32	The days used before cancel date	250
MilesUsed	Nullable Int32	The miles used before the cancel date	2500
RefundPercentag e	Decimal	The percentage of the refund	25.55
CustomerCost	Nullable Decimal	The original customer cost	25000.23
DealerProfit	Decimal	The original dealer profit	2444.22
CancelType	String	How the contract is cancelled	Covered Days
CancelMethod	String	The refund calculation method used	Prorated
ContractEffective Date	DateTime	The effective date of the contract	2016-02-18

CancelReason

Table 34 CancelReason Object Signature

Property Name	Type	Description	Example
Code	String	The code used to identify the reason	CMV
Reason	String	A description of the reason	Customer Modified Vehicle

CashTransaction

Table 35 CashTransaction Object Signature

Property Name	Type	Description	Example
TransactionNumber	String	The Number used to track the cash transaction	CT1234
Amount	Decimal	The amount the cash transaction is for	455.33

Dealer

Table 36 Dealer Object Signature

Property Name	Type	Description	Example
BillingAddress	Address Object	The address that the dealer is billed at	Address
PhysicalAddress	Address Object	The address the dealer is located at	Address
Name	String	The name of the dealer	Hob Roward Auto Mall
DealerNumber	String	The code the admin company assigned to the dealer	HR1234

Customer

Table 37 Customer Object Signature

Property Name	Type	Description	Example
BussinessName	String	The name of the business if the contract is being sold to a business entity	Jons Lawn Service
FirstName	String	The customer first name	John
LastName	String	The customers surname	Smith
EmailAddress	String	The customers email address	[email protected]
EmailOptIn	Boolean	Whether the custome would like to receive automated emails.	False
PhysicalAddress	Address Object	The address the dealer is located at	Address

BillingAddress	Address Object	The address that the dealer is billed at	Address

LienHolder

Table 38 LienHolder Object Signature

Property Name	Type	Description	Example
BillingAddress	Address Object	The address that the lein holder is billed at	Address
PhysicalAddress	Address Object	The address the lienholder is located at	Address
Name	String	The name of the lien holder	Second National Bank

Vehicle

Table 39 Vehicle Object Signature

Property Name	Type	Description	Example
Cylinders	Nullable Byte	Number of cylinders in vehicle	4
FuelDelivery	String	Type of fuel delivery	Normal
FuelType	String	The Type of fuel the vehicle uses	Gasoline
Make	String	The manufacturer of the vehicle	FORD
Model	String	The model of the vehicle	F150
Series	String	The series of the vehicle which defines things like trim packages	XLT
Odometer	Int	The mileage on the vehicle	25000
VIN	String	Vehicle Identification Number	JH4TB2H26CC000000
TonRating	Nullable Enum	The weight of the vehicle	TonRatingTypes
Year	Int	The Year the vehicle was produced	2012

DriveType	Enum	The drive type of the vehicle	DriveTypes

Plan

Table 40 Plan Object Signature

Property Name	Type	Description	Example
PlanCode	String	The code the admin company has given a plan	SILVERU
PlanName	String	The name for the plan	Silver Used
PlanDescription	String	The descriptiong of the plan	Silver used pland for used vehicles
ClassCode	String	The class of the vehicle based on the admin companys class tables	4
ProductType	Enum	The Product Type	ProductTypes
ProductSubType	Enum	The Product Subtype	ProductSubTypes
ProductSalesType	String	The sales type of the product	Windshield Products
ProductName	String	The Name of the Product	Certified Auto VSC
ProductCode	String	The code of the product	CAVSC
ProgramName	String	The name of the Program	Certified Auto
Terms	Array of Term Objects	The terms for each plan that define the mileage and time	Term

Address

Table 41 Address Object Signature

Property Name	Type	Description	Example
AddressLine1	String	The street address	123 Test St.
AddressLine2	String	Other address information such as PO box, apt #, or suite #	Suite #100
City	String	The city	Oklahoma City
PhoneNumber	String	The phone number	4055557879
Fax	String	The facsimile number	4055557880
Region	String	The state or region code	OK
ZipCode	String	The zip or postal code	73120

Term

Table 42 Tem Object Signature

Property Name	Type	Description	Example
SuggestedRetailprice	Nullable Decimal	The admins suggested price for this term	899.99
MaxMarkup	Nullable Decimal	The maximum markup that can be applied to the calculated adjusted cost of the term	100.50
MinMarkup	Nullable Decimal	The minimum markup that can be applied to the calculated adjusted cost of the term	50.25
Deductibles	Array of Deductible Objects	The amount a customer is responsible for before coverage during claism	Deductible
Surcharges	Array of Surcharge Objects	The list of possible surcharges for the term, some may be mandatory	Surcharge
Services	Array of PPMService Objects	The possible services if the term is for a PPM product	PPMService
DefaultDeductible	Deductible Object	The default deducitble for the term	Deductible
Months	Nullable Int	The term months	12
Miles	Nullable Int	The term miles	12,000
CalculatedAdjustedCost	Decimal	The cost of the term to the FI	850.25
RenewableCost	Nullable Decimal	The cost to renew the contract each term	59.99
ActivationCost	Nullable Decimal	The one time cost of activating a renewable contract	199.99
RateId	Int	The internal Rate Id used for subsequent calls	25454
DealerCost	Decimal	The amount the contract cost to the dealer	850.25
ClassCode	String	A duplicate of the plan Class Code	C1
RateCode	String	A code specific to this rate	R123

ClassDetails	Array of ClassDetail Objects	Gives information on what rules were used to class the vehicle.	ClassDetails

PPMService

Table 43 PPMService Object Signature

Property Name	Type	Description	Example
Code	String	The internal Code	TireRotations
Description	String	A description of the service	Full tire rotation service
Count	Int32	The Number of these service provided	4
ReimbursementAmount	Decimal	The amount that will be reimbursed	24.00

Deductible

Table 44 Deductible Object Signature

Property Name	Type	Description	Example
MinMarkup	Nullable Decimal	The minimum markup that can be applied to the calculated cost of the deductible	5.00
MaxMarkup	Nullable Decimal	The maximum markup that can be applied to the calculated cost of the deductible	10.00
SuggestedRetailprice	Nullable Decimal	The admins suggested price for this deductible	35.00
CalculatedCost	Decimal	The cost of deductible the to the dealer before any net remits are taken out	25.00
RenewableCost	Nullable Decimal	The cost the deductible adds to the renewable amount of the contract each term	5.99
ActivationCost	Nullable Decimal	The one time cost the deductible adds to activating a renewable contract	19.99
Code	String	The code for the deductible	10050
Description	String	The description of the deductible	$100 Deductible reducting to $50 at selling dealer
ReducesTo	Nullable Decimal	The amount that the deductible reduces to given certain criteria	50.00
Amount	Decimal	The actual deductible amount	100.00
DealerCost	Decimal	The cost to the dealer after net remits are taken out	25.00

Surcharge

Table 45 Surcharge Object Signature

Property Name	Type	Description	Example
MinMarkup	Nullable Decimal	The minimum markup that can be applied to the calculated cost of the surcharge	5.00
MaxMarkup	Nullable Decimal	The maximum markup that can be applied to the calculated cost of the surcharge	5.00
SuggestedRetailprice	Nullable Decimal	The admins suggested price for this surcharge	30.00
CalculatedCost	Decimal	The cost of surcharge the to the dealer before any net remits are taken out	25.00
RenewableCost	Nullable Decimal	The cost the surcharge adds to the renewable amount of the contract each term	5.99
ActivationCost	Nullable Decimal	The one time cost the surcharge adds to activating a renewable contract	19.99
Code	String	The code for the surcharge	4X4
Description	String	The description of the surcharge	4 wheel drive surcharge
Forced	Boolean	Whether the surcharge is required	True
DealerCost	Decimal	The cost of the surcharge to the dealer.	25.00

Pdf

Table 46 Pdf Object Signature

Property Name	Type	Description	Example
Name	String	The name of the pdf	Silver Agreement Pdf
Contents	Array of Byte	The contents of the PDF
SignatureLocations	PdfSignatureInfo	The locations where signatures may be applied to the document	PdfSignatureInfo

SignedDocument

Table 47 SignedDocument Object Signature

Property Name	Type	Description	Example
Description	String	The description of the document	Signed Documents for contract ABCDEF
MimeType	String	The MIME type of the document	application/pdf image/jpeg
DocumentContents	Array of Byte	The contents of the signed document

PdfSignatureInfo

Table 485 PdfSignatureInfo Object Signature

Property Name	Type	Description	Example
Signatory	Enum	The signer or signatory	Signatory
PanelText	String	Some text to be displayed on the signing device	Sign here
IsInitials	Boolean	Whether it is a full signature, or just initials	True
IsRequired	Boolean	Whether the signature is required e.g. customer, or not e.g. coBuyer	False
Page	Integer	The Page the signature panel should appear on.	1
Left	Float	The leftmost point of the rectangle	345.44
Bottom	Float	The bottommost point of the rectangle	455.54
Top	Float	The topmost point of the rectangle	255.55
Right	Float	The rightmost point of the rectangle	455.54

ClassDetails

Table 486 ClassDetail Object Signature

Property Name	Type	Description	Example
Type	String	The type of classing rule used	Make, Model, Series
Description	String	The value of the classing	Ford F-150 SVT

Enums

FieldTypes

Table 49 FieldTypes List

Option Name	Integer Value
Integer	1
String	2
Date	3
List	4
Decimal	5
Region	6

ProductTypes

Table 50 ProductTypes List

Option Name	Integer Value
All	0
VehicleServiceContract	1
GuaranteedAssetProtection	2
Ancillary	4
ScheduledMaintenance	8

ProductSubTypes

Table 51 ProductSubType List

Option Name	Integer Value
Invalid	0
VehicleServiceContract	1
LimitedWarranty	2

ScheduledMaintenance	4
TireAndWheel	8
Insurance	16
Waiver	32
Etch	64
KeyReplacement	128
AppearanceProtection	256
Other	512

PurchaseTypes

Table 52 PurchaseTypes List

Option Name	Integer Value
New	1
Used	2
Certified	4

FinanceTypes

Table 53 FinanceTypes List

Option Name	Integer Value
Lease	1
Balloon	2
Purchase	4
Cash	8

Signatories

Table 54 Signatories List

Option Name	Integer Value
Customer	1
CoBuyer	2
Dealer	3

TonRatingTypes

Table 55 TonRatingTypes List

Option Name	Integer Value
None	0
OneQuarter	1
OneHalf	2
ThreeQuarters	3
One	4
OneAndOneHalf	5
OneAndThreeQuarters	6
Two	7
TwoAndOneHalf	8
Three	9
ThreeAndOneHalf	10
Four	11
FourAndOneHalf	12
Five	13
Six	14
Seven	15
Eight	16
Nine	17
TenOrGreater	18

DriveTypes

Table 56 DriveTypes List

Option Name	Integer Value
Invalid	0
Rear	1
AWD	2
Front	3
FourByFour	4