Agreement Configuration

During agreement configuration API invocation, different results are returned based on the configuration. A normal successful call returns agreement configuration information; if no agreement is configured, an empty array is returned.

Request Description

Request Headers

Parameter Name	Name	Required	Type	Description
X-operating-sys-version	Caller client operating system version	No	String	windows10.1.1
X-device-fingerprint	Caller client device fingerprint	No	String	156aysdna213sc50
X-device-ip	Caller client IP	No	String	192.168.1.2
X-agent	User-Agent information	No	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	No	String	nTo1eRIub60vPb54WeE6aojPwYwImtl4
content-type	Content format type	Yes	String	application/json

Response Example

Success Example

HTTP/1.1 200 OK

{
    "code": "0",
    "data": [
        {
            "id": "20231213172230071-656B-DC5398451",
            "text": {
                "en": {
                    "context": "I have read and agree to the {20231214153403735-0EB3-72CE8BDC0} and {20231214153403729-2452-986A407AA}",
                    "agreements": [
                        {
                            "id": "20231214153403735-0EB3-72CE8BDC0",
                            "name": "23",
                            "type": "URL",
                            "context": "https://XXX"
                        },
                        {
                            "id": "20231214153403729-2452-986A407AA",
                            "name": "12",
                            "type": "URL",
                            "context": "https://XXX"
                        }
                    ]
                },
                "zh": {
                    "context": "I have read and agree to the {20231214153403717-76A1-31234B44F} and {20231214153403713-DA60-2201131A6}",
                    "agreements": [
                        {
                            "id": "20231214153403717-76A1-31234B44F",
                            "name": "2",
                            "type": "URL",
                            "context": "https://XXX"
                        },
                        {
                            "id": "20231214153403713-DA60-2201131A6",
                            "name": "1",
                            "type": "URL",
                            "context": "https://XXX"
                        }
                    ]
                }
            }
        }
    ],
    "message": null
}

Error Example

None

Response Parameters

data is the agreement configuration list. List field descriptions:

Parameter Name	Name	Type
id	Agreement configuration ID	String
text	Agreement body in the configuration	Object
text.context	Content in the agreement body	String
text.agreements	Agreements in the agreement body	Object
text.agreements.id	Agreement ID	String
text.agreements.name	Agreement name	String
text.agreements.type	Agreement type	String
text.agreements.context	Content corresponding to the agreement type	String

Error Codes

Status Code	Error Code	Error Message	Remediation
400	IDAAS.SDK.PARAM.0001	Device information is incomplete	Please check whether the entered device information is complete