Skip to main content

Addendum Notices

This API fetches all Addendum and Notices created by the member based on allowed exchange segments and login type. These notices are typically legal disclaimers or important messages shown to the user on login.

🛣️Path Parameters

ParameterTypeRequiredDescriptionExample/ENUM
market_allowedstringYesExchange segments for which the addendum is required268437595
login_typestringYesType of login for which the addendum appliesPASSWORD

🔑Header Parameters

HeaderTypeRequiredDescriptionExample/ENUM
AuthorizationstringYesBearer token for user authentication and access.Bearer

🟢Success Response - 200 Ok

FieldTypeDescriptionExample/ENUM
statusstringIndicates the status of the API call. Default: "success""success"
codestringAPI response code."s-101"
messagestringHuman-readable success message."Addendum and notices data fetch successfully",
dataarrayList of addendum and notice objects.[See details below]

📘Addendum Object

FieldTypeDescriptionExample/ENUM
notice_idstringUnique identifier for the addendum or notice."20"
notice_titlestringTitle of the notice to be displayed to the user."New Circular"
notice_descstringFull body text/content of the addendum.""This is to text the new circular regarding the Risk disclosure",..."
action_on_rejectstringAction to be taken if the user rejects the addendum."1"[1 = Log off, 0 = No action]
show_checkboxstringWhether to show a checkbox for acknowledgment."1"[1 = Yes, 2 = No]
checkbox_labelstringText label for the checkbox, if shown."I have read and agree to the terms"
log_off_messagestringMessage to display if the user is logged off due to rejection."You must accept the terms to continue."
frequencystringFrequency at which the notice is to be shown to the user."0"
segment_allowedstringMarket segment to which this notice is applicable."4102"
get/nontransactional/v1/addendumAndNotices