Mortgage Application
Get a list of submitted documents for a specifically placed application
All documents that have been shared against the Application ID can be retrieved here.
get/mortgages/applications/{applicationId}/documents
Path parameters
applicationIdstring uuid required
The application identifier (UUID v4) defined by FI.
Example:4bf92636-14a0-4511-98e2-acfde576e644
Uuid v4 of the application request.
Query parameters
cursorstring
Example:cursorIDxyz
Optional parameter for pagination. An opaque string value used for pagination.
limitinteger
Example:25
Optional parameter for pagination. Maximum number of entries to be returned.
Headers
X-CorAPI-Client-IDstring required
ID of the client forwarded to the provider.
X-Correlation-IDstring required
Unique ID (defined by the caller) which will be reflected back in the response.
User-Agentstring required
Name and version of the of the Client software.
Response
OK.
Example response
{
"documentList": [
{
"filename": "customer_id.pdf",
"filetype": "pdf",
"documentId": "7f648f12-fd45-4930-6543-456ef5671c37",
"filesize": 1024,
"uploaddate": "2018-04-13",
"statusInfo": {
"status": "pending",
"statusReason": "Additional information that can be shared with the status."
}
}
]
}