Skip to content
Agreement Signing

Get Pending Agreement Updates

Checks whether the signed-in Client has user agreement updates to confirm again, and returns the copy for the update prompt and the agreement links. The Broker App calls it after the Client signs in. When hit is true, show the windows.main dialog and render text in text_main that matches highlights[].name as links to highlights[].url. When hit is false, no dialog is needed.

  • If the Client agrees, call Record Accepted Agreement Versions with the key and version of every agreement in highlights.
  • If the Client declines, show the windows.cancel confirmation dialog. Sign the Client out if they confirm; show windows.main again if they go back.

When you call this operation through WhaleCore requestService(), you do not need to set requiresTradeToken to true.

GEThttps://api.lbkrs.com/v1/member/get_agreement_alert

Parameters

typestringqueryRequired

Agreement scope. Always pass member (user-level agreements)

member

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Pending Agreement Updates” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
hitboolean

Whether there are agreement updates for the Client to confirm. Show the dialog when it is true

highlightsarray<object>

Agreements to confirm

Child attributes
keystring

Agreement key. Submit it as a key of agreements when the Client agrees

versionstring

Agreement version. Submit it as the value in agreements when the Client agrees

namestring

Agreement name. It matches the text in the dialog body to render as a link

urlstring

Link to the agreement details

windowsobject

Dialog copy

Child attributes
mainobject

Copy for an agreement update dialog

Child attributes
titlestring

Dialog title

text_mainstring

Dialog body

text_explainstring

Supplementary note. Hide it when empty

btn_agreestring

Label of the confirming button

btn_cancelstring

Label of the cancelling button

cancelobject

Copy for an agreement update dialog

Child attributes
titlestring

Dialog title

text_mainstring

Dialog body

text_explainstring

Supplementary note. Hide it when empty

btn_agreestring

Label of the confirming button

btn_cancelstring

Label of the cancelling button

Whale Docs