跳到主要内容

Validation

要通过人脸识别执行客户验证,需要发送一张人脸照片以及已注册客户的 CPF。

随后,系统将在数据库中搜索该用户的记录,然后在数据库中存储的客户照片与发送的图片之间进行 1:1 验证。

对象定义

Request Body
{
"validation_key": "ee37510e-4dfe-4b9c-b1f4-667288de2190",
"document_number": "123.456.789-00",
"image": {
"image_key": "f1c0d2e1-f950-4360-896d-36588e443fc9",
"file_size": 47407,
"width_px": 0,
"height_px": 0,
"created_at": "2020-07-29T18:40:57Z",
},
"registration": {
"registration_key": "903dcb34-2970-4ddf-add5-87463ba51d99",
"registration_status": "authentic",
"registration_date": "2020-07-29T18:40:57Z"
},
"similarity_ratio": "99",
"validation_result": "pass",
"validation_date": "2020-07-29T18:40:57Z"
}

所有通过人脸识别的客户验证都将生成一个 Validation 对象。如果需要,此对象可以在将来通过适当的端点检索。

名称类型描述
validation_keystringValidation 对象的密钥
document_numberstring客户的 CPF
imageimage携带验证时发送的图片属性的对象
registrationregistration携带在验证中用作参考的注册属性的对象
similarity_ratiointeger注册图片与发送图片之间的相似度比率
validation_resultstring执行的 1:1 分析结果
validation_datedatetimeUTC 人脸识别验证日期

创建 Validation

Request Body:同时发送图片(Base64)
{
"document_number": "123.456.789-00",
"image": "base_64_image_code",
}
Request Body:提前发送图片
{
"document_number": "123.456.789-00",
"image_key": "f1c0d2e1-f950-4360-896d-36588e443fc9",
}

与注册一样,也接受两种 JSON 格式,一种包含图片 Base64,另一种包含通过 /image 端点发送图片时收到的 image_key

https://api.caas.qitech.app/face_recognition/validation

发送后,将返回包含分析结果以及指向发送图片的 UUID 的 JSON 对象。

注意 - 在通过人脸识别执行验证时同时发送图片时,该图片将接受与通过 /image 端点发送图片时相同的质量测试。因此,发送的图片受本文档图片部分描述的相同规则约束。

状态动态 - validation_result

执行分析后,将在 validation_result 标志下发送分析结果。可能的结果为:

结果描述
match发送的照片与注册用户匹配
mismatch发送的照片与注册用户不匹配

对象检索

Response Body
{
"validation_key": "ee37510e-4dfe-4b9c-b1f4-667288de2190",
"document_number": "123.456.789-00",
"validation_image": {
"image_key": "f1c0d2e1-f950-4360-896d-36588e443fc9",
"file_size": 47407,
"width_px": 0,
"height_px": 0,
"created_at": "2020-07-29T18:40:57Z",
},
"registration": {
"registration_key": "903dcb34-2970-4ddf-add5-87463ba51d99",
"registration_status": "authentic",
"registration_date": "2020-07-29T18:40:57Z"
},
"similarity_ratio": "99",
"validation_result": "pass",
"validation_date": "2020-07-29T18:40:57Z"
}

随时可以通过向以下端点发送 GET 请求来检索验证数据:

https://api.caas.qitech.app/face_recognition/validation/{validation_key}