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

Get Customer

Request

This endpoint retrieves the customer's profile information. This can be for an individual or a business.

It returns a Customer object which can be either an Individual or a Business object, containing details like name, address, email, and account_status.

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

Responses

Successful Response

Bodyapplication/json
addressobject(GeneralAddress)required
address.​street_addressstring(Street Address)<= 250 charactersrequired

Street address

address.​street_address2Street Address2 (string) or Street Address2 (null)(Street Address2)

Apartment, Suite, Box number, etc.

Any of:

Apartment, Suite, Box number, etc.

<= 250 characters
string(Street Address2)<= 250 characters
address.​citystring(City)<= 250 charactersrequired

City / Town

address.​postal_codestring(Postal Code)<= 50 charactersrequired

Postal code / ZIP code

address.​stateState (string) or State (null)(State)

State (Postal Abbreviations. Example: "AL", "NJ", "OH")

Any of:

State (Postal Abbreviations. Example: "AL", "NJ", "OH")

string(State)
address.​countrystring(Country)required

A ISO-3166 Alpha-2 country code (Abbreviated. Example: "US")

emailstring(Email)required
phone_numberstring(Phone Number)required
account_statusstring(Account Status)required
Enum"OPEN""CLOSED""FROZEN""PENDING"
typeany(Type)required
Discriminator
Value "BUSINESS"
namestring(Name)required
identification_numberobject(BusinessIdentificationNumber)required
identification_number.​identification_numberstring(Identification Number)required
identification_number.​issuing_countryIssuing Country (string) or Issuing Country (null)(Issuing Country)

A ISO-3166 Alpha-2 country code (Abbreviated. Example: "US")

Any of:

A ISO-3166 Alpha-2 country code (Abbreviated. Example: "US")

string(Issuing Country)
identification_number.​typestring(Type)required
Enum"TIN""EIN""NON_US_BUSINESS_ID"
Response
application/json
{ "address": { "street_address": "string", "street_address2": "string", "city": "string", "postal_code": "string", "state": "string", "country": "string" }, "email": "string", "phone_number": "string", "account_status": "OPEN", "type": "BUSINESS", "name": "string", "identification_number": { "identification_number": "string", "issuing_country": "string", "type": "TIN" } }

Upload Document To Customer

Request

This endpoint uploads a verification document (e.g., passport, articles of incorporation) directly to the customer's profile.

The document_type is specified in the URL path. The raw file data is sent in the request body with Content-Type and Content-Length headers. It returns the document's new document_id.

It is mainly used to verify customer requests (e.g. Customer change request, close account request, ACH request).

Security
CodeBearer
Path
document_typestring(Document Type)required
Enum"ID_FRONT""ID_BACK""ID_BARCODE""SELFIE""IDENTIFICATION_NUMBER_VERIFICATION""ADDRESS_VERIFICATION""PASSPORT""EIN_CONFIRMATION""OPERATING_AGREEMENT""PARTNERSHIP_AGREEMENT"
Headers
content-typestring(Content-Type)image/png|application/pdf|image/jpegrequired
content-lengthinteger(Content-Length)( 0 .. 52428800 )required
curl -i -X POST \
  'https://api.business.jiko.io/api/v1/documents/{document_type}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'content-length: 52428799' \
  -H 'content-type: string'

Responses

Successful Response

Bodyapplication/json
successboolean(Success)required
document_idstring(uuid)(Document Id)required
Response
application/json
{ "success": true, "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6" }

Get Beneficial Owners

Request

For business customers, this endpoint lists the beneficial owners who have been identified for the account.

It returns a ListBeneficialOwnersResponse object containing a list of BusinessIndividual objects.

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

Responses

Successful Response

Bodyapplication/json
itemsArray of objects(Items)required
items[].​idstring(uuid)(Id)required
items[].​nameobject(Name)required
items[].​name.​first_namestring(First Name)<= 50 charactersrequired

First Name

items[].​name.​middle_nameMiddle Name (string) or Middle Name (null)(Middle Name)

Middle Name

Any of:

Middle Name

<= 50 characters
string(Middle Name)<= 50 characters
items[].​name.​last_namestring(Last Name)<= 50 charactersrequired

Last Name

items[].​titlestring(Title)required
Response
application/json
{ "items": [ {} ] }

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