Jiko Customer API (Version: fd60d28d)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Introduction

Welcome to the Jiko Customer API Reference! Jiko enables you to integrate money storage and movement, backed by the safety and security of US Treasury Bills. Use the Customer API if you are a Jiko customer integrating Jiko directly into your internal systems.

For questions regarding authorization for the Customer API, please visit our OAuth guide

Download OpenAPI description

reference.json

reference.yaml

Servers

Production server

https://api.business.jiko.io

Sandbox server

https://customer-api.sandbox-api.jikoservices.com

Agreements

Use this endpoint to fetch Agreements specific to your institution and Jiko.

Operations

Events

Use these endpoints to view Events.

Operations

Notifications

Use these endpoints for interacting with Notifications.

Operations

Subscriptions

Use these endpoints to create, view, and manage Subscriptions. Subscriptions provide Partners with the ability to subscribe to Events. Once subscribed, Events will be sent to the specified URL.

Operations

Reports

⚠️ Experimental ⚠️ These endpoints are subject to change.

Use these endpoints to interact with Reports.

Operations

Statements

Use these endpoints to retrieve monthly statements for bank and brokerage accounts.

Operations

Team

Use these endpoints to view and manage details for a Team and its members.

Operations

Trades

Use these endpoints to view Trades, or transactions related to the buying and selling of T-bills, within the brokerage account component of Jiko Pockets.

Operations

Portals

Use these endpoints to create and view Portals. Portals allow third-party financial institutions to initiate ACH and wire transfers. A Portal consists of a routing and an account number. Multiple Portals can be created for a single Pocket.

Operations

Transfer Requests

Use these endpoints to manage Dual Authorization for Tranfer Requests.

Operations

Customer

Use these endpoints to view and manage personal details for a Customer.

Operations

User

Use these endpoints to view User information.

Operations

Business Applications V2

Use this endpoint to view, create and manage Business Applications.

Operations

Documents V2

Use this endpoint to upload a document associated with a specific document ID. Useful for providing supporting documents for verification purposes.

Operations

Pockets V2

Use these endpoints to view Pocket information. Jiko Pockets consist of a bank account and a brokerage account. When funds are deposited into a Pocket, they're immediately invested in T-bills.

Operations

List Customer Pockets

Request

This endpoint lists all the pockets for a given customer. It returns a Pockets object which is a paginated list of Pocket objects.

Security

CodeBearer

Query

offsetinteger(Offset)>= 0

Default 0

limitinteger(Limit)[ 1 .. 30 ]

Default 30

curl -i -X GET \
  'https://api.business.jiko.io/api/v2/pockets/?offset=0&limit=30' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json

offsetinteger(Offset)required

countinteger(Count)required

itemsArray of objects(Items)required

Customer pockets list

items[].idstring(uuid)(Id)required

ID of the pocket

items[].pocket_namestring(Pocket Name)required

Pocket name

items[].portfolioPortfolio (object) or null

Total liquid cash and holdings

Any of:

Total liquid cash and holdings

items[].statusstring(Status)required

Pocket status

Enum"PENDING""OPEN""FROZEN""CLOSED"

items[].attributesArray of strings(Attributes)

items[].deposit_strategy_idstring(Deposit Strategy Id)required

Pocket deposit trading strategy ID (Example: UST-4W)

items[].reinvestment_strategy_idReinvestment Strategy Id (string) or Reinvestment Strategy Id (null)(Reinvestment Strategy Id)required

Pocket reinvestment trading strategy ID (Example: UST-4W)

Any of:

Pocket reinvestment trading strategy ID (Example: UST-4W)

string(Reinvestment Strategy Id)

items[].object_typestring(Object Type)read-onlyrequired

object_typestring(Object Type)

Default "List"

Response

application/json

{
  "offset": 0,
  "count": 0,
  "items": [
    { … }
  ],
  "object_type": "List"
}

Create Customer Pocket

Request

This endpoint creates a new pocket for a customer.

The request body requires a CreatePocketRequest object, specifying the trading_strategy_id and a pocket_name. It returns the newly created Pocket object.

Security

CodeBearer

Bodyapplication/jsonrequired

pocket_namestring(Pocket Name)<= 100 charactersrequired

Pocket name

deposit_strategy_idstring(CreatePocketConfigurationId)required

Pocket deposit trading strategy ID (Example: UST-4W)

Enum"UST-52W""UST-26W""UST-13W""UST-4W""UST-1W"

reinvestment_strategy_idCreatePocketConfigurationId (string) or null

Pocket reinvestment trading strategy ID (Example: UST-4W)

Any of:

Pocket reinvestment trading strategy ID (Example: UST-4W)

string(CreatePocketConfigurationId)

Enum"UST-52W""UST-26W""UST-13W""UST-4W""UST-1W"

curl -i -X POST \
  https://api.business.jiko.io/api/v2/pockets/ \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "pocket_name": "string",
    "deposit_strategy_id": "UST-52W",
    "reinvestment_strategy_id": "UST-52W"
  }'

Responses

Successful Response

Bodyapplication/json

idstring(uuid)(Id)required

ID of the pocket

pocket_namestring(Pocket Name)required

Pocket name

portfolioPortfolio (object) or null

Total liquid cash and holdings

Any of:

Total liquid cash and holdings

statusstring(Status)required

Pocket status

Enum"PENDING""OPEN""FROZEN""CLOSED"

attributesArray of strings(Attributes)

deposit_strategy_idstring(Deposit Strategy Id)required

Pocket deposit trading strategy ID (Example: UST-4W)

reinvestment_strategy_idReinvestment Strategy Id (string) or Reinvestment Strategy Id (null)(Reinvestment Strategy Id)required

Pocket reinvestment trading strategy ID (Example: UST-4W)

Any of:

Pocket reinvestment trading strategy ID (Example: UST-4W)

string(Reinvestment Strategy Id)

object_typestring(Object Type)read-onlyrequired

Response

application/json

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "pocket_name": "string",
  "portfolio": {
    "securities": [ … ],
    "cash": { … },
    "all_time_earnings": { … },
    "total_value": { … },
    "fees": [ … ],
    "liquidation_value_t0": { … },
    "liquidation_value_t1": { … }
  },
  "status": "PENDING",
  "attributes": [
    "string"
  ],
  "deposit_strategy_id": "string",
  "reinvestment_strategy_id": "string",
  "object_type": "string"
}

Get Customer Pocket

Request

This endpoint retrieves the details of a specific pocket, and returns a Pocket object with detailed portfolio information.

Security

CodeBearer

Path

pocket_idstring(uuid)(Pocket Id)required

curl -i -X GET \
  'https://api.business.jiko.io/api/v2/pockets/{pocket_id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json

idstring(uuid)(Id)required

ID of the pocket

pocket_namestring(Pocket Name)required

Pocket name

portfolioPortfolio (object) or null

Total liquid cash and holdings

Any of:

Total liquid cash and holdings

statusstring(Status)required

Pocket status

Enum"PENDING""OPEN""FROZEN""CLOSED"

attributesArray of strings(Attributes)

deposit_strategy_idstring(Deposit Strategy Id)required

Pocket deposit trading strategy ID (Example: UST-4W)

reinvestment_strategy_idReinvestment Strategy Id (string) or Reinvestment Strategy Id (null)(Reinvestment Strategy Id)required

Pocket reinvestment trading strategy ID (Example: UST-4W)

Any of:

Pocket reinvestment trading strategy ID (Example: UST-4W)

string(Reinvestment Strategy Id)

customer_idstring(uuid)(Customer Id)required

The ID of the customer this pocket belongs to

object_typestring(Object Type)read-onlyrequired

Response

application/json

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "pocket_name": "string",
  "portfolio": {
    "securities": [ … ],
    "cash": { … },
    "all_time_earnings": { … },
    "total_value": { … },
    "fees": [ … ],
    "liquidation_value_t0": { … },
    "liquidation_value_t1": { … }
  },
  "status": "PENDING",
  "attributes": [
    "string"
  ],
  "deposit_strategy_id": "string",
  "reinvestment_strategy_id": "string",
  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  "object_type": "string"
}

Transactions V2

Use these endpoints to view Transactions of funds moving in and out of Jiko Pockets, specifically the bank account component (cash deposits and withdrawals). For viewing information regarding the brokerage account component (buying and selling of T-bills), use Trades.

Operations

Counterparties V2

Use these endpoints to view Counterparties. Counterparties represent external accounts when moving funds in or out of a Jiko Account. Jiko will only transfer funds between accounts where the Counterparty has status: “VERIFIED”, meaning ownership of the account has been confirmed.

Operations

Trading Strategies V2

Use these endpoints to see available trading strategies applicable to a Pocket.

Operations

Introduction

Agreements

Events

Notifications

Subscriptions

Reports

Statements

Team

Trades

Portals

Transfer Requests

Customer

User

Business Applications V2

Documents V2

Pockets V2

List Customer Pockets

Request

Responses

Was this helpful?

Create Customer Pocket

Request

Responses

Was this helpful?

Get Customer Pocket

Request

Responses

Was this helpful?

Transactions V2

Counterparties V2

Trading Strategies V2

Jiko Customer API (Version: fd60d28d)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from ClaudeConnect to CursorInstall MCP server on CursorConnect to VS CodeInstall MCP server on VS Code

Introduction

Agreements

Events

Notifications

Subscriptions

Reports

Statements

Team

Trades

Portals

Transfer Requests

Customer

User

Business Applications V2

Documents V2

Pockets V2

List Customer Pockets

Request

Responses

Was this helpful?

Create Customer Pocket

RequestExpand all

Responses

Was this helpful?

Get Customer Pocket

Request

Responses

Was this helpful?

Transactions V2

Counterparties V2

Trading Strategies V2

Request