POST UploadUserDocuments
Request Information
URI Parameters
None.
Body Parameters
ProspectUploadDoc| Name | Description | Type | Additional information |
|---|---|---|---|
| documentTypeId | integer |
None. |
|
| documentType | string |
None. |
|
| fileDescription | string |
None. |
|
| fileName | string |
None. |
|
| fileExtension | string |
None. |
|
| fileContent | Collection of byte |
None. |
|
| residentName | string |
None. |
|
| address | string |
None. |
|
| thirdPartyInsuranceCarrier | string |
None. |
|
| policyStartDate | date |
None. |
|
| policyEndDate | date |
None. |
|
| policyNumber | string |
None. |
|
| liabilityAmount | decimal number |
None. |
|
| isAIInsuranceData | boolean |
None. |
|
| isFileUploaded | boolean |
None. |
|
| userId | integer |
None. |
|
| leaseId | integer |
None. |
|
| managementCompanyId | integer |
None. |
|
| DBAId | integer |
None. |
|
| documentId | integer |
None. |
|
| subDomainName | string |
None. |
|
| transactionSourceId | integer |
None. |
|
| workOrderId | integer |
None. |
|
| userName | string |
None. |
|
| managementCompanyName | string |
None. |
|
| dbaName | string |
None. |
|
| tenantUnitId | integer |
None. |
|
| unitNumber | string |
None. |
|
| idNumber | string |
None. |
|
| idResidentName | string |
None. |
|
| idAddress | string |
None. |
|
| idGender | string |
None. |
|
| idDateOfBirth | string |
None. |
|
| idIssuedDate | string |
None. |
|
| idExpiryDate | string |
None. |
|
| idPlaceOfBirth | string |
None. |
|
| idNationality | string |
None. |
|
| isAIIDData | boolean |
None. |
|
| poiDocumentType | string |
None. |
|
| poiEmployer | string |
None. |
|
| poiPositionTitle | string |
None. |
|
| poiEmployerAddress | string |
None. |
|
| poiSupervisorName | string |
None. |
|
| poiHourlyRate | decimal number |
None. |
|
| poiYearlySalary | decimal number |
None. |
|
| poiPayFrequency | string |
None. |
|
| poiAverageMonthlyIncome | decimal number |
None. |
|
| poiIncomeCalculationDetails | string |
None. |
|
| poiBankBalances | string |
None. |
|
| poiCurrency | string |
None. |
|
| poiThreeConsecutiveChecks | string |
None. |
|
| isAIPOIData | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"documentTypeId": 1,
"documentType": "sample string 2",
"fileDescription": "sample string 3",
"fileName": "sample string 4",
"fileExtension": "sample string 5",
"fileContent": "QEA=",
"residentName": "sample string 6",
"address": "sample string 7",
"thirdPartyInsuranceCarrier": "sample string 8",
"policyStartDate": "2026-05-06T07:35:00.2499688-05:00",
"policyEndDate": "2026-05-06T07:35:00.2499688-05:00",
"policyNumber": "sample string 9",
"liabilityAmount": 1.0,
"isAIInsuranceData": true,
"isFileUploaded": true,
"userId": 1,
"leaseId": 1,
"managementCompanyId": 1,
"DBAId": 1,
"documentId": 10,
"subDomainName": "sample string 11",
"transactionSourceId": 12,
"workOrderId": 1,
"userName": "sample string 13",
"managementCompanyName": "sample string 14",
"dbaName": "sample string 15",
"tenantUnitId": 1,
"unitNumber": "sample string 16",
"idNumber": "sample string 17",
"idResidentName": "sample string 18",
"idAddress": "sample string 19",
"idGender": "sample string 20",
"idDateOfBirth": "sample string 21",
"idIssuedDate": "sample string 22",
"idExpiryDate": "sample string 23",
"idPlaceOfBirth": "sample string 24",
"idNationality": "sample string 25",
"isAIIDData": true,
"poiDocumentType": "sample string 27",
"poiEmployer": "sample string 28",
"poiPositionTitle": "sample string 29",
"poiEmployerAddress": "sample string 30",
"poiSupervisorName": "sample string 31",
"poiHourlyRate": 1.0,
"poiYearlySalary": 1.0,
"poiPayFrequency": "sample string 32",
"poiAverageMonthlyIncome": 1.0,
"poiIncomeCalculationDetails": "sample string 33",
"poiBankBalances": "sample string 34",
"poiCurrency": "sample string 35",
"poiThreeConsecutiveChecks": "sample string 36",
"isAIPOIData": true
}
application/xml, text/xml
Sample:
<ProspectUploadDoc xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.YottaResident.WebAPIs.Services"> <DBAId>1</DBAId> <address>sample string 7</address> <dbaName>sample string 15</dbaName> <documentId>10</documentId> <documentType>sample string 2</documentType> <documentTypeId>1</documentTypeId> <fileContent>QEA=</fileContent> <fileDescription>sample string 3</fileDescription> <fileExtension>sample string 5</fileExtension> <fileName>sample string 4</fileName> <idAddress>sample string 19</idAddress> <idDateOfBirth>sample string 21</idDateOfBirth> <idExpiryDate>sample string 23</idExpiryDate> <idGender>sample string 20</idGender> <idIssuedDate>sample string 22</idIssuedDate> <idNationality>sample string 25</idNationality> <idNumber>sample string 17</idNumber> <idPlaceOfBirth>sample string 24</idPlaceOfBirth> <idResidentName>sample string 18</idResidentName> <isAIIDData>true</isAIIDData> <isAIInsuranceData>true</isAIInsuranceData> <isAIPOIData>true</isAIPOIData> <isFileUploaded>true</isFileUploaded> <leaseId>1</leaseId> <liabilityAmount>1</liabilityAmount> <managementCompanyId>1</managementCompanyId> <managementCompanyName>sample string 14</managementCompanyName> <poiAverageMonthlyIncome>1</poiAverageMonthlyIncome> <poiBankBalances>sample string 34</poiBankBalances> <poiCurrency>sample string 35</poiCurrency> <poiDocumentType>sample string 27</poiDocumentType> <poiEmployer>sample string 28</poiEmployer> <poiEmployerAddress>sample string 30</poiEmployerAddress> <poiHourlyRate>1</poiHourlyRate> <poiIncomeCalculationDetails>sample string 33</poiIncomeCalculationDetails> <poiPayFrequency>sample string 32</poiPayFrequency> <poiPositionTitle>sample string 29</poiPositionTitle> <poiSupervisorName>sample string 31</poiSupervisorName> <poiThreeConsecutiveChecks>sample string 36</poiThreeConsecutiveChecks> <poiYearlySalary>1</poiYearlySalary> <policyEndDate>2026-05-06T07:35:00.2499688-05:00</policyEndDate> <policyNumber>sample string 9</policyNumber> <policyStartDate>2026-05-06T07:35:00.2499688-05:00</policyStartDate> <residentName>sample string 6</residentName> <subDomainName>sample string 11</subDomainName> <tenantUnitId>1</tenantUnitId> <thirdPartyInsuranceCarrier>sample string 8</thirdPartyInsuranceCarrier> <transactionSourceId>12</transactionSourceId> <unitNumber>sample string 16</unitNumber> <userId>1</userId> <userName>sample string 13</userName> <workOrderId>1</workOrderId> </ProspectUploadDoc>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.