API docs by Redocly

Remium API (1.0.0)

Download OpenAPI specification:

API Support: api-support@remium.uk URL: https://developer.remium.uk

API Overview

Welcome to the Remium API documentation. This API provides programmatic access to Remium's banking and financial services platform.

Base URL

All API requests should be made to the appropriate environment base URL:

Authentication

To access protected endpoints, you must authenticate and obtain a Bearer access token.

Obtain an Access Token

Method: POST Endpoint: /login-service/api/v1/auth
Content-Type: application/json

Request Body

{
  "email": "your_email@example.com",
  "password": "your_secure_password"
}

Successful Response

{
  "accessToken": "emdlfksdhkfjhds.......",
  "expires": "2019-08-24T14:15:22Z",
  "expiresIn": 8600
}

Using the Token

Authorization: Bearer {accessToken}

Token Expiry

API returns 401 Unauthorized when token expires

Obtain a new token using your credentials

Request Format

All API requests should include:

  • Content-Type: application/json header
  • Properly formatted JSON request bodies
  • Authentication headers where required

Error Handling

The API uses standard HTTP status codes and provides detailed error messages:

  • 400 Bad Request: Invalid request parameters
  • 401 Unauthorized: Authentication required or invalid
  • 403 Forbidden: Insufficient permissions
  • 404 Not Found: Resource not found
  • 500 Internal Server Error: Server-side error

Support

For API support and questions:

Authentication

Authentication and authorization operations

Get access token

Request Body schema: application/json
email
required
string or null <email>
password
required
string or null

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "expires": "2019-08-24T14:15:22Z",
  • "expiresIn": 0
}

Clients

Client management operations

Create individual client

Request Body schema: application/json
object (AddressRequest)
object (IndividualClientManagerDetails)

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "individualDetail": {
    }
}

Response samples

Content type
application/json
{
  • "clientId": "string",
  • "clientName": "string"
}

Create corporate client

Request Body schema: application/json
object (AddressRequest)
object (ClientCompanyDetailRequest)

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "companyDetail": {
    }
}

Response samples

Content type
application/json
{
  • "clientId": "string",
  • "clientName": "string"
}

Get a list of clients

query Parameters
page
integer <int32> [ 1 .. 2147483647 ]
Default: 1
perPage
integer <int32> [ 1 .. 2147483647 ]
Default: 20

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "pages": 0,
  • "total": 0,
  • "data": [
    ]
}

Onboarding

Upload client document

Uploads a document required for client onboarding (KYC). Used by managers to attach identity, company, address, financial or compliance documents.

Types

  • for individual: idFront, idBack, idSelfie, proofOfAddress
  • for company: document, companyDocument

Supported file types

  • PDF
  • JPEG / JPG
  • PNG

Response

Returns metadata of stored file including identifier for future reference.

Notes

  • Max file size: 5MB
  • Virus & fraud scan automatically runs on upload
  • File is securely stored and linked to onboarding profile
Request Body schema:
ClientId
required
string
Type
string (FileType)
Enum: "undefined" "document" "idFront" "idBack" "idSelfie" "proofOfAddress" "questionnaire" "companyDocument" "invoice"
File
required
string <binary>

Responses

Request samples

Content type
No sample

Response samples

Content type
application/json
"string"

Accounts

Account management operations

Create a new account

Request Body schema: application/json
clientId
required
string
currencyId
required
string = 3 characters

Responses

Request samples

Content type
application/json
{
  • "clientId": "string",
  • "currencyId": "USD"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "number": "string"
}

Get a list of all accounts

query Parameters
clientId
string
page
integer <int32> [ 1 .. 2147483647 ]
Default: 1
perPage
integer <int32> [ 1 .. 2147483647 ]
Default: 20

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "pages": 0,
  • "total": 0,
  • "data": [
    ]
}

Get account deposit details

query Parameters
accountId
string

Responses

Response samples

Content type
application/json
{
  • "regular": {
    },
  • "priority": {
    },
  • "possibleDeposit": [
    ]
}

Webhooks

Remium supports webhooks for real-time event notifications. Configure your webhook endpoints to receive notifications for events like:

  • Client onboarding status changes
  • Account updates
  • Transaction notifications
  • Compliance status changes

Webhook Events and Payloads

The Remium system sends the following webhook events:

Client Approved

Sent when a client's application has been successfully approved and verified.

{
  "type": "ClientStateChanged",
  "data": {
    "clientId": "cli-JohnSmith.remium.VNIsaEjWIL13",
    "clientName": "John Smith",
    "state": "verified"
  }
}

Client Rejected

Sent when a client's application has been declined or rejected.

{
  "type": "ClientStateChanged",
  "data": {
    "clientId": "cli-JohnSmith.remium.VNIsaEjWIL13",
    "clientName": "John Smith",
    "state": "declined"
  }
}

Account Opened

Sent when a new account has been successfully opened for a client.

{
  "type": "AccountOpened",
  "data": {
    "accountId": "acc.USD.TLfBCnWnwbEwf34",
    "clientId": "cli-JohnSmith.remium.VNIsaEjWIL13",
    "currencyId": "USD",
    "number": "SDJ-MXJJJ4421846-Q41"
  }
}