v1.0RESTful API

API Reference

Build powerful integrations with VaultCore OS using our comprehensive RESTful API.

Quick Start

Base URL

https://api.vaultcoreos.com/v1

Authentication

All API requests require authentication using Bearer tokens. Include your API token in the Authorization header:

curl -X GET "https://api.vaultcoreos.com/v1/customers" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Response Format

All responses are returned in JSON format with a consistent structure:

{
  "has_error": false,
  "message": "Success",
  "data": {
    // Response data here
  }
}

Endpoints

Authentication

Secure authentication and token management

POST

/api/v1/auth/login

Authenticate user and get access token

POST

/api/v1/auth/refresh

Refresh access token

POST

/api/v1/auth/logout

Invalidate current token

Customers

Customer account management

GET

/api/v1/customers

List all customers

POST

/api/v1/customers

Create new customer

GET

/api/v1/customers/{id}

Get customer details

PUT

/api/v1/customers/{id}

Update customer

GET

/api/v1/customers/{id}/accounts

Get customer accounts

Accounts

Savings and deposit account operations

GET

/api/v1/accounts

List all accounts

POST

/api/v1/accounts

Open new account

GET

/api/v1/accounts/{id}

Get account details

GET

/api/v1/accounts/{id}/balance

Get account balance

GET

/api/v1/accounts/{id}/transactions

Get transaction history

Transactions

Deposit, withdrawal, and transfer operations

POST

/api/v1/transactions/deposit

Process deposit

POST

/api/v1/transactions/withdraw

Process withdrawal

POST

/api/v1/transactions/transfer

Process transfer

GET

/api/v1/transactions/{id}

Get transaction details

Loans

Loan application and management

GET

/api/v1/loans

List all loans

POST

/api/v1/loans/apply

Submit loan application

GET

/api/v1/loans/{id}

Get loan details

POST

/api/v1/loans/{id}/disburse

Disburse approved loan

POST

/api/v1/loans/{id}/repay

Record loan repayment

GET

/api/v1/loans/{id}/schedule

Get repayment schedule

Products

Financial product configuration

GET

/api/v1/products/savings

List savings products

GET

/api/v1/products/loans

List loan products

GET

/api/v1/products/{id}

Get product details

Rate Limits

API requests are rate limited based on your subscription plan:

Plan	Requests/min
Starter	60
Professional	300
Enterprise	Unlimited

Error Codes

Code	Description
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
422	Validation Error
429	Rate Limit Exceeded

Need API access?

Contact our team to get your API credentials and start building integrations with VaultCore OS.

Request API Access