API V1 Users method group

/api/v1/users/local/authenticate
POST

Autentica um usuário com credenciais locais (email + senha) e estabelece uma sessão no servidor.
Após o login bem-sucedido, o servidor retorna o texto OK e define cookies
(session_id, access_token, refresh_token), que são usados para solicitações autorizadas subsequentes.

URL

https://quickex.io/api/v1/users/local/authenticate

Authorization Required

Não (login público com credenciais locais).

Headers

• Accept: application/json
• Content-Type: application/json

Request Body (JSON)

{
  "browserFingerprint": "1231231231231231212312312",
  "email": "test@test.com",
  "password": "testtest"
}

Request Example (cURL)

curl -X POST \
  'https://quickex.io/api/v1/users/local/authenticate' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "browserFingerprint": "1231231231231231212312312",
    "email": "test@test.com",
    "password": "testtest"
  }'

Responses

Uma resposta bem-sucedida inclui os cabeçalhos Set-Cookie e session-id, que estabelecem a sessão do usuário.

Notes

• Armazene tokens e cookies apenas em locais seguros (cookies HttpOnly/Secure, variáveis de ambiente, cofres de segredos).
• browserFingerprint deve permanecer consistente para um dispositivo/navegador específico.
• Após o login, utilize os cookies emitidos para chamar métodos protegidos da API v1.

Inicia o processo de redefinição de senha. Um código de recuperação será enviado para o endereço de email especificado.
Esse código deve ser salvo para uso posterior com o método /api/v1/users/local/reset-password.

URL

https://quickex.io/api/v1/users/local/request-password-reset

Authorization Required

Não (solicitação pública de redefinição de senha).

Headers

• Accept: application/json
• Content-Type: application/json

Request Body (JSON)

{
  "email": "user@example.com"
}

Request Example (cURL)

curl -X POST \
  'https://quickex.io/api/v1/users/local/request-password-reset' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "user@example.com"
  }'

Responses

{
  "status": "ERR_VALIDATION",
  "message": "Validation Exception",
  "data": {
    "email": {
      "isEmail": "email must be an email"
    }
  }
}

Notes

• Após chamar este método, o email especificado receberá um código de recuperação de senha.
• Guarde esse código — ele é necessário para a próxima etapa com o método /api/v1/users/local/reset-password.
• Se o email não existir ou for inválido, o servidor retornará um erro de validação (400).

Conclui o processo de redefinição de senha. O usuário deve fornecer o código de recuperação recebido por email como resultado da chamada
/api/v1/users/local/request-password-reset, juntamente com a nova senha.
Se bem-sucedida, a senha será atualizada e o usuário poderá fazer login com as novas credenciais.

URL

https://quickex.io/api/v1/users/local/reset-password

Authorization Required

Não (o código de recuperação é usado).

Headers

• Accept: application/json
• Content-Type: application/json

Request Body (JSON)

{
  "resetCode": "1231231231231231212312312",
  "password": "testtest",
  "email": "test@example.com"
}

Request Example (cURL)

curl -X POST \
  'https://quickex.io/api/v1/users/local/reset-password' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "resetCode": "1231231231231231212312312",
    "password": "testtest",
    "email": "test@example.com"
  }'

Responses

Notes

• Este método só deve ser usado após chamar /api/v1/users/local/request-password-reset.
• O código de recuperação possui um período de validade limitado.
• Após redefinir a senha com sucesso, use as novas credenciais para fazer login via /api/v1/users/local/authenticate.

Renova o access_token utilizando um refresh_token.
Este método é usado quando o access_token atual expirou.
Ele retorna um novo access_token, que deve ser utilizado para solicitações subsequentes a endpoints protegidos.

URL


https://quickex.io/api/v1/users/authentication/refresh


Authorization Required

Sim (é necessário um refresh_token válido enviado nos cookies).

Headers

• Accept: application/json
• Content-Type: application/json
• Cookie: refresh_token={REFRESH_TOKEN}

Request Body (JSON)

{
  "browserFingerprint": "1231231231231231212312312"
}

Request Example (cURL)

curl -X POST \
  'https://quickex.io/api/v1/users/authentication/refresh' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --cookie "refresh_token=YOUR_REFRESH_TOKEN" \
  -d '{
    "browserFingerprint": "1231231231231231212312312"
  }'

Responses

Notes

• Este método é usado apenas para renovar o access_token. Um novo refresh_token não é emitido.
• browserFingerprint deve ser o mesmo informado no login via /api/v1/users/local/authenticate.
• Sempre armazene e envie o refresh_token apenas em cookies seguros (HttpOnly, Secure).

Retorna os dados da conta de um usuário autenticado: ID, e-mail e um conjunto de permissões.
Usado pelo cliente após o login para determinar quais seções/ações estão disponíveis na interface.

URL


https://quickex.io/api/v1/users/account-data


Authorization Required

Sim — é necessário um cookie de sessão válido emitido pelo método /api/v1/users/local/authenticate.

Headers

• Accept: application/json
• Cookie (por exemplo, session_id=...)

Parameters

Nenhum

Request Example (cURL)

curl -X GET \
  'https://quickex.io/api/v1/users/account-data' \
  -H 'Accept: application/json' \
  --cookie "session_id=YOUR_SESSION_ID"

Response Example (200)

{
  "userId": 42,
  "email": "user@example.com",
  "permissions": "USER",
  "adminPermissionsScope": {
    "ORDERS": { "READ": true, "CONFIGURE": false, "PROCESS": true, "CREATE_LARGE_ADDITIONAL_WITHDRAWALS": false, "ENABLE_MANUAL_PROCESSING": false },
    "INSTRUMENTS": { "READ": true, "UPDATE": false },
    "PAIRS": { "READ": true, "UPDATE": false },
    "BESTCHANGE": { "READ": true, "UPDATE": false },
    "USERS": { "READ": true, "UPDATE": false },
    "API_KEYS": { "READ": true, "UPDATE": false },
    "STATS": { "READ": true },
    "AFFILIATES": { "READ": true, "UPDATE": false },
    "PLATFORM_FEE_COLLECTION": { "READ": true, "UPDATE": false },
    "TRANSLATION": { "READ": true, "UPDATE": false }
  }
}

Responses

Notes

• adminPermissionsScope detalha os direitos dos subsistemas (leitura/atualização/processamento, etc.).
• Se o frontend não exigir permissões administrativas, apenas os campos userId, email e permissions podem ser utilizados.
• Para renovar a sessão, utilize o método /api/v1/users/authentication/refresh (se aplicável ao seu fluxo).

Encerra a sessão atual do usuário.
Usado para fazer logout e invalidar tokens de autorização ativos (ou cookies).

URL


https://quickex.io/api/v1/users/authentication/logout


Authorization Required

Sim — o usuário deve estar autenticado.

Headers

• Accept: application/json

Request Body

Não é necessário (um corpo vazio é enviado).

Request Example (cURL)

curl -X POST \
  'https://quickex.io/api/v1/users/authentication/logout' \
  -H 'Accept: application/json' \
  --cookie "session_id=YOUR_SESSION_ID" \
  -d ''

Response Example (201)

OK

Responses

Notes

• Este método encerra apenas a sessão atual. Se o usuário estiver conectado em vários dispositivos, as outras sessões permanecerão ativas.
• Após chamar este método, o usuário deve se autenticar novamente para acessar métodos privados.
• Se o cookie ou token tiver expirado antes da chamada, o servidor retornará o erro 401 Unauthorized.

Gera uma nova chave de API para o usuário autenticado.
A chave consiste em um par: publicKey e secretKey, que são usadas ao trabalhar com os métodos da API v2.
Além disso, é possível especificar uma lista de endereços IP confiáveis (whitelist) e o status ativo da chave.

URL


https://quickex.io/api/v1/users/generate-api-key


Authorization Required

Sim — o método está disponível apenas para usuários autenticados.

Headers

• Accept: application/json
• Content-Type: application/json
• Cookie de Sessão (session_id=...)

Request Body (JSON)

{
  "name": "Api name / App name",
  "whiteListIp": [
    "127.0.0.1",
    "127.0.0.2"
  ],
  "isActive": true
}

Request Example (cURL)

curl -X POST \
  'https://quickex.io/api/v1/users/generate-api-key' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --cookie "session_id=YOUR_SESSION_ID" \
  -d '{
    "name": "Api name / App name",
    "whiteListIp": ["127.0.0.1", "127.0.0.2"],
    "isActive": true
  }'

Response Example (200)

{
  "apiId": 1,
  "name": "Api name / App name",
  "publicKey": "pk_123456789",
  "secretKey": "sk_987654321",
  "whiteListIp": ["127.0.0.1","127.0.0.2"],
  "isActive": true,
  "createdAt": "2025-08-26 12:16:20"
}

Responses

Notes

• Public Key é usada para identificar o cliente.
• Secret Key é armazenada apenas pelo usuário e é usada para assinar requisições na API v2.
• É recomendado restringir o uso da chave de API por IP (whiteListIp) para maior segurança.
• Se a secretKey for perdida, não pode ser recuperada — uma nova chave deve ser gerada.

Retorna uma lista de todas as chaves de API criadas pelo usuário.
O método permite visualizar chaves ativas e inativas, seus parâmetros (nome, lista de IPs permitidos, status), bem como a data de criação.
Utilizado para gerenciar chaves na conta pessoal do usuário.

URL


https://quickex.io/api/v1/users/list-api-key


Authorization Required

Sim — o usuário deve estar autenticado (cookie de sessão ou token de acesso).

Parameters

Nenhum

Request Example (cURL)

curl -X GET \
  'https://quickex.io/api/v1/users/list-api-key' \
  -H 'Accept: application/json' \
  --cookie "session_id=YOUR_SESSION_ID"

Response Example (200)

[
  {
    "apiId": 1,
    "name": "Api name / App name",
    "publicKey": "pk_123456789",
    "whiteListIp": [
      "127.0.0.1",
      "127.0.0.2"
    ],
    "isActive": true,
    "createdAt": "2025-08-26 12:16:20"
  }
]

Responses

Notes

• publicKey é usada nos cabeçalhos das requisições da API v2.
• secretKey é retornada apenas quando a chave é criada via /generate-api-key e não aparece na lista.
• whiteListIp restringe o uso da chave apenas aos endereços IP especificados.
• Para desativar ou excluir uma chave, devem ser usados métodos específicos de gerenciamento de chaves (se disponíveis).

Exclui uma chave de API gerada anteriormente.
Após a exclusão, a chave se torna inválida e não pode mais ser usada para autenticar requisições na API v2.

URL


https://quickex.io/api/v1/users/delete-api-key


Authorization Required

Sim — o método está disponível apenas para usuários autenticados.

Headers

• Accept: application/json
• Content-Type: application/json
• Session Cookie (session_id=...)

Request Body (JSON)

{
  "apiId": 1
}

Request Example (cURL)

curl -X POST \
  'https://quickex.io/api/v1/users/delete-api-key' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --cookie "session_id=YOUR_SESSION_ID" \
  -d '{
    "apiId": 1
  }'

Response Example (200)

true

Responses

Notes

• Após a exclusão, a chave não pode ser restaurada. Para acessar a API v2, uma nova chave deve ser gerada.
• O método aceita apenas o identificador da chave (apiId) obtido na lista de chaves (/api/v1/users/list-api-key).
• A exclusão é recomendada em casos de comprometimento da chave ou quando a integração não é mais necessária.

Retorna o status atual de KYC (Know Your Customer) do usuário autenticado.
Este método é usado para verificar se o usuário passou pela verificação de identidade, bem como para obter o motivo da rejeição caso a verificação não tenha sido bem-sucedida.

URL


https://quickex.io/api/v1/users/kyc/status


Authorization Required

Sim — é necessária uma sessão de usuário válida.

Headers

• Accept: application/json
• Session cookie (access_token=...)

Parameters

Nenhum

Request Example (cURL)

curl -X GET \
  'https://quickex.io/api/v1/users/kyc/status' \
  -H 'Accept: application/json' \
  --cookie "access_token=YOUR_TOKEN"

Example Response (200)

{
  "status": "PASS",
  "rejectReason": "ID_INFO_INVALID"
}

Possible status values

• PENDING — verificação de documentos em andamento.
• PASS — verificação concluída com sucesso.
• REJECTED — verificação rejeitada.

Responses

Notes

• Este método apenas retorna o status — o envio de documentos para KYC é realizado por outros métodos.
• O campo rejectReason aparece somente quando o status é REJECTED ou quando a verificação foi negada.
• Os valores de status podem ser usados para exibir o progresso no painel do usuário.