Agreement Signing

During agreement signing API invocation, sign agreements based on the agreement IDs in the agreement configuration. If the user has already signed the same agreement of the same version, it will not be signed again.

Request Description

Request Headers

Parameter Name	Name	Required	Type	Description
X-operating-sys-version	Caller client operating system version	Yes	String	windows10.1.1
X-device-fingerprint	Caller client device fingerprint	Yes	String	156aysdna213sc50
X-device-ip	Caller client IP	No	String	192.168.1.2
X-agent	User-Agent information	Yes	String	Mozilla/5.0 (iPhone; CPU iPhone OS 13_3 like Mac OS X)
X-L	Used for internationalization language setting	No	String	zh
X-client-id	Application authorization ID	Yes	String	nTo1eRIub60vPb54WeE6aojPwYwImtl4
Authorization	Authorization information	Yes	String	Bearer {id_token}
content-type	Content format type	Yes	String	application/json

Request Example

{
    "agreementIds": [
      "D8924F7071DC1D29A6822C794D848D9C",
      "DDS24F7071DC1D29A6822C794D848A1C"
    ],
    "scene":"LOGIN"
}

Request Parameters

Parameter Name	Name	Required	Type	Description
agreementIds	User agreement ID collection	Yes	List
scene	Signing scenario	Yes	String	Supports LOGIN, REGISTER

Response Example

Success Example

HTTP/1.1 200 OK

Error Example

HTTP/1.1 400 Bad Request

{
    "code": "ECS.AGREEMENT.0001",
    "data": null,
    "message": "User agreement does not exist"
}

Error Codes

Status Code	Error Code	Error Message	Remediation
400	ECS.AGREEMENT.0001	Agreement Id not exist	Please check whether the entered device information is complete
400	SDK.COMMON.1003	Device information is incomplete	Please check whether the entered device information is complete
400	IDAAS.SDK.PARAM.0016	IdToken is invalid or expired	Please re-acquire IdToken and try again
400	IDAAS.SDK.COMMON.1001	Parameter {0} cannot be left blank	Parameter {0} cannot be blank