Back
v1.98.0: Candidate Document Type - Metadata (2026-05-14)

What's Changed


GET /documentTypes/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property nameI18n (object)

      Translations keyed by language code.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration.

      • Deleted property ro (string)

      • Deleted property sq (string)

      • Deleted property be (string)

      • Deleted property bg (string)

      • Deleted property hr (string)

      • Deleted property cs (string)

      • Deleted property da (string)

      • Deleted property et (string)

      • Deleted property fi (string)

      • Deleted property el (string)

      • Deleted property hu (string)

      • Deleted property is (string)

      • Deleted property ga (string)

      • Deleted property lv (string)

      • Deleted property lt (string)

      • Deleted property mk (string)

      • Deleted property mt (string)

      • Deleted property no (string)

      • Deleted property pt (string)

      • Deleted property ru (string)

      • Deleted property sr (string)

      • Deleted property sk (string)

      • Deleted property sl (string)

      • Deleted property es (string)

      • Deleted property sv (string)

      • Deleted property uk (string)

      • Deleted property cy (string)

PATCH /documentTypes/{id}
Request:

Changed content type : application/json

  • Changed property nameI18n (object)

    Translations keyed by language code.

    • Added property {other language} (string)

      Placeholder for any other language code from the supported language enumeration.

    • Deleted property ro (string)

    • Deleted property sq (string)

    • Deleted property be (string)

    • Deleted property bg (string)

    • Deleted property hr (string)

    • Deleted property cs (string)

    • Deleted property da (string)

    • Deleted property et (string)

    • Deleted property fi (string)

    • Deleted property el (string)

    • Deleted property hu (string)

    • Deleted property is (string)

    • Deleted property ga (string)

    • Deleted property lv (string)

    • Deleted property lt (string)

    • Deleted property mk (string)

    • Deleted property mt (string)

    • Deleted property no (string)

    • Deleted property pt (string)

    • Deleted property ru (string)

    • Deleted property sr (string)

    • Deleted property sk (string)

    • Deleted property sl (string)

    • Deleted property es (string)

    • Deleted property sv (string)

    • Deleted property uk (string)

    • Deleted property cy (string)

Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property nameI18n (object)

      Translations keyed by language code.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration.

      • Deleted property ro (string)

      • Deleted property sq (string)

      • Deleted property be (string)

      • Deleted property bg (string)

      • Deleted property hr (string)

      • Deleted property cs (string)

      • Deleted property da (string)

      • Deleted property et (string)

      • Deleted property fi (string)

      • Deleted property el (string)

      • Deleted property hu (string)

      • Deleted property is (string)

      • Deleted property ga (string)

      • Deleted property lv (string)

      • Deleted property lt (string)

      • Deleted property mk (string)

      • Deleted property mt (string)

      • Deleted property no (string)

      • Deleted property pt (string)

      • Deleted property ru (string)

      • Deleted property sr (string)

      • Deleted property sk (string)

      • Deleted property sl (string)

      • Deleted property es (string)

      • Deleted property sv (string)

      • Deleted property uk (string)

      • Deleted property cy (string)

GET /document-validation-groups/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property messageI18n (object)

      Translations keyed by language code.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration.

      • Deleted property ro (string)

      • Deleted property sq (string)

      • Deleted property be (string)

      • Deleted property bg (string)

      • Deleted property hr (string)

      • Deleted property cs (string)

      • Deleted property da (string)

      • Deleted property et (string)

      • Deleted property fi (string)

      • Deleted property el (string)

      • Deleted property hu (string)

      • Deleted property is (string)

      • Deleted property ga (string)

      • Deleted property lv (string)

      • Deleted property lt (string)

      • Deleted property mk (string)

      • Deleted property mt (string)

      • Deleted property no (string)

      • Deleted property pt (string)

      • Deleted property ru (string)

      • Deleted property sr (string)

      • Deleted property sk (string)

      • Deleted property sl (string)

      • Deleted property es (string)

      • Deleted property sv (string)

      • Deleted property uk (string)

      • Deleted property cy (string)

PATCH /document-validation-groups/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property messageI18n (object)

      Translations keyed by language code.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration.

      • Deleted property ro (string)

      • Deleted property sq (string)

      • Deleted property be (string)

      • Deleted property bg (string)

      • Deleted property hr (string)

      • Deleted property cs (string)

      • Deleted property da (string)

      • Deleted property et (string)

      • Deleted property fi (string)

      • Deleted property el (string)

      • Deleted property hu (string)

      • Deleted property is (string)

      • Deleted property ga (string)

      • Deleted property lv (string)

      • Deleted property lt (string)

      • Deleted property mk (string)

      • Deleted property mt (string)

      • Deleted property no (string)

      • Deleted property pt (string)

      • Deleted property ru (string)

      • Deleted property sr (string)

      • Deleted property sk (string)

      • Deleted property sl (string)

      • Deleted property es (string)

      • Deleted property sv (string)

      • Deleted property uk (string)

      • Deleted property cy (string)

GET /companies/me
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property policy (object)

      This scheme is a collection of company policies for users in different languages.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

      • Deleted property ro (string)

        Used for users whose language is "Română"

      • Deleted property sq (string)

        Used for users whose language is "Shqip"

      • Deleted property be (string)

        Used for users whose language is "Беларуская"

      • Deleted property bg (string)

        Used for users whose language is "Български"

      • Deleted property hr (string)

        Used for users whose language is "Hrvatski"

      • Deleted property cs (string)

        Used for users whose language is "Čeština"

      • Deleted property da (string)

        Used for users whose language is "Dansk"

      • Deleted property et (string)

        Used for users whose language is "Eesti"

      • Deleted property fi (string)

        Used for users whose language is "Suomi"

      • Deleted property el (string)

        Used for users whose language is "Ελληνικά"

      • Deleted property hu (string)

        Used for users whose language is "Magyar"

      • Deleted property is (string)

        Used for users whose language is "Íslenska"

      • Deleted property ga (string)

        Used for users whose language is "Gaeilge"

      • Deleted property lv (string)

        Used for users whose language is "Latviešu"

      • Deleted property lt (string)

        Used for users whose language is "Lietuvių"

      • Deleted property mk (string)

        Used for users whose language is "Македонски"

      • Deleted property mt (string)

        Used for users whose language is "Malti"

      • Deleted property no (string)

        Used for users whose language is "Norsk"

      • Deleted property pt (string)

        Used for users whose language is "Português"

      • Deleted property ru (string)

        Used for users whose language is "Русский"

      • Deleted property sr (string)

        Used for users whose language is "Српски"

      • Deleted property sk (string)

        Used for users whose language is "Slovenčina"

      • Deleted property sl (string)

        Used for users whose language is "Slovenščina"

      • Deleted property es (string)

        Used for users whose language is "Español"

      • Deleted property sv (string)

        Used for users whose language is "Svenska"

      • Deleted property uk (string)

        Used for users whose language is "Українська"

      • Deleted property cy (string)

        Used for users whose language is "Cymraeg"

    • Changed property languages (array)

      Company languages (at least one language required). Any code from the language enumeration is accepted; only the main set is shown as an example.

GET /customFields/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property nameI18n (object)

      Translations keyed by language code.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration.

      • Deleted property ro (string)

      • Deleted property sq (string)

      • Deleted property be (string)

      • Deleted property bg (string)

      • Deleted property hr (string)

      • Deleted property cs (string)

      • Deleted property da (string)

      • Deleted property et (string)

      • Deleted property fi (string)

      • Deleted property el (string)

      • Deleted property hu (string)

      • Deleted property is (string)

      • Deleted property ga (string)

      • Deleted property lv (string)

      • Deleted property lt (string)

      • Deleted property mk (string)

      • Deleted property mt (string)

      • Deleted property no (string)

      • Deleted property pt (string)

      • Deleted property ru (string)

      • Deleted property sr (string)

      • Deleted property sk (string)

      • Deleted property sl (string)

      • Deleted property es (string)

      • Deleted property sv (string)

      • Deleted property uk (string)

      • Deleted property cy (string)

PATCH /customFields/{id}
Request:

Changed content type : application/json

  • Changed property nameI18n (object)

    Translations keyed by language code.

    • Added property {other language} (string)

      Placeholder for any other language code from the supported language enumeration.

    • Deleted property ro (string)

    • Deleted property sq (string)

    • Deleted property be (string)

    • Deleted property bg (string)

    • Deleted property hr (string)

    • Deleted property cs (string)

    • Deleted property da (string)

    • Deleted property et (string)

    • Deleted property fi (string)

    • Deleted property el (string)

    • Deleted property hu (string)

    • Deleted property is (string)

    • Deleted property ga (string)

    • Deleted property lv (string)

    • Deleted property lt (string)

    • Deleted property mk (string)

    • Deleted property mt (string)

    • Deleted property no (string)

    • Deleted property pt (string)

    • Deleted property ru (string)

    • Deleted property sr (string)

    • Deleted property sk (string)

    • Deleted property sl (string)

    • Deleted property es (string)

    • Deleted property sv (string)

    • Deleted property uk (string)

    • Deleted property cy (string)

Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property nameI18n (object)

      Translations keyed by language code.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration.

      • Deleted property ro (string)

      • Deleted property sq (string)

      • Deleted property be (string)

      • Deleted property bg (string)

      • Deleted property hr (string)

      • Deleted property cs (string)

      • Deleted property da (string)

      • Deleted property et (string)

      • Deleted property fi (string)

      • Deleted property el (string)

      • Deleted property hu (string)

      • Deleted property is (string)

      • Deleted property ga (string)

      • Deleted property lv (string)

      • Deleted property lt (string)

      • Deleted property mk (string)

      • Deleted property mt (string)

      • Deleted property no (string)

      • Deleted property pt (string)

      • Deleted property ru (string)

      • Deleted property sr (string)

      • Deleted property sk (string)

      • Deleted property sl (string)

      • Deleted property es (string)

      • Deleted property sv (string)

      • Deleted property uk (string)

      • Deleted property cy (string)

POST /documentValidationSets
Request:

Changed content type : application/json

  • Changed property validationGroups (array)

    Array of document validation groups related to this validation set. Should be included min 1 item

    Changed items (object): > Document validation set validation group properties

    • Changed property messageI18n (object)

      Translations keyed by language code.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration.

      • Deleted property ro (string)

      • Deleted property sq (string)

      • Deleted property be (string)

      • Deleted property bg (string)

      • Deleted property hr (string)

      • Deleted property cs (string)

      • Deleted property da (string)

      • Deleted property et (string)

      • Deleted property fi (string)

      • Deleted property el (string)

      • Deleted property hu (string)

      • Deleted property is (string)

      • Deleted property ga (string)

      • Deleted property lv (string)

      • Deleted property lt (string)

      • Deleted property mk (string)

      • Deleted property mt (string)

      • Deleted property no (string)

      • Deleted property pt (string)

      • Deleted property ru (string)

      • Deleted property sr (string)

      • Deleted property sk (string)

      • Deleted property sl (string)

      • Deleted property es (string)

      • Deleted property sv (string)

      • Deleted property uk (string)

      • Deleted property cy (string)

GET /document-validation-groups
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Document validation group included relations

    • Changed property messageI18n (object)

      Translations keyed by language code.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration.

      • Deleted property ro (string)

      • Deleted property sq (string)

      • Deleted property be (string)

      • Deleted property bg (string)

      • Deleted property hr (string)

      • Deleted property cs (string)

      • Deleted property da (string)

      • Deleted property et (string)

      • Deleted property fi (string)

      • Deleted property el (string)

      • Deleted property hu (string)

      • Deleted property is (string)

      • Deleted property ga (string)

      • Deleted property lv (string)

      • Deleted property lt (string)

      • Deleted property mk (string)

      • Deleted property mt (string)

      • Deleted property no (string)

      • Deleted property pt (string)

      • Deleted property ru (string)

      • Deleted property sr (string)

      • Deleted property sk (string)

      • Deleted property sl (string)

      • Deleted property es (string)

      • Deleted property sv (string)

      • Deleted property uk (string)

      • Deleted property cy (string)

POST /document-validation-groups
Request:

Changed content type : application/json

  • Changed property messageI18n (object)

    Translations keyed by language code.

    • Added property {other language} (string)

      Placeholder for any other language code from the supported language enumeration.

    • Deleted property ro (string)

    • Deleted property sq (string)

    • Deleted property be (string)

    • Deleted property bg (string)

    • Deleted property hr (string)

    • Deleted property cs (string)

    • Deleted property da (string)

    • Deleted property et (string)

    • Deleted property fi (string)

    • Deleted property el (string)

    • Deleted property hu (string)

    • Deleted property is (string)

    • Deleted property ga (string)

    • Deleted property lv (string)

    • Deleted property lt (string)

    • Deleted property mk (string)

    • Deleted property mt (string)

    • Deleted property no (string)

    • Deleted property pt (string)

    • Deleted property ru (string)

    • Deleted property sr (string)

    • Deleted property sk (string)

    • Deleted property sl (string)

    • Deleted property es (string)

    • Deleted property sv (string)

    • Deleted property uk (string)

    • Deleted property cy (string)

Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property messageI18n (object)

      Translations keyed by language code.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration.

      • Deleted property ro (string)

      • Deleted property sq (string)

      • Deleted property be (string)

      • Deleted property bg (string)

      • Deleted property hr (string)

      • Deleted property cs (string)

      • Deleted property da (string)

      • Deleted property et (string)

      • Deleted property fi (string)

      • Deleted property el (string)

      • Deleted property hu (string)

      • Deleted property is (string)

      • Deleted property ga (string)

      • Deleted property lv (string)

      • Deleted property lt (string)

      • Deleted property mk (string)

      • Deleted property mt (string)

      • Deleted property no (string)

      • Deleted property pt (string)

      • Deleted property ru (string)

      • Deleted property sr (string)

      • Deleted property sk (string)

      • Deleted property sl (string)

      • Deleted property es (string)

      • Deleted property sv (string)

      • Deleted property uk (string)

      • Deleted property cy (string)

PATCH /document-validation-groups
Request:

Changed content type : application/json

Changed items (object): > Update document validation groups body params

  • Changed property messageI18n (object)

    Translations keyed by language code.

    • Added property {other language} (string)

      Placeholder for any other language code from the supported language enumeration.

    • Deleted property ro (string)

    • Deleted property sq (string)

    • Deleted property be (string)

    • Deleted property bg (string)

    • Deleted property hr (string)

    • Deleted property cs (string)

    • Deleted property da (string)

    • Deleted property et (string)

    • Deleted property fi (string)

    • Deleted property el (string)

    • Deleted property hu (string)

    • Deleted property is (string)

    • Deleted property ga (string)

    • Deleted property lv (string)

    • Deleted property lt (string)

    • Deleted property mk (string)

    • Deleted property mt (string)

    • Deleted property no (string)

    • Deleted property pt (string)

    • Deleted property ru (string)

    • Deleted property sr (string)

    • Deleted property sk (string)

    • Deleted property sl (string)

    • Deleted property es (string)

    • Deleted property sv (string)

    • Deleted property uk (string)

    • Deleted property cy (string)

Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Document validation group properties

    • Changed property messageI18n (object)

      Translations keyed by language code.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration.

      • Deleted property ro (string)

      • Deleted property sq (string)

      • Deleted property be (string)

      • Deleted property bg (string)

      • Deleted property hr (string)

      • Deleted property cs (string)

      • Deleted property da (string)

      • Deleted property et (string)

      • Deleted property fi (string)

      • Deleted property el (string)

      • Deleted property hu (string)

      • Deleted property is (string)

      • Deleted property ga (string)

      • Deleted property lv (string)

      • Deleted property lt (string)

      • Deleted property mk (string)

      • Deleted property mt (string)

      • Deleted property no (string)

      • Deleted property pt (string)

      • Deleted property ru (string)

      • Deleted property sr (string)

      • Deleted property sk (string)

      • Deleted property sl (string)

      • Deleted property es (string)

      • Deleted property sv (string)

      • Deleted property uk (string)

      • Deleted property cy (string)

POST /document-validation-groups/bulk
Request:

Changed content type : application/json

Changed items (object): > Create document validation group body params

  • Changed property messageI18n (object)

    Translations keyed by language code.

    • Added property {other language} (string)

      Placeholder for any other language code from the supported language enumeration.

    • Deleted property ro (string)

    • Deleted property sq (string)

    • Deleted property be (string)

    • Deleted property bg (string)

    • Deleted property hr (string)

    • Deleted property cs (string)

    • Deleted property da (string)

    • Deleted property et (string)

    • Deleted property fi (string)

    • Deleted property el (string)

    • Deleted property hu (string)

    • Deleted property is (string)

    • Deleted property ga (string)

    • Deleted property lv (string)

    • Deleted property lt (string)

    • Deleted property mk (string)

    • Deleted property mt (string)

    • Deleted property no (string)

    • Deleted property pt (string)

    • Deleted property ru (string)

    • Deleted property sr (string)

    • Deleted property sk (string)

    • Deleted property sl (string)

    • Deleted property es (string)

    • Deleted property sv (string)

    • Deleted property uk (string)

    • Deleted property cy (string)

Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Document validation group properties

    • Changed property messageI18n (object)

      Translations keyed by language code.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration.

      • Deleted property ro (string)

      • Deleted property sq (string)

      • Deleted property be (string)

      • Deleted property bg (string)

      • Deleted property hr (string)

      • Deleted property cs (string)

      • Deleted property da (string)

      • Deleted property et (string)

      • Deleted property fi (string)

      • Deleted property el (string)

      • Deleted property hu (string)

      • Deleted property is (string)

      • Deleted property ga (string)

      • Deleted property lv (string)

      • Deleted property lt (string)

      • Deleted property mk (string)

      • Deleted property mt (string)

      • Deleted property no (string)

      • Deleted property pt (string)

      • Deleted property ru (string)

      • Deleted property sr (string)

      • Deleted property sk (string)

      • Deleted property sl (string)

      • Deleted property es (string)

      • Deleted property sv (string)

      • Deleted property uk (string)

      • Deleted property cy (string)

GET /documentValidations
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Document validation included relations

    • Changed property documentValidationGroup (object)

      Document validation group properties

      • Changed property messageI18n (object)

        Translations keyed by language code.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration.

        • Deleted property ro (string)

        • Deleted property sq (string)

        • Deleted property be (string)

        • Deleted property bg (string)

        • Deleted property hr (string)

        • Deleted property cs (string)

        • Deleted property da (string)

        • Deleted property et (string)

        • Deleted property fi (string)

        • Deleted property el (string)

        • Deleted property hu (string)

        • Deleted property is (string)

        • Deleted property ga (string)

        • Deleted property lv (string)

        • Deleted property lt (string)

        • Deleted property mk (string)

        • Deleted property mt (string)

        • Deleted property no (string)

        • Deleted property pt (string)

        • Deleted property ru (string)

        • Deleted property sr (string)

        • Deleted property sk (string)

        • Deleted property sl (string)

        • Deleted property es (string)

        • Deleted property sv (string)

        • Deleted property uk (string)

        • Deleted property cy (string)

GET /documentValidations/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property documentValidationGroup (object)

      Document validation group properties

      • Changed property messageI18n (object)

        Translations keyed by language code.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration.

        • Deleted property ro (string)

        • Deleted property sq (string)

        • Deleted property be (string)

        • Deleted property bg (string)

        • Deleted property hr (string)

        • Deleted property cs (string)

        • Deleted property da (string)

        • Deleted property et (string)

        • Deleted property fi (string)

        • Deleted property el (string)

        • Deleted property hu (string)

        • Deleted property is (string)

        • Deleted property ga (string)

        • Deleted property lv (string)

        • Deleted property lt (string)

        • Deleted property mk (string)

        • Deleted property mt (string)

        • Deleted property no (string)

        • Deleted property pt (string)

        • Deleted property ru (string)

        • Deleted property sr (string)

        • Deleted property sk (string)

        • Deleted property sl (string)

        • Deleted property es (string)

        • Deleted property sv (string)

        • Deleted property uk (string)

        • Deleted property cy (string)

POST /accounts
Request:

Changed content type : application/json

  • Changed property welcomeText (object)

    This scheme is a collection of account welcome text for users in different languages.

    • Added property {other language} (string)

      Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

    • Deleted property ro (string)

      Used for users whose language is "Română"

    • Deleted property sq (string)

      Used for users whose language is "Shqip"

    • Deleted property be (string)

      Used for users whose language is "Беларуская"

    • Deleted property bg (string)

      Used for users whose language is "Български"

    • Deleted property hr (string)

      Used for users whose language is "Hrvatski"

    • Deleted property cs (string)

      Used for users whose language is "Čeština"

    • Deleted property da (string)

      Used for users whose language is "Dansk"

    • Deleted property et (string)

      Used for users whose language is "Eesti"

    • Deleted property fi (string)

      Used for users whose language is "Suomi"

    • Deleted property el (string)

      Used for users whose language is "Ελληνικά"

    • Deleted property hu (string)

      Used for users whose language is "Magyar"

    • Deleted property is (string)

      Used for users whose language is "Íslenska"

    • Deleted property ga (string)

      Used for users whose language is "Gaeilge"

    • Deleted property lv (string)

      Used for users whose language is "Latviešu"

    • Deleted property lt (string)

      Used for users whose language is "Lietuvių"

    • Deleted property mk (string)

      Used for users whose language is "Македонски"

    • Deleted property mt (string)

      Used for users whose language is "Malti"

    • Deleted property no (string)

      Used for users whose language is "Norsk"

    • Deleted property pt (string)

      Used for users whose language is "Português"

    • Deleted property ru (string)

      Used for users whose language is "Русский"

    • Deleted property sr (string)

      Used for users whose language is "Српски"

    • Deleted property sk (string)

      Used for users whose language is "Slovenčina"

    • Deleted property sl (string)

      Used for users whose language is "Slovenščina"

    • Deleted property es (string)

      Used for users whose language is "Español"

    • Deleted property sv (string)

      Used for users whose language is "Svenska"

    • Deleted property uk (string)

      Used for users whose language is "Українська"

    • Deleted property cy (string)

      Used for users whose language is "Cymraeg"

  • Changed property aboutText (object)

    This scheme is a collection of account about text for users in different languages.

    • Added property {other language} (string)

      Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

    • Deleted property ro (string)

      Used for users whose language is "Română"

    • Deleted property sq (string)

      Used for users whose language is "Shqip"

    • Deleted property be (string)

      Used for users whose language is "Беларуская"

    • Deleted property bg (string)

      Used for users whose language is "Български"

    • Deleted property hr (string)

      Used for users whose language is "Hrvatski"

    • Deleted property cs (string)

      Used for users whose language is "Čeština"

    • Deleted property da (string)

      Used for users whose language is "Dansk"

    • Deleted property et (string)

      Used for users whose language is "Eesti"

    • Deleted property fi (string)

      Used for users whose language is "Suomi"

    • Deleted property el (string)

      Used for users whose language is "Ελληνικά"

    • Deleted property hu (string)

      Used for users whose language is "Magyar"

    • Deleted property is (string)

      Used for users whose language is "Íslenska"

    • Deleted property ga (string)

      Used for users whose language is "Gaeilge"

    • Deleted property lv (string)

      Used for users whose language is "Latviešu"

    • Deleted property lt (string)

      Used for users whose language is "Lietuvių"

    • Deleted property mk (string)

      Used for users whose language is "Македонски"

    • Deleted property mt (string)

      Used for users whose language is "Malti"

    • Deleted property no (string)

      Used for users whose language is "Norsk"

    • Deleted property pt (string)

      Used for users whose language is "Português"

    • Deleted property ru (string)

      Used for users whose language is "Русский"

    • Deleted property sr (string)

      Used for users whose language is "Српски"

    • Deleted property sk (string)

      Used for users whose language is "Slovenčina"

    • Deleted property sl (string)

      Used for users whose language is "Slovenščina"

    • Deleted property es (string)

      Used for users whose language is "Español"

    • Deleted property sv (string)

      Used for users whose language is "Svenska"

    • Deleted property uk (string)

      Used for users whose language is "Українська"

    • Deleted property cy (string)

      Used for users whose language is "Cymraeg"

  • Changed property completedBoxText (object)

    This scheme is a collection of account completed box text for users in different languages.

    • Added property {other language} (string)

      Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

    • Deleted property ro (string)

      Used for users whose language is "Română"

    • Deleted property sq (string)

      Used for users whose language is "Shqip"

    • Deleted property be (string)

      Used for users whose language is "Беларуская"

    • Deleted property bg (string)

      Used for users whose language is "Български"

    • Deleted property hr (string)

      Used for users whose language is "Hrvatski"

    • Deleted property cs (string)

      Used for users whose language is "Čeština"

    • Deleted property da (string)

      Used for users whose language is "Dansk"

    • Deleted property et (string)

      Used for users whose language is "Eesti"

    • Deleted property fi (string)

      Used for users whose language is "Suomi"

    • Deleted property el (string)

      Used for users whose language is "Ελληνικά"

    • Deleted property hu (string)

      Used for users whose language is "Magyar"

    • Deleted property is (string)

      Used for users whose language is "Íslenska"

    • Deleted property ga (string)

      Used for users whose language is "Gaeilge"

    • Deleted property lv (string)

      Used for users whose language is "Latviešu"

    • Deleted property lt (string)

      Used for users whose language is "Lietuvių"

    • Deleted property mk (string)

      Used for users whose language is "Македонски"

    • Deleted property mt (string)

      Used for users whose language is "Malti"

    • Deleted property no (string)

      Used for users whose language is "Norsk"

    • Deleted property pt (string)

      Used for users whose language is "Português"

    • Deleted property ru (string)

      Used for users whose language is "Русский"

    • Deleted property sr (string)

      Used for users whose language is "Српски"

    • Deleted property sk (string)

      Used for users whose language is "Slovenčina"

    • Deleted property sl (string)

      Used for users whose language is "Slovenščina"

    • Deleted property es (string)

      Used for users whose language is "Español"

    • Deleted property sv (string)

      Used for users whose language is "Svenska"

    • Deleted property uk (string)

      Used for users whose language is "Українська"

    • Deleted property cy (string)

      Used for users whose language is "Cymraeg"

  • Changed property completedText (object)

    This scheme is a collection of account completed text for users in different languages.

    • Added property {other language} (string)

      Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

    • Deleted property ro (string)

      Used for users whose language is "Română"

    • Deleted property sq (string)

      Used for users whose language is "Shqip"

    • Deleted property be (string)

      Used for users whose language is "Беларуская"

    • Deleted property bg (string)

      Used for users whose language is "Български"

    • Deleted property hr (string)

      Used for users whose language is "Hrvatski"

    • Deleted property cs (string)

      Used for users whose language is "Čeština"

    • Deleted property da (string)

      Used for users whose language is "Dansk"

    • Deleted property et (string)

      Used for users whose language is "Eesti"

    • Deleted property fi (string)

      Used for users whose language is "Suomi"

    • Deleted property el (string)

      Used for users whose language is "Ελληνικά"

    • Deleted property hu (string)

      Used for users whose language is "Magyar"

    • Deleted property is (string)

      Used for users whose language is "Íslenska"

    • Deleted property ga (string)

      Used for users whose language is "Gaeilge"

    • Deleted property lv (string)

      Used for users whose language is "Latviešu"

    • Deleted property lt (string)

      Used for users whose language is "Lietuvių"

    • Deleted property mk (string)

      Used for users whose language is "Македонски"

    • Deleted property mt (string)

      Used for users whose language is "Malti"

    • Deleted property no (string)

      Used for users whose language is "Norsk"

    • Deleted property pt (string)

      Used for users whose language is "Português"

    • Deleted property ru (string)

      Used for users whose language is "Русский"

    • Deleted property sr (string)

      Used for users whose language is "Српски"

    • Deleted property sk (string)

      Used for users whose language is "Slovenčina"

    • Deleted property sl (string)

      Used for users whose language is "Slovenščina"

    • Deleted property es (string)

      Used for users whose language is "Español"

    • Deleted property sv (string)

      Used for users whose language is "Svenska"

    • Deleted property uk (string)

      Used for users whose language is "Українська"

    • Deleted property cy (string)

      Used for users whose language is "Cymraeg"

Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property welcomeText (object)

      This scheme is a collection of account welcome text for users in different languages.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

      • Deleted property ro (string)

        Used for users whose language is "Română"

      • Deleted property sq (string)

        Used for users whose language is "Shqip"

      • Deleted property be (string)

        Used for users whose language is "Беларуская"

      • Deleted property bg (string)

        Used for users whose language is "Български"

      • Deleted property hr (string)

        Used for users whose language is "Hrvatski"

      • Deleted property cs (string)

        Used for users whose language is "Čeština"

      • Deleted property da (string)

        Used for users whose language is "Dansk"

      • Deleted property et (string)

        Used for users whose language is "Eesti"

      • Deleted property fi (string)

        Used for users whose language is "Suomi"

      • Deleted property el (string)

        Used for users whose language is "Ελληνικά"

      • Deleted property hu (string)

        Used for users whose language is "Magyar"

      • Deleted property is (string)

        Used for users whose language is "Íslenska"

      • Deleted property ga (string)

        Used for users whose language is "Gaeilge"

      • Deleted property lv (string)

        Used for users whose language is "Latviešu"

      • Deleted property lt (string)

        Used for users whose language is "Lietuvių"

      • Deleted property mk (string)

        Used for users whose language is "Македонски"

      • Deleted property mt (string)

        Used for users whose language is "Malti"

      • Deleted property no (string)

        Used for users whose language is "Norsk"

      • Deleted property pt (string)

        Used for users whose language is "Português"

      • Deleted property ru (string)

        Used for users whose language is "Русский"

      • Deleted property sr (string)

        Used for users whose language is "Српски"

      • Deleted property sk (string)

        Used for users whose language is "Slovenčina"

      • Deleted property sl (string)

        Used for users whose language is "Slovenščina"

      • Deleted property es (string)

        Used for users whose language is "Español"

      • Deleted property sv (string)

        Used for users whose language is "Svenska"

      • Deleted property uk (string)

        Used for users whose language is "Українська"

      • Deleted property cy (string)

        Used for users whose language is "Cymraeg"

    • Changed property aboutText (object)

      This scheme is a collection of account about text for users in different languages.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

      • Deleted property ro (string)

        Used for users whose language is "Română"

      • Deleted property sq (string)

        Used for users whose language is "Shqip"

      • Deleted property be (string)

        Used for users whose language is "Беларуская"

      • Deleted property bg (string)

        Used for users whose language is "Български"

      • Deleted property hr (string)

        Used for users whose language is "Hrvatski"

      • Deleted property cs (string)

        Used for users whose language is "Čeština"

      • Deleted property da (string)

        Used for users whose language is "Dansk"

      • Deleted property et (string)

        Used for users whose language is "Eesti"

      • Deleted property fi (string)

        Used for users whose language is "Suomi"

      • Deleted property el (string)

        Used for users whose language is "Ελληνικά"

      • Deleted property hu (string)

        Used for users whose language is "Magyar"

      • Deleted property is (string)

        Used for users whose language is "Íslenska"

      • Deleted property ga (string)

        Used for users whose language is "Gaeilge"

      • Deleted property lv (string)

        Used for users whose language is "Latviešu"

      • Deleted property lt (string)

        Used for users whose language is "Lietuvių"

      • Deleted property mk (string)

        Used for users whose language is "Македонски"

      • Deleted property mt (string)

        Used for users whose language is "Malti"

      • Deleted property no (string)

        Used for users whose language is "Norsk"

      • Deleted property pt (string)

        Used for users whose language is "Português"

      • Deleted property ru (string)

        Used for users whose language is "Русский"

      • Deleted property sr (string)

        Used for users whose language is "Српски"

      • Deleted property sk (string)

        Used for users whose language is "Slovenčina"

      • Deleted property sl (string)

        Used for users whose language is "Slovenščina"

      • Deleted property es (string)

        Used for users whose language is "Español"

      • Deleted property sv (string)

        Used for users whose language is "Svenska"

      • Deleted property uk (string)

        Used for users whose language is "Українська"

      • Deleted property cy (string)

        Used for users whose language is "Cymraeg"

    • Changed property completedBoxText (object)

      This scheme is a collection of account completed box text for users in different languages.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

      • Deleted property ro (string)

        Used for users whose language is "Română"

      • Deleted property sq (string)

        Used for users whose language is "Shqip"

      • Deleted property be (string)

        Used for users whose language is "Беларуская"

      • Deleted property bg (string)

        Used for users whose language is "Български"

      • Deleted property hr (string)

        Used for users whose language is "Hrvatski"

      • Deleted property cs (string)

        Used for users whose language is "Čeština"

      • Deleted property da (string)

        Used for users whose language is "Dansk"

      • Deleted property et (string)

        Used for users whose language is "Eesti"

      • Deleted property fi (string)

        Used for users whose language is "Suomi"

      • Deleted property el (string)

        Used for users whose language is "Ελληνικά"

      • Deleted property hu (string)

        Used for users whose language is "Magyar"

      • Deleted property is (string)

        Used for users whose language is "Íslenska"

      • Deleted property ga (string)

        Used for users whose language is "Gaeilge"

      • Deleted property lv (string)

        Used for users whose language is "Latviešu"

      • Deleted property lt (string)

        Used for users whose language is "Lietuvių"

      • Deleted property mk (string)

        Used for users whose language is "Македонски"

      • Deleted property mt (string)

        Used for users whose language is "Malti"

      • Deleted property no (string)

        Used for users whose language is "Norsk"

      • Deleted property pt (string)

        Used for users whose language is "Português"

      • Deleted property ru (string)

        Used for users whose language is "Русский"

      • Deleted property sr (string)

        Used for users whose language is "Српски"

      • Deleted property sk (string)

        Used for users whose language is "Slovenčina"

      • Deleted property sl (string)

        Used for users whose language is "Slovenščina"

      • Deleted property es (string)

        Used for users whose language is "Español"

      • Deleted property sv (string)

        Used for users whose language is "Svenska"

      • Deleted property uk (string)

        Used for users whose language is "Українська"

      • Deleted property cy (string)

        Used for users whose language is "Cymraeg"

    • Changed property completedText (object)

      This scheme is a collection of account completed text for users in different languages.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

      • Deleted property ro (string)

        Used for users whose language is "Română"

      • Deleted property sq (string)

        Used for users whose language is "Shqip"

      • Deleted property be (string)

        Used for users whose language is "Беларуская"

      • Deleted property bg (string)

        Used for users whose language is "Български"

      • Deleted property hr (string)

        Used for users whose language is "Hrvatski"

      • Deleted property cs (string)

        Used for users whose language is "Čeština"

      • Deleted property da (string)

        Used for users whose language is "Dansk"

      • Deleted property et (string)

        Used for users whose language is "Eesti"

      • Deleted property fi (string)

        Used for users whose language is "Suomi"

      • Deleted property el (string)

        Used for users whose language is "Ελληνικά"

      • Deleted property hu (string)

        Used for users whose language is "Magyar"

      • Deleted property is (string)

        Used for users whose language is "Íslenska"

      • Deleted property ga (string)

        Used for users whose language is "Gaeilge"

      • Deleted property lv (string)

        Used for users whose language is "Latviešu"

      • Deleted property lt (string)

        Used for users whose language is "Lietuvių"

      • Deleted property mk (string)

        Used for users whose language is "Македонски"

      • Deleted property mt (string)

        Used for users whose language is "Malti"

      • Deleted property no (string)

        Used for users whose language is "Norsk"

      • Deleted property pt (string)

        Used for users whose language is "Português"

      • Deleted property ru (string)

        Used for users whose language is "Русский"

      • Deleted property sr (string)

        Used for users whose language is "Српски"

      • Deleted property sk (string)

        Used for users whose language is "Slovenčina"

      • Deleted property sl (string)

        Used for users whose language is "Slovenščina"

      • Deleted property es (string)

        Used for users whose language is "Español"

      • Deleted property sv (string)

        Used for users whose language is "Svenska"

      • Deleted property uk (string)

        Used for users whose language is "Українська"

      • Deleted property cy (string)

        Used for users whose language is "Cymraeg"

GET /accounts
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Scenario included relations

    • Changed property welcomeText (object)

      This scheme is a collection of account welcome text for users in different languages.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

      • Deleted property ro (string)

        Used for users whose language is "Română"

      • Deleted property sq (string)

        Used for users whose language is "Shqip"

      • Deleted property be (string)

        Used for users whose language is "Беларуская"

      • Deleted property bg (string)

        Used for users whose language is "Български"

      • Deleted property hr (string)

        Used for users whose language is "Hrvatski"

      • Deleted property cs (string)

        Used for users whose language is "Čeština"

      • Deleted property da (string)

        Used for users whose language is "Dansk"

      • Deleted property et (string)

        Used for users whose language is "Eesti"

      • Deleted property fi (string)

        Used for users whose language is "Suomi"

      • Deleted property el (string)

        Used for users whose language is "Ελληνικά"

      • Deleted property hu (string)

        Used for users whose language is "Magyar"

      • Deleted property is (string)

        Used for users whose language is "Íslenska"

      • Deleted property ga (string)

        Used for users whose language is "Gaeilge"

      • Deleted property lv (string)

        Used for users whose language is "Latviešu"

      • Deleted property lt (string)

        Used for users whose language is "Lietuvių"

      • Deleted property mk (string)

        Used for users whose language is "Македонски"

      • Deleted property mt (string)

        Used for users whose language is "Malti"

      • Deleted property no (string)

        Used for users whose language is "Norsk"

      • Deleted property pt (string)

        Used for users whose language is "Português"

      • Deleted property ru (string)

        Used for users whose language is "Русский"

      • Deleted property sr (string)

        Used for users whose language is "Српски"

      • Deleted property sk (string)

        Used for users whose language is "Slovenčina"

      • Deleted property sl (string)

        Used for users whose language is "Slovenščina"

      • Deleted property es (string)

        Used for users whose language is "Español"

      • Deleted property sv (string)

        Used for users whose language is "Svenska"

      • Deleted property uk (string)

        Used for users whose language is "Українська"

      • Deleted property cy (string)

        Used for users whose language is "Cymraeg"

    • Changed property aboutText (object)

      This scheme is a collection of account about text for users in different languages.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

      • Deleted property ro (string)

        Used for users whose language is "Română"

      • Deleted property sq (string)

        Used for users whose language is "Shqip"

      • Deleted property be (string)

        Used for users whose language is "Беларуская"

      • Deleted property bg (string)

        Used for users whose language is "Български"

      • Deleted property hr (string)

        Used for users whose language is "Hrvatski"

      • Deleted property cs (string)

        Used for users whose language is "Čeština"

      • Deleted property da (string)

        Used for users whose language is "Dansk"

      • Deleted property et (string)

        Used for users whose language is "Eesti"

      • Deleted property fi (string)

        Used for users whose language is "Suomi"

      • Deleted property el (string)

        Used for users whose language is "Ελληνικά"

      • Deleted property hu (string)

        Used for users whose language is "Magyar"

      • Deleted property is (string)

        Used for users whose language is "Íslenska"

      • Deleted property ga (string)

        Used for users whose language is "Gaeilge"

      • Deleted property lv (string)

        Used for users whose language is "Latviešu"

      • Deleted property lt (string)

        Used for users whose language is "Lietuvių"

      • Deleted property mk (string)

        Used for users whose language is "Македонски"

      • Deleted property mt (string)

        Used for users whose language is "Malti"

      • Deleted property no (string)

        Used for users whose language is "Norsk"

      • Deleted property pt (string)

        Used for users whose language is "Português"

      • Deleted property ru (string)

        Used for users whose language is "Русский"

      • Deleted property sr (string)

        Used for users whose language is "Српски"

      • Deleted property sk (string)

        Used for users whose language is "Slovenčina"

      • Deleted property sl (string)

        Used for users whose language is "Slovenščina"

      • Deleted property es (string)

        Used for users whose language is "Español"

      • Deleted property sv (string)

        Used for users whose language is "Svenska"

      • Deleted property uk (string)

        Used for users whose language is "Українська"

      • Deleted property cy (string)

        Used for users whose language is "Cymraeg"

    • Changed property completedBoxText (object)

      This scheme is a collection of account completed box text for users in different languages.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

      • Deleted property ro (string)

        Used for users whose language is "Română"

      • Deleted property sq (string)

        Used for users whose language is "Shqip"

      • Deleted property be (string)

        Used for users whose language is "Беларуская"

      • Deleted property bg (string)

        Used for users whose language is "Български"

      • Deleted property hr (string)

        Used for users whose language is "Hrvatski"

      • Deleted property cs (string)

        Used for users whose language is "Čeština"

      • Deleted property da (string)

        Used for users whose language is "Dansk"

      • Deleted property et (string)

        Used for users whose language is "Eesti"

      • Deleted property fi (string)

        Used for users whose language is "Suomi"

      • Deleted property el (string)

        Used for users whose language is "Ελληνικά"

      • Deleted property hu (string)

        Used for users whose language is "Magyar"

      • Deleted property is (string)

        Used for users whose language is "Íslenska"

      • Deleted property ga (string)

        Used for users whose language is "Gaeilge"

      • Deleted property lv (string)

        Used for users whose language is "Latviešu"

      • Deleted property lt (string)

        Used for users whose language is "Lietuvių"

      • Deleted property mk (string)

        Used for users whose language is "Македонски"

      • Deleted property mt (string)

        Used for users whose language is "Malti"

      • Deleted property no (string)

        Used for users whose language is "Norsk"

      • Deleted property pt (string)

        Used for users whose language is "Português"

      • Deleted property ru (string)

        Used for users whose language is "Русский"

      • Deleted property sr (string)

        Used for users whose language is "Српски"

      • Deleted property sk (string)

        Used for users whose language is "Slovenčina"

      • Deleted property sl (string)

        Used for users whose language is "Slovenščina"

      • Deleted property es (string)

        Used for users whose language is "Español"

      • Deleted property sv (string)

        Used for users whose language is "Svenska"

      • Deleted property uk (string)

        Used for users whose language is "Українська"

      • Deleted property cy (string)

        Used for users whose language is "Cymraeg"

    • Changed property completedText (object)

      This scheme is a collection of account completed text for users in different languages.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

      • Deleted property ro (string)

        Used for users whose language is "Română"

      • Deleted property sq (string)

        Used for users whose language is "Shqip"

      • Deleted property be (string)

        Used for users whose language is "Беларуская"

      • Deleted property bg (string)

        Used for users whose language is "Български"

      • Deleted property hr (string)

        Used for users whose language is "Hrvatski"

      • Deleted property cs (string)

        Used for users whose language is "Čeština"

      • Deleted property da (string)

        Used for users whose language is "Dansk"

      • Deleted property et (string)

        Used for users whose language is "Eesti"

      • Deleted property fi (string)

        Used for users whose language is "Suomi"

      • Deleted property el (string)

        Used for users whose language is "Ελληνικά"

      • Deleted property hu (string)

        Used for users whose language is "Magyar"

      • Deleted property is (string)

        Used for users whose language is "Íslenska"

      • Deleted property ga (string)

        Used for users whose language is "Gaeilge"

      • Deleted property lv (string)

        Used for users whose language is "Latviešu"

      • Deleted property lt (string)

        Used for users whose language is "Lietuvių"

      • Deleted property mk (string)

        Used for users whose language is "Македонски"

      • Deleted property mt (string)

        Used for users whose language is "Malti"

      • Deleted property no (string)

        Used for users whose language is "Norsk"

      • Deleted property pt (string)

        Used for users whose language is "Português"

      • Deleted property ru (string)

        Used for users whose language is "Русский"

      • Deleted property sr (string)

        Used for users whose language is "Српски"

      • Deleted property sk (string)

        Used for users whose language is "Slovenčina"

      • Deleted property sl (string)

        Used for users whose language is "Slovenščina"

      • Deleted property es (string)

        Used for users whose language is "Español"

      • Deleted property sv (string)

        Used for users whose language is "Svenska"

      • Deleted property uk (string)

        Used for users whose language is "Українська"

      • Deleted property cy (string)

        Used for users whose language is "Cymraeg"

PATCH /accounts/{id}
Request:

Changed content type : application/json

  • Changed property welcomeText (object)

    This scheme is a collection of account welcome text for users in different languages.

    • Added property {other language} (string)

      Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

    • Deleted property ro (string)

      Used for users whose language is "Română"

    • Deleted property sq (string)

      Used for users whose language is "Shqip"

    • Deleted property be (string)

      Used for users whose language is "Беларуская"

    • Deleted property bg (string)

      Used for users whose language is "Български"

    • Deleted property hr (string)

      Used for users whose language is "Hrvatski"

    • Deleted property cs (string)

      Used for users whose language is "Čeština"

    • Deleted property da (string)

      Used for users whose language is "Dansk"

    • Deleted property et (string)

      Used for users whose language is "Eesti"

    • Deleted property fi (string)

      Used for users whose language is "Suomi"

    • Deleted property el (string)

      Used for users whose language is "Ελληνικά"

    • Deleted property hu (string)

      Used for users whose language is "Magyar"

    • Deleted property is (string)

      Used for users whose language is "Íslenska"

    • Deleted property ga (string)

      Used for users whose language is "Gaeilge"

    • Deleted property lv (string)

      Used for users whose language is "Latviešu"

    • Deleted property lt (string)

      Used for users whose language is "Lietuvių"

    • Deleted property mk (string)

      Used for users whose language is "Македонски"

    • Deleted property mt (string)

      Used for users whose language is "Malti"

    • Deleted property no (string)

      Used for users whose language is "Norsk"

    • Deleted property pt (string)

      Used for users whose language is "Português"

    • Deleted property ru (string)

      Used for users whose language is "Русский"

    • Deleted property sr (string)

      Used for users whose language is "Српски"

    • Deleted property sk (string)

      Used for users whose language is "Slovenčina"

    • Deleted property sl (string)

      Used for users whose language is "Slovenščina"

    • Deleted property es (string)

      Used for users whose language is "Español"

    • Deleted property sv (string)

      Used for users whose language is "Svenska"

    • Deleted property uk (string)

      Used for users whose language is "Українська"

    • Deleted property cy (string)

      Used for users whose language is "Cymraeg"

  • Changed property aboutText (object)

    This scheme is a collection of account about text for users in different languages.

    • Added property {other language} (string)

      Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

    • Deleted property ro (string)

      Used for users whose language is "Română"

    • Deleted property sq (string)

      Used for users whose language is "Shqip"

    • Deleted property be (string)

      Used for users whose language is "Беларуская"

    • Deleted property bg (string)

      Used for users whose language is "Български"

    • Deleted property hr (string)

      Used for users whose language is "Hrvatski"

    • Deleted property cs (string)

      Used for users whose language is "Čeština"

    • Deleted property da (string)

      Used for users whose language is "Dansk"

    • Deleted property et (string)

      Used for users whose language is "Eesti"

    • Deleted property fi (string)

      Used for users whose language is "Suomi"

    • Deleted property el (string)

      Used for users whose language is "Ελληνικά"

    • Deleted property hu (string)

      Used for users whose language is "Magyar"

    • Deleted property is (string)

      Used for users whose language is "Íslenska"

    • Deleted property ga (string)

      Used for users whose language is "Gaeilge"

    • Deleted property lv (string)

      Used for users whose language is "Latviešu"

    • Deleted property lt (string)

      Used for users whose language is "Lietuvių"

    • Deleted property mk (string)

      Used for users whose language is "Македонски"

    • Deleted property mt (string)

      Used for users whose language is "Malti"

    • Deleted property no (string)

      Used for users whose language is "Norsk"

    • Deleted property pt (string)

      Used for users whose language is "Português"

    • Deleted property ru (string)

      Used for users whose language is "Русский"

    • Deleted property sr (string)

      Used for users whose language is "Српски"

    • Deleted property sk (string)

      Used for users whose language is "Slovenčina"

    • Deleted property sl (string)

      Used for users whose language is "Slovenščina"

    • Deleted property es (string)

      Used for users whose language is "Español"

    • Deleted property sv (string)

      Used for users whose language is "Svenska"

    • Deleted property uk (string)

      Used for users whose language is "Українська"

    • Deleted property cy (string)

      Used for users whose language is "Cymraeg"

  • Changed property completedBoxText (object)

    This scheme is a collection of account completed box text for users in different languages.

    • Added property {other language} (string)

      Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

    • Deleted property ro (string)

      Used for users whose language is "Română"

    • Deleted property sq (string)

      Used for users whose language is "Shqip"

    • Deleted property be (string)

      Used for users whose language is "Беларуская"

    • Deleted property bg (string)

      Used for users whose language is "Български"

    • Deleted property hr (string)

      Used for users whose language is "Hrvatski"

    • Deleted property cs (string)

      Used for users whose language is "Čeština"

    • Deleted property da (string)

      Used for users whose language is "Dansk"

    • Deleted property et (string)

      Used for users whose language is "Eesti"

    • Deleted property fi (string)

      Used for users whose language is "Suomi"

    • Deleted property el (string)

      Used for users whose language is "Ελληνικά"

    • Deleted property hu (string)

      Used for users whose language is "Magyar"

    • Deleted property is (string)

      Used for users whose language is "Íslenska"

    • Deleted property ga (string)

      Used for users whose language is "Gaeilge"

    • Deleted property lv (string)

      Used for users whose language is "Latviešu"

    • Deleted property lt (string)

      Used for users whose language is "Lietuvių"

    • Deleted property mk (string)

      Used for users whose language is "Македонски"

    • Deleted property mt (string)

      Used for users whose language is "Malti"

    • Deleted property no (string)

      Used for users whose language is "Norsk"

    • Deleted property pt (string)

      Used for users whose language is "Português"

    • Deleted property ru (string)

      Used for users whose language is "Русский"

    • Deleted property sr (string)

      Used for users whose language is "Српски"

    • Deleted property sk (string)

      Used for users whose language is "Slovenčina"

    • Deleted property sl (string)

      Used for users whose language is "Slovenščina"

    • Deleted property es (string)

      Used for users whose language is "Español"

    • Deleted property sv (string)

      Used for users whose language is "Svenska"

    • Deleted property uk (string)

      Used for users whose language is "Українська"

    • Deleted property cy (string)

      Used for users whose language is "Cymraeg"

  • Changed property completedText (object)

    This scheme is a collection of account completed text for users in different languages.

    • Added property {other language} (string)

      Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

    • Deleted property ro (string)

      Used for users whose language is "Română"

    • Deleted property sq (string)

      Used for users whose language is "Shqip"

    • Deleted property be (string)

      Used for users whose language is "Беларуская"

    • Deleted property bg (string)

      Used for users whose language is "Български"

    • Deleted property hr (string)

      Used for users whose language is "Hrvatski"

    • Deleted property cs (string)

      Used for users whose language is "Čeština"

    • Deleted property da (string)

      Used for users whose language is "Dansk"

    • Deleted property et (string)

      Used for users whose language is "Eesti"

    • Deleted property fi (string)

      Used for users whose language is "Suomi"

    • Deleted property el (string)

      Used for users whose language is "Ελληνικά"

    • Deleted property hu (string)

      Used for users whose language is "Magyar"

    • Deleted property is (string)

      Used for users whose language is "Íslenska"

    • Deleted property ga (string)

      Used for users whose language is "Gaeilge"

    • Deleted property lv (string)

      Used for users whose language is "Latviešu"

    • Deleted property lt (string)

      Used for users whose language is "Lietuvių"

    • Deleted property mk (string)

      Used for users whose language is "Македонски"

    • Deleted property mt (string)

      Used for users whose language is "Malti"

    • Deleted property no (string)

      Used for users whose language is "Norsk"

    • Deleted property pt (string)

      Used for users whose language is "Português"

    • Deleted property ru (string)

      Used for users whose language is "Русский"

    • Deleted property sr (string)

      Used for users whose language is "Српски"

    • Deleted property sk (string)

      Used for users whose language is "Slovenčina"

    • Deleted property sl (string)

      Used for users whose language is "Slovenščina"

    • Deleted property es (string)

      Used for users whose language is "Español"

    • Deleted property sv (string)

      Used for users whose language is "Svenska"

    • Deleted property uk (string)

      Used for users whose language is "Українська"

    • Deleted property cy (string)

      Used for users whose language is "Cymraeg"

Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property welcomeText (object)

      This scheme is a collection of account welcome text for users in different languages.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

      • Deleted property ro (string)

        Used for users whose language is "Română"

      • Deleted property sq (string)

        Used for users whose language is "Shqip"

      • Deleted property be (string)

        Used for users whose language is "Беларуская"

      • Deleted property bg (string)

        Used for users whose language is "Български"

      • Deleted property hr (string)

        Used for users whose language is "Hrvatski"

      • Deleted property cs (string)

        Used for users whose language is "Čeština"

      • Deleted property da (string)

        Used for users whose language is "Dansk"

      • Deleted property et (string)

        Used for users whose language is "Eesti"

      • Deleted property fi (string)

        Used for users whose language is "Suomi"

      • Deleted property el (string)

        Used for users whose language is "Ελληνικά"

      • Deleted property hu (string)

        Used for users whose language is "Magyar"

      • Deleted property is (string)

        Used for users whose language is "Íslenska"

      • Deleted property ga (string)

        Used for users whose language is "Gaeilge"

      • Deleted property lv (string)

        Used for users whose language is "Latviešu"

      • Deleted property lt (string)

        Used for users whose language is "Lietuvių"

      • Deleted property mk (string)

        Used for users whose language is "Македонски"

      • Deleted property mt (string)

        Used for users whose language is "Malti"

      • Deleted property no (string)

        Used for users whose language is "Norsk"

      • Deleted property pt (string)

        Used for users whose language is "Português"

      • Deleted property ru (string)

        Used for users whose language is "Русский"

      • Deleted property sr (string)

        Used for users whose language is "Српски"

      • Deleted property sk (string)

        Used for users whose language is "Slovenčina"

      • Deleted property sl (string)

        Used for users whose language is "Slovenščina"

      • Deleted property es (string)

        Used for users whose language is "Español"

      • Deleted property sv (string)

        Used for users whose language is "Svenska"

      • Deleted property uk (string)

        Used for users whose language is "Українська"

      • Deleted property cy (string)

        Used for users whose language is "Cymraeg"

    • Changed property aboutText (object)

      This scheme is a collection of account about text for users in different languages.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

      • Deleted property ro (string)

        Used for users whose language is "Română"

      • Deleted property sq (string)

        Used for users whose language is "Shqip"

      • Deleted property be (string)

        Used for users whose language is "Беларуская"

      • Deleted property bg (string)

        Used for users whose language is "Български"

      • Deleted property hr (string)

        Used for users whose language is "Hrvatski"

      • Deleted property cs (string)

        Used for users whose language is "Čeština"

      • Deleted property da (string)

        Used for users whose language is "Dansk"

      • Deleted property et (string)

        Used for users whose language is "Eesti"

      • Deleted property fi (string)

        Used for users whose language is "Suomi"

      • Deleted property el (string)

        Used for users whose language is "Ελληνικά"

      • Deleted property hu (string)

        Used for users whose language is "Magyar"

      • Deleted property is (string)

        Used for users whose language is "Íslenska"

      • Deleted property ga (string)

        Used for users whose language is "Gaeilge"

      • Deleted property lv (string)

        Used for users whose language is "Latviešu"

      • Deleted property lt (string)

        Used for users whose language is "Lietuvių"

      • Deleted property mk (string)

        Used for users whose language is "Македонски"

      • Deleted property mt (string)

        Used for users whose language is "Malti"

      • Deleted property no (string)

        Used for users whose language is "Norsk"

      • Deleted property pt (string)

        Used for users whose language is "Português"

      • Deleted property ru (string)

        Used for users whose language is "Русский"

      • Deleted property sr (string)

        Used for users whose language is "Српски"

      • Deleted property sk (string)

        Used for users whose language is "Slovenčina"

      • Deleted property sl (string)

        Used for users whose language is "Slovenščina"

      • Deleted property es (string)

        Used for users whose language is "Español"

      • Deleted property sv (string)

        Used for users whose language is "Svenska"

      • Deleted property uk (string)

        Used for users whose language is "Українська"

      • Deleted property cy (string)

        Used for users whose language is "Cymraeg"

    • Changed property completedBoxText (object)

      This scheme is a collection of account completed box text for users in different languages.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

      • Deleted property ro (string)

        Used for users whose language is "Română"

      • Deleted property sq (string)

        Used for users whose language is "Shqip"

      • Deleted property be (string)

        Used for users whose language is "Беларуская"

      • Deleted property bg (string)

        Used for users whose language is "Български"

      • Deleted property hr (string)

        Used for users whose language is "Hrvatski"

      • Deleted property cs (string)

        Used for users whose language is "Čeština"

      • Deleted property da (string)

        Used for users whose language is "Dansk"

      • Deleted property et (string)

        Used for users whose language is "Eesti"

      • Deleted property fi (string)

        Used for users whose language is "Suomi"

      • Deleted property el (string)

        Used for users whose language is "Ελληνικά"

      • Deleted property hu (string)

        Used for users whose language is "Magyar"

      • Deleted property is (string)

        Used for users whose language is "Íslenska"

      • Deleted property ga (string)

        Used for users whose language is "Gaeilge"

      • Deleted property lv (string)

        Used for users whose language is "Latviešu"

      • Deleted property lt (string)

        Used for users whose language is "Lietuvių"

      • Deleted property mk (string)

        Used for users whose language is "Македонски"

      • Deleted property mt (string)

        Used for users whose language is "Malti"

      • Deleted property no (string)

        Used for users whose language is "Norsk"

      • Deleted property pt (string)

        Used for users whose language is "Português"

      • Deleted property ru (string)

        Used for users whose language is "Русский"

      • Deleted property sr (string)

        Used for users whose language is "Српски"

      • Deleted property sk (string)

        Used for users whose language is "Slovenčina"

      • Deleted property sl (string)

        Used for users whose language is "Slovenščina"

      • Deleted property es (string)

        Used for users whose language is "Español"

      • Deleted property sv (string)

        Used for users whose language is "Svenska"

      • Deleted property uk (string)

        Used for users whose language is "Українська"

      • Deleted property cy (string)

        Used for users whose language is "Cymraeg"

    • Changed property completedText (object)

      This scheme is a collection of account completed text for users in different languages.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

      • Deleted property ro (string)

        Used for users whose language is "Română"

      • Deleted property sq (string)

        Used for users whose language is "Shqip"

      • Deleted property be (string)

        Used for users whose language is "Беларуская"

      • Deleted property bg (string)

        Used for users whose language is "Български"

      • Deleted property hr (string)

        Used for users whose language is "Hrvatski"

      • Deleted property cs (string)

        Used for users whose language is "Čeština"

      • Deleted property da (string)

        Used for users whose language is "Dansk"

      • Deleted property et (string)

        Used for users whose language is "Eesti"

      • Deleted property fi (string)

        Used for users whose language is "Suomi"

      • Deleted property el (string)

        Used for users whose language is "Ελληνικά"

      • Deleted property hu (string)

        Used for users whose language is "Magyar"

      • Deleted property is (string)

        Used for users whose language is "Íslenska"

      • Deleted property ga (string)

        Used for users whose language is "Gaeilge"

      • Deleted property lv (string)

        Used for users whose language is "Latviešu"

      • Deleted property lt (string)

        Used for users whose language is "Lietuvių"

      • Deleted property mk (string)

        Used for users whose language is "Македонски"

      • Deleted property mt (string)

        Used for users whose language is "Malti"

      • Deleted property no (string)

        Used for users whose language is "Norsk"

      • Deleted property pt (string)

        Used for users whose language is "Português"

      • Deleted property ru (string)

        Used for users whose language is "Русский"

      • Deleted property sr (string)

        Used for users whose language is "Српски"

      • Deleted property sk (string)

        Used for users whose language is "Slovenčina"

      • Deleted property sl (string)

        Used for users whose language is "Slovenščina"

      • Deleted property es (string)

        Used for users whose language is "Español"

      • Deleted property sv (string)

        Used for users whose language is "Svenska"

      • Deleted property uk (string)

        Used for users whose language is "Українська"

      • Deleted property cy (string)

        Used for users whose language is "Cymraeg"

GET /accounts/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property welcomeText (object)

      This scheme is a collection of account welcome text for users in different languages.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

      • Deleted property ro (string)

        Used for users whose language is "Română"

      • Deleted property sq (string)

        Used for users whose language is "Shqip"

      • Deleted property be (string)

        Used for users whose language is "Беларуская"

      • Deleted property bg (string)

        Used for users whose language is "Български"

      • Deleted property hr (string)

        Used for users whose language is "Hrvatski"

      • Deleted property cs (string)

        Used for users whose language is "Čeština"

      • Deleted property da (string)

        Used for users whose language is "Dansk"

      • Deleted property et (string)

        Used for users whose language is "Eesti"

      • Deleted property fi (string)

        Used for users whose language is "Suomi"

      • Deleted property el (string)

        Used for users whose language is "Ελληνικά"

      • Deleted property hu (string)

        Used for users whose language is "Magyar"

      • Deleted property is (string)

        Used for users whose language is "Íslenska"

      • Deleted property ga (string)

        Used for users whose language is "Gaeilge"

      • Deleted property lv (string)

        Used for users whose language is "Latviešu"

      • Deleted property lt (string)

        Used for users whose language is "Lietuvių"

      • Deleted property mk (string)

        Used for users whose language is "Македонски"

      • Deleted property mt (string)

        Used for users whose language is "Malti"

      • Deleted property no (string)

        Used for users whose language is "Norsk"

      • Deleted property pt (string)

        Used for users whose language is "Português"

      • Deleted property ru (string)

        Used for users whose language is "Русский"

      • Deleted property sr (string)

        Used for users whose language is "Српски"

      • Deleted property sk (string)

        Used for users whose language is "Slovenčina"

      • Deleted property sl (string)

        Used for users whose language is "Slovenščina"

      • Deleted property es (string)

        Used for users whose language is "Español"

      • Deleted property sv (string)

        Used for users whose language is "Svenska"

      • Deleted property uk (string)

        Used for users whose language is "Українська"

      • Deleted property cy (string)

        Used for users whose language is "Cymraeg"

    • Changed property aboutText (object)

      This scheme is a collection of account about text for users in different languages.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

      • Deleted property ro (string)

        Used for users whose language is "Română"

      • Deleted property sq (string)

        Used for users whose language is "Shqip"

      • Deleted property be (string)

        Used for users whose language is "Беларуская"

      • Deleted property bg (string)

        Used for users whose language is "Български"

      • Deleted property hr (string)

        Used for users whose language is "Hrvatski"

      • Deleted property cs (string)

        Used for users whose language is "Čeština"

      • Deleted property da (string)

        Used for users whose language is "Dansk"

      • Deleted property et (string)

        Used for users whose language is "Eesti"

      • Deleted property fi (string)

        Used for users whose language is "Suomi"

      • Deleted property el (string)

        Used for users whose language is "Ελληνικά"

      • Deleted property hu (string)

        Used for users whose language is "Magyar"

      • Deleted property is (string)

        Used for users whose language is "Íslenska"

      • Deleted property ga (string)

        Used for users whose language is "Gaeilge"

      • Deleted property lv (string)

        Used for users whose language is "Latviešu"

      • Deleted property lt (string)

        Used for users whose language is "Lietuvių"

      • Deleted property mk (string)

        Used for users whose language is "Македонски"

      • Deleted property mt (string)

        Used for users whose language is "Malti"

      • Deleted property no (string)

        Used for users whose language is "Norsk"

      • Deleted property pt (string)

        Used for users whose language is "Português"

      • Deleted property ru (string)

        Used for users whose language is "Русский"

      • Deleted property sr (string)

        Used for users whose language is "Српски"

      • Deleted property sk (string)

        Used for users whose language is "Slovenčina"

      • Deleted property sl (string)

        Used for users whose language is "Slovenščina"

      • Deleted property es (string)

        Used for users whose language is "Español"

      • Deleted property sv (string)

        Used for users whose language is "Svenska"

      • Deleted property uk (string)

        Used for users whose language is "Українська"

      • Deleted property cy (string)

        Used for users whose language is "Cymraeg"

    • Changed property completedBoxText (object)

      This scheme is a collection of account completed box text for users in different languages.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

      • Deleted property ro (string)

        Used for users whose language is "Română"

      • Deleted property sq (string)

        Used for users whose language is "Shqip"

      • Deleted property be (string)

        Used for users whose language is "Беларуская"

      • Deleted property bg (string)

        Used for users whose language is "Български"

      • Deleted property hr (string)

        Used for users whose language is "Hrvatski"

      • Deleted property cs (string)

        Used for users whose language is "Čeština"

      • Deleted property da (string)

        Used for users whose language is "Dansk"

      • Deleted property et (string)

        Used for users whose language is "Eesti"

      • Deleted property fi (string)

        Used for users whose language is "Suomi"

      • Deleted property el (string)

        Used for users whose language is "Ελληνικά"

      • Deleted property hu (string)

        Used for users whose language is "Magyar"

      • Deleted property is (string)

        Used for users whose language is "Íslenska"

      • Deleted property ga (string)

        Used for users whose language is "Gaeilge"

      • Deleted property lv (string)

        Used for users whose language is "Latviešu"

      • Deleted property lt (string)

        Used for users whose language is "Lietuvių"

      • Deleted property mk (string)

        Used for users whose language is "Македонски"

      • Deleted property mt (string)

        Used for users whose language is "Malti"

      • Deleted property no (string)

        Used for users whose language is "Norsk"

      • Deleted property pt (string)

        Used for users whose language is "Português"

      • Deleted property ru (string)

        Used for users whose language is "Русский"

      • Deleted property sr (string)

        Used for users whose language is "Српски"

      • Deleted property sk (string)

        Used for users whose language is "Slovenčina"

      • Deleted property sl (string)

        Used for users whose language is "Slovenščina"

      • Deleted property es (string)

        Used for users whose language is "Español"

      • Deleted property sv (string)

        Used for users whose language is "Svenska"

      • Deleted property uk (string)

        Used for users whose language is "Українська"

      • Deleted property cy (string)

        Used for users whose language is "Cymraeg"

    • Changed property completedText (object)

      This scheme is a collection of account completed text for users in different languages.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

      • Deleted property ro (string)

        Used for users whose language is "Română"

      • Deleted property sq (string)

        Used for users whose language is "Shqip"

      • Deleted property be (string)

        Used for users whose language is "Беларуская"

      • Deleted property bg (string)

        Used for users whose language is "Български"

      • Deleted property hr (string)

        Used for users whose language is "Hrvatski"

      • Deleted property cs (string)

        Used for users whose language is "Čeština"

      • Deleted property da (string)

        Used for users whose language is "Dansk"

      • Deleted property et (string)

        Used for users whose language is "Eesti"

      • Deleted property fi (string)

        Used for users whose language is "Suomi"

      • Deleted property el (string)

        Used for users whose language is "Ελληνικά"

      • Deleted property hu (string)

        Used for users whose language is "Magyar"

      • Deleted property is (string)

        Used for users whose language is "Íslenska"

      • Deleted property ga (string)

        Used for users whose language is "Gaeilge"

      • Deleted property lv (string)

        Used for users whose language is "Latviešu"

      • Deleted property lt (string)

        Used for users whose language is "Lietuvių"

      • Deleted property mk (string)

        Used for users whose language is "Македонски"

      • Deleted property mt (string)

        Used for users whose language is "Malti"

      • Deleted property no (string)

        Used for users whose language is "Norsk"

      • Deleted property pt (string)

        Used for users whose language is "Português"

      • Deleted property ru (string)

        Used for users whose language is "Русский"

      • Deleted property sr (string)

        Used for users whose language is "Српски"

      • Deleted property sk (string)

        Used for users whose language is "Slovenčina"

      • Deleted property sl (string)

        Used for users whose language is "Slovenščina"

      • Deleted property es (string)

        Used for users whose language is "Español"

      • Deleted property sv (string)

        Used for users whose language is "Svenska"

      • Deleted property uk (string)

        Used for users whose language is "Українська"

      • Deleted property cy (string)

        Used for users whose language is "Cymraeg"

GET /adminUsers
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Admin user included relations

    • Changed property company (object)

      Base properties of company entity

      • Changed property languages (array)

        Company languages (at least one language required). Any code from the language enumeration is accepted; only the main set is shown as an example.

GET /adminUsers/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property company (object)

      Base properties of company entity

      • Changed property languages (array)

        Company languages (at least one language required). Any code from the language enumeration is accepted; only the main set is shown as an example.

GET /adminUsers/me/info
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property company (object)

      Base properties of company entity

      • Changed property languages (array)

        Company languages (at least one language required). Any code from the language enumeration is accepted; only the main set is shown as an example.

GET /candidateCustomFields
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Candidate custom field included relations

    • Changed property customField (object)

      Base properties of custom field for an entity

      • Changed property nameI18n (object)

        Translations keyed by language code.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration.

        • Deleted property ro (string)

        • Deleted property sq (string)

        • Deleted property be (string)

        • Deleted property bg (string)

        • Deleted property hr (string)

        • Deleted property cs (string)

        • Deleted property da (string)

        • Deleted property et (string)

        • Deleted property fi (string)

        • Deleted property el (string)

        • Deleted property hu (string)

        • Deleted property is (string)

        • Deleted property ga (string)

        • Deleted property lv (string)

        • Deleted property lt (string)

        • Deleted property mk (string)

        • Deleted property mt (string)

        • Deleted property no (string)

        • Deleted property pt (string)

        • Deleted property ru (string)

        • Deleted property sr (string)

        • Deleted property sk (string)

        • Deleted property sl (string)

        • Deleted property es (string)

        • Deleted property sv (string)

        • Deleted property uk (string)

        • Deleted property cy (string)

GET /candidateCustomFields/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property customField (object)

      Base properties of custom field for an entity

      • Changed property nameI18n (object)

        Translations keyed by language code.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration.

        • Deleted property ro (string)

        • Deleted property sq (string)

        • Deleted property be (string)

        • Deleted property bg (string)

        • Deleted property hr (string)

        • Deleted property cs (string)

        • Deleted property da (string)

        • Deleted property et (string)

        • Deleted property fi (string)

        • Deleted property el (string)

        • Deleted property hu (string)

        • Deleted property is (string)

        • Deleted property ga (string)

        • Deleted property lv (string)

        • Deleted property lt (string)

        • Deleted property mk (string)

        • Deleted property mt (string)

        • Deleted property no (string)

        • Deleted property pt (string)

        • Deleted property ru (string)

        • Deleted property sr (string)

        • Deleted property sk (string)

        • Deleted property sl (string)

        • Deleted property es (string)

        • Deleted property sv (string)

        • Deleted property uk (string)

        • Deleted property cy (string)

POST /customFields
Request:

Changed content type : application/json

  • Changed property nameI18n (object)

    Translations keyed by language code.

    • Added property {other language} (string)

      Placeholder for any other language code from the supported language enumeration.

    • Deleted property ro (string)

    • Deleted property sq (string)

    • Deleted property be (string)

    • Deleted property bg (string)

    • Deleted property hr (string)

    • Deleted property cs (string)

    • Deleted property da (string)

    • Deleted property et (string)

    • Deleted property fi (string)

    • Deleted property el (string)

    • Deleted property hu (string)

    • Deleted property is (string)

    • Deleted property ga (string)

    • Deleted property lv (string)

    • Deleted property lt (string)

    • Deleted property mk (string)

    • Deleted property mt (string)

    • Deleted property no (string)

    • Deleted property pt (string)

    • Deleted property ru (string)

    • Deleted property sr (string)

    • Deleted property sk (string)

    • Deleted property sl (string)

    • Deleted property es (string)

    • Deleted property sv (string)

    • Deleted property uk (string)

    • Deleted property cy (string)

Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property nameI18n (object)

      Translations keyed by language code.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration.

      • Deleted property ro (string)

      • Deleted property sq (string)

      • Deleted property be (string)

      • Deleted property bg (string)

      • Deleted property hr (string)

      • Deleted property cs (string)

      • Deleted property da (string)

      • Deleted property et (string)

      • Deleted property fi (string)

      • Deleted property el (string)

      • Deleted property hu (string)

      • Deleted property is (string)

      • Deleted property ga (string)

      • Deleted property lv (string)

      • Deleted property lt (string)

      • Deleted property mk (string)

      • Deleted property mt (string)

      • Deleted property no (string)

      • Deleted property pt (string)

      • Deleted property ru (string)

      • Deleted property sr (string)

      • Deleted property sk (string)

      • Deleted property sl (string)

      • Deleted property es (string)

      • Deleted property sv (string)

      • Deleted property uk (string)

      • Deleted property cy (string)

GET /customFields
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Base properties of custom field for an entity

    • Changed property nameI18n (object)

      Translations keyed by language code.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration.

      • Deleted property ro (string)

      • Deleted property sq (string)

      • Deleted property be (string)

      • Deleted property bg (string)

      • Deleted property hr (string)

      • Deleted property cs (string)

      • Deleted property da (string)

      • Deleted property et (string)

      • Deleted property fi (string)

      • Deleted property el (string)

      • Deleted property hu (string)

      • Deleted property is (string)

      • Deleted property ga (string)

      • Deleted property lv (string)

      • Deleted property lt (string)

      • Deleted property mk (string)

      • Deleted property mt (string)

      • Deleted property no (string)

      • Deleted property pt (string)

      • Deleted property ru (string)

      • Deleted property sr (string)

      • Deleted property sk (string)

      • Deleted property sl (string)

      • Deleted property es (string)

      • Deleted property sv (string)

      • Deleted property uk (string)

      • Deleted property cy (string)

GET /requests/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property validation (array)

      Array of daas request validations

      Changed items (object): > Daas Request Validation Group

      • Changed property messageI18n (object)

        Translations keyed by language code.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration.

        • Deleted property ro (string)

        • Deleted property sq (string)

        • Deleted property be (string)

        • Deleted property bg (string)

        • Deleted property hr (string)

        • Deleted property cs (string)

        • Deleted property da (string)

        • Deleted property et (string)

        • Deleted property fi (string)

        • Deleted property el (string)

        • Deleted property hu (string)

        • Deleted property is (string)

        • Deleted property ga (string)

        • Deleted property lv (string)

        • Deleted property lt (string)

        • Deleted property mk (string)

        • Deleted property mt (string)

        • Deleted property no (string)

        • Deleted property pt (string)

        • Deleted property ru (string)

        • Deleted property sr (string)

        • Deleted property sk (string)

        • Deleted property sl (string)

        • Deleted property es (string)

        • Deleted property sv (string)

        • Deleted property uk (string)

        • Deleted property cy (string)

PATCH /documentValidationSets/{id}
Request:

Changed content type : application/json

  • Changed property validationGroups (array)

    Array of document validation groups related to this validation set

    Changed items (object): > Document validation set validation group properties

    • Changed property messageI18n (object)

      Translations keyed by language code.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration.

      • Deleted property ro (string)

      • Deleted property sq (string)

      • Deleted property be (string)

      • Deleted property bg (string)

      • Deleted property hr (string)

      • Deleted property cs (string)

      • Deleted property da (string)

      • Deleted property et (string)

      • Deleted property fi (string)

      • Deleted property el (string)

      • Deleted property hu (string)

      • Deleted property is (string)

      • Deleted property ga (string)

      • Deleted property lv (string)

      • Deleted property lt (string)

      • Deleted property mk (string)

      • Deleted property mt (string)

      • Deleted property no (string)

      • Deleted property pt (string)

      • Deleted property ru (string)

      • Deleted property sr (string)

      • Deleted property sk (string)

      • Deleted property sl (string)

      • Deleted property es (string)

      • Deleted property sv (string)

      • Deleted property uk (string)

      • Deleted property cy (string)

POST /scenarios
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property documentTypes (array)

      Scenario document types

      Changed items (object):

      • Changed property nameI18n (object)

        Translations keyed by language code.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration.

        • Deleted property ro (string)

        • Deleted property sq (string)

        • Deleted property be (string)

        • Deleted property bg (string)

        • Deleted property hr (string)

        • Deleted property cs (string)

        • Deleted property da (string)

        • Deleted property et (string)

        • Deleted property fi (string)

        • Deleted property el (string)

        • Deleted property hu (string)

        • Deleted property is (string)

        • Deleted property ga (string)

        • Deleted property lv (string)

        • Deleted property lt (string)

        • Deleted property mk (string)

        • Deleted property mt (string)

        • Deleted property no (string)

        • Deleted property pt (string)

        • Deleted property ru (string)

        • Deleted property sr (string)

        • Deleted property sk (string)

        • Deleted property sl (string)

        • Deleted property es (string)

        • Deleted property sv (string)

        • Deleted property uk (string)

        • Deleted property cy (string)

GET /scenarios
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Scenario included relations

    • Changed property documentTypes (array)

      Scenario document types

      Changed items (object):

      • Changed property nameI18n (object)

        Translations keyed by language code.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration.

        • Deleted property ro (string)

        • Deleted property sq (string)

        • Deleted property be (string)

        • Deleted property bg (string)

        • Deleted property hr (string)

        • Deleted property cs (string)

        • Deleted property da (string)

        • Deleted property et (string)

        • Deleted property fi (string)

        • Deleted property el (string)

        • Deleted property hu (string)

        • Deleted property is (string)

        • Deleted property ga (string)

        • Deleted property lv (string)

        • Deleted property lt (string)

        • Deleted property mk (string)

        • Deleted property mt (string)

        • Deleted property no (string)

        • Deleted property pt (string)

        • Deleted property ru (string)

        • Deleted property sr (string)

        • Deleted property sk (string)

        • Deleted property sl (string)

        • Deleted property es (string)

        • Deleted property sv (string)

        • Deleted property uk (string)

        • Deleted property cy (string)

    • Changed property company (object)

      Base properties of company entity

      • Changed property languages (array)

        Company languages (at least one language required). Any code from the language enumeration is accepted; only the main set is shown as an example.

PATCH /scenarios/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property documentTypes (array)

      Scenario document types

      Changed items (object):

      • Changed property nameI18n (object)

        Translations keyed by language code.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration.

        • Deleted property ro (string)

        • Deleted property sq (string)

        • Deleted property be (string)

        • Deleted property bg (string)

        • Deleted property hr (string)

        • Deleted property cs (string)

        • Deleted property da (string)

        • Deleted property et (string)

        • Deleted property fi (string)

        • Deleted property el (string)

        • Deleted property hu (string)

        • Deleted property is (string)

        • Deleted property ga (string)

        • Deleted property lv (string)

        • Deleted property lt (string)

        • Deleted property mk (string)

        • Deleted property mt (string)

        • Deleted property no (string)

        • Deleted property pt (string)

        • Deleted property ru (string)

        • Deleted property sr (string)

        • Deleted property sk (string)

        • Deleted property sl (string)

        • Deleted property es (string)

        • Deleted property sv (string)

        • Deleted property uk (string)

        • Deleted property cy (string)

GET /scenarios/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property documentTypes (array)

      Scenario document types

      Changed items (object):

      • Changed property nameI18n (object)

        Translations keyed by language code.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration.

        • Deleted property ro (string)

        • Deleted property sq (string)

        • Deleted property be (string)

        • Deleted property bg (string)

        • Deleted property hr (string)

        • Deleted property cs (string)

        • Deleted property da (string)

        • Deleted property et (string)

        • Deleted property fi (string)

        • Deleted property el (string)

        • Deleted property hu (string)

        • Deleted property is (string)

        • Deleted property ga (string)

        • Deleted property lv (string)

        • Deleted property lt (string)

        • Deleted property mk (string)

        • Deleted property mt (string)

        • Deleted property no (string)

        • Deleted property pt (string)

        • Deleted property ru (string)

        • Deleted property sr (string)

        • Deleted property sk (string)

        • Deleted property sl (string)

        • Deleted property es (string)

        • Deleted property sv (string)

        • Deleted property uk (string)

        • Deleted property cy (string)

    • Changed property company (object)

      Base properties of company entity

      • Changed property languages (array)

        Company languages (at least one language required). Any code from the language enumeration is accepted; only the main set is shown as an example.

GET /candidateDocumentTypes/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Added property metadata (object)

      Candidate Document Type metadata (external properties)

    • Changed property documentType (object)

      • Changed property nameI18n (object)

        Translations keyed by language code.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration.

        • Deleted property ro (string)

        • Deleted property sq (string)

        • Deleted property be (string)

        • Deleted property bg (string)

        • Deleted property hr (string)

        • Deleted property cs (string)

        • Deleted property da (string)

        • Deleted property et (string)

        • Deleted property fi (string)

        • Deleted property el (string)

        • Deleted property hu (string)

        • Deleted property is (string)

        • Deleted property ga (string)

        • Deleted property lv (string)

        • Deleted property lt (string)

        • Deleted property mk (string)

        • Deleted property mt (string)

        • Deleted property no (string)

        • Deleted property pt (string)

        • Deleted property ru (string)

        • Deleted property sr (string)

        • Deleted property sk (string)

        • Deleted property sl (string)

        • Deleted property es (string)

        • Deleted property sv (string)

        • Deleted property uk (string)

        • Deleted property cy (string)

PATCH /candidateDocumentTypes/{id}
Request:

Changed content type : application/json

  • Added property metadata (object)

    Candidate Document Type metadata (external properties)

Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Added property metadata (object)

      Candidate Document Type metadata (external properties)

GET /candidatePresets
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Candidate Preset included relations

    • Changed property company (object)

      Base properties of company entity

      • Changed property languages (array)

        Company languages (at least one language required). Any code from the language enumeration is accepted; only the main set is shown as an example.

GET /candidatePresets/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property company (object)

      Base properties of company entity

      • Changed property languages (array)

        Company languages (at least one language required). Any code from the language enumeration is accepted; only the main set is shown as an example.

POST /requests
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property validation (array)

      Array of daas request validations

      Changed items (object): > Daas Request Validation Group

      • Changed property messageI18n (object)

        Translations keyed by language code.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration.

        • Deleted property ro (string)

        • Deleted property sq (string)

        • Deleted property be (string)

        • Deleted property bg (string)

        • Deleted property hr (string)

        • Deleted property cs (string)

        • Deleted property da (string)

        • Deleted property et (string)

        • Deleted property fi (string)

        • Deleted property el (string)

        • Deleted property hu (string)

        • Deleted property is (string)

        • Deleted property ga (string)

        • Deleted property lv (string)

        • Deleted property lt (string)

        • Deleted property mk (string)

        • Deleted property mt (string)

        • Deleted property no (string)

        • Deleted property pt (string)

        • Deleted property ru (string)

        • Deleted property sr (string)

        • Deleted property sk (string)

        • Deleted property sl (string)

        • Deleted property es (string)

        • Deleted property sv (string)

        • Deleted property uk (string)

        • Deleted property cy (string)

GET /requests
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object):

    • Changed property validation (array)

      Array of daas request validations

      Changed items (object): > Daas Request Validation Group

      • Changed property messageI18n (object)

        Translations keyed by language code.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration.

        • Deleted property ro (string)

        • Deleted property sq (string)

        • Deleted property be (string)

        • Deleted property bg (string)

        • Deleted property hr (string)

        • Deleted property cs (string)

        • Deleted property da (string)

        • Deleted property et (string)

        • Deleted property fi (string)

        • Deleted property el (string)

        • Deleted property hu (string)

        • Deleted property is (string)

        • Deleted property ga (string)

        • Deleted property lv (string)

        • Deleted property lt (string)

        • Deleted property mk (string)

        • Deleted property mt (string)

        • Deleted property no (string)

        • Deleted property pt (string)

        • Deleted property ru (string)

        • Deleted property sr (string)

        • Deleted property sk (string)

        • Deleted property sl (string)

        • Deleted property es (string)

        • Deleted property sv (string)

        • Deleted property uk (string)

        • Deleted property cy (string)

GET /registration-pages
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property account (object)

      • Changed property welcomeText (object)

        This scheme is a collection of account welcome text for users in different languages.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

        • Deleted property ro (string)

          Used for users whose language is "Română"

        • Deleted property sq (string)

          Used for users whose language is "Shqip"

        • Deleted property be (string)

          Used for users whose language is "Беларуская"

        • Deleted property bg (string)

          Used for users whose language is "Български"

        • Deleted property hr (string)

          Used for users whose language is "Hrvatski"

        • Deleted property cs (string)

          Used for users whose language is "Čeština"

        • Deleted property da (string)

          Used for users whose language is "Dansk"

        • Deleted property et (string)

          Used for users whose language is "Eesti"

        • Deleted property fi (string)

          Used for users whose language is "Suomi"

        • Deleted property el (string)

          Used for users whose language is "Ελληνικά"

        • Deleted property hu (string)

          Used for users whose language is "Magyar"

        • Deleted property is (string)

          Used for users whose language is "Íslenska"

        • Deleted property ga (string)

          Used for users whose language is "Gaeilge"

        • Deleted property lv (string)

          Used for users whose language is "Latviešu"

        • Deleted property lt (string)

          Used for users whose language is "Lietuvių"

        • Deleted property mk (string)

          Used for users whose language is "Македонски"

        • Deleted property mt (string)

          Used for users whose language is "Malti"

        • Deleted property no (string)

          Used for users whose language is "Norsk"

        • Deleted property pt (string)

          Used for users whose language is "Português"

        • Deleted property ru (string)

          Used for users whose language is "Русский"

        • Deleted property sr (string)

          Used for users whose language is "Српски"

        • Deleted property sk (string)

          Used for users whose language is "Slovenčina"

        • Deleted property sl (string)

          Used for users whose language is "Slovenščina"

        • Deleted property es (string)

          Used for users whose language is "Español"

        • Deleted property sv (string)

          Used for users whose language is "Svenska"

        • Deleted property uk (string)

          Used for users whose language is "Українська"

        • Deleted property cy (string)

          Used for users whose language is "Cymraeg"

      • Changed property aboutText (object)

        This scheme is a collection of account about text for users in different languages.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

        • Deleted property ro (string)

          Used for users whose language is "Română"

        • Deleted property sq (string)

          Used for users whose language is "Shqip"

        • Deleted property be (string)

          Used for users whose language is "Беларуская"

        • Deleted property bg (string)

          Used for users whose language is "Български"

        • Deleted property hr (string)

          Used for users whose language is "Hrvatski"

        • Deleted property cs (string)

          Used for users whose language is "Čeština"

        • Deleted property da (string)

          Used for users whose language is "Dansk"

        • Deleted property et (string)

          Used for users whose language is "Eesti"

        • Deleted property fi (string)

          Used for users whose language is "Suomi"

        • Deleted property el (string)

          Used for users whose language is "Ελληνικά"

        • Deleted property hu (string)

          Used for users whose language is "Magyar"

        • Deleted property is (string)

          Used for users whose language is "Íslenska"

        • Deleted property ga (string)

          Used for users whose language is "Gaeilge"

        • Deleted property lv (string)

          Used for users whose language is "Latviešu"

        • Deleted property lt (string)

          Used for users whose language is "Lietuvių"

        • Deleted property mk (string)

          Used for users whose language is "Македонски"

        • Deleted property mt (string)

          Used for users whose language is "Malti"

        • Deleted property no (string)

          Used for users whose language is "Norsk"

        • Deleted property pt (string)

          Used for users whose language is "Português"

        • Deleted property ru (string)

          Used for users whose language is "Русский"

        • Deleted property sr (string)

          Used for users whose language is "Српски"

        • Deleted property sk (string)

          Used for users whose language is "Slovenčina"

        • Deleted property sl (string)

          Used for users whose language is "Slovenščina"

        • Deleted property es (string)

          Used for users whose language is "Español"

        • Deleted property sv (string)

          Used for users whose language is "Svenska"

        • Deleted property uk (string)

          Used for users whose language is "Українська"

        • Deleted property cy (string)

          Used for users whose language is "Cymraeg"

      • Changed property completedBoxText (object)

        This scheme is a collection of account completed box text for users in different languages.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

        • Deleted property ro (string)

          Used for users whose language is "Română"

        • Deleted property sq (string)

          Used for users whose language is "Shqip"

        • Deleted property be (string)

          Used for users whose language is "Беларуская"

        • Deleted property bg (string)

          Used for users whose language is "Български"

        • Deleted property hr (string)

          Used for users whose language is "Hrvatski"

        • Deleted property cs (string)

          Used for users whose language is "Čeština"

        • Deleted property da (string)

          Used for users whose language is "Dansk"

        • Deleted property et (string)

          Used for users whose language is "Eesti"

        • Deleted property fi (string)

          Used for users whose language is "Suomi"

        • Deleted property el (string)

          Used for users whose language is "Ελληνικά"

        • Deleted property hu (string)

          Used for users whose language is "Magyar"

        • Deleted property is (string)

          Used for users whose language is "Íslenska"

        • Deleted property ga (string)

          Used for users whose language is "Gaeilge"

        • Deleted property lv (string)

          Used for users whose language is "Latviešu"

        • Deleted property lt (string)

          Used for users whose language is "Lietuvių"

        • Deleted property mk (string)

          Used for users whose language is "Македонски"

        • Deleted property mt (string)

          Used for users whose language is "Malti"

        • Deleted property no (string)

          Used for users whose language is "Norsk"

        • Deleted property pt (string)

          Used for users whose language is "Português"

        • Deleted property ru (string)

          Used for users whose language is "Русский"

        • Deleted property sr (string)

          Used for users whose language is "Српски"

        • Deleted property sk (string)

          Used for users whose language is "Slovenčina"

        • Deleted property sl (string)

          Used for users whose language is "Slovenščina"

        • Deleted property es (string)

          Used for users whose language is "Español"

        • Deleted property sv (string)

          Used for users whose language is "Svenska"

        • Deleted property uk (string)

          Used for users whose language is "Українська"

        • Deleted property cy (string)

          Used for users whose language is "Cymraeg"

      • Changed property completedText (object)

        This scheme is a collection of account completed text for users in different languages.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

        • Deleted property ro (string)

          Used for users whose language is "Română"

        • Deleted property sq (string)

          Used for users whose language is "Shqip"

        • Deleted property be (string)

          Used for users whose language is "Беларуская"

        • Deleted property bg (string)

          Used for users whose language is "Български"

        • Deleted property hr (string)

          Used for users whose language is "Hrvatski"

        • Deleted property cs (string)

          Used for users whose language is "Čeština"

        • Deleted property da (string)

          Used for users whose language is "Dansk"

        • Deleted property et (string)

          Used for users whose language is "Eesti"

        • Deleted property fi (string)

          Used for users whose language is "Suomi"

        • Deleted property el (string)

          Used for users whose language is "Ελληνικά"

        • Deleted property hu (string)

          Used for users whose language is "Magyar"

        • Deleted property is (string)

          Used for users whose language is "Íslenska"

        • Deleted property ga (string)

          Used for users whose language is "Gaeilge"

        • Deleted property lv (string)

          Used for users whose language is "Latviešu"

        • Deleted property lt (string)

          Used for users whose language is "Lietuvių"

        • Deleted property mk (string)

          Used for users whose language is "Македонски"

        • Deleted property mt (string)

          Used for users whose language is "Malti"

        • Deleted property no (string)

          Used for users whose language is "Norsk"

        • Deleted property pt (string)

          Used for users whose language is "Português"

        • Deleted property ru (string)

          Used for users whose language is "Русский"

        • Deleted property sr (string)

          Used for users whose language is "Српски"

        • Deleted property sk (string)

          Used for users whose language is "Slovenčina"

        • Deleted property sl (string)

          Used for users whose language is "Slovenščina"

        • Deleted property es (string)

          Used for users whose language is "Español"

        • Deleted property sv (string)

          Used for users whose language is "Svenska"

        • Deleted property uk (string)

          Used for users whose language is "Українська"

        • Deleted property cy (string)

          Used for users whose language is "Cymraeg"

    • Changed property documents (array)

      Related documents

      Changed items (object):

      • Changed property documentType (object)

        • Changed property nameI18n (object)

          Translations keyed by language code.

          • Added property {other language} (string)

            Placeholder for any other language code from the supported language enumeration.

          • Deleted property ro (string)

          • Deleted property sq (string)

          • Deleted property be (string)

          • Deleted property bg (string)

          • Deleted property hr (string)

          • Deleted property cs (string)

          • Deleted property da (string)

          • Deleted property et (string)

          • Deleted property fi (string)

          • Deleted property el (string)

          • Deleted property hu (string)

          • Deleted property is (string)

          • Deleted property ga (string)

          • Deleted property lv (string)

          • Deleted property lt (string)

          • Deleted property mk (string)

          • Deleted property mt (string)

          • Deleted property no (string)

          • Deleted property pt (string)

          • Deleted property ru (string)

          • Deleted property sr (string)

          • Deleted property sk (string)

          • Deleted property sl (string)

          • Deleted property es (string)

          • Deleted property sv (string)

          • Deleted property uk (string)

          • Deleted property cy (string)

GET /registration-pages/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property account (object)

      • Changed property welcomeText (object)

        This scheme is a collection of account welcome text for users in different languages.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

        • Deleted property ro (string)

          Used for users whose language is "Română"

        • Deleted property sq (string)

          Used for users whose language is "Shqip"

        • Deleted property be (string)

          Used for users whose language is "Беларуская"

        • Deleted property bg (string)

          Used for users whose language is "Български"

        • Deleted property hr (string)

          Used for users whose language is "Hrvatski"

        • Deleted property cs (string)

          Used for users whose language is "Čeština"

        • Deleted property da (string)

          Used for users whose language is "Dansk"

        • Deleted property et (string)

          Used for users whose language is "Eesti"

        • Deleted property fi (string)

          Used for users whose language is "Suomi"

        • Deleted property el (string)

          Used for users whose language is "Ελληνικά"

        • Deleted property hu (string)

          Used for users whose language is "Magyar"

        • Deleted property is (string)

          Used for users whose language is "Íslenska"

        • Deleted property ga (string)

          Used for users whose language is "Gaeilge"

        • Deleted property lv (string)

          Used for users whose language is "Latviešu"

        • Deleted property lt (string)

          Used for users whose language is "Lietuvių"

        • Deleted property mk (string)

          Used for users whose language is "Македонски"

        • Deleted property mt (string)

          Used for users whose language is "Malti"

        • Deleted property no (string)

          Used for users whose language is "Norsk"

        • Deleted property pt (string)

          Used for users whose language is "Português"

        • Deleted property ru (string)

          Used for users whose language is "Русский"

        • Deleted property sr (string)

          Used for users whose language is "Српски"

        • Deleted property sk (string)

          Used for users whose language is "Slovenčina"

        • Deleted property sl (string)

          Used for users whose language is "Slovenščina"

        • Deleted property es (string)

          Used for users whose language is "Español"

        • Deleted property sv (string)

          Used for users whose language is "Svenska"

        • Deleted property uk (string)

          Used for users whose language is "Українська"

        • Deleted property cy (string)

          Used for users whose language is "Cymraeg"

      • Changed property aboutText (object)

        This scheme is a collection of account about text for users in different languages.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

        • Deleted property ro (string)

          Used for users whose language is "Română"

        • Deleted property sq (string)

          Used for users whose language is "Shqip"

        • Deleted property be (string)

          Used for users whose language is "Беларуская"

        • Deleted property bg (string)

          Used for users whose language is "Български"

        • Deleted property hr (string)

          Used for users whose language is "Hrvatski"

        • Deleted property cs (string)

          Used for users whose language is "Čeština"

        • Deleted property da (string)

          Used for users whose language is "Dansk"

        • Deleted property et (string)

          Used for users whose language is "Eesti"

        • Deleted property fi (string)

          Used for users whose language is "Suomi"

        • Deleted property el (string)

          Used for users whose language is "Ελληνικά"

        • Deleted property hu (string)

          Used for users whose language is "Magyar"

        • Deleted property is (string)

          Used for users whose language is "Íslenska"

        • Deleted property ga (string)

          Used for users whose language is "Gaeilge"

        • Deleted property lv (string)

          Used for users whose language is "Latviešu"

        • Deleted property lt (string)

          Used for users whose language is "Lietuvių"

        • Deleted property mk (string)

          Used for users whose language is "Македонски"

        • Deleted property mt (string)

          Used for users whose language is "Malti"

        • Deleted property no (string)

          Used for users whose language is "Norsk"

        • Deleted property pt (string)

          Used for users whose language is "Português"

        • Deleted property ru (string)

          Used for users whose language is "Русский"

        • Deleted property sr (string)

          Used for users whose language is "Српски"

        • Deleted property sk (string)

          Used for users whose language is "Slovenčina"

        • Deleted property sl (string)

          Used for users whose language is "Slovenščina"

        • Deleted property es (string)

          Used for users whose language is "Español"

        • Deleted property sv (string)

          Used for users whose language is "Svenska"

        • Deleted property uk (string)

          Used for users whose language is "Українська"

        • Deleted property cy (string)

          Used for users whose language is "Cymraeg"

      • Changed property completedBoxText (object)

        This scheme is a collection of account completed box text for users in different languages.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

        • Deleted property ro (string)

          Used for users whose language is "Română"

        • Deleted property sq (string)

          Used for users whose language is "Shqip"

        • Deleted property be (string)

          Used for users whose language is "Беларуская"

        • Deleted property bg (string)

          Used for users whose language is "Български"

        • Deleted property hr (string)

          Used for users whose language is "Hrvatski"

        • Deleted property cs (string)

          Used for users whose language is "Čeština"

        • Deleted property da (string)

          Used for users whose language is "Dansk"

        • Deleted property et (string)

          Used for users whose language is "Eesti"

        • Deleted property fi (string)

          Used for users whose language is "Suomi"

        • Deleted property el (string)

          Used for users whose language is "Ελληνικά"

        • Deleted property hu (string)

          Used for users whose language is "Magyar"

        • Deleted property is (string)

          Used for users whose language is "Íslenska"

        • Deleted property ga (string)

          Used for users whose language is "Gaeilge"

        • Deleted property lv (string)

          Used for users whose language is "Latviešu"

        • Deleted property lt (string)

          Used for users whose language is "Lietuvių"

        • Deleted property mk (string)

          Used for users whose language is "Македонски"

        • Deleted property mt (string)

          Used for users whose language is "Malti"

        • Deleted property no (string)

          Used for users whose language is "Norsk"

        • Deleted property pt (string)

          Used for users whose language is "Português"

        • Deleted property ru (string)

          Used for users whose language is "Русский"

        • Deleted property sr (string)

          Used for users whose language is "Српски"

        • Deleted property sk (string)

          Used for users whose language is "Slovenčina"

        • Deleted property sl (string)

          Used for users whose language is "Slovenščina"

        • Deleted property es (string)

          Used for users whose language is "Español"

        • Deleted property sv (string)

          Used for users whose language is "Svenska"

        • Deleted property uk (string)

          Used for users whose language is "Українська"

        • Deleted property cy (string)

          Used for users whose language is "Cymraeg"

      • Changed property completedText (object)

        This scheme is a collection of account completed text for users in different languages.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

        • Deleted property ro (string)

          Used for users whose language is "Română"

        • Deleted property sq (string)

          Used for users whose language is "Shqip"

        • Deleted property be (string)

          Used for users whose language is "Беларуская"

        • Deleted property bg (string)

          Used for users whose language is "Български"

        • Deleted property hr (string)

          Used for users whose language is "Hrvatski"

        • Deleted property cs (string)

          Used for users whose language is "Čeština"

        • Deleted property da (string)

          Used for users whose language is "Dansk"

        • Deleted property et (string)

          Used for users whose language is "Eesti"

        • Deleted property fi (string)

          Used for users whose language is "Suomi"

        • Deleted property el (string)

          Used for users whose language is "Ελληνικά"

        • Deleted property hu (string)

          Used for users whose language is "Magyar"

        • Deleted property is (string)

          Used for users whose language is "Íslenska"

        • Deleted property ga (string)

          Used for users whose language is "Gaeilge"

        • Deleted property lv (string)

          Used for users whose language is "Latviešu"

        • Deleted property lt (string)

          Used for users whose language is "Lietuvių"

        • Deleted property mk (string)

          Used for users whose language is "Македонски"

        • Deleted property mt (string)

          Used for users whose language is "Malti"

        • Deleted property no (string)

          Used for users whose language is "Norsk"

        • Deleted property pt (string)

          Used for users whose language is "Português"

        • Deleted property ru (string)

          Used for users whose language is "Русский"

        • Deleted property sr (string)

          Used for users whose language is "Српски"

        • Deleted property sk (string)

          Used for users whose language is "Slovenčina"

        • Deleted property sl (string)

          Used for users whose language is "Slovenščina"

        • Deleted property es (string)

          Used for users whose language is "Español"

        • Deleted property sv (string)

          Used for users whose language is "Svenska"

        • Deleted property uk (string)

          Used for users whose language is "Українська"

        • Deleted property cy (string)

          Used for users whose language is "Cymraeg"

    • Changed property documents (array)

      Related documents

      Changed items (object):

      • Changed property documentType (object)

        • Changed property nameI18n (object)

          Translations keyed by language code.

          • Added property {other language} (string)

            Placeholder for any other language code from the supported language enumeration.

          • Deleted property ro (string)

          • Deleted property sq (string)

          • Deleted property be (string)

          • Deleted property bg (string)

          • Deleted property hr (string)

          • Deleted property cs (string)

          • Deleted property da (string)

          • Deleted property et (string)

          • Deleted property fi (string)

          • Deleted property el (string)

          • Deleted property hu (string)

          • Deleted property is (string)

          • Deleted property ga (string)

          • Deleted property lv (string)

          • Deleted property lt (string)

          • Deleted property mk (string)

          • Deleted property mt (string)

          • Deleted property no (string)

          • Deleted property pt (string)

          • Deleted property ru (string)

          • Deleted property sr (string)

          • Deleted property sk (string)

          • Deleted property sl (string)

          • Deleted property es (string)

          • Deleted property sv (string)

          • Deleted property uk (string)

          • Deleted property cy (string)

GET /candidates
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Immutable candidate properties

    • Changed property account (object)

      • Changed property welcomeText (object)

        This scheme is a collection of account welcome text for users in different languages.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

        • Deleted property ro (string)

          Used for users whose language is "Română"

        • Deleted property sq (string)

          Used for users whose language is "Shqip"

        • Deleted property be (string)

          Used for users whose language is "Беларуская"

        • Deleted property bg (string)

          Used for users whose language is "Български"

        • Deleted property hr (string)

          Used for users whose language is "Hrvatski"

        • Deleted property cs (string)

          Used for users whose language is "Čeština"

        • Deleted property da (string)

          Used for users whose language is "Dansk"

        • Deleted property et (string)

          Used for users whose language is "Eesti"

        • Deleted property fi (string)

          Used for users whose language is "Suomi"

        • Deleted property el (string)

          Used for users whose language is "Ελληνικά"

        • Deleted property hu (string)

          Used for users whose language is "Magyar"

        • Deleted property is (string)

          Used for users whose language is "Íslenska"

        • Deleted property ga (string)

          Used for users whose language is "Gaeilge"

        • Deleted property lv (string)

          Used for users whose language is "Latviešu"

        • Deleted property lt (string)

          Used for users whose language is "Lietuvių"

        • Deleted property mk (string)

          Used for users whose language is "Македонски"

        • Deleted property mt (string)

          Used for users whose language is "Malti"

        • Deleted property no (string)

          Used for users whose language is "Norsk"

        • Deleted property pt (string)

          Used for users whose language is "Português"

        • Deleted property ru (string)

          Used for users whose language is "Русский"

        • Deleted property sr (string)

          Used for users whose language is "Српски"

        • Deleted property sk (string)

          Used for users whose language is "Slovenčina"

        • Deleted property sl (string)

          Used for users whose language is "Slovenščina"

        • Deleted property es (string)

          Used for users whose language is "Español"

        • Deleted property sv (string)

          Used for users whose language is "Svenska"

        • Deleted property uk (string)

          Used for users whose language is "Українська"

        • Deleted property cy (string)

          Used for users whose language is "Cymraeg"

      • Changed property aboutText (object)

        This scheme is a collection of account about text for users in different languages.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

        • Deleted property ro (string)

          Used for users whose language is "Română"

        • Deleted property sq (string)

          Used for users whose language is "Shqip"

        • Deleted property be (string)

          Used for users whose language is "Беларуская"

        • Deleted property bg (string)

          Used for users whose language is "Български"

        • Deleted property hr (string)

          Used for users whose language is "Hrvatski"

        • Deleted property cs (string)

          Used for users whose language is "Čeština"

        • Deleted property da (string)

          Used for users whose language is "Dansk"

        • Deleted property et (string)

          Used for users whose language is "Eesti"

        • Deleted property fi (string)

          Used for users whose language is "Suomi"

        • Deleted property el (string)

          Used for users whose language is "Ελληνικά"

        • Deleted property hu (string)

          Used for users whose language is "Magyar"

        • Deleted property is (string)

          Used for users whose language is "Íslenska"

        • Deleted property ga (string)

          Used for users whose language is "Gaeilge"

        • Deleted property lv (string)

          Used for users whose language is "Latviešu"

        • Deleted property lt (string)

          Used for users whose language is "Lietuvių"

        • Deleted property mk (string)

          Used for users whose language is "Македонски"

        • Deleted property mt (string)

          Used for users whose language is "Malti"

        • Deleted property no (string)

          Used for users whose language is "Norsk"

        • Deleted property pt (string)

          Used for users whose language is "Português"

        • Deleted property ru (string)

          Used for users whose language is "Русский"

        • Deleted property sr (string)

          Used for users whose language is "Српски"

        • Deleted property sk (string)

          Used for users whose language is "Slovenčina"

        • Deleted property sl (string)

          Used for users whose language is "Slovenščina"

        • Deleted property es (string)

          Used for users whose language is "Español"

        • Deleted property sv (string)

          Used for users whose language is "Svenska"

        • Deleted property uk (string)

          Used for users whose language is "Українська"

        • Deleted property cy (string)

          Used for users whose language is "Cymraeg"

      • Changed property completedBoxText (object)

        This scheme is a collection of account completed box text for users in different languages.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

        • Deleted property ro (string)

          Used for users whose language is "Română"

        • Deleted property sq (string)

          Used for users whose language is "Shqip"

        • Deleted property be (string)

          Used for users whose language is "Беларуская"

        • Deleted property bg (string)

          Used for users whose language is "Български"

        • Deleted property hr (string)

          Used for users whose language is "Hrvatski"

        • Deleted property cs (string)

          Used for users whose language is "Čeština"

        • Deleted property da (string)

          Used for users whose language is "Dansk"

        • Deleted property et (string)

          Used for users whose language is "Eesti"

        • Deleted property fi (string)

          Used for users whose language is "Suomi"

        • Deleted property el (string)

          Used for users whose language is "Ελληνικά"

        • Deleted property hu (string)

          Used for users whose language is "Magyar"

        • Deleted property is (string)

          Used for users whose language is "Íslenska"

        • Deleted property ga (string)

          Used for users whose language is "Gaeilge"

        • Deleted property lv (string)

          Used for users whose language is "Latviešu"

        • Deleted property lt (string)

          Used for users whose language is "Lietuvių"

        • Deleted property mk (string)

          Used for users whose language is "Македонски"

        • Deleted property mt (string)

          Used for users whose language is "Malti"

        • Deleted property no (string)

          Used for users whose language is "Norsk"

        • Deleted property pt (string)

          Used for users whose language is "Português"

        • Deleted property ru (string)

          Used for users whose language is "Русский"

        • Deleted property sr (string)

          Used for users whose language is "Српски"

        • Deleted property sk (string)

          Used for users whose language is "Slovenčina"

        • Deleted property sl (string)

          Used for users whose language is "Slovenščina"

        • Deleted property es (string)

          Used for users whose language is "Español"

        • Deleted property sv (string)

          Used for users whose language is "Svenska"

        • Deleted property uk (string)

          Used for users whose language is "Українська"

        • Deleted property cy (string)

          Used for users whose language is "Cymraeg"

      • Changed property completedText (object)

        This scheme is a collection of account completed text for users in different languages.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

        • Deleted property ro (string)

          Used for users whose language is "Română"

        • Deleted property sq (string)

          Used for users whose language is "Shqip"

        • Deleted property be (string)

          Used for users whose language is "Беларуская"

        • Deleted property bg (string)

          Used for users whose language is "Български"

        • Deleted property hr (string)

          Used for users whose language is "Hrvatski"

        • Deleted property cs (string)

          Used for users whose language is "Čeština"

        • Deleted property da (string)

          Used for users whose language is "Dansk"

        • Deleted property et (string)

          Used for users whose language is "Eesti"

        • Deleted property fi (string)

          Used for users whose language is "Suomi"

        • Deleted property el (string)

          Used for users whose language is "Ελληνικά"

        • Deleted property hu (string)

          Used for users whose language is "Magyar"

        • Deleted property is (string)

          Used for users whose language is "Íslenska"

        • Deleted property ga (string)

          Used for users whose language is "Gaeilge"

        • Deleted property lv (string)

          Used for users whose language is "Latviešu"

        • Deleted property lt (string)

          Used for users whose language is "Lietuvių"

        • Deleted property mk (string)

          Used for users whose language is "Македонски"

        • Deleted property mt (string)

          Used for users whose language is "Malti"

        • Deleted property no (string)

          Used for users whose language is "Norsk"

        • Deleted property pt (string)

          Used for users whose language is "Português"

        • Deleted property ru (string)

          Used for users whose language is "Русский"

        • Deleted property sr (string)

          Used for users whose language is "Српски"

        • Deleted property sk (string)

          Used for users whose language is "Slovenčina"

        • Deleted property sl (string)

          Used for users whose language is "Slovenščina"

        • Deleted property es (string)

          Used for users whose language is "Español"

        • Deleted property sv (string)

          Used for users whose language is "Svenska"

        • Deleted property uk (string)

          Used for users whose language is "Українська"

        • Deleted property cy (string)

          Used for users whose language is "Cymraeg"

    • Changed property company (object)

      Base properties of company entity

      • Changed property languages (array)

        Company languages (at least one language required). Any code from the language enumeration is accepted; only the main set is shown as an example.

    • Changed property candidateDocumentTypes (array)

      Candidate document types relation

      Changed items (object): > Candidate Document Type properties

      • Added property metadata (object)

        Candidate Document Type metadata (external properties)

GET /candidates/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property account (object)

      • Changed property welcomeText (object)

        This scheme is a collection of account welcome text for users in different languages.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

        • Deleted property ro (string)

          Used for users whose language is "Română"

        • Deleted property sq (string)

          Used for users whose language is "Shqip"

        • Deleted property be (string)

          Used for users whose language is "Беларуская"

        • Deleted property bg (string)

          Used for users whose language is "Български"

        • Deleted property hr (string)

          Used for users whose language is "Hrvatski"

        • Deleted property cs (string)

          Used for users whose language is "Čeština"

        • Deleted property da (string)

          Used for users whose language is "Dansk"

        • Deleted property et (string)

          Used for users whose language is "Eesti"

        • Deleted property fi (string)

          Used for users whose language is "Suomi"

        • Deleted property el (string)

          Used for users whose language is "Ελληνικά"

        • Deleted property hu (string)

          Used for users whose language is "Magyar"

        • Deleted property is (string)

          Used for users whose language is "Íslenska"

        • Deleted property ga (string)

          Used for users whose language is "Gaeilge"

        • Deleted property lv (string)

          Used for users whose language is "Latviešu"

        • Deleted property lt (string)

          Used for users whose language is "Lietuvių"

        • Deleted property mk (string)

          Used for users whose language is "Македонски"

        • Deleted property mt (string)

          Used for users whose language is "Malti"

        • Deleted property no (string)

          Used for users whose language is "Norsk"

        • Deleted property pt (string)

          Used for users whose language is "Português"

        • Deleted property ru (string)

          Used for users whose language is "Русский"

        • Deleted property sr (string)

          Used for users whose language is "Српски"

        • Deleted property sk (string)

          Used for users whose language is "Slovenčina"

        • Deleted property sl (string)

          Used for users whose language is "Slovenščina"

        • Deleted property es (string)

          Used for users whose language is "Español"

        • Deleted property sv (string)

          Used for users whose language is "Svenska"

        • Deleted property uk (string)

          Used for users whose language is "Українська"

        • Deleted property cy (string)

          Used for users whose language is "Cymraeg"

      • Changed property aboutText (object)

        This scheme is a collection of account about text for users in different languages.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

        • Deleted property ro (string)

          Used for users whose language is "Română"

        • Deleted property sq (string)

          Used for users whose language is "Shqip"

        • Deleted property be (string)

          Used for users whose language is "Беларуская"

        • Deleted property bg (string)

          Used for users whose language is "Български"

        • Deleted property hr (string)

          Used for users whose language is "Hrvatski"

        • Deleted property cs (string)

          Used for users whose language is "Čeština"

        • Deleted property da (string)

          Used for users whose language is "Dansk"

        • Deleted property et (string)

          Used for users whose language is "Eesti"

        • Deleted property fi (string)

          Used for users whose language is "Suomi"

        • Deleted property el (string)

          Used for users whose language is "Ελληνικά"

        • Deleted property hu (string)

          Used for users whose language is "Magyar"

        • Deleted property is (string)

          Used for users whose language is "Íslenska"

        • Deleted property ga (string)

          Used for users whose language is "Gaeilge"

        • Deleted property lv (string)

          Used for users whose language is "Latviešu"

        • Deleted property lt (string)

          Used for users whose language is "Lietuvių"

        • Deleted property mk (string)

          Used for users whose language is "Македонски"

        • Deleted property mt (string)

          Used for users whose language is "Malti"

        • Deleted property no (string)

          Used for users whose language is "Norsk"

        • Deleted property pt (string)

          Used for users whose language is "Português"

        • Deleted property ru (string)

          Used for users whose language is "Русский"

        • Deleted property sr (string)

          Used for users whose language is "Српски"

        • Deleted property sk (string)

          Used for users whose language is "Slovenčina"

        • Deleted property sl (string)

          Used for users whose language is "Slovenščina"

        • Deleted property es (string)

          Used for users whose language is "Español"

        • Deleted property sv (string)

          Used for users whose language is "Svenska"

        • Deleted property uk (string)

          Used for users whose language is "Українська"

        • Deleted property cy (string)

          Used for users whose language is "Cymraeg"

      • Changed property completedBoxText (object)

        This scheme is a collection of account completed box text for users in different languages.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

        • Deleted property ro (string)

          Used for users whose language is "Română"

        • Deleted property sq (string)

          Used for users whose language is "Shqip"

        • Deleted property be (string)

          Used for users whose language is "Беларуская"

        • Deleted property bg (string)

          Used for users whose language is "Български"

        • Deleted property hr (string)

          Used for users whose language is "Hrvatski"

        • Deleted property cs (string)

          Used for users whose language is "Čeština"

        • Deleted property da (string)

          Used for users whose language is "Dansk"

        • Deleted property et (string)

          Used for users whose language is "Eesti"

        • Deleted property fi (string)

          Used for users whose language is "Suomi"

        • Deleted property el (string)

          Used for users whose language is "Ελληνικά"

        • Deleted property hu (string)

          Used for users whose language is "Magyar"

        • Deleted property is (string)

          Used for users whose language is "Íslenska"

        • Deleted property ga (string)

          Used for users whose language is "Gaeilge"

        • Deleted property lv (string)

          Used for users whose language is "Latviešu"

        • Deleted property lt (string)

          Used for users whose language is "Lietuvių"

        • Deleted property mk (string)

          Used for users whose language is "Македонски"

        • Deleted property mt (string)

          Used for users whose language is "Malti"

        • Deleted property no (string)

          Used for users whose language is "Norsk"

        • Deleted property pt (string)

          Used for users whose language is "Português"

        • Deleted property ru (string)

          Used for users whose language is "Русский"

        • Deleted property sr (string)

          Used for users whose language is "Српски"

        • Deleted property sk (string)

          Used for users whose language is "Slovenčina"

        • Deleted property sl (string)

          Used for users whose language is "Slovenščina"

        • Deleted property es (string)

          Used for users whose language is "Español"

        • Deleted property sv (string)

          Used for users whose language is "Svenska"

        • Deleted property uk (string)

          Used for users whose language is "Українська"

        • Deleted property cy (string)

          Used for users whose language is "Cymraeg"

      • Changed property completedText (object)

        This scheme is a collection of account completed text for users in different languages.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration. Used for users whose language is "other language"

        • Deleted property ro (string)

          Used for users whose language is "Română"

        • Deleted property sq (string)

          Used for users whose language is "Shqip"

        • Deleted property be (string)

          Used for users whose language is "Беларуская"

        • Deleted property bg (string)

          Used for users whose language is "Български"

        • Deleted property hr (string)

          Used for users whose language is "Hrvatski"

        • Deleted property cs (string)

          Used for users whose language is "Čeština"

        • Deleted property da (string)

          Used for users whose language is "Dansk"

        • Deleted property et (string)

          Used for users whose language is "Eesti"

        • Deleted property fi (string)

          Used for users whose language is "Suomi"

        • Deleted property el (string)

          Used for users whose language is "Ελληνικά"

        • Deleted property hu (string)

          Used for users whose language is "Magyar"

        • Deleted property is (string)

          Used for users whose language is "Íslenska"

        • Deleted property ga (string)

          Used for users whose language is "Gaeilge"

        • Deleted property lv (string)

          Used for users whose language is "Latviešu"

        • Deleted property lt (string)

          Used for users whose language is "Lietuvių"

        • Deleted property mk (string)

          Used for users whose language is "Македонски"

        • Deleted property mt (string)

          Used for users whose language is "Malti"

        • Deleted property no (string)

          Used for users whose language is "Norsk"

        • Deleted property pt (string)

          Used for users whose language is "Português"

        • Deleted property ru (string)

          Used for users whose language is "Русский"

        • Deleted property sr (string)

          Used for users whose language is "Српски"

        • Deleted property sk (string)

          Used for users whose language is "Slovenčina"

        • Deleted property sl (string)

          Used for users whose language is "Slovenščina"

        • Deleted property es (string)

          Used for users whose language is "Español"

        • Deleted property sv (string)

          Used for users whose language is "Svenska"

        • Deleted property uk (string)

          Used for users whose language is "Українська"

        • Deleted property cy (string)

          Used for users whose language is "Cymraeg"

    • Changed property company (object)

      Base properties of company entity

      • Changed property languages (array)

        Company languages (at least one language required). Any code from the language enumeration is accepted; only the main set is shown as an example.

    • Changed property candidateDocumentTypes (array)

      Candidate document types relation

      Changed items (object): > Candidate Document Type properties

      • Added property metadata (object)

        Candidate Document Type metadata (external properties)

GET /candidateDocumentTypes
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Candidate Document Type properties

    • Added property metadata (object)

      Candidate Document Type metadata (external properties)

    • Changed property documentType (object)

      • Changed property nameI18n (object)

        Translations keyed by language code.

        • Added property {other language} (string)

          Placeholder for any other language code from the supported language enumeration.

        • Deleted property ro (string)

        • Deleted property sq (string)

        • Deleted property be (string)

        • Deleted property bg (string)

        • Deleted property hr (string)

        • Deleted property cs (string)

        • Deleted property da (string)

        • Deleted property et (string)

        • Deleted property fi (string)

        • Deleted property el (string)

        • Deleted property hu (string)

        • Deleted property is (string)

        • Deleted property ga (string)

        • Deleted property lv (string)

        • Deleted property lt (string)

        • Deleted property mk (string)

        • Deleted property mt (string)

        • Deleted property no (string)

        • Deleted property pt (string)

        • Deleted property ru (string)

        • Deleted property sr (string)

        • Deleted property sk (string)

        • Deleted property sl (string)

        • Deleted property es (string)

        • Deleted property sv (string)

        • Deleted property uk (string)

        • Deleted property cy (string)

POST /candidateDocumentTypes
Request:

Changed content type : application/json

  • Added property metadata (object)

    Candidate Document Type metadata (external properties)

Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Added property metadata (object)

      Candidate Document Type metadata (external properties)

PUT /candidateDocumentTypes
Request:

Changed content type : application/json

  • Changed property create (array)

    Changed items (object): > Create Candidate Document Type body params

    • Added property metadata (object)

      Candidate Document Type metadata (external properties)

Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property created (array)

      Candidate document type

      Changed items (object): > Candidate Document Type properties

      • Added property metadata (object)

        Candidate Document Type metadata (external properties)

PATCH /candidateDocumentTypes
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Candidate Document Type properties

    • Added property metadata (object)

      Candidate Document Type metadata (external properties)

POST /documentTypes
Request:

Changed content type : application/json

  • Changed property nameI18n (object)

    Translations keyed by language code.

    • Added property {other language} (string)

      Placeholder for any other language code from the supported language enumeration.

    • Deleted property ro (string)

    • Deleted property sq (string)

    • Deleted property be (string)

    • Deleted property bg (string)

    • Deleted property hr (string)

    • Deleted property cs (string)

    • Deleted property da (string)

    • Deleted property et (string)

    • Deleted property fi (string)

    • Deleted property el (string)

    • Deleted property hu (string)

    • Deleted property is (string)

    • Deleted property ga (string)

    • Deleted property lv (string)

    • Deleted property lt (string)

    • Deleted property mk (string)

    • Deleted property mt (string)

    • Deleted property no (string)

    • Deleted property pt (string)

    • Deleted property ru (string)

    • Deleted property sr (string)

    • Deleted property sk (string)

    • Deleted property sl (string)

    • Deleted property es (string)

    • Deleted property sv (string)

    • Deleted property uk (string)

    • Deleted property cy (string)

Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property nameI18n (object)

      Translations keyed by language code.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration.

      • Deleted property ro (string)

      • Deleted property sq (string)

      • Deleted property be (string)

      • Deleted property bg (string)

      • Deleted property hr (string)

      • Deleted property cs (string)

      • Deleted property da (string)

      • Deleted property et (string)

      • Deleted property fi (string)

      • Deleted property el (string)

      • Deleted property hu (string)

      • Deleted property is (string)

      • Deleted property ga (string)

      • Deleted property lv (string)

      • Deleted property lt (string)

      • Deleted property mk (string)

      • Deleted property mt (string)

      • Deleted property no (string)

      • Deleted property pt (string)

      • Deleted property ru (string)

      • Deleted property sr (string)

      • Deleted property sk (string)

      • Deleted property sl (string)

      • Deleted property es (string)

      • Deleted property sv (string)

      • Deleted property uk (string)

      • Deleted property cy (string)

GET /documentTypes
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object):

    • Changed property nameI18n (object)

      Translations keyed by language code.

      • Added property {other language} (string)

        Placeholder for any other language code from the supported language enumeration.

      • Deleted property ro (string)

      • Deleted property sq (string)

      • Deleted property be (string)

      • Deleted property bg (string)

      • Deleted property hr (string)

      • Deleted property cs (string)

      • Deleted property da (string)

      • Deleted property et (string)

      • Deleted property fi (string)

      • Deleted property el (string)

      • Deleted property hu (string)

      • Deleted property is (string)

      • Deleted property ga (string)

      • Deleted property lv (string)

      • Deleted property lt (string)

      • Deleted property mk (string)

      • Deleted property mt (string)

      • Deleted property no (string)

      • Deleted property pt (string)

      • Deleted property ru (string)

      • Deleted property sr (string)

      • Deleted property sk (string)

      • Deleted property sl (string)

      • Deleted property es (string)

      • Deleted property sv (string)

      • Deleted property uk (string)

      • Deleted property cy (string)

    • Changed property candidateDocumentTypes (array)

      Related Candidate Document Types

      Changed items (object): > Candidate Document Type properties

      • Added property metadata (object)

        Candidate Document Type metadata (external properties)

GET /signature-requests
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Signature request included relations

    • Changed property company (object)

      Base properties of company entity

      • Changed property languages (array)

        Company languages (at least one language required). Any code from the language enumeration is accepted; only the main set is shown as an example.

    • Changed property candidateDocumentType (object)

      Candidate Document Type properties

      • Added property metadata (object)

        Candidate Document Type metadata (external properties)

GET /signature-requests/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property company (object)

      Base properties of company entity

      • Changed property languages (array)

        Company languages (at least one language required). Any code from the language enumeration is accepted; only the main set is shown as an example.

    • Changed property candidateDocumentType (object)

      Candidate Document Type properties

      • Added property metadata (object)

        Candidate Document Type metadata (external properties)