跳到主要内容

Registration

在使用 API 人脸验证资源之前，需要先注册客户。此操作将在数据库中生成一条初始记录，提供一张在验证过程中用作基准的图片。

对象定义​

Request Body
{        
    "registration_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",
    },
    "status": "indeterminate",
    "registration_status_events": [],
    "registration_date": "2020-07-29T18:40:57Z"
}

注册客户时，我们的 API 将生成一个包含与此注册相关所有信息的 JSON 对象。此对象将在对该客户执行交易前进行人脸识别时用作参考。

名称类型描述
registration_keystringRegistration 对象的密钥
document_numberstring客户的 CPF
imageimage携带注册时发送的图片属性的对象
statusstring客户注册状态
registration_status_eventsregistration_status_events携带注册状态修改历史记录的对象
registration_datedatetimeUTC 注册日期

状态动态 - status​

注册客户后，将在 status 标志下返回此注册的状态。可能的结果为：

结果描述
authentic此注册有成功完成交易的历史记录
undefined此注册没有欺诈历史记录，也没有成功完成交易的历史记录
fraud此注册有与之关联的欺诈历史记录

创建 Registration​

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 对象的 POST 请求：

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

支持两种类型的注册 JSON 对象。一种是通过 /image 端点提前发送图片的情况，另一种是在注册请求时同时发送图片的情况。

名称类型描述
document_numberString客户的 CPF
imageString不含头部或附加信息的图片 Base64
image_keyString通过 /image 端点发送图片时返回的 UUID4

发送后，将返回包含用户注册数据的 Registration 对象。

注意 - 在注册时同时发送图片时，该图片将接受与通过 /image 端点发送图片时相同的质量测试。因此，发送的图片受本文档图片部分描述的相同规则约束。

状态更新 - status​

Request Body
{
    "registration_status": "fraud",
    "incident": "misappropriation",
    "event_date": "2029-08-25T13:34:12-03:00"                  
}

为了保证欺诈者数据库的反馈，需要在客户发生任何类型的欺诈或客户首次成功完成交易时通知系统。

为此，将客户注册状态更新为欺诈者需要向以下端点发送 PUT 类型的请求：

https://api.caas.qitech.app/face_recognition/registration/{registration_key}/status

以下值可用于 incident 字段，该字段指示客户犯下的欺诈类型：

枚举值描述
misappropriation个人对某产品进行了不当占有
misrepresentation个人使用虚假或第三方文件注册
successfull_transaction个人成功完成了一次交易
status_restoration用于希望将状态恢复为 undefined 的情况

对象检索​

Response Body
{        
    "registration_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",
    },
    "status": "fraud",
    "registration_status_events": [
        {
        "registration_status": "fraud",
        "incident": "misappropriation",
        "event_date": "2020-08-25T13:34:12Z"        
        }
    ],
    "registration_date": "2020-07-29T18:40:57Z"
}

随时可以通过向以下端点发送 GET 请求来检索客户的注册数据：

https://api.caas.qitech.app/face_recognition/registration/{registration_key}