1. 开发集成
  2. /
  3. 标准 Web 应用
  4. /
  5. C#
  6. /

  7. 管理模块

  8. /

  9. 用户管理

  10. /
  11. 获取用户实名认证信息

获取用户实名认证信息

更新时间: 2024-10-10 07:28:40
编辑

通过用户 ID，获取用户实名认证信息，可以选择指定用户 ID 类型。

请求参数

名称类型必填默认值描述示例值
userIdstring是-用户 ID。6229ffaxxxxxxxxcade3e3d9
userIdTypestring否user_id用户 ID 类型，可以指定为用户 ID、手机号、邮箱、用户名和 externalId。。 枚举值：user_id,external_id,phone,email,usernameuser_id

示例代码


using Authing.CSharp.SDK.Models;
using Authing.CSharp.SDK.Services;
using Authing.CSharp.SDK.Utils;
using Authing.CSharp.SDK.UtilsImpl;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;

namespace Example
{
    class Program
    {
      private static ManagementClientOptions options;
      private static string ACCESS_Key_ID = "AUTHING_USERPOOL_ID";
      private static string ACCESS_KEY_SECRET = "AUTHING_USERPOOL_SECRET";

      static void Main(string[] args)
      {
          MainAsync().GetAwaiter().GetResult();
      }

      private static async Task MainAsync()
      {
          options = new ManagementClientOptions()
          {
              AccessKeyId = ACCESS_Key_ID,
              AccessKeySecret = ACCESS_KEY_SECRET,
          };

          ManagementClient managementClient = new ManagementClient(options);
        
          PrincipalAuthenticationInfoPaginatedRespDto  result = await managementClient.GetUserPrincipalAuthenticationInfo
          (             
                userId: "6229ffaxxxxxxxxcade3e3d9", 
                userIdType: "user_id"
          );
        }
    }
}

请求响应

类型： PrincipalAuthenticationInfoPaginatedRespDto

名称类型描述
statusCodenumber业务状态码，可以通过此状态码判断操作是否成功，200 表示成功。
messagestring描述信息
apiCodenumber细分错误码，可通过此错误码得到具体的错误类型。
dataPrincipalAuthenticationInfoPagingDto响应数据

示例结果：

{
  "statusCode": 200,
  "message": "操作成功",
  "apiCode": 20001,
  "data": {
    "list": {
      "authenticated": true,
      "principalType": "认证主体类型，P 代表个人，E 代表企业",
      "principalCode": "6229c4deb3e4d8a20b6021ff",
      "principalName": "ss",
      "authenticatedAt": "2022-04-05T10:23:50.631Z"
    }
  }
}

数据结构

PrincipalAuthenticationInfoPagingDto

名称类型必填描述
totalCountnumber是记录总数。
listarray是响应数据。嵌套类型：PrincipalAuthenticationInfoDto。

PrincipalAuthenticationInfoDto

名称类型必填描述
authenticatedboolean是是否进行认证。 示例值： true
principalTypestring是用户 ID。 示例值： 认证主体类型，P 代表个人，E 代表企业
principalCodestring是认证主体证件号码。 示例值： 6229c4deb3e4d8a20b6021ff
principalNamestring是认证主体名称。 示例值： ss
authenticatedAtstring是认证时间，标准时间字符串。 示例值： 2022-04-05T10:23:50.631Z