client/docs/passport/login.md

3.0 KiB

Login

Passport-通行证模块-登录

/passport.Login/Pwd

通过密码登录

Request

{
    account: "", // type<string>, 账号 必填
    password: "", // type<string>, 密码 必填
}

Reply

{
    id: "0", // type<int64>
    identity: "", // type<string>, 用户唯一码
    token: "", // type<string>, 用户凭证
    extend: {
        "": ""
    }, // map<string,string>, 扩展字段
    verify_status: {
        email_verify: 0, // type<int32>, 邮箱是否已验证
        phone_verify: 0, // type<int32>, 手机是否已验证
        face_verify: 0, // type<int32>, 人脸或照片是否已验证
        document_verify: 0, // type<int32>, 证件是否已验证
        kyc_verify: 0, // type<int32>, 实名是否已验证
    }, // type<VerifyStatus>, 用户验证状态
}

/passport.Login/Code

通过验证码登录

Request

{
    country: "", // type<string>, 国家
    phone: "", // type<string>, 手机号码
    code: "", // type<string>, 验证码
    agency_id: "0", // type<int64>, 代理ID
    staff_id: "0", // type<int64>, 工作人员ID
    owner_id: "0", // type<int64>, 所属ID
    owner_identity: "", // type<string>, 所属唯一码
}

Reply

{
    id: "0", // type<int64>
    identity: "", // type<string>, 用户唯一码
    token: "", // type<string>, 用户凭证
    extend: {
        "": ""
    }, // map<string,string>, 扩展字段
    verify_status: {
        email_verify: 0, // type<int32>, 邮箱是否已验证
        phone_verify: 0, // type<int32>, 手机是否已验证
        face_verify: 0, // type<int32>, 人脸或照片是否已验证
        document_verify: 0, // type<int32>, 证件是否已验证
        kyc_verify: 0, // type<int32>, 实名是否已验证
    }, // type<VerifyStatus>, 用户验证状态
}

/passport.Login/CodeAndRegister

通过验证码登录并注册

Request

{
    country: "", // type<string>, 国家
    phone: "", // type<string>, 手机号码
    code: "", // type<string>, 验证码
    agency_id: "0", // type<int64>, 代理ID
    staff_id: "0", // type<int64>, 工作人员ID
    owner_id: "0", // type<int64>, 所属ID
    owner_identity: "", // type<string>, 所属唯一码
}

Reply

{
    id: "0", // type<int64>
    identity: "", // type<string>, 用户唯一码
    token: "", // type<string>, 用户凭证
    extend: {
        "": ""
    }, // map<string,string>, 扩展字段
    verify_status: {
        email_verify: 0, // type<int32>, 邮箱是否已验证
        phone_verify: 0, // type<int32>, 手机是否已验证
        face_verify: 0, // type<int32>, 人脸或照片是否已验证
        document_verify: 0, // type<int32>, 证件是否已验证
        kyc_verify: 0, // type<int32>, 实名是否已验证
    }, // type<VerifyStatus>, 用户验证状态
}