RPSDKInterface.h 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131
  1. //
  2. // RPSDKInterface.h
  3. // ALRealIdentity
  4. //
  5. // Created by Hank Zhang on 2019/11/1.
  6. // Copyright © 2019 Alibaba. All rights reserved.
  7. //
  8. #import <Foundation/Foundation.h>
  9. #import <UIKit/UIKit.h>
  10. #import <RPSDK/RPConfiguration.h>
  11. #import <RPSDK/RPResult.h>
  12. NS_ASSUME_NONNULL_BEGIN
  13. /**
  14. `RPSDK` 实人认证 SDK 接口。
  15. */
  16. NS_SWIFT_NAME(RPSDK)
  17. @interface RPSDK : NSObject
  18. /**
  19. 实人认证初始化,建议应用启动时调用。
  20. */
  21. + (void)setup;
  22. /**
  23. 优先推荐使用此方法
  24. 开始实人认证,使用默认 UI 配置,适用于纯 Native 的认证方案。支持认证基础方案列表如下:
  25. * RPBioOnly
  26. * RPBioOnlyPro
  27. * FVBioOnly
  28. * FDBioOnly
  29. 认证方案介绍: https://help.aliyun.com/document_detail/127757.html
  30. 支持引导页、隐私页、活体页,如果您的方案需要’拍证件照‘或者’手输身份证‘需求,则请使用 ’startWithVerifyToken:‘ 方法。
  31. @param verifyToken 实人认证流程的唯一标识,一般从接入方自己的服务端获取,有效时间 30 分钟。
  32. @param viewController 调用实人认证的视图控制器。
  33. @param completion 实人认证结果回调。
  34. */
  35. + (void)startByNativeWithVerifyToken:(NSString *)verifyToken
  36. viewController:(UIViewController *)viewController
  37. completion:(RPCompletion _Nullable)completion;
  38. /**
  39. 优先推荐使用此方法
  40. 开始实人认证,可自定义 UI 配置,适用于纯 Native 的认证方案。支持认证基础方案列表如下:
  41. * RPBioOnly
  42. * RPBioOnlyPro
  43. * FVBioOnly
  44. * FDBioOnly
  45. 认证方案介绍: https://help.aliyun.com/document_detail/127757.html
  46. 支持引导页、隐私页、活体页,如果您的方案需要’拍证件照‘或者’手输身份证‘需求,则请使用 ’startWithVerifyToken:‘ 方法。
  47. @param verifyToken 实人认证流程的唯一标识,一般从接入方自己的服务端获取,有效时间 30 分钟。
  48. @param viewController 调用实人认证的视图控制器。
  49. @param configuration 实人认证配置。
  50. @param progress 实人认证过程回调。
  51. @param completion 实人认证结果回调。
  52. */
  53. + (void)startByNativeWithVerifyToken:(NSString *)verifyToken
  54. viewController:(UIViewController *)viewController
  55. configuration:(RPConfiguration *)configuration
  56. progress:(RPProgress _Nullable)progress
  57. completion:(RPCompletion _Nullable)completion;
  58. /**
  59. 开始实人认证,使用默认 UI 配置,适用于需要’拍证件照‘或者’手输身份证‘的认证方案, 支持方案列表如下:
  60. * RPBioID
  61. * RPBasic
  62. * RPManual
  63. 认证方案介绍: https://help.aliyun.com/document_detail/127757.html
  64. @param verifyToken 实人认证流程的唯一标识,一般从接入方自己的服务端获取,有效时间 30 分钟。
  65. @param viewController 调用实人认证的视图控制器。
  66. @param completion 实人认证结果回调。
  67. */
  68. + (void)startWithVerifyToken:(NSString *)verifyToken
  69. viewController:(UIViewController *)viewController
  70. completion:(RPCompletion _Nullable)completion;
  71. /**
  72. 开始实人认证,可自定义 UI 配置,适用于需要’拍证件照‘或者’手输身份证‘的认证方案, 支持方案列表如下:
  73. * RPBioID
  74. * RPBasic
  75. * RPManual
  76. 认证方案介绍: https://help.aliyun.com/document_detail/127757.html
  77. @param verifyToken 实人认证流程的唯一标识,一般从接入方自己的服务端获取,有效时间 30 分钟。
  78. @param viewController 调用实人认证的视图控制器。
  79. @param configuration 实人认证配置。
  80. @param completion 实人认证结果回调。
  81. */
  82. + (void)startWithVerifyToken:(NSString *)verifyToken
  83. viewController:(UIViewController *)viewController
  84. configuration:(RPConfiguration *)configuration
  85. completion:(RPCompletion _Nullable)completion;
  86. /**
  87. 废弃!!! 开始实人认证,使用指定的 H5 地址作为认证入口。 建议使用 startWithVerifyToken 接口,如不能满足需求可以咨询实人开发同学
  88. 使用 UI 默认配置。
  89. @param url 实人认证流程的地址。
  90. @param viewController 调用实人认证的视图控制器。
  91. @param completion 实人认证结果回调。
  92. */
  93. + (void)startByURL:(NSString *)url
  94. viewController:(UIViewController *)viewController
  95. completion:(RPCompletion _Nullable)completion
  96. DEPRECATED_MSG_ATTRIBUTE("建议使用 startWithVerifyToken 接口,如不能满足需求可以咨询实人开发或产品同学,计划于 2021.12.12 之后版本下线");
  97. /**
  98. 废弃!!! 开始实人认证,使用指定的 H5 地址作为认证入口。建议使用 startWithVerifyToken 接口,如不能满足需求可以咨询实人开发同学
  99. @param url 实人认证流程的地址。
  100. @param viewController 调用实人认证的视图控制器。
  101. @param completion 实人认证结果回调。
  102. */
  103. + (void)startByURL:(NSString *)url
  104. viewController:(UIViewController *)viewController
  105. configuration:(RPConfiguration *)configuration
  106. completion:(RPCompletion _Nullable)completion
  107. DEPRECATED_MSG_ATTRIBUTE("建议使用 startWithVerifyToken 接口,如不能满足需求可以咨询实人认证开发或产品,计划于 2021.12.12 之后版本下线");
  108. @end
  109. NS_ASSUME_NONNULL_END