@getyoti/yoti-doc-scan-react-native

中文文档
8.0.0发布于 2026/07/06https://www.yoti.com/terms/identity-verificationCommonJS零依赖近 30 天下载 3210

Yoti 身份验证服务的反应本地 SDK

中文使用文档
文档目录13 节
  1. 先决条件
  2. 所需资源
  3. 一体化
  4. 机器人
  5. iOS系统
  6. 使用量
  7. 1. 进口模块
  8. 2. 可选配置和定制
  9. 3. 发起一次会议
  10. 支持的语言
  11. 状态代码
  12. 支助
  13. 许可证

Yoti IDV, 反应原生

GitHub tag (latest SemVer) Publish Release Illustration

Yoti IDV 的本地反应包 机器人 财务报告和审定财务报表 iOS系统. Yoti IDV允许您的应用程序的用户拍摄他们的文档相片,以及扫描或捕捉他们的相片,然后我们立即核实并准备回复,然后您的系统可以在您的主机站点取回.

先决条件

为了与Yoti IDV融合,需要有一个工作基础设施(见 开发者. yoti.com 要更多细节或联系我们 这里) (中文(简体) ).

所需资源

一体化

启动您的整合, 在您的属性中添加以下 package.json 文件 :

"dependencies": {
    "@getyoti/yoti-doc-scan-react-native": "^8.0.0"
}

机器人

继续您对 Android 的整合, 在您的项目中添加以下属性和寄存器 build.gradle 文件 :

buildscript {
    ext {
        yotiSdkVersion = "4.3.0"
    }
}
allprojects {
    repositories {
        maven {
            url 'https://maven.regulaforensics.com/RegulaDocumentReader'
        }
    }
}

现在把这些可选的依赖添加到您的应用程序中 build.gradle 文件 :

dependencies {
    // With automatic capture via OCR and NFC capture
    implementation "com.yoti.mobile.android.sdk:yoti-sdk-doc-scan:${rootProject.ext.yotiSdkVersion}"
    // With manual capture only, no OCR, no NFC - around 14Mb smaller in size
    implementation "com.yoti.mobile.android.sdk:yoti-sdk-doc-scan-slim:${rootProject.ext.yotiSdkVersion}"
    implementation "com.yoti.mobile.android.sdk:yoti-sdk-doc-scan-sup:${rootProject.ext.yotiSdkVersion}"
    implementation "com.yoti.mobile.android.sdk:yoti-sdk-liveness-zoom:${rootProject.ext.yotiSdkVersion}"
    // With embedded AI model
    implementation "com.yoti.mobile.android.sdk:yoti-sdk-facecapture:${rootProject.ext.yotiSdkVersion}"
     // Without embedded AI model - around 20 MB smaller in size
    implementation "com.yoti.mobile.android.sdk:yoti-sdk-facecapture-unbundled:${rootProject.ext.yotiSdkVersion}"
}

使用Proguard或其他模糊工具的,还应当在您的配置中添加下列配置规则: proguard-rules.pro 文件 :

-keepclassmembers class kotlinx.** {
    volatile <fields>;
}
-keep class com.yoti.** { *; }
-dontwarn com.facetec.sdk.**
-keep class com.facetec.sdk.** { *; }
-dontwarn javax.annotation.Nullable
-keepclassmembers class io.ktor.** { volatile <fields>; }

iOS系统

为了继续融入iOS,您应该添加以下内容: Podfile 运行 pod install 从其目录中:

require_relative '../node_modules/@react-native-community/cli-platform-ios/native_modules'
require_relative '../node_modules/react-native/scripts/react_native_pods'

platform :ios, '15.1'

target 'TargetName' do
  config = use_native_modules!
  use_react_native!(:path => config[:reactNativePath])
  use_frameworks!
  use_native_modules!
  pod 'YotiDocumentScan'                # Include if `YotiSDKIdentityDocument` is included and to support identity document OCR
  pod 'YotiNFC'                         # Include if `YotiSDKIdentityDocument` is included and to support identity document NFC
  pod 'YotiSDKIdentityDocument'         # Optional
  pod 'YotiSDKSupplementaryDocument'    # Optional
  pod 'YotiSDKFaceTec'                  # Optional
  pod 'YotiSDKFaceCapture'              # Optional

  # If your target includes `YotiSDKFaceTec`, then you must also provide `FaceTecSDK` per build configuration.
  # ENV['YOTI_FACETEC_VERSION'] = '9.0.0' # Uncomment to pin FaceTec to a specific 'yoti-doc-scan-ios' version (defaults to latest)
  pod 'FaceTecSDK', :podspec => '../node_modules/@getyoti/yoti-doc-scan-react-native/ios/Podspecs/FaceTecSDK.podspec', :configurations => ['Release']
  pod 'FaceTecSDKForDevelopment', :podspec => '../node_modules/@getyoti/yoti-doc-scan-react-native/ios/Podspecs/FaceTecSDKForDevelopment.podspec', :configurations => ['Debug']
end

此外,你应该 修改工程目标的性质和能力。 。 。 .

使用量

1. 进口模块

import RNYotiDocScan from '@getyoti/yoti-doc-scan-react-native';

2. 可选配置和定制

关于Android的定制,可以参考概述的文档 这里。此外,还可以选择设置请求代码:

RNYotiDocScan.setRequestCode(0); // default: 9001

在iOS上,SDK预计一个被启动的会话默认会包含多个流量. 为启用单流会话,配置并包含 yoti-doc-scan- react-intative-confuction-ios.json 互联网档案馆的存檔,存档日期2013-12-12 在项目目标中,然后设定配置如下:

RNYotiDocScan.setConfiguration({
    bundle_identifier: "", // Optional: defaults to the main bundle identifier if not specified.
    filename: "yoti-doc-scan-react-native-configuration-ios.json"
});

确保只设置一个模块类型属性 true 何时 single_flow 已启用.

要自定义iOS上的外观, 您可以使用 SDK 配置 yoti-doc-scan- react-intative-confuction- with-them-ios.json 互联网档案馆的存檔,存档日期2013-12-21 相反,它支持下列主题选项:

  • 光和暗模式颜色主题. 我们也支持只指定每种模式的主要颜色
  • 类型学主题(系统和自定义字体、字体重量、大小、行高多重和kern)
  • 间距模式(配合、正则和放松)
  • 形状主题( 角半径和边框宽度)
  • 图标主题(自定义向量、系统和自定义 SF 符号,包括本地化符号)
  • 说明主题(定制向量)

所有自定义类型都是可选的,可以相互独立设置.

3. 发起一次会议

利用 start 函数.

const completion = (code, description) => {
    ...
}
RNYotiDocScan.start(sessionID, sessionToken, completion);

支持的语言

我们的SDK支持下表中列出的9种语言,但其使用由您目标本地化配置所驱动. 如果你的目标只支持我们SDK支持的语言的子集,那么我们的SDK会回到你的目标不支持的英语上.

语言代码
阿拉伯语ar (单位:千美元)
荷兰语Name无
英语( 默认)内
法语f 读取
德语页:1
意大利语这个
俄语吕
西班牙语对
土耳其语Name双

状态代码

代码说明
0 个用户完成会话
1 000个用户取消了会话
联合国未经批准的请求(错误或过期会话代号)
联合国未找到会话
联合国会话已过期
联合国SDK 启动时没有会话符号
联合国SDK 没有会话 ID 启动
3000个Yoti 的服务中断或无法处理请求
3001 (英语)网络请求中发生错误
3002号用户没有网络连接
3003 (英语)网络请求超时
4000个用户没有给相机许可
4001 (英语)用户提交错误的文档
5000块未找到用户相机, 不允许上传文件
5002 (中文(简体) )别再找活口了
5003 (英语)SDK已过时, 请更新到最新版本
5004 (英语)发生了出乎意料的内部错误
5005 (英语)发生了意外的文档抓取错误
五百零六号发生了意外活性捕捉错误
5008 (英语)使用了不支持的配置
6000个无法找到身份证件依赖性
6001 (英语)无法找到面部扫描依赖性
6002 (英语)找不到补充文件的依赖性
6003 (英语)无法找到面部抓取依赖性
7 000个用户没有所需的文件

支助

有问题或支持请联系我们 这里一旦我们回答了你的问题,我们可以再次与你联系,讨论Yoti产品和服务。 如果你希望我们不要这样做, 请告诉我们,当你的电子邮件.

许可证

见牌照 这里。 。 。 .

版本与发布记录

@getyoti/yoti-doc-scan-react-native 共发布 14 个版本,首次发布于 2023/08/04;过去 12 个月发布了 5 个版本。

版本发布日期距今
8.0.0latest2026/07/064 个月前
7.0.02026/02/208 个月前
6.0.02026/01/239 个月前
5.0.22025/11/1811 个月前
6.0.0-alpha.22025/11/1811 个月前
6.0.0-alpha.12025/10/241.1 年前

关于 @getyoti/yoti-doc-scan-react-native 的常见问题

@getyoti/yoti-doc-scan-react-native 是什么?

Yoti 身份验证服务的反应本地 SDK

如何安装 @getyoti/yoti-doc-scan-react-native?

在项目目录运行 npm install @getyoti/yoti-doc-scan-react-native,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(>=19.1.0)、react-native(>=0.80.3)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@getyoti/yoti-doc-scan-react-native 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/getyoti__yoti-doc-scan-react-native 是否存在。

@getyoti/yoti-doc-scan-react-native 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@getyoti/yoti-doc-scan-react-native 可以商用吗?

@getyoti/yoti-doc-scan-react-native 使用 https://www.yoti.com/terms/identity-verification 许可。声明的许可为 https://www.yoti.com/terms/identity-verification,请阅读许可原文确认使用条件。以上为概括,不构成法律意见,请以许可原文为准。

@getyoti/yoti-doc-scan-react-native 的下载量有多少?

根据 npm 官方下载统计,@getyoti/yoti-doc-scan-react-native 在 2026/10/17 – 2026/11/15 这 30 天内被下载 3,210 次,日均约 107 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@getyoti/yoti-doc-scan-react-native 还在维护吗?

最新版本 8.0.0 发布于 2026/07/06(4 个月前);至今共发布 14 个版本,其中过去 12 个月发布了 5 个;首次发布于 2023/08/04。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。