Skip to content

Jiko Customer API (Version: fd60d28d)

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
Languages
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

Get User Info

Request

This endpoint retrieves information about the currently authenticated user.

It returns a UserInfo object containing the user's user_id, email, name, role, and other details.

Security
CodeBearer
curl -i -X GET \
  https://api.business.jiko.io/api/v1/user/ \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json
member_idMember Id (string) or Member Id (null)(Member Id)
Any of:
string(uuid)(Member Id)
user_idstring(User Id)required
emailstring(Email)required
namestring(Name)required
roleRole (string) or null
Any of:
string(Role)
Enum"ADMINISTRATOR""MAKER""CHECKER""VIEWER""USER_ADMINISTRATOR"
phone_numberstring(Phone Number)required
dual_auth_no_reviewers_modeDual Auth No Reviewers Mode (boolean) or Dual Auth No Reviewers Mode (null)(Dual Auth No Reviewers Mode)
Any of:
boolean(Dual Auth No Reviewers Mode)
is_onboardingboolean(Is Onboarding)
Default false
feature_flagsobject(Feature Flags)
Default {}
Response
application/json
{ "member_id": "435a4844-006a-4cfc-a644-e8eb2dd2ca43", "user_id": "string", "email": "string", "name": "string", "role": "ADMINISTRATOR", "phone_number": "string", "dual_auth_no_reviewers_mode": true, "is_onboarding": false, "feature_flags": {} }

Get Memberships

Request

This endpoint retrieves all team memberships for the currently authenticated user.

It returns a list of MembershipInfo objects, each detailing a team and the user's role within it.

Security
CodeBearer
curl -i -X GET \
  https://api.business.jiko.io/api/v1/user/memberships/ \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/jsonArray [
team_idstring(uuid)(Team Id)required
member_idstring(uuid)(Member Id)required
customer_namestring(Customer Name)required
is_currentboolean(Is Current)required
last_loginLast Login (string) or Last Login (null)(Last Login)
Any of:
string(date-time)(Last Login)
rolestring(Role)required
Enum"ADMINISTRATOR""MAKER""CHECKER""VIEWER""USER_ADMINISTRATOR"
]
Response
application/json
[ { "team_id": "810007d0-bec5-486c-b5d1-28fcd8a079ba", "member_id": "435a4844-006a-4cfc-a644-e8eb2dd2ca43", "customer_name": "string", "is_current": true, "last_login": "2019-08-24T14:15:22Z", "role": "ADMINISTRATOR" } ]

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

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