npm 包 onfido-sdk-core 使用教程

阅读时长 5 分钟读完

介绍

onfido-sdk-core 是一款用于与 Onfido API 交互的 npm 包。Onfido 是一家提供身份验证服务的公司,使用该服务可以验证用户的身份信息。

在前端开发中,我们常常需要调用 Onfido API 进行身份验证。使用 onfido-sdk-core 可以方便地完成这一任务。本文将介绍如何使用 onfido-sdk-core 进行身份验证。

安装

使用 npm 进行安装:

安装完成后,在代码中引入 sdk:

使用

使用 onfido-sdk-core 进行身份验证共需要以下步骤:

  1. 建立连接;
  2. 上传材料信息;
  3. 发起身份验证请求。

建立连接

首先,需要使用 Onfido API 的 token 建立与服务器的连接:

在实际开发中,应该使用安全的方式存储 API Token,如将其存储在环境变量中。

上传材料信息

接下来,需要上传需要验证的身份证件信息。身份证件信息可以由用户自行上传或者由第三方系统提供。在上传身份证件信息时,需要指明上传的文件类型、国家名称、身份证件类型以及身份证件号码:

-- -------------------- ---- -------
----- --- - -
    ----- ----------- -- -------
    ---------------- ------ -- ----
    ------- ----------- -- ------
-
----- --------- - ----- ------------------------
    ----- ---------------
    ----- ------------ -- --------
    ----- -------- -- ---
    ------------ -
        --------- --- -- ------
    -
--
----- ---------- - ------------ -- --------- --

在上传文件时,需要指定身份证件的类型、国家和号码,并将身份证件信息添加到身份证件上传的 metadata 中。

发起身份验证请求

最后,需要发起身份验证请求并获取验证结果:

-- -------------------- ---- -------
----- --------- - ----- -------------------------
    ---------- -------
    --------- ------
    ------ ---------------
    ---------- ------------ -- ----- --
--
----- ------ - ----- ---------------------
    ------------ -------------
    ----------- ---------- -- ----
    ------- --
        ----- ----------- -- ----
        ------------ ------------ -- ------- --
    --
--
----- ------ - ----- ---------------------------

在发起身份验证请求时,需要指定使用哪种报告类型和验证类型,并提供之前上传的身份证件文件 ID。

最后,从 Onfido API 获取身份验证结果。

示例代码

完整的身份认证代码示例如下:

-- -------------------- ---- -------
----- ------ - --------------------------

----- -------- ---------------- -
    ----- ------ - --------
        --------- ----------------
    --

    -- --------
    ----- --- - -
        ----- -----------
        ---------------- ------
        ------- -----------
    -
    ----- --------- - ----- ------------------------
        ----- ---------------
        ----- ------------
        ----- --------
        ------------ - --------- --- -
    --
    ----- ---------- - ------------

    -- -------
    ----- --------- - ----- -------------------------
        ---------- -------
        --------- ------
        ------ ---------------
        ---------- ------------
    --

    -- ------
    ----- ------ - ----- ---------------------
        ------------ -------------
        ----------- ----------
        ------- --
            ----- -----------
            ------------ ------------
        --
    --

    -- --------
    ----- ------ - ----- ---------------------------

    ------ ------
-

---------------------------- -- -
    -------------------
--

总结

使用 onfido-sdk-core 可以方便地进行身份验证。在实际开发中,应该采用安全的方式存储 API Token,并确保上传的文件和申请人信息都是合法的。另外,我们还应该将身份验证的结果用于进一步的决策。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600671a630d09270238224ca

纠错
反馈