apiModels.go 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
  1. package asign
  2. type APIRspData interface {
  3. interface{} | APIBankCard4Rsp | APIAddPersonalUserRsp | APICaptchaVerifyRsp | APIGetUserRsp
  4. }
  5. type APIRsp[T APIRspData] struct {
  6. Code int `json:"code"` // 响应码,100000表示成功,其他表示异常
  7. Msg string `json:"msg"` // 响应信息
  8. Data T // 响应数据
  9. }
  10. // APIPersonBankCard4Req 个人银行卡四要素认证入参
  11. type APIPersonBankCard4Req struct {
  12. RealName string `json:"realName" binding:"required"` // 真实姓名
  13. IdCardNo string `json:"idCardNo" binding:"required"` // 身份证号
  14. BankCard string `json:"bankCard" binding:"required"` // 银行卡号(仅限印有“银联”字样的银行卡)
  15. Mobile string `json:"mobile" binding:"required"` // 手机号码(限中国大陆11位手机号)
  16. }
  17. // APICompanyBankCard4Req 企业法人银行卡四要素认证入参
  18. type APICompanyBankCard4Req struct {
  19. CompanyName string `json:"companyName" binding:"required"` // 企业名称
  20. CreditCode string `json:"creditCode" binding:"required"` // 社会统一信用代码
  21. RealName string `json:"realName" binding:"required"` // 法人姓名
  22. IdCardNo string `json:"idCardNo" binding:"required"` // 法人身份证号
  23. BankCard string `json:"bankCard" binding:"required"` // 法人银行卡号(仅限印有“银联”字样的银行卡)
  24. Mobile string `json:"mobile" binding:"required"` // 法人手机号(限中国大陆11位手机号)
  25. }
  26. // APIBankCard4Rsp 银行卡四要素认证出参
  27. type APIBankCard4Rsp struct {
  28. Result int `json:"result"` // 认证结果 0.暂无结果/认证中 1.成功 2.失败
  29. SerialNo string `json:"serialNo"` // 认证流水号
  30. Type string `json:"type"` // 认证类型
  31. }
  32. type APICaptchaResendReq struct {
  33. SerialNo string `json:"serialNo" binding:"required"` // 认证流水号
  34. }
  35. // CaptchaVerifyReq 认证验证码校验入参
  36. type APICaptchaVerifyReq struct {
  37. SerialNo string `json:"serialNo" binding:"required"` // 认证流水号
  38. Captcha string `json:"captcha" binding:"required"` // 短信验证码
  39. }
  40. // CaptchaVerifyRsp 认证验证码校验出参
  41. type APICaptchaVerifyRsp struct {
  42. Result int `json:"result"` // 认证结果 0.暂无结果/认证中 1.成功 2.失败
  43. SerialNo string `json:"serialNo"` // 认证流水号
  44. Type string `json:"type"` // 认证类型
  45. }
  46. // APIGetUserReq 查询用户信息入参
  47. type APIGetUserReq struct {
  48. Account *string `json:"account"` // 用户唯一识别码
  49. CreditCode *string `json:"creditCode"` // 社会统一信用代码
  50. IdCard *string `json:"idCard"` // 证件号码
  51. }
  52. // APIGetUserRsp 查询用户信息出参
  53. type APIGetUserRsp struct {
  54. Account string `json:"account"` // 用户账号,用户唯一识别码
  55. Name string `json:"name"` // 个人用户姓名/企业法人姓名
  56. CompanyName string `json:"companyName"` // 企业名称
  57. IdCard string `json:"idCard"` // 个人用户证件号/企业法人身份证号
  58. Mobile string `json:"mobile"` // 用户手机号(签约短信通知手机号)
  59. Email string `json:"email"` // 用户邮箱号
  60. UserType int `json:"userType"` // 用户类型: 1:企业 2:个人
  61. CreditCode string `json:"creditCode"` // 社会统一信用代码
  62. BankCard string `json:"bankCard"` // 用户银行卡号
  63. PortVersion int `json:"portVersion"` // 用户添加时调用的接口版本: 0:历史接口 1:V2版本接口
  64. IdentifyType int `json:"identifyType"` // 认证类型
  65. AuthType int `json:"authType"` // 认证方式: 当portVersion=0 历史接口时 0:非强制认证 1:爱签平台强制认证 当portVersion=1 (V2)版本接口时 0:平台方自行认证 1:爱签平台认证
  66. CreateTime string `json:"createTime"` // 创建时间
  67. IdentifyTime string `json:"identifyTime"` // 认证时间
  68. }
  69. // AddPersonalUserReq 添加个人用户(V2)入参
  70. type APIAddPersonalUserReq struct {
  71. Account string `json:"account" binding:"required"` // 用户唯一识别码(请转入UserID)
  72. SerialNo string `json:"serialNo"` // 实名认证流水号
  73. Name string `json:"name"` // 用户姓名
  74. IdCard string `json:"idCard"` // 个人身份证、台胞证、港澳通行证等证件号
  75. IdCardType int `json:"idCardType"` // 证件类型 1:居民身份证 2:台湾居民来往内地通行证 3:港澳居民往来内地通行证 10:武装警察身份证 11:军人身份证 15:警察(警官)证 21:外国人永久居留证 23:护照
  76. Mobile string `json:"mobile"` // 手机号码
  77. SignPwd string `json:"signPwd"` // 签约密码(MTP2登录密码加密方式),如果为空将随机生成签约密码(当签约方式为“签约密码签约”时会使用到,可通过重置接口修改)
  78. IsSignPwdNotice int `json:"isSignPwdNotice"` // 是否将签约密码以短信形式通知用户 0:不通知(默认) 1:通知
  79. IsNotice int `json:"isNotice"` // 用户发起合同或需要签署时是否进行短信通知 0:否(默认) 1:是
  80. }
  81. // AddPersonalUserRsp 添加个人用户(V2)出参
  82. type APIAddPersonalUserRsp struct {
  83. SealNo string `json:"sealNo" binding:"required"` // 生成默认印章编号
  84. }
  85. type APITemplate struct {
  86. TemplateNo string `json:"templateNo"` // 合同模板编号
  87. }
  88. type APICreateContractReq struct {
  89. ContractNo string `json:"contractNo" binding:"required"` // 合同ID,合同唯一编号
  90. ContractName string `json:"contractName" binding:"required"` // 合同名称
  91. ValidityTime int `json:"validityTime"` // 合同签署剩余天数(系统当前时间+该天数=在此日期之前可以签署合同日期),【注】与合同有效截止日期必传其一,【例】可传剩余天数:15
  92. ValidityDate string `json:"validityDate"` // 合同有效截止日期(在此日期之前可以签署合同,格式要求:yyyyMMddHHmmss),【注】与合同有效天数必传其一,【例】传值“20231207190000” 为:2023年12月07日19时00分00秒
  93. SignOrder int `json:"signOrder" binding:"required"` // 签约方式 1:无序签约(默认) 2:顺序签约
  94. }