Get Supporting Document Status
Retrieve a list of documents that were uploaded for an application.
GET /v3/api/applications/{applicationId}/supportingDocuments
Request URL query parameters:
| Property | Required/Optional | Type | Description |
|---|---|---|---|
| applicationId | Required | Long | Valid application Id that user has access to. |
Response attributes:
| Property | Nullable | Type | Description |
|---|---|---|---|
| Name | No | String | Name of the supporting document. |
| UploadTimeUTC | No | String | Document upload date in UTC |
| UploadUserName | No | String | Username of the supporting document uploader. |
| Category | No | String | Indicates the catergory of the document. This field will be a valid SupportingDocumentTypeEnum value. |
Example Response:
[
{
"Name": "test",
"UploadTimeUTC": "2020-09-14T11:12:09.383",
"UploadUserName": "Dora TheExplorer",
"Category": "general"
},
{
"Name": "test2",
"UploadTimeUTC": "2020-09-14T16:53:27.94",
"UploadUserName": "Dora TheExplorer",
"Category": "paperwork"
}
]
Submit Supporting Document
Submits supporting document for an application.
POST /v3/api/applications/{applicationId}/supportingDocuments
Request attributes:
| Property | Required/Optional | Type | Description |
|---|---|---|---|
| DocumentName | Required | String | Name of the document being uploaded. |
| Description | Required | String | Description of the document being uploaded. |
| ViewDocumentType | Required | SupportingDocumentTypeEnum | Must be a valid SupportingDocumentTypeEnum value. |
| Document | Required | Object |
| Property | Required/Optional | Type | Description |
|---|---|---|---|
| FileName | Required | String | Files with these (.gif, .jpg, .jpeg, .tiff, .tif, .pdf, .docx, .png, .bmp) extensions are only allowed. |
| Content | Required | String | The file itself and MUST be BASE64 encoded. Maximum file size is 30MB |
Example request:
{
"DocumentName": "suppDocument",
"Description": "supporting document",
"ViewDocumentType": "Paperwork",
"Document": {
"Filename": "myfile.png",
"Content": "YmaImSFmhpgZYmaImSFmhpgZYmaImSFmhpgZYmaImSEXowYB+y/K/GkAAAAASUVORK5CYII="
}
}