AFS Vanguard API Methods:
Method1 type: POST
Method1 name: afsvanguardcustapplicationsOTH
Method1 description:
- Given an application filled out by your customer in your web site, translate and insert into the proper AFS Vanguard office database.
- Insertion will take place on a 5 minute interval polling thread.
- The AFS Vanguard user at the office has the option to manually execute insertion in real time.
Method1 important notes:
- Please inquire with our service team at service@afshq.com if your company has been assigned a 3 or 4 character company identifier for API access purposes. If so, please replace “OTH” above with your assigned company identifier.
- Required parameters are: afsVanguardAppCode, applOfficeTo, applAmountOfLoan, applIndividual or applJoint, applLastName, applFirstName, applDateOfBirth, applSocialSecurityNumber, applEmail, applPhone, applAddress, applCity, applZip, applState, applicantESignature, applicantESignatureDate
- The characters ? and & cannot be present inside any of the parameters.
Parameters:
- POST afsVanguardAppCode String #Comment: Security code provided by service@afshq.com
- POST applOfficeTo Number #Comment: Office selected by applicant (insertion will occur in such office)
- POST applAmountOfLoan Number Values (100,200,300,400,500,600,700,800,900,1000,1100,1200,1300)
- POST applPurposeOfLoan Number
- POST applType Number Values (1,2) #Comment: Individual=1, Joint=2
- POST applReferredBy String Values (Internet, Drive By, Friend)
- POST applLastName String
- POST applFirstName String
- POST applDateOfBirth String Format(“yyyy-mm-dd”)
- POST applSocialSecurityNumber String
- POST applEmail String
- POST applPhone String Format(“(nnn)-nnn-nnnn”)
- POST applAddress String
- POST applCity String
- POST applZip String
- POST applState String Values (AL, CA, FL, GA, KY, LA, MS, NC, NM, OK, SC, TX, VA)
- POST residenceType String Values (Rent Home/Apartment, Buying Home, Own Home, Other)
- POST residenceMonthlyPayment Number
- POST residenceTimeAt String Values (Less than 1 Year, 1-2 Years, 2-5 Years, 5+ Years)
- POST employer String
- POST employerPhone String Format(“(nnn)-nnn-nnnn”)
- POST employerTimeAt String Values (Less than 1 Year, 1-2 Years, 2-5 Years, 5+ Years)
- POST employerPosition String
- POST employerNetPayPerCheck Number
- POST incomeAdditionalRental Number
- POST incomeAdditionalPT Number
- POST incomeAdditionalAlimonyOrChildSupport Number
- POST incomeAdditionalSSI Number
- POST incomeAdditionalPension Number
- POST incomeAdditionalDisability Number
- POST incomeAdditionalSocialSecurity Number
- POST incomeAdditionalOther Number
- POST incomeTotal Number
- POST debtsAndCreditors1 String
- POST debtsAndCreditorsPaymentAmount1 Number
- POST debtsAndCreditors2 String
- POST debtsAndCreditorsPaymentAmount2 Number
- POST debtsAndCreditors3 String
- POST debtsAndCreditorsPaymentAmount3 Number
- POST debtsAndCreditors4 String
- POST debtsAndCreditorsPaymentAmount4 Number
- POST debtsAndCreditors5 String
- POST debtsAndCreditorsPaymentAmount5 Number
- POST vehicleMake String
- POST vehicleModel String
- POST vehicleYear String Format(“yyyy”)
- POST vehiclePayments Number
- POST expensesLivingTotal Number
- POST applicantESignature String
- POST applicantESignatureDate String Format(“yyyy-mm-dd”)
Response:
- 1 Inserted
- 0 Not inserted:
Errors:
- Error: Invalid afsVanguardAppCode.
- Error: Invalid applOfficeTo: nnnn
- Error: Parameter ppppppp invalid number: nnnnnnn
- Error: Parameter ppppppp invalid date format: ddddddd
- Error: Parameter ppppppp invalid string: sssssss
- Error: Social SecurityNumber is duplicated in office applOfficeTo.
- Error: Required parameter ppppppp is missing.
- Error: Cloud database connection failed.
Example:
afsVanguardcustapplicationsOTH?afsVanguardAppCode=0123456789&applOfficeTo=101&applAmountOfLoan=100& applIndividual=true&applLastName=myLastName&applFirstName=myFirstName&applDateOfBirth=1980-01-01&applSocialSecurityNumber=111-11-1111&applEmail=myEmail@email.com&applPhone=111-111-1111&applAddress=myAddress&applCity=myCity&applZip=11111&applState=TX&applicantESignature=myESignature& applicantESignatureDate=2021-09-25