Criação de Conta
O Produto de Monitoramento de Conta é dividido entre Conta Pessoa Física e Conta Pessoa Jurídica, onde uma Conta Pessoa Física pode possuir apenas pessoas físicas, enquanto a Conta Pessoa Júridica pode possuir tanto pessoas jurídicas quanto físicas. Para realizar a criação de uma conta basta enviar um objeto do tipo Account para um dos seguintes endpoints:
- Conta Pessoa Física
POST https://api.caas.qitech.app/account_monitoring/natural_person_account
Exemplo
{
"account_id": "5ce7fab5-8165-44a5-9b89-bb2d6d61e4f4",
"registration_date": "2019-12-20T15:23:12"
}
- Conta Pessoa Jurídica
POST https://api.caas.qitech.app/account_monitoring/legal_person_account
Exemplo
{
"account_id": "5ce7fab5-8165-44a5-9b89-bb2d6d61e4f4",
"registration_date": "2019-12-20T15:23:12"
}
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.
nome | tipo | descrição |
---|---|---|
account_id | string | Identificador único da conta. É essencial que este número seja único para cada requisição |
registration_date | string (ISO 8601) | Data e hora do cadastro. |
Desativação e Reativação de Conta
Para realizar a desativação de contas dentro do produto de monitoramento de contas, deve-se realizar uma requisição no seguinte endpoint com o seguinte payload, passando o campo de new_account_status como 'deactivated':
- Conta Pessoa Física
PATCH https://api.caas.qitech.app/account_monitoring/natural_person_account/{account_id}
Exemplo
{
"new_account_status" : "deactivated"
}
- Conta Pessoa Jurídica
PATCH https://api.caas.qitech.app/account_monitoring/legal_person_account/{account_id}
Exemplo
{
"new_account_status" : "deactivated"
}
Isso desativará a conta e interromperá seu monitoramento. Para reativar uma conta, e consequentemente retomar seu monitoramento, basta realizar uma requisição no seguinte endpoint com o seguinte payload, passando agora o new_account_status como 'active':
- Conta Pessoa Física
PATCH https://api.caas.qitech.app/account_monitoring/natural_person_account/{account_id}
Exemplo
{
"new_account_status" : "active"
}
- Conta Pessoa Jurídica
PATCH https://api.caas.qitech.app/account_monitoring/legal_person_account/{account_id}
Exemplo
{
"new_account_status" : "active"
}
Ao se realizar a reativação de uma conta, os interavalos de monitoramento dos tópicos da conta serão reiniciados. Por exemplo, caso todos os tópicos sejam monitorados de 24 em 24 horas, no momento da reativação da conta, as atualizações serão realizadas 24 horas após a reativação.