Consultar dispositivo
Request
ENDPOINT
/account/ACCOUNT_KEY/device/DEVICE_KEYMÉTODO
GETPath Params
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
account_key | uuidv4 | Chave única de identificação da conta. | 36 |
device_key | uuidv4 | Chave única de identificação do dispositivo. | 36 |
Response
STATUS
200Response Body: Dispositivo encontrado
{
"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 Params
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
device_key * | uuidv4 | Chave única de identificação do dispositivo no formato uuid v4 | 36 |
session_id * | uuidv4 | Identificador da sessão obtido via device_scan | 36 |
analysis_status * | string | Status da análise do motor de fraude | Enumeradores analysis_status |
status * | string | Status do dispositivo | Enumeradores status |
device_registration_data * | object | Dados de registro do dispositivo | Objeto device_registration_data |
analysis_status_events * | array | Histórico de eventos de mudança de status de análise | - |
status_events * | array | Histórico de eventos de mudança de status do dispositivo | - |
registration_date * | string | Data de registro do dispositivo no formato ISO (UTC - "YYYY-MM-DDTHH:MM:SSZ") | 20 |
created_at * | string | Data de criação do dispositivo no formato ISO (UTC - "YYYY-MM-DDTHH:MM:SSZ") | 20 |
Objeto device_registration_data
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
device_key * | uuidv4 | Chave única de identificação do dispositivo no formato uuid v4 | 36 |
session_id * | uuidv4 | Identificador da sessão obtido via device_scan | 36 |
document_number | string | Número do documento (CPF/CNPJ) do usuário | 14 |
registration_date * | string | Data de registro no formato ISO com fuso horário | 25 |
face_recognition_key | uuidv4 | Chave de reconhecimento facial (quando aplicável) | 36 |
Objeto analysis_status_event
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
new_analisys_status * | string | Novo status de análise | Enumeradores analysis_status |
reason | string | Razão da mudança de status (quando aplicável) | - |
reason_description | string | Descrição da razão da mudança de status (quando aplicável) | - |
event_date * | string | Data do evento no formato ISO (UTC - "YYYY-MM-DDTHH:MM:SSZ") | 20 |
Objeto status_event
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
new_status * | string | Novo status do dispositivo | Enumeradores status |
event_date * | string | Data do evento no formato ISO (UTC - "YYYY-MM-DDTHH:MM:SSZ") | 20 |
Enumeradores analysis_status
| Enumerador | Descrição |
|---|---|
| automatically_approved | Aprovado automaticamente pelo motor de fraude |
| automatically_reproved | Reprovado automaticamente pelo motor de fraude |
| pending | Pendente de análise |
Enumeradores status
| Enumerador | Descrição |
|---|---|
| registered | Dispositivo registrado |
| disabled | Dispositivo desativado |
| pending | Dispositivo pendente de aprovação |
STATUS
4xxResponse Body: Error
{
"title": "titulo",
"description": "description in English",
"translation": "descrição em portugues",
"code": "codigo",
"extra_fields": {}
}
Código HTTPstatus | Código QIcode | Títulotitle | Descrição (eng)description | Descrição (ptbr)translation |
|---|---|---|---|---|
| 400 | QIT000001 | Bad Request | Schema Error | Erro de Schema |
| 404 | OBD000002 | Not Found | Bank account not found | Conta não encontrada |
| 404 | OBD000100 | Device not found | No device is associated with the provided device_key. | Nenhum dispositivo está associado à device_key fornecida. |