申请创建设备
Request
ENDPOINT
/account/ACCOUNT_KEY/deviceMÉTODO
POST路径参数
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
account_key | uuidv4 | 账户唯一标识键。 | 36 |
- SMS
- Image Key
Request Body: 通过 SMS 身份验证
{
"device_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
"session_id": "fae3cb6c-9012-4b1c-9d61-7e8b2a6a5ed2",
"tfa_info": {
"approver_document_number": "98765432100",
"contact_type": "sms",
},
}
Body 参数
| 字段 | 类 型 | 描述 | 字符数 |
|---|---|---|---|
device_key * | uuidv4 | UUID v4 格式的设备唯一标识键，通过 device_scan 获取（由集成客户端在此时创建）。 | 36 |
session_id * | uuidv4 | UUID v4 格式的会话唯一标识键，通过 device_scan 获取（由集成客户端在此时创建）。 | 36 |
tfa_info* | Object | 包含账户审批人文件号码及联系方式或 image_key 的对象。 | tfa_info 对象 |
tfa_info 对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
approver_document_number* | string | 账户审批人的文件号码。 | 11 |
contact_type* | string | 指定与账户审批负责人的联系方式。可能的值为 sms、email 或 liveness（使用 image_key 进行身份验证时）。 |
Response
STATUS
202Response Body: 交易已申请
{
"device_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
"device_status": "pending_2fa_approval",
"created_at": "2024-12-22T20:30:23.459Z"
}
Request Body: 通过 Email 身份验证
{
"device_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
"session_id": "fae3cb6c-9012-4b1c-9d61-7e8b2a6a5ed2",
"tfa_info": {
"approver_document_number": "98765432100",
"contact_type": "email",
},
}
Body 参数
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
device_key * | uuidv4 | UUID v4 格式的设备唯一标识键，通过 device_scan 获取（由集成客户端在此时创建）。 | 36 |
session_id * | uuidv4 | UUID v4 格式的会话唯一标识键，通过 device_scan 获取（由集成客户端在此时创建）。 | 36 |
tfa_info* | Object | 包含账户审批人文件号码及联系方式或 image_key 的对象。 | tfa_info 对象 |
tfa_info 对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
approver_document_number* | string | 账户审批人的文件号码。 | 11 |
contact_type* | string | 指定与账户审批负责人的联系方式。可能的值为 sms、email 或 liveness（使用 image_key 进行身份验证时）。 |
Response
STATUS
202Response Body: 交易已申请
{
"device_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
"device_status": "pending_2fa_approval",
"created_at": "2024-12-22T20:30:23.459Z"
}
Request Body: 通过 Image Key 身份验证
{
"device_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
"session_id": "fae3cb6c-9012-4b1c-9d61-7e8b2a6a5ed2",
"tfa_info": {
"approver_document_number": "98765432100",
"contact_type": "liveness",
"image_key": "367195fc-de24-46b0-9ddb-79231dc7eeff",
},
}
Body 参数
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
device_key * | uuidv4 | UUID v4 格式的设备唯一标识键，通过 device_scan 获取（由集成客户端在此时创建）。 | 36 |
session_id * | uuidv4 | UUID v4 格式的会话唯一标识键，通过 device_scan 获取（由集成客户端在此时创建）。 | 36 |
tfa_info* | Object | 包含账户审批人文件号码及联系方式或 image_key 的对象。 | tfa_info 对象 |
tfa_info 对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
approver_document_number* | string | 账户审批人的文件号码。 | 11 |
contact_type* | string | 指定与账户审批负责人的联系方式。可能的值为 sms、email 或 liveness（使用 image_key 进行身份验证时）。 | |
image_key * | uuidv4 | UUID v4 格式的人脸识别图像唯一标识键，通过 liveness 过程获取。 | 36 |
Response
STATUS
202Response Body: 设备已创建
{
"device_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
"device_status": "created",
"created_at": "2024-12-22T20:30:23.459Z"
}
STATUS
4xxResponse Body: Error
{
"title": "titulo",
"description": "description in English",
"translation": "descrição em portugues",
"code": "codigo",
"extra_fields": {}
}
HTTP 代码status | QI 代码code | 标题title | 描述（英文）description | 描述（葡文）translation |
|---|---|---|---|---|
| 400 | QIT000001 | Bad Request | Schema Error | Erro de Schema |
| 404 | OBD000002 | Not Found | Bank account not found | Conta não encontrada |
| 400 | OBD000088 | Bad Request | Account blocked or closed can not perform this action | A conta bloqueada ou fechada não pode executar esta ação |
| 400 | OBD000089 | Bad Request | Hub account can not perform this action | A conta hub não pode executar esta ação |
| 403 | OBD000090 | No approver permission | Given document number does not belong to an approver for this account string | Número de documento enviado não pertence a um aprovador da conta |
| 400 | OBD000091 | tfa_info is required | Client must send object tfa_info | Cliente deve enviar objeto tfa_info. |
| 400 | OBD000092 | Invalid device info | Session ID and Device Key must be a valid UUID4 | A Session ID e o Device Key devem ser um UUID4 válidos |
| 404 | OBD000093 | Requester Configuration not found | There is no Requester Configuration attributed to requester_key | Não há Requester Configuration para a requester_key enviada |
| 403 | OBD000094 | Requester not allowed to create a device | Requester has no permission to create a device | Requester não possui permissão para criar um dispositivo |
| 400 | OBD000097 | Error occurred while sending token | An unexpected error occurred while sending token | Um erro inexperado ocorreu ao tentar enviar token |