Device Object

Device registration with unique identification must be performed via the Device endpoint. For the registration to be effective, the use of Device Scan is required so that the device identification is recorded for future recognition.

Status Dynamics - status

The status field indicates the current situation of the device. The following statuses are available:

• registered
• not_registered
• deactivated

Status Dynamics - analysis_status

The analysis_status field indicates the decision status of the fraud engine and follows this state flow:

• automatically_approved
• automatically_reproved
• pending

Device Object Definition

Request Body

{
  "device_id": "12345678",
  "session_id": "12345678",
  "face_recognition_key": "12345678",
  "document_number": "111.111.111-11",
  "mfa_status": "approved",
  "registration_date": "2019-12-11T11:37:15.12-03:00"
}

All information exchanges regarding a registration use the following definition for this object. In some cases, to facilitate implementation and reduce data flow between parties, some information may be omitted.

name	type	description
device_id	string	Device identifier. It is essential that this number be unique for each device (mandatory)
session_id	string	Session identifier in Device Scan. (mandatory)
face_recognition_key	string	Image identifier for facial biometrics if the product is contracted as registration 2FA.
document_number	string	User document for face validation. It should only be sent if not informed during the Person object registration.
mfa_status	string	Registration MFA status, which can be one of the following values: approved reproved
registration_date	datetime	The start date and time of the registration, with timezone. (mandatory)

Attention

The document_number field is necessary for face validation in the database; therefore, if it was not provided during user registration, it is mandatory. It must never differ from the one registered in the Person object.

Register a Device

Request Body

  {
    "device_id": "12345",
    ...
  }

Response Body

  {
    "device_id": "12345",
    "status": "registered",
    "analysis_status": "automatically_approved",
    "reason": "rule_decision_enum",
    "reason_description": "Descrição da regra"
  }

To register a Device, simply send a Device type object to the following endpoint:

POST https://api.caas.qitech.app/device_manager/account/{account_id}/person/{person_id}/device