Pular para o conteúdo principal

Consultar dispositivo

Request​

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

Path Params​

CampoTipoDescriçãoCaracteres
account_keyuuidv4Chave única de identificação da conta.36
device_keyuuidv4Chave única de identificação do dispositivo.36

Response​

STATUS
200
Response 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​

CampoTipoDescriçãoCaracteres
device_key *uuidv4Chave única de identificação do dispositivo no formato uuid v436
session_id *uuidv4Identificador da sessão obtido via device_scan36
analysis_status *stringStatus da análise do motor de fraudeEnumeradores analysis_status
status *stringStatus do dispositivoEnumeradores status
device_registration_data *objectDados de registro do dispositivoObjeto device_registration_data
analysis_status_events *arrayHistórico de eventos de mudança de status de análise-
status_events *arrayHistórico de eventos de mudança de status do dispositivo-
registration_date *stringData de registro do dispositivo no formato ISO (UTC - "YYYY-MM-DDTHH:MM:SSZ")20
created_at *stringData de criação do dispositivo no formato ISO (UTC - "YYYY-MM-DDTHH:MM:SSZ")20

Objeto device_registration_data​

CampoTipoDescriçãoCaracteres
device_key *uuidv4Chave única de identificação do dispositivo no formato uuid v436
session_id *uuidv4Identificador da sessão obtido via device_scan36
document_numberstringNúmero do documento (CPF/CNPJ) do usuário14
registration_date *stringData de registro no formato ISO com fuso horário25
face_recognition_keyuuidv4Chave de reconhecimento facial (quando aplicável)36

Objeto analysis_status_event​

CampoTipoDescriçãoCaracteres
new_analisys_status *stringNovo status de análiseEnumeradores analysis_status
reasonstringRazão da mudança de status (quando aplicável)-
reason_descriptionstringDescrição da razão da mudança de status (quando aplicável)-
event_date *stringData do evento no formato ISO (UTC - "YYYY-MM-DDTHH:MM:SSZ")20

Objeto status_event​

CampoTipoDescriçãoCaracteres
new_status *stringNovo status do dispositivoEnumeradores status
event_date *stringData do evento no formato ISO (UTC - "YYYY-MM-DDTHH:MM:SSZ")20

Enumeradores analysis_status​

EnumeradorDescrição
automatically_approvedAprovado automaticamente pelo motor de fraude
automatically_reprovedReprovado automaticamente pelo motor de fraude
pendingPendente de análise

Enumeradores status​

EnumeradorDescrição
registeredDispositivo registrado
disabledDispositivo desativado
pendingDispositivo pendente de aprovação
STATUS
4xx
Response Body: Error
{
"title": "titulo",
"description": "description in English",
"translation": "descrição em portugues",
"code": "codigo",
"extra_fields": {}
}
Código HTTP
status
Código QI
code
Título
title
Descrição (eng)
description
Descrição (ptbr)
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.