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. As informações citadas abaixo devem seguir os padrões estabelecidos, mas quaisquer campos podem ser adicionados aos dados da conta caso seja necessário.

Definição do Objeto Account

Request Body

{
  "person_id": "12345678",
  "document_number": "111.111.111-11",
  "registration_date": "2019-12-11T11:37:15.12-03:00",
  "account_data": {
    "name": "Joao da Silva",
    "email": "person@email.com",
    "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.
registration_date	datetime	Data e hora do registro da pessoa associada à conta, com fuso horário. (obrigatório)
account_data	object	objeto que pode conter quais quer dados da pessoa, mas se conter o nome name, email email, e telefone phone sendo o telefone um objeto com os campos number, international_dial_code e area_code, todos os objetos citados devem ser do tipo string.

Enviar um Person

Request Body

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

Response Body

  {
    "person_id": "12345678",
    "document_number": "111.111.111-11",
    "registration_date": "2019-12-11T11:37:15.12-03:00",
    "email": "person@email.com",
    "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