Borrower Address Input

Input representation for Borrower addresses.

Root XML tag 

<addresses>

JSON Example 

1{
2  "addresses": [
3    {
4      "addressOwnership": "Own",
5      "extendedFields": [],
6      "externalId": "e8d51e2a-7d97-4da0-8356-ca86995d3d39",
7      "monthlyRentPayment": 2300,
8      "name": "Addr1",
9      "residenceAdditionalMonthCount": 23,
10      "residenceAddress": {
11        "city": "San Francisco",
12        "country": "United States",
13        "postalCode": "94105",
14        "state": "CA",
15        "street": "50 Fremont Street"
16      },
17      "residenceYearCount": 3,
18      "residencyType": "Former Residence"
19    }
20  ]
21}

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
addressOwnershipStringIdentifies borrower’s status at residence.Optional48.0
extendedFieldsExtended Fields Input[]Custom fields related to the borrower’s address.Optional48.0
externalIdStringIdentifier assigned to imported borrower’s address data by external data source. (if applicable)Optional48.0
idStringID of the borrower’s addressOptional48.0
monthlyRentPaymentDoubleBorrower’s monthly rent payment (if applicable).Optional48.0
nameStringName of the borrower’s address.Optional48.0
residenceAdditionalMonthCountIntegerAdditional months borrower lived at this residence.Optional48.0
residenceAddressAddress Input[]Residence’s physical address.Optional48.0
residenceYearCountIntegerYears borrower lived at this residence.Optional48.0
residencyTypeStringIdentifies borrower’s current residency status.Optional48.0