Skip to main content

​
CentryOS API

Welcome to the CentryOS API documentation. Our API provides a RESTful interface for managing financial transactions and accounts through our Liquidity Service.

​
Pre-requisites

Before using any endpoints, you’ll need to:
  1. Create a CentryOS account for your organization
  2. Obtain your apiClientId and apiClientSecret from your dashboard
  3. Generate a JWT token

​
Account Setup

​
1. Sign Up for a CentryOS Account

Click Sign Up to begin creating your account. Signup Page Screenshot After clicking the link:
  1. Fill in your required details.
  2. You will be redirected to the verification page.

​
2. Enter Your Passcode

You will receive a passcode in your registered email. Enter the passcode on the verification screen. Passcode Screenshot After successful verification, you should see a message:
“Account created successfully”

​
3. Generate Your API Key and Register a Webhook URL

To generate your API key:
  1. Go to the bottom-left corner of your dashboard.
  2. Click on Developer.
Developer Tab Screenshot Inside the Developer section:
  1. Click Add Webhook URL
  2. Provide the URL and the Secret Hash
  3. Click Register
Webhook Registration Screenshot
Keep your API keys secure and never expose them in public repos or client-side code.

​
Base URLs

​
Response Format

All responses are returned in JSON format and follow a consistent structure:

​
Rate Limiting

The API has rate limits to ensure fair usage:

Production

1000 requests per minute

Staging

100 requests per minute

​
Error Handling

The API uses conventional HTTP response codes to indicate the success or failure of requests: Error responses follow this format:

​
Support

If you need help or have questions:
  1. Check the API documentation
  2. Contact support at centryos@gradientfi.com