Skip to main content

Objeto Device

O registro de um dispositivo com identificação única deve ser realizada através do endpoint de Device. Para que o cadastro seja efetivado é necessário a utilização da Device scan para que a identificação desse dispositivo, seja salva e identificada posteriormente.

Dinâmica dos Status - status​

O status status relacionado ao status do dispositivo. Os seguintes status estão disponíveis:

  • registered
  • not_registered
  • deactivated

Dinâmica dos Status - analysis_status​

O status analysis_status indica o status da decisão do motor de fraude e possui uma máquina de estados bastante simples:

  • automatically_approved
  • automatically_reproved
  • pending

Definição do Objeto Device​

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

Todas as trocas de informação de um cadastro utilizam a seguinte definição para este objeto. Em alguns casos, para facilitar a implementação e diminuir o fluxo de dados entre as partes, algumas informações poderão ser omitidas.

nometipodescrição
device_idstringIdentificador do dispositivo.
É essencial que este número seja único para cada dispositivo (obrigatório)
session_idstringIdentificador da sessão na Device Scan. (obrigatório)
face_recognition_keystringIdentificador da imagem para biometria facial caso o produto seja contratado.
mfa_statusstringStatus do MFA do cadastro podendo estar entre os seguintes valores: approved reproved
registration_datedatetimeA data e hora de início do cadastro, com fuso horário. (obrigatório)

Enviar um Device Registration​

Request Body
  {
    "device_id": "12345",
    ...
  }
Response Body
  {
    "device_id": "12345",
    "status": "registered",
    "analysis_status": "automatically_approved",
    "reason": "rule_decision_enum",
    "reason_desciption": "Descrição da regra"
  }

Para realizar o registro de um Dispositivo, basta enviar um objeto do tipo Device ao seguinte endpoint:

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