Employee Identity (EIAM)
Agreement Signing
During the invocation of the agreement signing interface, sign the agreement based on the agreement ID in the agreement configuration. If the user has already signed the same version of the same agreement, it will not be signed again.
# Request Description
POST https://{your_domain}/api/v2/sdk/agreement/sign
# Request Headers
| Parameter Name | Chinese Name | Required | Type | Example |
|---|---|---|---|---|
| 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 | 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
{
"agreements": [
"D8924F7071DC1D29A6822C794D848D9C",
"DDS24F7071DC1D29A6822C794D848A1C"
],
"scene":"LOGIN"
}
1
2
3
4
5
6
7
2
3
4
5
6
7
# Request Parameters
| Parameter Name | Chinese 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
Content-Type: application/json
Error Example:
HTTP/1.1 400 Bad Request
{
"code": "ECS.AGREEMENT.0001",
"data": null,
"message": "User agreement does not exist"
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# Error Codes
| Status Code | Error Code | Error Message | Handling Measure |
|---|---|---|---|
| 400 | ECS.AGREEMENT.0001 | Agreement Id not exist | Please check if the input device information is complete |
| Agreement ID does not exist | |||
| 400 | SDK.COMMON.1003 | Device information is incomplete | Please check if the input device information is complete |
| Device information is incomplete | |||
| 400 | IDAAS.SDK.PARAM.0016 | IdToken is invalid or expired | Please try again after obtaining a new IdToken |
| IdToken is invalid or has expired | |||
| 400 | IDAAS.SDK.COMMON.1001 | Parameter {0} cannot be left blank | |
| Parameter {0} cannot be empty |
I'm ready. Please paste the Markdown content you need translated.