SetPropertyDocumentations

  • API: setPropertyDocumentations

  • Purpose & Use Cases: This API allows you to bind specific documents to a property, which must be uploaded before placing an order.

Currently, four types of documents are supported:

  1. government_issued_ID
  2. visa
  3. guarantors_income_proof
  4. proof_of_enrollment

These documents are required before the order can be submitted.

Note: This API only applies to properties outside the European Union.

  • Request:
Attribute Name Data Type Required Details
propertyId DecodedPropertyID Yes Identifier for the related property object
propertyDocumentations SetPropertyDocumentationInput[] Yes A list to the SetPropertyDocumentationInput object;

SetPropertyDocumentationInput is an object includes,
documentationSlug: NonEmptyString!,
documentationTimeValue: NonEmptyString!;		 
  QUERY
mutation SetPropertyDocumentations($input: SetPropertyDocumentationsInput!) {
  setPropertyDocumentations(input: $input) {
    result
  }
}

GRAPHQL VARIABLES
{
  "input": {
    "propertyDocumentations": [
      {
        "documentationSlug": "government_issued_ID",
        "documentationTimeValue": "before_submit_order"
      },
      {
        "documentationSlug": "guarantors_income_proof",
        "documentationTimeValue": "before_submit_order"
      }
    ],
    "propertyId": "eyJ0eXBlIjoiUHJvcGVydHkiLCJpZCI6MTA0NDc3OH0"
  }
}
  • Response:
  {
    "data": {
        "setPropertyDocumentations": {
            "result": true
        }
    }
}
  • Error Message:
Error Message Description
a_file_is_selected_multiple_times Unable to set property documentation because duplicate files were provided
propertyId is error, not found property Unable to set property documentation because the specified propertyId does not correspond to an existing property
property`s country_id is error, not found country Unable to set property documentation because the country_id associated with the property is invalid or does not exist
The API only allows the required documentation for properties in Europe and outside the EU Unable to set Unable to set property documentation because the property is located in a country where specific documentation is required.
The allowed countries are:
[uk, de, nl, es, hu, fr, ie, pl, it, at, se, pt, ch, be, dm, lt, cz, gr, mt, lu, lv, fi, no, is, fo, ee, by, ru, ua, md, sk, li, mc, ro, bg, rs, mk, al, si, hr, me, va, sm, ad, gi, cy, ba]