Account Status

The getAccount API method allows a customer to retrieve the current status of their account, including whether it's active or disabled.

Endpoint Details

Description

Data

API Name

getAccount

HTTP Method

GET

URL

/v1/account

Headers

Key

Value

Content-Type

application/json

x-api-key

API_KEY

Parameters

There are no parameters required for this request.

The response will contain the details of the account status.

{
    result: {
        account: {
            name: string,       // Name of the account
            isActive: boolean   // true or false if inactive
        }
    } | error?: IResponseError   // Optional error information
}

Success response example

{
    "result": {
        "account": {
            "name": "Demo account",
            "isActive": true
        }
    }
}

Error messages

Invalid API Key
- { "code: 401, "message": "Invalid api key" }

Examples

curl -X GET 'https://sandbox.api.labs.zelus.io/v1/account' \
     -H "x-api-key: YOUR_API_KEY"

import requests

url = "https://sandbox.api.labs.zelus.io/v1/account"
headers = {
    "x-api-key": "YOUR_API_KEY"
}

response = requests.get(url, headers=headers)
account_status = response.json() # Parsing response

name = account_status['result']['account']['name']
is_active = account_status['result']['account']['isActive']

print(f"Account Name: {name}")
print(f"Is Account Active: {is_active}")

const axios = require('axios');

const url = "https://sandbox.api.labs.zelus.io/v1/account";
const headers = {
    "x-api-key": "YOUR_API_KEY"
};

axios.get(url, { headers: headers }).then(response => {
    const account_status = response.data; // Parsing response
    const name = account_status.result.account.name;
    const isActive = account_status.result.account.isActive;
    
    console.log(`Account Name: ${name}`);
    console.log(`Is Account Active: ${isActive}`);
}).catch(error => {
    console.error('Error:', error.response.data);
});

Notes

The request to this endpoint does not require any specific parameters or form-data.
The response will indicate the current status of the customer's account, whether active or disabled. If an error occurs, an IResponseError object may be included in the response.

PreviousAccount API NextAccount Contracts

Last updated 2 years ago

hashtagEndpoint Details

hashtagHeaders

hashtagParameters

hashtagSuccess response example

hashtagError messages

hashtagExamples

hashtagNotes