# Verify user authorization credentials
Interface should be called on the server side, not in the front end (Weixin Mini Program, web pages, APP, etc.) directly called, specific reference interface call guide
Interface name: snsAuth
Verify that the authorization certificate (access_token) is valid
# 1. How to call
# HTTPS calls
GET https://api.weixin.qq.com/sns/auth?access_token=ACCESS_TOKEN&openid=OPENID
# Cloud Calls
- This interface does not support cloud calls
# Third party invocation
- Third Party Platform calls are not supported by this interface.
# 2. Request parameters
# Query parametersQuery String parameters
Parameter Name | type | Required to fill in | Example | Introductions |
---|---|---|---|---|
access_token | string | yes | ACCESS_TOKEN | Interface invoke credentials, using access_token |
openid | string | yes | OPENID | The unique identifier of the user |
# Request BodyRequest Payload
nothing
# 3. Return Parameters
# Response Payload
Parameter Name | type | Introductions |
---|---|---|
errcode | number | Error code |
errmsg | string | Error Description |
# 4. Note
There are no special considerations for this interface
# 5. Code examples
# 5.1 Proof of validity
Example Requests
https://api.weixin.qq.com/sns/auth?access_token=ACCESS_TOKEN&openid=OPENID
Return an example
{
"errcode":0,
"errmsg":"ok"
}
# 5.2 An invalid certificate
Example Requests
https://api.weixin.qq.com/sns/auth?access_token=ACCESS_TOKEN&openid=OPENID
Return an example
{
"errcode":40003,
"errmsg":"invalid openid"
}
# 6. Error code
The following is a list of error codes for this interface, other error codes can refer to General error codes
Error code | Error Description | Solutions |
---|---|---|
40003 | invalid openid | Invalid OpenID. Please confirm if the OpenID is following Official Account, or if it is another OpenID from the Official Account message template. |
# 7. Scope of application
How this interface can be invoked under different account types:
Service Account | Mobile App | Website App |
---|---|---|
Certification only | ✔ | ✔ |
- Authentication only: means that only authenticated accounts are allowed to be invoked by the enterprise entity, and accounts that are not authenticated or do not support authentication cannot be invoked.
- ✔: The account can call this interface
- Other account types that are not expressly stated may not be called on this interface without special instructions;