Corebanq

Introduction to CoreBanq API

Overview of core entities in the CoreBanq system

Standard Objects

Authentication and Authorization

General

Addresses

API reference for authentication and authorization

Authentication overview

Authenticate user and get tokens. If MFA is enabled for the user, returns MFA challenge instead of tokens.

Login

Verify 2FA code and complete authentication

Verify 2FA

Refresh token

Logout

Users overview

API reference for role-based access control (RBAC)

Roles overview

API reference for managing personal and organizational identities

Personas overview

Customer management functionality including teams, shareholders, and signatories

Customers overview

Countries overview

Currency management and exchange rate functionality

Currencies overview

Currency exchange and FX tariff management functionality

FX overview

API reference for managing accounting ledgers

Ledgers overview

API reference for managing tariffs and fee calculations

Tariffs overview

Endpoint for Kubernetes liveness probe to check if the application is alive

Liveness Check

Endpoint for Kubernetes readiness probe to check if the application is ready to accept requests

Readiness Check

Kubernetes PreStop hook endpoint for graceful shutdown

PreStop Hook

API reference for task management and assignments

Tasks overview

API reference for transaction management and processing

Transactions overview

API reference for file upload and document management

Uploads overview

API reference for managing invoices and payment documents

Invoices overview

Core banking account management functionality

Accounts overview

Real-time chat and messaging functionality

Chat overview

API reference for miscellaneous utility operations

Utilities overview

API reference for managing user profiles and settings

Profile overview

API reference for Know Your Business verification flows

KYB overview

API reference for Role-Based Access Control management

RBAC overview

Community

API Reference

Dashboard

Support

Create Address

Get Address

List Addresses

Update Address

Delete Address

Set Primary Address

Initiate registration

Verify registration

Create user

Get user

List users

Update user

Delete user

Add credential

List credentials

Validate credential

Update credential

Delete credential

Reset password

Change password

Create role

Get role

List roles

Update role

Delete role

Assign role

Remove role

Create persona

Get persona

List personas

Update persona

Delete persona

Get user's persona

Update user's persona

Create customer

Get customer by ID

List all customers

Update customer

Delete customer

Search customers

Invite team member

Update team member

Remove team member

Resend team invitation

Update KYC status

Update customer tariff

Update customer FX settings

Get customer documents

Get customer avatar

Create new country

Get country by ID

Get all countries

Update country

Delete country

Get country by ISO code

Get all currencies

Get currency by code

Get exchange rate

Update exchange rate

Convert amount

Get currency history

Get available exchange rates

Convert currency amount

Create a new accounting ledger with specified type and settings

Create a new ledger

Get a ledger by ID

Retrieve all ledgers accessible to the user

Get all ledgers

Update ledger active status or close ledger

Update ledger status

Create ledger entry

Retrieve current and available balance for a ledger

Get ledger balance

Transfer between ledgers

Get ledger statement

Get ledger analytics

Create tariff

Get tariff

List tariffs

Update tariff

Delete tariff

Create fee range

Get fee range

Update fee range

Delete fee range

Calculate fee

Create task

Get task

Retrieve all tasks with optional filtering

List tasks

Delete task

Get task categories

Perform task

Reassign task

Cancel task

Decline task

Get task assignees

Create transaction

Get transaction

List all transactions with optional filtering

List transactions

Sign transaction

Cancel transaction

API reference for managing payment recipients

Recipients overview

Create recipient

Get recipient

Retrieve all recipients with optional filtering

Get all recipients

Update recipient

Delete recipient

Search recipients

Create file

Get file

List files

Update file

Delete file

Get file content

Adjust signature count

Create customer file

Get customer files

Get customer file by type

Create a new invoice with automatic numbering and PDF generation

Create new invoice

Retrieve complete invoice details including line items

Get invoice by ID

List all invoices with support for filtering and pagination

Get all invoices

Update invoice

Delete invoice

Extract invoice details from documents using OCR technology

Process invoice with OCR

Extract payment information from Swiss QR-bills

Read QR code from invoice

Get invoice PDF

API reference for managing invoice payers

Payers overview

Create a new payer associated with a customer

Create payer

Retrieve payers with filtering and pagination

List payers

API Documentation

Addresses

Authentication

Users

Roles

Personas

Customers

Countries

Currencies

FX

Ledger

Tariffs

Health

Tasks

Transactions

Uploads

Invoices

Accounts

Chat

Utilities

Profile

KYB

RBAC

Get payer