Source

string

Mandatory

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

Mandatory

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Mandatory

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

CustomerID

string

Conditional

Used to identify, for which Customer Co-Applicant need to be udpated. Valid Values: 0-9 Format: XXXXX Example:12345 Condition: At least one of CustomerID\Account Number is required.

Allowable Values:

19

CoApplicantTitle

string

Optional

Co-Applicant’s Title

Allowable Values:

10

CoApplicantFirstName

string

Optional

Co-Applicant’s First Name Valid Values: A- Z Format: Example: John

Allowable Values:

50

CoApplicantMiddleName

string

Optional

Co-Applicant’s middle name Valid Values: A-Z Example: LEE

Allowable Values:

50

CoApplicantLastName

string

Optional

Co-Applicant’s last name Valid Values: A-Z Example:Smith

Allowable Values:

50

CoApplicantDateOfBirth

datetime

Optional

Co-Applicant’s date of birth Format: MM/DD/YYYY Example: 01/01/1990

CoApplicantSurnameSuffix

string

Optional

Co-Applicant’s surname suffix Valid Values:Sr / Jr Example:SR

Allowable Values:

5

CoApplicantMarritalStatus

string

Optional

Co-Applicant’s marrital status Example:Married,Single, Divorced

Allowable Values:

19

CoApplicantGender

string

Optional

Co-Applicant’s gender Example: Male, Female

Allowable Values:

5

CoApplicantAddressLine1

string

Optional

Co-Applicant’s Address line 1 Valid Values:A-Z, 0-9 Example:123 HWY

Allowable Values:

50

CoApplicantAddressLine2

string

Optional

Co-Applicant’s Address line 2 Example:Park Avenue

Allowable Values:

50

CoApplicantCity

string

Optional

Co-Applicant’s city Example:Los Angeles

Allowable Values:

40

CoApplicantState

string

Conditional

Co-Applicant’s state

Allowable Values:

30

CoApplicantPostalCode

string

Optional

Postal code of the CoApplicant address. Format: XXXXX Example:46077

Allowable Values:

10

CoApplicantCountry

string

Optional

CoApplicant's Country

Allowable Values:

5

CoApplicantResidenceType

string

Optional

Co-Applicant’s residence type Valid Values: Own Rent Other Owns or is buying a home Rents or leases a home Does not rent or own Board Example: own

Allowable Values:

50

CoApplicantBadAddress

integer

Optional

Flag for Bad Address Valid Values: 0, 1 Format: x Example: 1

CoApplicantHomePhoneNumber

string

Optional

Co-Applicant’s home phone number Valid Values: 0-9 Format: XXXXXXXXXX Example: 7896541236

Allowable Values:

20

CoApplicantMobilePhoneNumber

string

Optional

Co-Applicant’s Mobile number

Allowable Values:

20

CoApplicantEmailID

string

Optional

Co-Applicant’s email id Valid Values: 0-9 Format: XXXXXXXXXX Example: 7896541236

Allowable Values:

254

CoApplicantWorkPhoneNUmber

string

Optional

Co-Applicant’s work phone number Valid Values: 0-9 Format: XXXXXXXXXX Example:7896541236

Allowable Values:

20

CoApplicantMobileCarrier

string

Optional

Co-Applicant’s mobile carrier name. Example: BSNL

Allowable Values:

40

CoApplicantFaxNumber

string

Optional

CoApplicant's Fax number Valid Values: 0-9 Format: xxxxx Example: 12548795541

Allowable Values:

15

CoApplicantOtherPhoneNumber

string

Optional

CoApplicant's Other Phone number Valid Values: 0-9 Format: xxxxx Example: 12548795541

Allowable Values:

15

CoApplicantCreditFilePhone

string

Optional

CoApplicant's Credit File Phone number Valid Values: 0-9 Format: xxxxx Example: 12548795541

Allowable Values:

15

CoApplicantAlternatePhoneNumber

string

Optional

CoApplicant's Alternate Phone number Valid Values: 0-9 Format: xxxxx Example: 12548795541

Allowable Values:

15

OptOutForEmailMarketing

integer

Optional

Flag to Opt out for email marketing Valid Values: 0,1 Format: x Example: 1

CoApplicantOptOutTextMarketingHomePhoneNUM

integer

Optional

Option for user to opt out for text marketing message on Home phone number. Valid Values:0-1 Format:X Example: 1

CoApplicantOptOutTextMarketingWorkPhoneNUM

integer

Optional

Option for user to opt out for text marketing message on work phone number. Valid Values:0-1 Format:X Example: Y/N

CoApplicantBadHomePhoneNUM

integer

Optional

Bad phone flag for Home Phone number. Valid Values: 0,1 Format: x Example: 0-no, 1-yes

CoApplicantBadMobileNUM

integer

Optional

Bad phone flag for mobile Phone number. Valid Values: 0,1 Format: x Example: 0-no, 1-yes

CoApplicantBadWorkPhoneNUM

integer

Optional

Bad phone flag for work Phone number. Valid Values: 0,1 Format: x Example: 0-no, 1-yes

CoApplicantDoNotCallHomePhoneNUM

integer

Optional

Do not call flag for Home Phone Number Valid Values: 0,1 Format: x Example: 0-no, 1-yes

CoApplicantDoNotCallMobileNUM

integer

Optional

Do not call flag for Mobile Phone Number. Valid Values: 0,1 Format: x Example: 0-no, 1-yes

CoApplicantDoNotCallWorkPhoneNUM

integer

Optional

Do not call flag for work Phone Number Valid Values: 0,1 Format: x Example: 0-no, 1-yes

CoApplicantOptOutTextMarketingMobileNUM

integer

Optional

Flag to mark opt out text marketing Valid Values: 0,1 Format: x Example: 1

CoApplicantOptOutTextMarketingOtherPhoneNUM

integer

Optional

Flag to mark opt out text marketing for other phone number. Valid Values: 0, 1 Format: x Example: 1

CoApplicantOptOutTextMarketingCreditFilePhone

integer

Optional

Flag to mark opt out text marketing for credit file phone number. Valid Values: 0,1 Format: x Example: 0-no, 1-yes

CoApplicantOptOutTextMarketingAlternatePhone

integer

Optional

Flag to mark opt out text marketing for alternate phone number. Valid Values: 0,1 Format: x Example: 0-no, 1-yes

CoApplicantBadFaxNumber

integer

Optional

Flag to mark bad for fax number. Valid Values: 0,1 Format: x Example: 0-no, 1-yes

CoApplicantBadOtherPhoneNUM

integer

Optional

Flag to mark bad for other phone number. Valid Values: 0,1 Format: x Example: 0-no, 1-yes

CoApplicantBadCreditFilePhone

integer

Optional

Flag to mark bad for credit file phone number. Valid Values: 0,1 Format: x Example: 0-no, 1-yes

CoApplicantBadAlternatePhone

integer

Optional

Flag to mark bad for alternate phone number. Valid Values: 0,1 Format: x Example: 0-no, 1-yes

CoApplicantDoNotCallFaxNumber

integer

Optional

Flag for do not call at Fax Number. Valid Values: 0,1 Format: x Example: 0-no, 1-yes

CoApplicantDoNotCallOtherPhoneNUM

integer

Optional

Flag for do not call at other phone Valid Values: 0, 1 Format: x Example: 1

CoApplicantDoNotCallCreditFilePhone

integer

Optional

Flag for do not call at Credit File Phone. Valid Values: 0,1 Format: x Example: 0-no, 1-yes

CoApplicantDoNotCallAlternatePhone

integer

Optional

Flag for do not call at Alternate phone number. Valid Values: 0,1 Format: x Example: 0-no, 1-yes

CoApplicantBankruptcy

integer

Optional

Flag to indicate Bankruptcy Valid Values: 0,1 Format: x Example: 0-no, 1-yes

CoApplicantThreePDM

integer

Optional

Flag to indicate Third party debt management Valid Values: 0,1 Format: x Example: 0-no, 1-yes

CoApplicantDeceased

integer

Optional

Flag to indicate Co applicant is deceased. Valid Values: 0,1 Format: x Example: 0- No, 1 - Yes

CoApplicantCeaseandDesist

integer

Optional

Flag to indicate co applicant is Cease And Desist Valid Values: 0,1 Format: x Example: 0-no, 1-yes

CoApplicantMaritalStatus

string

Optional

Co-Applicant’s marital status Valid Values: 0 - 6 Format: x Example: 1 = Married, 2 = Single, 3 = Divorced, 4 = Seperated, 5 = Common Law, 6 = Unknown

Allowable Values:

2

CoApplicantOptOutofEmailMarketing

integer

Optional

Flag to Opt out for email marketing Valid Values: 0,1 Format: x Example: 1