Skip to main content

Main API Service

The main API service handles core business operations including participant management, user administration, and custodian banking operations.

Base URL: https://api.ledgerlink.ai/v1

Admin Module​

Administrative functions for platform management.

Admin Users​

Manage administrative users and their permissions.

List Admin Users​

GET /admin/users

Headers:

  • Authorization: Bearer {jwt_token}
  • X-API-KEY: {api_key}

Query Parameters:

  • limit (integer, optional): Number of results per page (default: 20)
  • offset (integer, optional): Number of results to skip (default: 0)

Response:

{
  "data": [
    {
      "id": "uuid",
      "email": "admin@example.com",
      "name": "John Doe",
      "status": "ACTIVE",
      "roles": ["ADMIN"],
      "createdAt": "2025-06-17T10:00:00Z",
      "updatedAt": "2025-06-17T10:00:00Z"
    }
  ],
  "pageInfo": {
    "limit": 20,
    "offset": 0,
    "total": 1
  }
}

Create Admin User​

POST /admin/users

Request Body:

{
  "email": "newadmin@example.com",
  "name": "Jane Smith",
  "roleIds": ["role-uuid-1", "role-uuid-2"]
}

Update Admin User​

PUT /admin/users/{userId}

Delete Admin User​

DELETE /admin/users/{userId}

List Admin Roles​

GET /admin/roles

Admin Participants (PFI Management)​

Manage Payment Financial Institution (PFI) participants.

List PFI Participants​

GET /admin/pfi

Query Parameters:

  • limit (integer, optional): Results per page
  • offset (integer, optional): Results to skip
  • search (string, optional): Search by participant name
  • status (string, optional): Filter by status

Get PFI Participant Details​

GET /admin/pfi/{participantId}

Review PFI Documents​

GET /admin/pfi/{participantId}/documents

Update PFI Status​

PUT /admin/pfi/{participantId}/status

Request Body:

{
  "status": "APPROVED",
  "comments": "KYC verification completed"
}

Admin Additional Information​

Manage additional information requirements for compliance.

List Additional Information​

GET /admin/additional-information

Create Additional Information​

POST /admin/additional-information

Update Additional Information​

PUT /admin/additional-information/{id}

Delete Additional Information​

DELETE /admin/additional-information/{id}

Admin Custodian Banks​

Manage custodian bank relationships.

List Custodian Banks​

GET /admin/custodian-bank

Create Custodian Bank​

POST /admin/custodian-bank

Delete Custodian Bank​

DELETE /admin/custodian-bank/{id}

PFI Module​

APIs for Payment Financial Institution operations.

Participant Management​

Register New Participant​

POST /participants

Request Body:

{
  "name": "Example Bank",
  "email": "contact@example-bank.com",
  "country": "US",
  "businessType": "BANK",
  "registrationNumber": "REG123456",
  "address": {
    "street": "123 Banking St",
    "city": "New York",
    "state": "NY",
    "zipCode": "10001",
    "country": "US"
  }
}

Get Current Participant Details​

GET /participants/detail

Update Participant Information​

PUT /participants/detail

Get Counter Parties​

GET /participants/counter-parties

Query Parameters:

  • search (string, optional): Filter by counter party name

Response:

{
  "data": [
    {
      "id": "uuid",
      "name": "Counter Party Bank",
      "country": "CA",
      "status": "ACTIVE"
    }
  ]
}

Participant Bank Accounts​

Create Bank Account​

POST /participants/{participantId}/accounts

Request Body:

{
  "accountNumber": "1234567890",
  "routingNumber": "021000021",
  "accountType": "CHECKING",
  "currency": "USD",
  "custodianBankId": "custodian-uuid"
}

List Bank Accounts​

GET /participants/{participantId}/accounts

API Key Management​

Get Current API Key​

GET /participants/api-key

Generate New API Key​

POST /participants/api-key

Request Body:

{
  "expirationDate": 60
}

Response:

{
  "data": {
    "id": "uuid",
    "apiKey": "ak_live_...",
    "createdAt": "2025-06-17T10:00:00Z",
    "expirationDate": "2025-08-16T10:00:00Z"
  }
}

Custodians​

List Available Custodians​

GET /custodians

Response:

{
  "data": [
    {
      "id": "uuid",
      "name": "Trust Bank Corp",
      "country": "US",
      "services": ["CUSTODY", "SETTLEMENT"],
      "status": "ACTIVE"
    }
  ]
}

Credit Lines​

Get Credit Line Information​

GET /credit-line

Additional Information​

List Additional Information​

GET /additional-information

Get Additional Information by Participant​

GET /additional-information/participant/{participantId}

AML Engine​

Submit AML Request​

POST /aml-engine

Request Body:

{
  "participantId": "participant-uuid",
  "custodianBankId": "custodian-uuid",
  "transactionAmount": 10000.00,
  "transactionCurrency": "USD",
  "customerData": {
    "firstName": "John",
    "lastName": "Doe",
    "dateOfBirth": "1990-01-01",
    "nationality": "US"
  }
}

Response:

{
  "data": {
    "riskLevel": "LOW",
    "needConfirm": false,
    "amlId": "aml-uuid",
    "score": 85
  }
}

Custodian Module​

APIs for custodian bank operations.

Custodian Users​

List Custodian Users​

GET /custodian-bank/users

Get User Details​

GET /custodian-bank/users/{userId}

Create User​

POST /custodian-bank/users

Update User​

PUT /custodian-bank/users/{userId}

Delete User​

DELETE /custodian-bank/users/{userId}

Custodian Transactions​

List Transactions​

GET /custodian-bank/transactions

Query Parameters:

  • limit (integer, optional): Results per page
  • offset (integer, optional): Results to skip
  • search (string, optional): Search transactions
  • status (array, optional): Filter by status
  • type (array, optional): Filter by transaction type
  • sortBy (string, optional): Sort field
  • sortDirection (string, optional): Sort direction (ASC/DESC)

Get Transaction Details​

GET /custodian-bank/transactions/{transactionId}

Custodian Participants​

List Participants​

GET /custodian-bank/participants

Custodian Balance​

Get Balance Information​

GET /custodian-bank/balance

Custodian Details​

Get Custodian Information​

GET /custodian-bank/custodian-detail

Credit Lines​

Get Credit Line Status​

GET /custodian-bank/credit-line