API Reference

Verifications

Snap Verifications 帮助企业改进身份验证流程。客户只需输入用户的身份详细信息（如姓名、联系信息和 ID 号码），Snap Verification 就会将这些信息与可靠的数据源进行匹配和验证，并输出每个属性的验证状态。

Snap Verification API 至少需要三项信息：

  1. 用户的姓名
  2. 用户的 ID 或电子邮件（请参阅下面的受支持 ID 列表）
  3. 用户的授权凭证

提供信息后，Smile 会根据所提供的 ID 和您在请求中包含的数据检查所有可靠的数据源，让您能够快速判断最终用户所提供数据的真实性。通过将快速验证与 Snap Verification API 相结合，并在所提供的数据不充分时使用 Wink SDK，您可以高效获得服务客户所需的信息。

Smile Snap Verification API 目前处于 alpha 阶段。

如何发送验证请求

  1. 准备验证请求的详细信息。

    您需要发送以下信息：

    • 用户的姓名（全名或名+姓）
    • 用户的标识符（以下支持的标识符之一，或者您也可以提供电子邮件地址）
    • 用户的授权凭证

  2. 使用我们的 Request Verification 端点发送验证请求。

    📘

    注意

    用户授权和数据隐私对我们非常重要。您必须在创建请求时将用户授权的凭证与其数据一起提交。请查看下面的数据对象。

  3. 订阅事件通知或存储您请求的验证 ID。

  4. 通过 TASK_FINISHED webhook 事件或 Get Verification 端点接收验证结果。

支持的标识符和数据端点

ID 或标识符可验证的数据属性
纳税识别号 tin_ph全名、名、中间名、姓、后缀、出生日期、性别*、电子邮件、电话
社会保障号码 sss_ph全名*、名、中间名、姓、后缀、出生日期、性别、电子邮件、电话
专业执照 prclicense_ph全名、名、中间名、姓*、许可证类型、电子邮件
Pag-IBIG 成员 ID 编号全名*、名、中间名、姓、电子邮件
电子邮件全名*

更多种类的 ID 敬请期待。

验证对象

请求对象

这是您提供给我们的请求对象，也是跟踪请求细节的元对象。

属性类型详情
fullNamestring请求中提供的用户的全名
firstNamestring请求中提供的用户的名字
middleNamestring请求中提供的用户的中间名
lastNamestring请求中提供的用户的姓氏
suffixstring请求中提供的用户的后缀
additionalDataobject请求中提供的有关用户的其他数据
consentobject请求中提供的用户授权的凭证

附加数据（请求）对象

属性类型详情
idsarray包含用户身份证/号码信息的对象数组（只接受一个对象）
emailstring请求中提供的用户的电子邮件地址
phonestring请求中提供的用户的电话号码
dobdate请求中提供的用户的出生日期，格式为 YYYY-MM-DD
genderstring请求中提供的用户的性别，可以是 Male 或 Female

标识符（请求）对象

属性类型详情
idTypestring请求中发送的用户提供的 ID 类型
idSubTypestringID 的子类型（如适用），即许可证类型
idNumberstring请求中提供的用户的 ID 编号

授权对象

如果您选择在 Smile 中存储授权文件，您可以在提出验证请求时提供授权模板的 ID ，或者直接在请求中提供授权文件的详细信息，以及用户授权验证流程的日期和时间。

属性类型详情
typestring授权文件的内部文件名称，如 "Product X Terms & Conditions" 或 "App Privacy Policy"
versionstring您的授权文件的内部版本，用于跟踪更新
consentedWithstring通常以复选框或表单中用户签署姓名和签名的形式出现。此字段用于显示用户授权您提供给他们的文件的字样
consentedAtdate-time用户授权您处理其数据的时间，以 Zulu 时间格式表示
consentTemplateIdnumber如果您选择在 Smile 中存储这些数据，这代表您的授权模板 ID

验证对象

属性类型详情
idstringSmile Network 上验证请求的唯一 ID
createdAtdate-time创建验证请求的日期/时间
updatedAtdate-time验证请求最后的更新日期/时间
statusstring验证请求的状态。可以是 PROCESSING、COMPLETED 或 ERROR
errorMessagestring如适用，代表验证请求的错误信息
requestMetaobject包含原始请求数据的对象。请参阅 请求对象。
resultobject包含验证结果的对象

结果对象

属性类型详情
finalMatchesboolean如果提供的姓名与提供的标识符匹配，则返回 true
namesobject包含姓名的详细匹配信息的对象
additionalDataobject包含附加属性的详细匹配信息的对象

姓名（结果）对象

属性类型详情
fullNameMatchesboolean如果提供的全名与提供的标识符匹配，则返回 true。如果未提供或不支持，则返回空值
firstNameMatchesboolean如果提供的名字与提供的标识符匹配，则返回 true。如果未提供或不支持，则返回空值
middleNameMatchesboolean如果提供的中间名与提供的标识符匹配，则返回 true。如果未提供或不支持，则返回空值
lastNameMatchesboolean如果提供的姓氏与提供的标识符匹配，则返回 true。如果未提供或不支持，则返回空值

补充数据（结果）对象

属性类型详情
idsarray如果提供的名称与提供的标识符匹配，则包含匹配信息的对象数组。如果未提供或不支持，则返回空值
dobMatchesboolean如果提供的出生日期与可用记录匹配，则返回 true。如果未提供、不支持或 finalMatches 为 false，则返回空值
genderMatchesboolean如果提供的性别与可用记录匹配，则返回 true。如果未提供、不支持或 finalMatches 为 false，则返回空值
phoneMatchesobject如果提供的电话与可用记录匹配，则包含匹配信息和其他信息的对象。如果未提供、不支持或 finalMatches 为 false，则返回空值
emailMatchesobject如果提供的电子邮件地址与可用记录匹配，则包含匹配信息和其他信息的对象。如果未提供、不支持或 finalMatches 为 false，则返回空值

标识符（结果）对象

属性类型详情
idNumberstring根据请求中提供的 ID 编号进行匹配
idTypestring根据请求中提供的 ID 类型进行匹配
idSubTypestring根据请求中提供的 ID 子类型进行匹配
matchesboolean如果提供的名称与提供的标识符匹配，则返回 true。如果未提供或不支持，则返回空值

电子邮件或电话匹配对象

属性类型详情
valuestring请求中提供的经匹配的电子邮件地址或电话号码
matchesboolean如果提供的电子邮件或电话与可用记录匹配，则返回 true。如果未提供、不支持或 finalMatches 为 false，则返回空值
disposableboolean如果匹配的电子邮件或电话是无效的，则返回 true。如果未提供、不支持或 finalMatches 为 false，则返回空值
deliverableboolean如果匹配的电子邮件/电话号码可送达，则返回 true。如果未提供、不支持、finalMatches为 false 或用于电话，则返回空值
activeboolean如果匹配的电子邮件/电话号码处于激活状态，则返回 true。如果未提供、不支持、finalMatches为 false，则返回空值
providerstring返回电子邮件服务提供商或电话运营商的名称。如果未提供、不支持或 finalMatches 为 false，则返回空值
freeProviderboolean如果匹配的电子邮件或电话运营商是免费服务提供商，则返回 true。如果未提供、不支持或 finalMatches 为 false，则返回空值

验证结果数据样例

{
  "id": "ver-123abc456def789abc123def456abc78",
  "createdAt": "2024-01-01T08:00:00Z",
  "status": "COMPLETED",
  "updatedAt": "2024-01-01T08:01:00Z",
  "errorMessage": null,
  "requestMeta": {
    "fullName": "George Cimafranca Palomero",
    "firstName": "George",
    "middleName": "Cimafranca",
    "lastName": "Palomero",
    "suffix": "",
    "additionalData": {
      "ids" : [{
        "idType": "tin_ph",
        "idSubType": "",
        "idNumber": "123456789"
      }],
      "email": "[email protected]",
      "phone": null,
      "dob": "1980-01-01",
      "gender": "Male",
      },
      "consent": {
        "type": "Terms & Conditions",
        "version": "1.0",
        "consentedAt": "2024-01-01T08:00:00Z",
        "consentedWith": "I consent to ABC Company processing my data",
        "consentTemplateId": null
      }
  },
  "result": {
    "finalMatches": true,
    "names": {
      "fullNameMatches": true,
      "firstNameMatches": true,
      "lastNameMatches": true,
      "middleNameMatches": true
    },
    "additionalData": {
      "ids": [{
        "idNumber": "234957978",
        "idType": "tin_ph",
        "idSubtype": "",
        "matches": true
      }],
      "dobMatches": true,
      "genderMatches": true,
      "phoneMatches": null,
      "emailMatches": {
        "value": "[email protected]",
        "matches": true,
        "disposable": false,
        "deliverable": true,
        "active": null,
        "provider": "Google LLC",
        "freeProvider": true
      }
    }
  }
}

端点

端点
获取验证数据列表GET /verifications
请求验证数据POST /verifications
获取一条验证数据GET /verifications/{id}