SWswissfintechinnovations
Mortgage Application

Add documents for the specific application

Changed on

Documents can be assigned to a specific application ID.

post/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.

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.

Request body multipart/form-data

documentType'cash' | 'gift' | 'reservation_deposit' | 'advancement_of_inheritance' | 'third_pillar' | 'pension_fund' | 'third_party_loan' | 'third_pillar_fund' | 'fungible_investments' | 'vested_benefit' | 'life_insurance_3a' | 'life_insurance_3b' | 'tax_statement' | 'lending_of_third_party_property' | 'employment' | 'self_employment' | 'additional_income' | 'pension_fund_income' | 'ahv_income' | 'fixed_expenses' | 'dividend' | 'publicly_notarized_purchase_contract' | 'draft_purchase_contract' | 'land_register_extract' | 'official_estimation' | 'building_insurance_certificate' | 'professional_estimation' | 'real_estate_documentation' | 'situation_cadastral_plan' | 'floor_plan' | 'property_pictures_outside' | 'property_pictures_inside' | 'proof_of_interest' | 'easements_contracts' | 'owner_association' | 'contract_for_the_establishment' | 'mortgage_note' | 'mortgage_note_erection' | 'salary_certificate_month' | 'salary_certificate_year' | 'consent_form' | 'debt_information' | 'divorce_copy' | 'building_plan' | 'survey_copy' | 'cubical_calculation' | 'other' required

All supported document types. For the enum value tax_statement. Tax statement is required.

fileContentstring binary required

The file content.

namestring required

The name of the file without file type extension.

sizeinteger required

The file size in bytes.

typestring required

The file type.

applicantIdstring uuid

UUID v4 of the applicant (existing applicant within the current application).

Example request

{
  "documentType": "tax_statement",
  "name": "my-property-flyer",
  "size": 21543,
  "type": "application/pdf",
  "applicantId": "576f8de3-6b30-4882-a7af-da2132a456cf"
}

Response

created.

idstring uuid required

Uuid v4 of the created resource.

Example response

{
  "id": "4bf92636-14a0-4511-98e2-acfde576e644"
}

Changes