API概览

2024-01-17 01:01

本文介绍ZOLOZ提供的相关服务端API，调用这些API可以集成ZOLOZ服务。

CN Authority

ZOLOZ CN Authority为客户提供中国大陆权威身份认证解决方案。通过将采集的用户人脸与中国大陆权威数据库中存储的信息进行比对，以验证用户身份的真实性。

接口名称	API路径	描述
verify	/api/v1/zoloz/cnauthority/verify	该接口用于将采集的人脸信息与中国大陆权威数据库中存储的信息进行比对，以验证用户身份的真实性，并为验证过程生成一个唯一的事务ID。

Connect

ZOLOZ Connect提供了一个在线的身份验证解决方案，通过人脸活体检测和人脸比对进行身份验证。

接口名称	API路径	描述
initialize	/api/v1/zoloz/connect/initialize	该接口用于初始化ZOLOZ中的人脸验证进程，并为其生成一个唯一的事务ID。后续在与ZOLOZ交互的所有过程中均使用该事务ID。
checkresult	/api/v1/zoloz/connect/checkresult	该接口用于获取人脸验证的结果。
enroll	/api/v1/zoloz/connect/enroll	该接口用于注册已采集的用户人脸图片，供后续Connect进行人脸验证使用。此人脸图片可以从RealID或Face Capture的结果中获取。

RealID

ZOLOZ RealID为eKYC（Know Your Customer）提供数字在线解决方案，实现了身份证明进程中涉及到的证件验证、人脸验证和风险控制等多种能力。

ZOLOZ RealID支持以下两种集成模式，这两种集成模式均支持以下两个服务端API。

App SDK模式：用户在商户的移动App中启动身份验证进程。
H5模式：用户通过移动Web浏览器启动身份验证进程。

接口名称	API路径	描述
initialize	/api/v1/zoloz/realid/initialize	该接口用于初始化ZOLOZ中的身份验证进程，并为其生成一个唯一的事务ID。后续在与ZOLOZ交互的所有过程中均使用该事务ID。
checkresult	/api/v1/zoloz/realid/checkresult	该接口用于获取身份验证进程的运行状态和相关的验证结果，包括证件验证结果及详细信息、人脸验证结果、风险控制结果等。

Face Compare

ZOLOZ Face Compare用于比对传入的两张人脸图片，判断两张人脸是否为同一人，并输出两张人脸图片的比对结果。

接口名称	API路径	描述
compare	/api/v1/zoloz/facecompare/compare	该接口用于对指定的两张人脸图片进行相似性比对，并返回比对结果。

Face Capture

ZOLOZ Face Capture为采集用户人脸图片提供了一个数字在线解决方案，实现了一个人脸采集过程，包括人脸活体检测和人脸质量检测。

接口名称	API路径	描述
initialize	/api/v1/zoloz/facecapture/initialize	该接口用于初始化ZOLOZ中的人脸采集进程，并为其生成一个唯一的事务ID。后续在与ZOLOZ交互的所有过程中均使用该事务ID。
checkresult	/api/v1a/zoloz/facecapture/checkresult	该接口用于获取人脸采集的结果。

ID Recognition

ZOLOZ ID Recognition是一款基于多种智能证件算法，对身份证件进行智能化检测和信息识别的产品。适用于远程身份认证和自动信息录入等场景，可有效降低人力成本，提高信息处理效率。

接口名称	API路径	描述
recognize	/api/v1/zoloz/idrecognition/recognize	该接口用于为护照、身份证、驾照等大部分证件提供文字识别（Optical Character Recognition，简称OCR）功能和证件防伪检测结果。
initialize	/api/v1/zoloz/idrecognition/initialize	该接口用于初始化ZOLOZ中的证件识别进程，并为其生成一个唯一的事务ID。后续在与ZOLOZ交互的所有过程中均使用该事务ID。
checkresult	/api/v1/zoloz/idrecognition/checkresult	该接口用于获取证件识别进程的运行状态和相关的验证结果，包括证件验证结果及详细信息。

IdNetwork

ZOLOZ IdNetwork是一款基于大量的历史数据（人脸数据、图像背景数据、用户身份信息等）构建出网络图谱，利用计算机视觉算法、文本算法、图挖掘算法和大规模检索技术，识别批量欺诈风险的产品。

接口名称	API路径	描述
add	/api/v1/zoloz/idnetwork/add	该接口用于新增一条记录，即将记录入库。
risk query	/api/v1/zoloz/idnetwork/risk/query	该接口用于查询一条记录存在的风险。
get	/api/v1/zoloz/idnetwork/get	该接口用于查询一条记录的详细内容。
alliance get	/api/v1/zoloz/idnetwork/alliance/get	该接口用于查询联盟记录。
remove	/api/v1/zoloz/idnetwork/remove	该接口用于删除一条记录。

AML

接口名称	API路径	描述
扫描信息接口	/api/v1/aml/analyze	该接口用于提供名单筛查扫描的结果。客户提供扫描入参后，根据不同的扫描场景和扫描逻辑，可以得到包括政治高风险人物、制裁名单、负面新闻等名单扫描的结果。
审理信息接口	/api/v1/aml/checkCaseResult	该接口用于查询任务结果。

NFC Reader

NFC Reader是一款基于手机NFC功能，进行证件芯片解码，读取证件芯片加密信息，快捷便利地获取证件信息的产品。适用于远程身份认证和自动信息录入等场景，可有效降低人力成本，提高信息处理效率，防止黑产合成证件图片攻击，提升业务的安全风控能力。

接口名称	API路径	描述
initialize	/api/v1/zoloz/nfc/initialize	该接口用于初始化ZOLOZ中的NFC身份识别服务，并为其生成一个唯一的事务ID。后续在与ZOLOZ交互的所有过程中均使用该事务ID。
checkresult	/api/v1/zoloz/nfc/checkresult	该接口用于获取NFC身份识别服务的运行状态和相关的识别结果，包括证件详细信息、人脸详细信息等。

中国公民出入境记录识别

ZOLOZ中国公民出入境记录识别（Statement of Travel Records）是一款面向中国公民，对中国公民出入境记录的电子版PDF文档进行识别的产品，支持从PDF文档中进行文档信息提取和签名验证。适用于远程身份辅助认证和自动信息录入等场景，可有效降低人力成本，提高信息处理效率，提升业务的安全风控能力。

接口名称	API路径	描述
extract	/api/v1/zoloz/pdf/extract	该接口用于电子版PDF解析，并根据传入的pdfType决定提取的字段列表，如果PDF内含有签名则自动校验签名的有效性。

Blacklists

黑名单不是一个独立的产品，而是RealID的一个增强功能，用于在eKYC流程中提供额外的黑名单拦截能力。

接口名称	API路径	描述
Add Item	/api/v1/zoloz/blacklist/additem	该接口用于向黑名单中添加一条记录。
Get Item	/api/v1/zoloz/blacklist/getitem	该接口用于获取已有黑名单记录的详细信息。
Remove Item	/api/v1/zoloz/blacklist/removeitem	该接口用于从目标黑名单列表中删除一条记录。

Privacy

隐私管理不是一个独立的产品，而是一个辅助功能，用于对多个产品（RealID、Face Capture、Face Compare、ID Recognition）使用过程中存储的个人隐私信息进行管理。

接口名称	API路径	描述
delete	/api/v1/zoloz/privacyinfo/delete	该接口用于删除隐私信息，例如证件或人脸图片、OCR或输入信息。