5 - Funções da conta

5.0 - Conceituação

Essa seção visa descrever as rotas do escopo funções da conta.

5.1 - Documento da conta

[GET] /api/v1/account/document

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Condição	Tipo
document (QueryParam)	document do cliente	Sim		String

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na consulta	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String
data	Dados do cliente	Object
data.full_name	Nome completo do cliente	String
data.document	Documento do cliente	String
data.avatar_url	URL do avatar do cliente	String

{
    "success": "true",
    "code": "200",
    "message": "Documneto encontrado",
    "data": {
        "full_name": "Fulano",
        "document": "12345678910",
        "avatar_url": "https://"
    }
}

5.2 - Consultar CEP

[GET] /api/v1/account/consultcep/:cep

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Condição	Tipo
cep (PathParam)	Cep	Sim		String

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na consulta	Boolean
code	Código de sucesso	Number
data	Dados do endereço	Object
data.cep	CEP	String
data.logradouro	Logradouro	String
data.complemento	Complemento	String
data.bairro	Bairro	String
data.localidade	Cidade	String
data.uf	Unidade Federativa (UF)	String
data.ibge	Código IBGE do município	String
data.gia	Código GIA	String
data.ddd	Código DDD	String
data.siafi	Código SIAFI	String
message	Mensagem da operação	String

{
    "success": "true",
    "code": "200",
    "data": {
        "cep": "12345-678",
        "logradouro": "Rua Yuki hashira",
        "complemento": "",
        "bairro": "Hakasaki nilan",
        "localidade": "Presidente Prudente",
        "uf": "SP",
        "ibge": "1457895",
        "gia": "4586",
        "ddd": "18",
        "siafi": "3645"
    },
    "message": "Cep consultado"
}

5.3 - Atualizar endereço

[POST] /api/v1/account/updateaddress

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Tipo
postal_code	CEP do endereço	Sim	String
address_type_id	Tipo de endereço (Domínio 1.3)	Sim	String
street	Nome da rua, avenida ou logradouro	Sim	String
number	Número do endereço	Sim	String
neighborhood	Bairro	Sim	String
state	Sigla da unidade federativa (2 caracteres)	Sim	String
city	Nome da cidade	Sim	String
country	Código do país no padrão ISO 3166-1 Alpha-2 (2 caracteres). Ex.: BR	Sim	String
complement	Complemento do endereço	Não	String

{
    "postal_code": "04538133",
    "address_type_id": "2",
    "street": "Avenida Brigadeiro Faria Lima",
    "number": "3477",
    "neighborhood": "Itaim Bibi",
    "state": "SP",
    "city": "São Paulo",
    "country": "BR",
    "complement": "Conjunto 102"
}

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na operação	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String

{
    "success": "true",
    "code": "200",
    "message": "Endereço atualizado"
}

5.4 - Consultar conta bancária

[GET] /api/v1/account

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Indica se a operação foi executada com sucesso	Boolean
message	Mensagem descritiva do resultado da operação	String
code	Código de retorno da operação	Number
data	Dados da conta bancária consultada	Object
data.type_b_account	Tipo da conta bancária	String
data.bank_code	Código da instituição financeira	String
data.bank_name	Nome da instituição financeira	String
data.agency	Número da agência bancária	String
data.account_number	Número da conta bancária	String
data.account_digit	Dígito verificador da conta	String
data.account_id	Identificador único da conta bancária	String
data.created_at	Data de criação do cadastro da conta	String
data.ispb	Código ISPB da instituição financeira	String
data.wl_id	Identificador da Whitelabel vinculada à conta	String
data.id	Identificador único do cliente	String

{
    "success": true,
    "message": "Dados da conta bancária consultados",
    "code": 200,
    "data": {
        "type_b_account": "Conta Corrente",
        "bank_code": "341",
        "bank_name": "BANCO TESTE S.A.",
        "agency": "1234",
        "account_number": "98765432-1",
        "account_digit": "1",
        "account_id": "f3c9e7b1-8d52-4a8d-b6c4-91a5d2f7e8a0",
        "created_at": "2026-06-15T10:30:45Z",
        "ispb": "60701190",
        "wl_id": "7a2f8c9d-5b61-4c8f-9d23-8e5a7b4c1d90",
        "id": "c4b7d8f9-3e21-4a65-9f70-2d8c6e1b5a34"
    }
}

5.5 - Consultar endereço

[GET] /api/v1/account/address

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na consulta	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String
address	Dados do endereço	Object
address.postal_code	CEP	String
address.country	País	String
address.state	Estado	String
address.neighborhood	Bairro	String
address.city	Cidade	String
address.street	Logradouro	String
address.number	Número	String
address.number	Complemento	String

{
    "success": "true",
    "code": "200",
    "message": "Endereço",
    "address": {
        "postal_code": "12345678",
        "country": "Brasil",
        "state": "SP",
        "neighborhood": "Jd. Hyorashi",
        "city": "Presidente Prudente",
        "street": "Gyuski tashyran",
        "number": "190",
        "complement": null
    }
}

5.6 - Solicitar encerramento de conta

[GET] /api/v1/account/closingaccount

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na operação	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String

{
    "success": "true",
    "code": "200",
    "message": "Solicitação de encerramento realizada"
}

5.7 - Consultar avatar

[GET] /api/v1/user/avatar

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na operação	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String
avatar_url	URL da imagem de avatar	String

{
    "success": "true",
    "code": "200",
    "message": "",
    "avatar_url": "https://"
}

5.8 - Alterar avatar

[POST] /api/v1/user/avatar

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Tipo
file	Arquivo enviado em formato Base64	Sim	String

{
    "file": {{arquivo_base64}}
}

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na operação	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String
avatar_url	URL da imagem de avatar	String

{
    "success": "true",
    "code": "200",
    "message": "",
    "avatar_url": "https://"
}

5.9 - Consultar Indicados

[GET] /api/v1/account/myrecommendations

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na consulta	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String
data	Lista de usuários	Array
data.[].name	Nome do usuário	String
data.[].email	E-mail do usuário	String
data.[].active	Status de ativação	Number
data.[].id	ID do usuário	String

{
    "success": true,
    "code": 200,
    "message": "indicados consultados com sucesso",
    "data": [
        {
            "name": "Fulano",
            "email": "fulano@gmail.com",
            "active": false,
            "id": "10e680cc-98f2-4d66-841b-1172dc2d6cd5"
        }
    ]
}

5.10 - Cadastrar Indicados

[POST] /api/v1/account/myrecommendations

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Tipo
indicated_name	Nome completo da pessoa indicada	Sim	String
indicated_email	Endereço de e-mail da pessoa indicada	Sim	String

{
    "indicated_name": "Indicação teste",
    "indicated_email": "nome@gmail.com"
}

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na operação	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String

{
    "success": "true",
    "code": "200",
    "message": "Convite enviado com sucesso!"
}

5.11 - Reenvia email para o indicado

[POST] /api/v1/account/myrecommendations/:id

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Condição	Tipo
id (PathParam)	id da indicação	Sim		String

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na operação	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String

{
    "success": "true",
    "code": "200",
    "message": "Convite reenviado com sucesso!"
}

5.12 - Deletar indicado

[DELETE] /api/v1/account/myrecommendations/:id

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Condição	Tipo
id (PathParam)	id da indicação	Sim		String

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na operação	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String

{
    "success": true,
    "code": 200,
    "message": "Indicação excluída"
}

5.13 - Consulta o cliente

[GET] /api/v1/account/consult

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Tipo
document (QueryParam)	Documento do cliente	Não	String

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na consulta	Boolean
message	Mensagem da operação	String
data	Dados da indicação	Object
data.name	Nome completo	String
data.document	Documento (CPF/CNPJ)	String
data.birthdate	Data de nascimento	String
data.email	E-mail	Number
data.type_account	Tipo de conta	Number
data.bank_account	Dados da conta bancária	Object
data.bank_account.agency	Número da agência	String
data.bank_account.account_number	Número da conta	String
data.bank_account.account_digit	Dígito da conta	String
data.data_cadastro	Data de cadastro	String
code	Código de sucesso	Number

{
    "success": "true",
    "message": "Cliente consultado",
    "data": {
        "name": "Fulano da silva",
        "document": "41254788541",
        "birthdate": "2002-10-17",
        "email": "fulanosilva@gmail.com",
        "type_account": "cpf",
        "bank_account": {
            "agency": "0001",
            "account_number": "30314",
            "account_digit": "1"
        },
        "data_cadastro": "27/09/2023 10:06:00"
    },
    "code": "200"
}

5.14 - Listar notificações

[GET] /api/v1/notifications/getnotifications

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Tipo
limit (QueryParam)	limite de notificações	Não	Number

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na consulta	Boolean
code	Código de sucesso	Number
current_page	Página atual	Number
total_pages	Total de páginas	Number
per_page	Quantidade de registros por página	Number
notification	Lista de notificações	Array
notification.[].message	Mensagem da notificação	String
notification.[].is_read	Indicador de leitura	Number
notification.[].date	Data da notificação	String

{
    "success": "true",
    "code": "201",
    "current_page": "1",
    "total_pages": "1",
    "per_page": "1",
    "notification": [
        {
            "message": "Pix recebido de Ciclano da Silva, no valor de R$99,90",
            "is_read": "0",
            "date": "2023-11-11 08:00:00"
        }
    ]
}