Skip to main content

Account Object

The account is an organizational entity that allows for device registration. This API was designed to comply with BACEN Regulation 491; therefore, account data must follow a standard regarding information defined by the Central Bank, but any other necessary fields may be added to the account data.

Account Object Definition​

Request Body
{
  "account_id": "12345678",
  "account_type": "natural_person",
  "registration_date": "2019-12-11T11:37:15.12-03:00",
  "account_data": {
    "account_number": "12345678",
    "agency_number": "1234"
    ...
  }
}
</details>

All information exchanges regarding an account 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
:----: | :----: | ---------
account_id | string | Account identifier. <br /> It is essential that this number be unique for each account. *(mandatory)*
account_type | string | Identifier of the account type registered in the device registration system. Accounts can be of the natural person type `natural_person` or legal person type `legal_person` .*(mandatory)*
registration_date | datetime | Date and time of the account registration, with timezone. *(mandatory)*
account_data | object | object that may contain any account data, but if it contains the account number `account_number` and agency `agency_number`, both must be of the string type.

## Send an Account

<details>
<summary>
<strong>Request Body</strong>
</summary>
<div></div>

```json
  {
    "account_id": "12345",
    ...
  }
Response Body
  {
    "account_id": "12345678",
    "account_type": "natural_person",
    "registration_date": "2019-12-11T11:37:15.12-03:00",
    "account_data": {
      "account_number": "12345678",
      "agency_number": "1234"
      ...
    }
  }

To create an account, simply send an Account type object to the following endpoint:

POST https://api.caas.qitech.app/device_manager/account