alipay.intl.user.query.getUserInfo

2021-11-08 07:10

API Overview

name: alipay.intl.user.query.getUserInfo
version: 2.0.0
endpoint: https://open.alipay.hk/api/alipay/intl/user/query/getUserInfo.htm
description: This API is used by the merchant to query the user information includes user name, mobile, address, etc of a specific user associated with the access token. the information would be filtered according to the contract of merchant.

Function Logic

Request Parameter

Header

No	Name	Description	Type	Length	Required	Remarks	Condition	Sample
1	version	API version	string	8	ME	As per the respective API reference		2.0.0
2	function	API interface	string	128	ME	According to specifications defined by each business domain		alipay.intl.function
3	clientId	Client ID	string	32	ME	Provided by Alipay, used to identify partner and application system		211020000000000000044
4	reqTime	Request time	datetime	/	M	DateTime with timezone, which follows the ISO-8601 standard. Refer to: RFC 3339 Section 5.6		2001-07-04T12:08:56+05:30
5	reqMsgId	Request message ID	string	64	ME	Each request will be assigned with a unique id (uuid). The reqMsgId identify an unique system request, it is not used to identity an unique business request.		1234567asdfasdf1123fda
6	accessToken	Access token	string	64	M			fadadfad679dfasdf1123fda
7	reserve	Reserved for future implementation	string	256	O	Key/Value		{}

Body

No	Name	Description	Type	Length	Required	Remarks	Condition	Sample
1	merchantId	Merchant Id.	string	64	M			2160400000000177

Response Parameter

Header

No	Name	Description	Type	Length	Required	Remarks	Condition	Sample
1	version	API version	string	8	ME	As per the respective API reference		2.0.0
2	function	API interface	string	128	ME	According to specifications defined by each business domain		alipay.intl.function
3	clientId	Client ID	string	32	ME	Provided by Alipay, used to identify partner and application system		211020000000000000044
4	respTime	Response time	datetime	/	M	DateTime with timezone, which follows the ISO-8601 standard. Refer to: RFC 3339 Section 5.6		2001-07-04T12:08:56+05:30
5	reqMsgId	Request message ID	string	64	ME	Each request will be assigned with a unique id (uuid).		1234567asdfasdf1123fda
6	accessToken	Access token	string	64	M			fadadfad679dfasdf1123fda
7	reserve	Reserved for future implementation	string	256	O	Key/Value		{}

Body

No	Name	Description	Type	Length	Required	Remarks	Condition	Sample
1	resultInfo	Result Info.	[ResultInfo](data_structure/00. Global Common Structure.htm#ResultInfo)	/	M			{ "resultStatus": "S", "resultCodeId": "00000000", "resultCode":"SUCCESS", "resultMsg": "" }
2	userName	User name.	[UserNameInfo](data_structure/04. User Domain Structure.htm#UserNameInfo)	/	C		y: (resultInfo.resultCode = SUCCESS)	{ "firstName":"James", "lastName":"Green" }
3	userStatus	User status.	enum<[UserStatusEnum](data_structure/04. User Domain Structure.htm#UserStatusEnum)>	/	O			ENABLE
4	gender	User's gender.	enum<[GenderEnum](data_structure/04. User Domain Structure.htm#GenderEnum)>	/	O			MALE
5	birthday	User's birthday, represented as an YYYY-MM-DD format.	string	10	O			1980-01-01
6	certified	User's KYC status.	boolean	/	O			true
7	certifyLevel	User's KYC level. 1 for lowest and 10 for highest.	number(2,0)	2	C		y:(certified=true)	2
8	mobileNo	User's mobile phone number.	[MobileNoInfo](data_structure/04. User Domain Structure.htm#MobileNoInfo)	/	O			{ "phoneNo":"13800210000", "countryCode":"86" }
9	address	User's address.	[AddressInfo](data_structure/04. User Domain Structure.htm#AddressInfo)	/	O			{ "country": "China", "state": "Zhejiang", "city": "Hangzhou", "address1": "1 Westbrook Resort, Zijingang Road", "address2": "Xihu District","zipCode": "310000" }

Request Sample

copy
{
  "request":{
    "head":{
      "version":"2.0.0",
      "function":"alipay.intl.user.query.getUserInfo",
      "clientId":"211020000000000000044",
      "reqTime":"2001-07-04T12:08:56+05:30",
      "reqMsgId":"1234567asdfasdf1123fda",
      "accessToken":"fadadfad679dfasdf1123fda",
      "reserve":"{}"
    },
    "body":{
      "merchantId":"2160400000000177"
    }
  },
  "signature":"signature string"
}

Response Sample

copy
{
  "response":{
    "head":{
      "version":"2.0.0",
      "function":"alipay.intl.user.query.getUserInfo",
      "clientId":"211020000000000000044",
      "respTime":"2001-07-04T12:08:56+05:30",
      "reqMsgId":"1234567asdfasdf1123fda",
      "accessToken":"fadadfad679dfasdf1123fda",
      "reserve":"{}"
    },
    "body":{
      "resultInfo":{
        "resultStatus":"S",
        "resultCodeId":"00000000",
        "resultCode":"SUCCESS",
        "resultMsg":"success"
      },
      "userName":{
        "firstName":"James",
        "lastName":"Green",
        "middleName":"Jerry"
      },
      "userStatus":"ENABLE",
      "gender":"MALE",
      "birthday":"1980-01-01",
      "certified":true,
      "certifyLevel":"2",
      "mobileNo":{
        "phoneNo":"13800210000",
        "countryCode":"86"
      },
      "address":{
        "country":"China",
        "state":"Zhejiang",
        "city":"Hangzhou",
        "address1":"1 Westbrook Resort, Zijingang Road",
        "address2":"Xihu District",
        "zipCode":"3100000"
      }
    }
  },
  "signature":"signature string"
}

Result Info

No	ResultCodeId	ResultCode	ResultStatus	Remarks
1	12014173	ACCESS_TOKEN_NOT_EXIST	F	Access token does not exist.
2	12002005	USER_NOT_EXIST	F	User does not exist.
3	12002006	USER_STATUS_ABNORMAL	F	User status is not normal.

Basic Result Code: The following global result codes might be returned for all APIs.

No	ResultCodeId	ResultCode	ResultStatus	Remarks
1	00000000	SUCCESS	S	Success
2	00000019	PROCESS_FAIL	F	General business failure. No retry.
3	00000901	UNKNOWN_EXCEPTION	U	API failed due to unknown reason.
4	00000004	PARAM_ILLEGAL	F	Illegal parameters. For example, non-numeric input, invalid date.
5	00000007	INVALID_SIGNATURE	F	Signature is invalid.
6	00000008	KEY_NO_FOUND	F	Key is not found.
7	00000013	NO_INTERFACE_DEF	F	API is not defined
8	00000014	API_IS_INVALID	F	API is invalid (or not active)
9	00000016	OAUTH_FAILED	F	oAuth authentication failed
10	00000021	ACCESS_DENIED	F	Access denied
11	12014152	CLIENT_FORBIDDEN_ACCESS_API	F	Client is not authorized to use this API
12	12014155	UNKNOWN_CLIENT	F	Unknown client
13	12014156	INVALID_CLIENT_STATUS	F	Invalid client status
14	00000024	REQUEST_TRAFFIC_EXCEED_LIMIT	F	The request traffic exceeds the limit.