Skip to main content

Get markup room data

This endpoint is used to fetch the Markup Room data by markup room configuration id. The data is used by the frontend to load the config, participants and documents.

Responses
200

Successful response. Markup room configuration data successfully fetched

Schema OPTIONAL
url string OPTIONAL
config object OPTIONAL

UI configuration with all the defaults applied

idv object OPTIONAL

Determines if kba and credential analysis checkboxes for enabling/disabling kba and credential analysis in the add/edit participants modal is shown. If both properties are false, then KBA and credential analysis is set to not be required

kba boolean OPTIONAL

Shows KBA checkbox in add/edit participant modal

credentialAnalysis boolean OPTIONAL

Shows Credential analysis checkbox in add/edit participant modal

authentication object OPTIONAL

Determines the options shown in the "Authentication Type" dropdown in the add/edit participant form. If both two-factor and personal-password are disabled, the participant's authentication-type is defaulted to none

personalPassword boolean OPTIONAL

shows "Personal Password" option in the "authentication type" dropdown

twoFactor boolean OPTIONAL

shows "Two factor" as an option in the "authentication type" dropdown

documents object OPTIONAL
rename boolean OPTIONAL

if true, then the document title can be changed. If false, then it is disabled.

edit boolean OPTIONAL

if true, then tags can be dropped onto the document. If false, then all tools are disabled.

advancedEdit boolean OPTIONAL

if true, then advanced editing (delete page, reordering and context menu in the thumbnail view) is enabled. If false, then buttons under thumbnails and the thumbnail context menu is not shown.

participants object OPTIONAL
add boolean OPTIONAL

If true, then the ability to add participants to the list of participants is enabled. The "Add Participant" button is shown in the UI.

edit boolean OPTIONAL

If true, then the ability to edit participants in the list of participants is enabled. The "Edit" button will be shown in the dropdown for each participant.

remove boolean OPTIONAL

If true, then the ability to remove participants from the list of participants is enabled. The "Remove" button will be shown in the dropdown for each participant. Otherwise it is not shown

400

Bad request - Payload validation

Schema OPTIONAL
object

Error response for bad request caused by invalid request data

401

Unauthorized request

Schema OPTIONAL
object

Error response for unauthorized caused by the api permissions not being enabled for the organization, or invalid senderId where the senderId does not reference an existing user or the user does not belong to the organization the access token was issue for.

404

Not found

Schema OPTIONAL
object

Error response for record not being found.