Objeto Person

A conta pode ter mais de um usuário acessando-a, logo cada usuário deve ter seu registro para segregar ações em contas conjuntas.

Definição do Objeto Account

Request Body

{
  "person_id": "12345678",
  "document_number": "111.111.111-11",
  "account_data": {
    "name": "Joao da Silva",
    "phone": {
      "number": "999999999",
      "international_dial_code": "55",
      "area_code": "11"
    }
  }
}

Todas as trocas de informação de uma pessoa 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.

nome	tipo	descrição
person_id	string	Identificador da pessoa. É essencial que este número seja único para cada pessoa (obrigatório)
document_number	string	número do documento podendo ser cpf ou cnpj com pontuação.(obrigatório)
account_data	object	objeto que pode conter quais quer dados da pessoa, mas deve conter no mínimo o nome name e telefone phone sendo o telefone um objeto com os campos number, international_dial_code e area_code todos do tipo string.

Enviar um Person

Request Body

  {
    "person_id": "12345",
    ...
  }

Response Body

  {
    "person_id": "12345678",
    "document_number": "111.111.111-11",
    "account_data": {
      "name": "Joao da Silva",
      "phone": {
        "number": "999999999",
        "international_dial_code": "55",
        "area_code": "11"
      }
    }
  }

Para realizar a criação de uma pessoa, basta enviar um objeto do tipo Person ao seguinte endpoint:

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