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

Team Audits As Csv

Request

This endpoint downloads team audit logs in CSV format for offline analysis and record-keeping, and can be filtered by member_id and a timestamp range.

Security
CodeBearer
Query
member_idMember Id (string) or Member Id (null)(Member Id)
Any of:
string(uuid)(Member Id)
timestamp_fromTimestamp From (string) or Timestamp From (null)(Timestamp From)
Any of:
string(date-time)(Timestamp From)
timestamp_toTimestamp To (string) or Timestamp To (null)(Timestamp To)
Any of:
string(date-time)(Timestamp To)
curl -i -X GET \
  'https://api.business.jiko.io/api/v1/team/audit-logs.csv?member_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&timestamp_from=2019-08-24T14%3A15%3A22Z&timestamp_to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json
itemsArray of objects(Items)required
items[].​actorstring(Actor)required
items[].​event_nameEvent Name (string)(Event Name)required
Any of:
string(Event Name)
Enum"account.list""account.get""pocket.get""pocket.list""pocket.create""pocket.modify""pocket_earnings.get""statement.list""portal.list""portal.create"
items[].​idstring(uuid)(Id)required
items[].​entry_metadataEntry Metadata (object) or Entry Metadata (null)(Entry Metadata)
Any of:
items[].​team_idTeam Id (string) or Team Id (null)(Team Id)
Any of:
string(uuid)(Team Id)
items[].​timestampstring(date-time)(Timestamp)required
prev_pagePrev Page (string) or Prev Page (null)(Prev Page)
Any of:
string(Prev Page)
next_pageNext Page (string) or Next Page (null)(Next Page)
Any of:
string(Next Page)
Response
application/json
{ "items": [ {} ], "prev_page": "string", "next_page": "string" }

Get Team

Request

This endpoint retrieves information about the team, including a list of all team members.

It returns a TeamResponse object which contains the team ID and a list of MemberGroup objects, categorized by member status (ACTIVE, PENDING, etc.).

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

Responses

Successful Response

Bodyapplication/json
team_idstring(uuid)(Team Id)required
members_by_statusArray of objects(Members By Status)required
members_by_status[].​namestring(Name)required
members_by_status[].​totalinteger(Total)required
members_by_status[].​membersArray of objects(Members)required
members_by_status[].​members[].​member_idstring(uuid)(Member Id)required
members_by_status[].​members[].​last_loginLast Login (string) or Last Login (null)(Last Login)required
Any of:
string(date-time)(Last Login)
members_by_status[].​members[].​first_namestring(First Name)required
members_by_status[].​members[].​last_namestring(Last Name)required
members_by_status[].​members[].​emailstring(Email)required
members_by_status[].​members[].​rolestring(Role)required
Enum"ADMINISTRATOR""MAKER""CHECKER""VIEWER""USER_ADMINISTRATOR"
members_by_status[].​members[].​statusstring(MembershipStatus)required
Enum"PENDING""ACTIVE""DEACTIVATED"
members_by_status[].​members[].​added_datestring(date-time)(Added Date)required
members_by_status[].​members[].​deactivated_dateDeactivated Date (string) or Deactivated Date (null)(Deactivated Date)required
Any of:
string(date-time)(Deactivated Date)
members_by_status[].​members[].​phone_numberstring(Phone Number)required
members_by_status[].​members[].​user_idstring(uuid)(User Id)required
allowed_authentication_methodsArray of objects(Allowed Authentication Methods)required
allowed_authentication_methods[].​idstring(uuid)(Id)
allowed_authentication_methods[].​typestring(AuthenticationMethodType)required
Enum"SSO""USERPASS"
allowed_authentication_methods[].​sso_provider_idSso Provider Id (string) or Sso Provider Id (null)(Sso Provider Id)
Any of:
string(uuid)(Sso Provider Id)
service_usersArray of objects(Service Users)required
service_users[].​member_idstring(uuid)(Member Id)required
service_users[].​last_loginLast Login (string) or Last Login (null)(Last Login)required
Any of:
string(date-time)(Last Login)
service_users[].​display_namestring(Display Name)required
service_users[].​emailstring(Email)required
service_users[].​rolestring(Role)required
Enum"ADMINISTRATOR""MAKER""CHECKER""VIEWER""USER_ADMINISTRATOR"
service_users[].​statusstring(MembershipStatus)required
Enum"PENDING""ACTIVE""DEACTIVATED"
service_users[].​added_datestring(date-time)(Added Date)required
service_users[].​deactivated_dateDeactivated Date (string) or Deactivated Date (null)(Deactivated Date)required
Any of:
string(date-time)(Deactivated Date)
service_users[].​user_idstring(uuid)(User Id)required
Response
application/json
{ "team_id": "810007d0-bec5-486c-b5d1-28fcd8a079ba", "members_by_status": [ {} ], "allowed_authentication_methods": [ {} ], "service_users": [ {} ] }

Get Team Member

Request

This endpoint retrieves the details of a specific team member, and returns a TeamMemberResponse object.

Security
CodeBearer
Path
member_idstring(uuid)(Member Id)required
curl -i -X GET \
  'https://api.business.jiko.io/api/v1/team/{member_id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json
member_idstring(uuid)(Member Id)required
emailstring(Email)required
first_namestring(First Name)required
last_namestring(Last Name)required
rolestring(Role)required
Enum"ADMINISTRATOR""MAKER""CHECKER""VIEWER""USER_ADMINISTRATOR"
statusstring(MembershipStatus)required
Enum"PENDING""ACTIVE""DEACTIVATED"
added_datestring(date-time)(Added Date)required
last_loginLast Login (string) or Last Login (null)(Last Login)required
Any of:
string(date-time)(Last Login)
deactivated_dateDeactivated Date (string) or Deactivated Date (null)(Deactivated Date)required
Any of:
string(date-time)(Deactivated Date)
team_idstring(uuid)(Team Id)required
partner_idstring(uuid)(Partner Id)required
user_idstring(uuid)(User Id)required
phone_numberPhone Number (string) or Phone Number (null)(Phone Number)required
Any of:
string(Phone Number)
Response
application/json
{ "member_id": "435a4844-006a-4cfc-a644-e8eb2dd2ca43", "email": "string", "first_name": "string", "last_name": "string", "role": "ADMINISTRATOR", "status": "PENDING", "added_date": "2019-08-24T14:15:22Z", "last_login": "2019-08-24T14:15:22Z", "deactivated_date": "2019-08-24T14:15:22Z", "team_id": "810007d0-bec5-486c-b5d1-28fcd8a079ba", "partner_id": "6a3a39f6-861b-4a48-b868-5de838400e06", "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5", "phone_number": "string" }

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

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