GET GetUserProfile
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
UserRepository| Name | Description | Type | Additional information |
|---|---|---|---|
| successful | boolean |
None. |
|
| message | string |
None. |
|
| data | UserInfo |
None. |
Response Formats
application/json, text/json
Sample:
{
"successful": true,
"message": "sample string 2",
"data": {
"userId": 1,
"isPrimary": true,
"renewalsEnabled": true,
"applicantId": 4,
"firstName": "sample string 5",
"lastName": "sample string 6",
"name": "sample string 7",
"primaryApplicantName": "sample string 8",
"lastUpdatedDate": 9,
"email": "sample string 10",
"daytimePhone": "sample string 11",
"eveningPhone": "sample string 12",
"mobile": "sample string 13",
"otherPhone": "sample string 14",
"unitId": 15,
"unitNumber": "sample string 16",
"unitDetails": "sample string 17",
"managementCompanyId": 18,
"managementCompanyName": "sample string 19",
"dBAId": 20,
"dBAName": "sample string 21",
"moveInDate": 22,
"tenantUnitId": 23,
"residentTypeId": 24,
"residentType": "sample string 25",
"residentStatusId": 26,
"residentStatus": "sample string 27",
"leaseId": 28,
"leaseTypeId": 29,
"LeaseType": "sample string 30",
"leaseStatusId": 64,
"leaseStatus": "sample string 32",
"leaseStartDate": 33,
"leaseEndDate": 34,
"leaseTermId": 35,
"leaseTerm": "sample string 36",
"leaseSignedDate": 37,
"lateRuleConfigId": 38,
"mtmStartDate": 39,
"noticeForDate": 40,
"noticeGivenDate": 41,
"transferDate": 42,
"moveoutDate": 43,
"isLeaseSigned": true,
"isActive": true,
"addressLine1": "sample string 46",
"addressLine2": "sample string 47",
"city": "sample string 48",
"stateId": 64,
"zip": "sample string 50",
"allowOnlinePayment": true,
"disablePaymentAfterLateFeeDay": true,
"allowCreditCardOnline": true,
"allowECheckOnline": true,
"IsAuthenticatedUser": true,
"isHavingMultipleUnits": true,
"rentAccountLedgerSummary": {
"balanceDue": 1.0,
"dailyLate": 2.0,
"totalDue": 3.0,
"futureBalance": 4.0
},
"build": {
"androidVersion": "sample string 1",
"iOSVersion": "sample string 2",
"isAndroidForceUpdate": true,
"isIOSForceUpdate": true
},
"moneyGramData": {
"moneyGramReceiveCode": "sample string 1",
"accountNumber": "sample string 2",
"firstName": "sample string 3",
"lastName": "sample string 4",
"companyName": "sample string 5",
"amountToPay": 6.0,
"moveInProrates": 7.0,
"showMoveInProrates": true,
"moneygramLocations": [
{
"moneyGramLocationId": 1,
"locationName": "sample string 2",
"address": "sample string 3",
"latitude": 1.1,
"longitude": 1.1,
"distance": 4.1
},
{
"moneyGramLocationId": 1,
"locationName": "sample string 2",
"address": "sample string 3",
"latitude": 1.1,
"longitude": 1.1,
"distance": 4.1
}
]
},
"lateFeeData": {
"lateFeeType": "sample string 1",
"initialLateFeeDay": "sample string 2",
"initialLateFee": "sample string 3",
"dailyLateFee": "sample string 4",
"maxMonthlyLateFee": "sample string 5",
"applicableBalance": "sample string 6",
"secondLateFeeDay": "sample string 7",
"secondLateFee": "sample string 8",
"showSecondLateFeeDay": true,
"showSecondLateFee": true
},
"isAllowedToSubscribeForPaperless": true,
"latitude": 58.1,
"longitude": 59.1,
"accessYUBS": true,
"enrollmentStatus": true,
"showRenewal": true,
"showMTM": true,
"showEsign": true,
"isEsignAllowed": true,
"esignLabelText": "sample string 66",
"monthlyLabelText": "sample string 67",
"renewalLeaseId": 68,
"renewalStartDate": 69,
"renewalEndDate": 70,
"renewalLeaseTermId": 71,
"renewalLeaseTerm": "sample string 72",
"isRenewalLeaseSigned": true,
"renewalRent": 74.0,
"renewalLeaseSignedDate": 75,
"allowUpdateORCancelRenewal": true,
"createMoveInCheckList": true,
"checkListStatusId": 78,
"mTMData": {
"unitDetails": "sample string 1",
"mTMStartDate": "sample string 2",
"currentRent": "sample string 3",
"mtmNewRent": "sample string 4"
},
"yottaRealAWSAccessKey": "sample string 79",
"yottaRealAWSSecretKey": "sample string 80",
"yottaRealAWSBucketName": "sample string 81",
"AWSFolderName": "sample string 82",
"showMoveInCheckList": 83,
"applicationEssentials": {
"ApplicationEssentialId": 1,
"ApplicationId": 2,
"ApplicationName": "sample string 3",
"AWSAccessKey": "sample string 4",
"AWSSecretKey": "sample string 5",
"BucketName": "sample string 6",
"AWSFolderName": "sample string 7"
},
"lastUpdatedDateDate": "2026-02-03T21:11:24.0370923-06:00",
"moveInDateDate": "2026-02-03T21:11:24.0370923-06:00",
"leaseStartDateDate": "2026-02-03T21:11:24.0370923-06:00",
"leaseEndDateDate": "2026-02-03T21:11:24.0370923-06:00",
"leaseSignedDateDate": "2026-02-03T21:11:24.0370923-06:00",
"renewalStartDateDate": "2026-02-03T21:11:24.0370923-06:00",
"mtmStartDateDate": "2026-02-03T21:11:24.0370923-06:00",
"renewalEndDateDate": "2026-02-03T21:11:24.0370923-06:00",
"renewalLeaseSignedDateDate": "2026-02-03T21:11:24.0370923-06:00",
"noticeForDateDate": "2026-02-03T21:11:24.0370923-06:00",
"noticeGivenDateDate": "2026-02-03T21:11:24.0370923-06:00",
"transferDateDate": "2026-02-03T21:11:24.0370923-06:00",
"moveoutDateDate": "2026-02-03T21:11:24.0370923-06:00",
"otherApplicants": "sample string 84",
"showTax": true,
"IsInitialLogin": true,
"allowDepositCreditCardOnline": true,
"allowDepositECheckOnline": true,
"allowMoneyGramOnline": true,
"allowDepositMoneyGramOnline": true,
"enableOnlineEsignatureRequest": true,
"isAgreedtoSignatLeasingOffice": true,
"isEsignRequested": true,
"isFeedBacksAvailable": true,
"isYieldstarEnabled": true,
"allowWesternUnionOnline": true,
"passwordComplexity": 97,
"passwordComplexityMessage": "sample string 98",
"isPasswordExpired": true,
"showPasswordExpiryNotification": true,
"passwordExpiryNotificationMessage": "sample string 101",
"westernUnionData": {
"westernUnionReceiveCode": "sample string 1",
"accountNumber": "sample string 2",
"firstName": "sample string 3",
"lastName": "sample string 4",
"companyName": "sample string 5",
"amountToPay": 6.0,
"moveInProrates": 7.0,
"showMoveInProrates": true,
"westernUnionLocations": [
{
"westernUnionLocationId": 1,
"locationName": "sample string 2",
"address": "sample string 3",
"latitude": 1.1,
"longitude": 1.1,
"distance": 4.1
},
{
"westernUnionLocationId": 1,
"locationName": "sample string 2",
"address": "sample string 3",
"latitude": 1.1,
"longitude": 1.1,
"distance": 4.1
}
]
},
"allowMobileUploads": true,
"showCOVID19Alert": true,
"isInsuAutoFill": true
}
}
application/xml, text/xml
Sample:
<UserRepository xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.YottaResident.WebAPIs.Services">
<data>
<AWSFolderName>sample string 82</AWSFolderName>
<IsAuthenticatedUser>true</IsAuthenticatedUser>
<IsInitialLogin>true</IsInitialLogin>
<LeaseType>sample string 30</LeaseType>
<accessYUBS>true</accessYUBS>
<addressLine1>sample string 46</addressLine1>
<addressLine2>sample string 47</addressLine2>
<allowCreditCardOnline>true</allowCreditCardOnline>
<allowDepositCreditCardOnline>true</allowDepositCreditCardOnline>
<allowDepositECheckOnline>true</allowDepositECheckOnline>
<allowDepositMoneyGramOnline>true</allowDepositMoneyGramOnline>
<allowECheckOnline>true</allowECheckOnline>
<allowMobileUploads>true</allowMobileUploads>
<allowMoneyGramOnline>true</allowMoneyGramOnline>
<allowOnlinePayment>true</allowOnlinePayment>
<allowUpdateORCancelRenewal>true</allowUpdateORCancelRenewal>
<allowWesternUnionOnline>true</allowWesternUnionOnline>
<applicantId>4</applicantId>
<applicationEssentials>
<AWSAccessKey>sample string 4</AWSAccessKey>
<AWSFolderName>sample string 7</AWSFolderName>
<AWSSecretKey>sample string 5</AWSSecretKey>
<ApplicationEssentialId>1</ApplicationEssentialId>
<ApplicationId>2</ApplicationId>
<ApplicationName>sample string 3</ApplicationName>
<BucketName>sample string 6</BucketName>
</applicationEssentials>
<build>
<androidVersion>sample string 1</androidVersion>
<iOSVersion>sample string 2</iOSVersion>
<isAndroidForceUpdate>true</isAndroidForceUpdate>
<isIOSForceUpdate>true</isIOSForceUpdate>
</build>
<checkListStatusId>78</checkListStatusId>
<city>sample string 48</city>
<createMoveInCheckList>true</createMoveInCheckList>
<dBAId>20</dBAId>
<dBAName>sample string 21</dBAName>
<daytimePhone>sample string 11</daytimePhone>
<disablePaymentAfterLateFeeDay>true</disablePaymentAfterLateFeeDay>
<email>sample string 10</email>
<enableOnlineEsignatureRequest>true</enableOnlineEsignatureRequest>
<enrollmentStatus>true</enrollmentStatus>
<esignLabelText>sample string 66</esignLabelText>
<eveningPhone>sample string 12</eveningPhone>
<firstName>sample string 5</firstName>
<isActive>true</isActive>
<isAgreedtoSignatLeasingOffice>true</isAgreedtoSignatLeasingOffice>
<isAllowedToSubscribeForPaperless>true</isAllowedToSubscribeForPaperless>
<isEsignAllowed>true</isEsignAllowed>
<isEsignRequested>true</isEsignRequested>
<isFeedBacksAvailable>true</isFeedBacksAvailable>
<isHavingMultipleUnits>true</isHavingMultipleUnits>
<isInsuAutoFill>true</isInsuAutoFill>
<isLeaseSigned>true</isLeaseSigned>
<isPasswordExpired>true</isPasswordExpired>
<isPrimary>true</isPrimary>
<isRenewalLeaseSigned>true</isRenewalLeaseSigned>
<isYieldstarEnabled>true</isYieldstarEnabled>
<lastName>sample string 6</lastName>
<lastUpdatedDate>9</lastUpdatedDate>
<lastUpdatedDateDate>2026-02-03T21:11:24.0370923-06:00</lastUpdatedDateDate>
<lateFeeData>
<applicableBalance>sample string 6</applicableBalance>
<dailyLateFee>sample string 4</dailyLateFee>
<initialLateFee>sample string 3</initialLateFee>
<initialLateFeeDay>sample string 2</initialLateFeeDay>
<lateFeeType>sample string 1</lateFeeType>
<maxMonthlyLateFee>sample string 5</maxMonthlyLateFee>
<secondLateFee>sample string 8</secondLateFee>
<secondLateFeeDay>sample string 7</secondLateFeeDay>
<showSecondLateFee>true</showSecondLateFee>
<showSecondLateFeeDay>true</showSecondLateFeeDay>
</lateFeeData>
<lateRuleConfigId>38</lateRuleConfigId>
<latitude>58.1</latitude>
<leaseEndDate>34</leaseEndDate>
<leaseEndDateDate>2026-02-03T21:11:24.0370923-06:00</leaseEndDateDate>
<leaseId>28</leaseId>
<leaseSignedDate>37</leaseSignedDate>
<leaseSignedDateDate>2026-02-03T21:11:24.0370923-06:00</leaseSignedDateDate>
<leaseStartDate>33</leaseStartDate>
<leaseStartDateDate>2026-02-03T21:11:24.0370923-06:00</leaseStartDateDate>
<leaseStatus>sample string 32</leaseStatus>
<leaseStatusId>64</leaseStatusId>
<leaseTerm>sample string 36</leaseTerm>
<leaseTermId>35</leaseTermId>
<leaseTypeId>29</leaseTypeId>
<longitude>59.1</longitude>
<mTMData>
<currentRent>sample string 3</currentRent>
<mTMStartDate>sample string 2</mTMStartDate>
<mtmNewRent>sample string 4</mtmNewRent>
<unitDetails>sample string 1</unitDetails>
</mTMData>
<managementCompanyId>18</managementCompanyId>
<managementCompanyName>sample string 19</managementCompanyName>
<mobile>sample string 13</mobile>
<moneyGramData>
<accountNumber>sample string 2</accountNumber>
<amountToPay>6</amountToPay>
<companyName>sample string 5</companyName>
<firstName>sample string 3</firstName>
<lastName>sample string 4</lastName>
<moneyGramReceiveCode>sample string 1</moneyGramReceiveCode>
<moneygramLocations>
<UserRepository.MoneyGramLocations>
<address>sample string 3</address>
<distance>4.1</distance>
<latitude>1.1</latitude>
<locationName>sample string 2</locationName>
<longitude>1.1</longitude>
<moneyGramLocationId>1</moneyGramLocationId>
</UserRepository.MoneyGramLocations>
<UserRepository.MoneyGramLocations>
<address>sample string 3</address>
<distance>4.1</distance>
<latitude>1.1</latitude>
<locationName>sample string 2</locationName>
<longitude>1.1</longitude>
<moneyGramLocationId>1</moneyGramLocationId>
</UserRepository.MoneyGramLocations>
</moneygramLocations>
<moveInProrates>7</moveInProrates>
<showMoveInProrates>true</showMoveInProrates>
</moneyGramData>
<monthlyLabelText>sample string 67</monthlyLabelText>
<moveInDate>22</moveInDate>
<moveInDateDate>2026-02-03T21:11:24.0370923-06:00</moveInDateDate>
<moveoutDate>43</moveoutDate>
<moveoutDateDate>2026-02-03T21:11:24.0370923-06:00</moveoutDateDate>
<mtmStartDate>39</mtmStartDate>
<mtmStartDateDate>2026-02-03T21:11:24.0370923-06:00</mtmStartDateDate>
<name>sample string 7</name>
<noticeForDate>40</noticeForDate>
<noticeForDateDate>2026-02-03T21:11:24.0370923-06:00</noticeForDateDate>
<noticeGivenDate>41</noticeGivenDate>
<noticeGivenDateDate>2026-02-03T21:11:24.0370923-06:00</noticeGivenDateDate>
<otherApplicants>sample string 84</otherApplicants>
<otherPhone>sample string 14</otherPhone>
<passwordComplexity>97</passwordComplexity>
<passwordComplexityMessage>sample string 98</passwordComplexityMessage>
<passwordExpiryNotificationMessage>sample string 101</passwordExpiryNotificationMessage>
<primaryApplicantName>sample string 8</primaryApplicantName>
<renewalEndDate>70</renewalEndDate>
<renewalEndDateDate>2026-02-03T21:11:24.0370923-06:00</renewalEndDateDate>
<renewalLeaseId>68</renewalLeaseId>
<renewalLeaseSignedDate>75</renewalLeaseSignedDate>
<renewalLeaseSignedDateDate>2026-02-03T21:11:24.0370923-06:00</renewalLeaseSignedDateDate>
<renewalLeaseTerm>sample string 72</renewalLeaseTerm>
<renewalLeaseTermId>71</renewalLeaseTermId>
<renewalRent>74</renewalRent>
<renewalStartDate>69</renewalStartDate>
<renewalStartDateDate>2026-02-03T21:11:24.0370923-06:00</renewalStartDateDate>
<renewalsEnabled>true</renewalsEnabled>
<rentAccountLedgerSummary>
<balanceDue>1</balanceDue>
<dailyLate>2</dailyLate>
<futureBalance>4</futureBalance>
<totalDue>3</totalDue>
</rentAccountLedgerSummary>
<residentStatus>sample string 27</residentStatus>
<residentStatusId>26</residentStatusId>
<residentType>sample string 25</residentType>
<residentTypeId>24</residentTypeId>
<showCOVID19Alert>true</showCOVID19Alert>
<showEsign>true</showEsign>
<showMTM>true</showMTM>
<showMoveInCheckList>83</showMoveInCheckList>
<showPasswordExpiryNotification>true</showPasswordExpiryNotification>
<showRenewal>true</showRenewal>
<showTax>true</showTax>
<stateId>64</stateId>
<tenantUnitId>23</tenantUnitId>
<transferDate>42</transferDate>
<transferDateDate>2026-02-03T21:11:24.0370923-06:00</transferDateDate>
<unitDetails>sample string 17</unitDetails>
<unitId>15</unitId>
<unitNumber>sample string 16</unitNumber>
<userId>1</userId>
<westernUnionData>
<accountNumber>sample string 2</accountNumber>
<amountToPay>6</amountToPay>
<companyName>sample string 5</companyName>
<firstName>sample string 3</firstName>
<lastName>sample string 4</lastName>
<moveInProrates>7</moveInProrates>
<showMoveInProrates>true</showMoveInProrates>
<westernUnionLocations>
<UserRepository.WesternUnionLocations>
<address>sample string 3</address>
<distance>4.1</distance>
<latitude>1.1</latitude>
<locationName>sample string 2</locationName>
<longitude>1.1</longitude>
<westernUnionLocationId>1</westernUnionLocationId>
</UserRepository.WesternUnionLocations>
<UserRepository.WesternUnionLocations>
<address>sample string 3</address>
<distance>4.1</distance>
<latitude>1.1</latitude>
<locationName>sample string 2</locationName>
<longitude>1.1</longitude>
<westernUnionLocationId>1</westernUnionLocationId>
</UserRepository.WesternUnionLocations>
</westernUnionLocations>
<westernUnionReceiveCode>sample string 1</westernUnionReceiveCode>
</westernUnionData>
<yottaRealAWSAccessKey>sample string 79</yottaRealAWSAccessKey>
<yottaRealAWSBucketName>sample string 81</yottaRealAWSBucketName>
<yottaRealAWSSecretKey>sample string 80</yottaRealAWSSecretKey>
<zip>sample string 50</zip>
</data>
<message>sample string 2</message>
<successful>true</successful>
</UserRepository>