SWswissfintechinnovations
Mortgage Application

Get a list of submitted documents for a specifically placed application

Changed on

All documents that have been shared against the Application ID can be retrieved here.

get/mortgages/applications/{applicationId}/documents

Request

  • Base URL
    https://mortgage.common-api.ch
  • URL
    https://mortgage.common-api.ch/mortgages/applications/{applicationId}/documents
  • Auth
    • API key in header X-API-Key
    • or OAuth 2
      Authorization code: https://example.com/oauth/authorize
      Token URL: https://example.com/oauth/token scopes: read, write

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."
      }
    }
  ]
}

Changes

  • 735bf0a87227Revision changes
    • info

      api operation id getApplicationDocuments was added

  • 990b493a4a31Revision changes
    • breaking

      the response's body type changed from array to object for status

    • info

      added the new optional query request parameter cursor

    • info

      added the new optional query request parameter limit

    • info

      added the required property to the response with the status