Employee Identity (EIAM)

Bind or Register User with Phone Number or Email

Call this interface when binding a platform user with a phone number or email, or registering a user with a phone number or email. Before calling this interface, you need to obtain a temporary token through the WeChat Mini Program Login Interface.


# Request Specification

POST https://{your_domain}/api/v2/sdk/social/register-bind

# Request Headers

Parameter Name Chinese Name Required Type Example
X-operating-sys-version Calling Client Operating System Version Yes String windows10.1.1
X-device-fingerprint Calling Client Device Fingerprint Yes String 156aysdna213sc50
X-device-ip Calling 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
X-state-token Temporary Token Yes String eyJhbcOiJ……nEPRiIC4we0
content-type Content Format Type Yes String application/json

# Request Example

1、Using mobile number + SMS verification code

{
    "mobile":"11012345678",
    "verify_code":"232326"
}
1
2
3
4

# Request Parameters

Parameter Name Chinese Name Required Type Description
mobile Mobile Number Yes String The mobile number receiving the verification code
verify_code SMS Verification Code Yes String The received verification code
To obtain the verification code, please refer to the Send SMS Verification Code API
type = REGISTER_SMS

2、Using email + email verification code

{
    "email":"zhangsan@qq.com",
    "verify_code":"123456"
}
1
2
3
4

# Request Parameters

Parameter Name Chinese Name Required Type Description
email Email Yes String The email address receiving the verification code
verify_code Email Verification Code Yes String The received verification code
To obtain the verification code, please refer to the Send Email Verification Code API
type = REGISTER_EMS

# Response Example

Success Example:
HTTP/1.1 200 OK
Content-Type: application/json
{
    "session_token": "btsiBjx85prcZu6I6Ki057Tmw3nSF2VO",
    "expire": 432000,
    "status": "SUCCESS",
    "id_token": "eyJraWQn0.eyJpc3MiOiJodHR…g1A7jG8O0uw"
}

Error Example:
HTTP/1.1 400 Bad Request
{
    "error_code": "IDAAS.SDK.COMMON.1007",
    "error_msg": "state_token parameter error"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# Response Parameters

Parameter Name Chinese Name Type Description
status Login Flow Status Identifier String SUCCESS: Login successful SOCIAL_BIND: Binding flow USER_REGISTER: Auto-registration binding flow ACCESS_DENIED: Access denied MFA_AUTH: Secondary authentication
expire session_token Validity Period Number Session_token validity period
session_token User session_token String User session_token
id_token Identity token for the logged-in user, short-term valid String This field is in JWT format and contains user identity information. Refer to "Get User Information Based on id_token" to obtain user information. The token validity period is 5 minutes by default.