Account API

Overview

This API retrieves comprehensive information about your SendClean account. It provides a complete
overview of your account status, usage statistics, and configuration settings. Use this endpoint to monitor your account
health, check remaining credits, verify sending limits, and understand your current reputation score.

The response includes critical metrics like:

Account balance and credit information
Current sender reputation score (affects deliverability)
Configured sending speed and hourly limits
Account creation date and status
Contact information and verification status

This endpoint is particularly useful for building dashboards, monitoring systems, or automated alerts that track account
health and usage patterns.

Endpoint Details

HTTP Method	POST
Endpoint Path	v1.0/account/viewUserDetail
API Version	Single API (v1.0)
Content-Type	application/json

Request Parameters

Parameter	Type	Required	Description	Example
owner_id	String	Yes	Your unique SendClean account identifier	user_12345
token	String	Yes	Your API authentication token for secure access	sk_live_abc123...

Request Example

Below is a complete example of the request body. Replace placeholder values with your actual credentials and data.

{
  "owner_id": "{{owner_id}}",
  "token": "{{token}}"
}

Response Format

Successful Response:

{
    "status": "success",
    "code": 200,
    "message": "Operation completed successfully"
}

Common Errors & Troubleshooting

401 - Unauthorized: Authentication credentials are missing or invalid

Solution: Verify owner_id and token are correct. Ensure they match your account credentials exactly with no extra whitespace.

500 - Internal server error: Unexpected server error occurred

Solution: Retry the request after a brief delay. If error persists, contact SendClean support with the request details and timestamp.

Implementation Examples

curl -X POST \
  https://api.sendclean.com/v1.0/account/viewUserDetail \
  -H 'Content-Type: application/json' \
  -d '{
  "owner_id": "{{owner_id}}",
  "token": "{{token}}"
}'

const axios = require('axios');

const url = 'https://api.sendclean.com/v1.0/account/viewUserDetail';

const payload = {
    "owner_id":"{{owner_id}}",
    "token":"{{token}}"
};

axios.post(url, payload, {
    headers: {
        'Content-Type': 'application/json'
    }
})
.then(response => {
    console.log('Success:', response.data);
})
.catch(error => {
    console.error('Error:', error.response ? error.response.data : error.message);
});

<?php

$url = 'https://api.sendclean.com/v1.0/account/viewUserDetail';

$payload = json_decode('{
    "owner_id":"{{owner_id}}",
    "token":"{{token}}"
}', true);

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json'
]);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($httpCode == 200) {
    $result = json_decode($response, true);
    print_r($result);
} else {
    echo "Error: $httpCode - $response";
}

?>