Query device

Request

ENDPOINT

/account/ACCOUNT_KEY/device/DEVICE_KEY

METHOD

GET

Path Params

Field	Type	Description	Characters
account_key	uuidv4	Unique account identification key.	36
device_key	uuidv4	Unique device identification key.	36

Response

STATUS

200

Response Body: Device found

{
  "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

Field	Type	Description	Characters
device_key *	uuidv4	Unique device identification key in uuid v4 format	36
session_id *	uuidv4	Session identifier obtained via device_scan	36
analysis_status *	string	Fraud engine analysis status	analysis_status Enumerators
status *	string	Device status	status Enumerators
device_registration_data *	object	Device registration data	device_registration_data Object
analysis_status_events *	array	History of analysis status change events	-
status_events *	array	History of device status change events	-
registration_date *	string	Device registration date in ISO format (UTC - "YYYY-MM-DDTHH:MM:SSZ")	20
created_at *	string	Device creation date in ISO format (UTC - "YYYY-MM-DDTHH:MM:SSZ")	20

device_registration_data Object

Field	Type	Description	Characters
device_key *	uuidv4	Unique device identification key in uuid v4 format	36
session_id *	uuidv4	Session identifier obtained via device_scan	36
document_number	string	User's document number (CPF/CNPJ)	14
registration_date *	string	Registration date in ISO format with timezone	25
face_recognition_key	uuidv4	Face recognition key (when applicable)	36

analysis_status_event Object

Field	Type	Description	Characters
new_analisys_status *	string	New analysis status	analysis_status Enumerators
reason	string	Reason for status change (when applicable)	-
reason_description	string	Description of the reason for status change (when applicable)	-
event_date *	string	Event date in ISO format (UTC - "YYYY-MM-DDTHH:MM:SSZ")	20

status_event Object

Field	Type	Description	Characters
new_status *	string	New device status	status Enumerators
event_date *	string	Event date in ISO format (UTC - "YYYY-MM-DDTHH:MM:SSZ")	20

analysis_status Enumerators

Enumerator	Description
automatically_approved	Automatically approved by fraud engine
automatically_reproved	Automatically rejected by fraud engine
pending	Pending analysis

status Enumerators

Enumerator	Description
registered	Registered device
disabled	Disabled device
pending	Device pending approval

STATUS

4xx

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

HTTP Code status	QI Code code	Title title	Description (eng) description	Description (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.