Skip to content
Longport WhaleLongport Whale
Account Profile & Status

Whale Record Agreement

Synchronizes and records a user's signing status for a given category of agreements.

Request parameters

  • Required: type (agreement category), agreements_info (signing details), member_id (user ID), platform (signing channel).
  • agreements_info is a list where each item carries the agreement name, version, and whether it has been signed.
  • See the field descriptions for each field's format, value range, and business meaning.

Business notes

Writes the user's signing results from the given platform back into the account system to record compliance signing status. Each agreement is identified by name and version. Use remark for optional notes.

Result

On success, the signing status is synchronized. Refer to the 200 response definition for the resulting state.

POSThttps://b-api.lbkrs.com/v1/whaleapi/account/record_agreement

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

kyc.agreement_document_risk

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

typestringrequired

type

agreements_infoarray<object>required

agreements_info

Child attributes
keystringrequired

key

versionstringrequired

version

signedstringrequired

signed

Values
Y
Signed
N
Not signed
member_idintegerrequired

member ID. member ID

member_id is the customer ID. It differs from the securities account number account_no and the internal securities account ID aaid; one customer can have multiple securities accounts.

platformstringrequired

platform. Only api is supported.

Values
api
remarkstring

remark

Responses

HTTP 200Successful response
HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs