跳到主要内容

查询设备

Request​

ENDPOINT
/account/ACCOUNT_KEY/device/DEVICE_KEY
MÉTODO
GET

路径参数​

字段类型描述字符数
account_keyuuidv4账户唯一标识键。36
device_keyuuidv4设备唯一标识键。36

Response​

STATUS
200
Response Body: 找到设备
{
"device_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
"session_id": "05894BAD-C94E-4A61-B2A8-57EDAE868A0F",
"analysis_status": "automatically_approved",
"status": "registered",
"device_registration_data": {
"device_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
"session_id": "05894BAD-C94E-4A61-B2A8-57EDAE868A0F",
"document_number": "438.858.048-16",
"registration_date": "2025-06-30T14:52:13-03:00",
"face_recognition_key": "367195fc-de24-46b0-9ddb-79231dc7eeff"
},
"analysis_status_events": [
{
"new_analisys_status": "automatically_approved",
"reason": null,
"reason_description": null,
"event_date": "2025-06-30T14:52:13Z"
}
],
"status_events": [
{
"new_status": "registered",
"event_date": "2025-06-30T14:52:13Z"
}
],
"registration_date": "2025-06-30T14:52:14Z",
"created_at": "2025-06-30T14:52:13Z"
}

Response Body 参数​

字段类型描述字符数
device_key *uuidv4UUID v4 格式的设备唯一标识键36
session_id *uuidv4通过 device_scan 获取的会话标识符36
analysis_status *string欺诈引擎分析状态analysis_status 枚举值
status *string设备状态status 枚举值
device_registration_data *object设备注册数据device_registration_data 对象
analysis_status_events *array分析状态变更事件历史记录-
status_events *array设备状态变更事件历史记录-
registration_date *stringISO 格式的设备注册日期(UTC - "YYYY-MM-DDTHH:MM:SSZ")20
created_at *stringISO 格式的设备创建日期(UTC - "YYYY-MM-DDTHH:MM:SSZ")20

device_registration_data 对象​

字段类型描述字符数
device_key *uuidv4UUID v4 格式的设备唯一标识键36
session_id *uuidv4通过 device_scan 获取的会话标识符36
document_numberstring用户的文件号码(CPF/CNPJ)14
registration_date *string带时区的 ISO 格式注册日期25
face_recognition_keyuuidv4人脸识别键(适用时)36

analysis_status_event 对象​

字段类型描述字符数
new_analisys_status *string新的分析状态analysis_status 枚举值
reasonstring状态变更原因(适用时)-
reason_descriptionstring状态变更原因描述(适用时)-
event_date *stringISO 格式的事件日期(UTC - "YYYY-MM-DDTHH:MM:SSZ")20

status_event 对象​

字段类型描述字符数
new_status *string设备的新状态status 枚举值
event_date *stringISO 格式的事件日期(UTC - "YYYY-MM-DDTHH:MM:SSZ")20

analysis_status 枚举值​

枚举值描述
automatically_approved欺诈引擎自动批准
automatically_reproved欺诈引擎自动拒绝
pending待分析

status 枚举值​

枚举值描述
registered设备已注册
disabled设备已停用
pending设备待审批
STATUS
4xx
Response Body: Error
{
"title": "titulo",
"description": "description in English",
"translation": "descrição em portugues",
"code": "codigo",
"extra_fields": {}
}
HTTP 代码
status
QI 代码
code
标题
title
描述(英文)
description
描述(葡文)
translation
400QIT000001Bad RequestSchema ErrorErro de Schema
404OBD000002Not FoundBank account not foundConta não encontrada
404OBD000100Device not foundNo device is associated with the provided device_key.Nenhum dispositivo está associado à device_key fornecida.