Skip to content
API Reference
/
/
Get Counterparty

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
reference.json
reference.yaml
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

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

Create Counterparty

Request

This endpoint is used to create a new counterparty for a customer. You can create different types of counterparties, including ach, on-us, wire, and international_wire, by providing the relevant details in the request body.

Note: The account_number field for creating an on-us counterparty represents the Jiko network address of the pocket.

The request body must conform to one of the request schemas. On success, it returns the newly created counterparty object.

Security
CodeBearer
Bodyapplication/jsonrequired
Any of:
routing_numberstring(Routing Number)required
identifierstring(Identifier)required

Bank Account Number

identifier_codestring(Identifier Code)required

The code describing the identifier for the counterparty at the counterparty institution.

Enum"SWIFT_BIC""CHIPS_PARTICIPANT""DIRECT_DEPOSIT_ACCOUNT""FED_ROUTING_NUMBER""SWIFT_ID_AND_ACCOUNT_NUMBER""CHIPS_IDENTIFIER""PASSPORT_NUMBER""TAX_IDENTIFICATION_NUMBER""DRIVERS_LICENSE_NUMBER""ALIEN_REGISTRATION_NUMBER"
addressobject(CounterpartyAddress)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.​statestring(State)required

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

address.​countrystring(Country)required

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

wire_instructionsWire Instructions (string) or Wire Instructions (null)(Wire Instructions)

Any additional wire instructions required for the wire to be processed correctly.

Any of:

Any additional wire instructions required for the wire to be processed correctly.

<= 140 characters
string(Wire Instructions)<= 140 characters
counterparty_nameany(Counterparty name)required
counterparty_name.​business_namestring(Business Name)required

The name of the business counterparty.

counterparty_name.​typeany(Type)required
Discriminator
Value "business"
verificationany(Verification)required
verification.​typeany(Type)required
Discriminator
Value "incoming_wire"
verification.​wire_idstring(uuid)(Wire Id)required
typeany(Type)required
Value "wire"
curl -i -X POST \
  https://api.business.jiko.io/api/v2/counterparties/ \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "routing_number": "string",
    "identifier": "string",
    "identifier_code": "SWIFT_BIC",
    "address": {
      "street_address": "string",
      "street_address2": "string",
      "city": "string",
      "postal_code": "string",
      "state": "string",
      "country": "string"
    },
    "wire_instructions": "string",
    "counterparty_name": {
      "first_name": "string",
      "last_name": "string",
      "type": "individual"
    },
    "verification": {
      "type": "supporting_documents",
      "document_ids": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ]
    },
    "type": "wire"
  }'

Responses

Successful Response

Bodyapplication/json
idstring(uuid)(Id)required
time_createdstring(date-time)(Time Created)required
statusstring(Status)required
Enum"PENDING""FAILED""LINKED""UNLINKED""CLOSED"
verificationany(Verification)required
verification.​idstring(uuid)(Id)required
verification.​descriptionDescription (string) or Description (null)(Description)required
Any of:
string(Description)
verification.​typeany(Type)required
Discriminator
Value "incoming_wire"
verification.​wire_idstring(uuid)(Wire Id)required
verification.​statusstring(Status)required
Enum"PENDING_REVIEW""APPROVED""REJECTED"
typeany(Type)required
Discriminator
Value "ach"
counterparty_namestring(Counterparty Name)required
institution_nameInstitution Name (string) or Institution Name (null)(Institution Name)required
Any of:
string(Institution Name)
routing_numberRouting Number (string) or Routing Number (null)(Routing Number)required
Any of:
string(Routing Number)
account_numberAccount Number (string) or Account Number (null)(Account Number)required
Any of:
string(Account Number)
account_typestring(Account Type)required
Enum"CHECKING""SAVINGS"
object_typestring(Object Type)read-onlyrequired
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "time_created": "2019-08-24T14:15:22Z",
  "status": "PENDING",
  "verification": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "description": "string",
    "type": "supporting_documents",
    "supporting_documents": [ … ],
    "status": "PENDING_REVIEW"
  },
  "type": "ach",
  "counterparty_name": "string",
  "institution_name": "string",
  "routing_number": "string",
  "account_number": "string",
  "account_type": "CHECKING",
  "object_type": "string"
}

Get Counterparty

Request

This endpoint retrieves the details of a specific counterparty by its unique ID. It returns a single counterparty object corresponding to the provided counterparty_id.

Security
CodeBearer
Path
counterparty_idstring(uuid)(Counterparty Id)required
curl -i -X GET \
  'https://api.business.jiko.io/api/v2/counterparties/{counterparty_id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json
idstring(uuid)(Id)required
time_createdstring(date-time)(Time Created)required
statusstring(Status)required
Enum"PENDING""FAILED""LINKED""UNLINKED""CLOSED"
verificationany(Verification)required
verification.​idstring(uuid)(Id)required
verification.​descriptionDescription (string) or Description (null)(Description)required
Any of:
string(Description)
verification.​typeany(Type)required
Discriminator
Value "incoming_wire"
verification.​wire_idstring(uuid)(Wire Id)required
verification.​statusstring(Status)required
Enum"PENDING_REVIEW""APPROVED""REJECTED"
typeany(Type)required
Discriminator
Value "ach"
counterparty_namestring(Counterparty Name)required
institution_nameInstitution Name (string) or Institution Name (null)(Institution Name)required
Any of:
string(Institution Name)
routing_numberRouting Number (string) or Routing Number (null)(Routing Number)required
Any of:
string(Routing Number)
account_numberAccount Number (string) or Account Number (null)(Account Number)required
Any of:
string(Account Number)
account_typestring(Account Type)required
Enum"CHECKING""SAVINGS"
object_typestring(Object Type)read-onlyrequired
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "time_created": "2019-08-24T14:15:22Z",
  "status": "PENDING",
  "verification": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "description": "string",
    "type": "supporting_documents",
    "supporting_documents": [ … ],
    "status": "PENDING_REVIEW"
  },
  "type": "ach",
  "counterparty_name": "string",
  "institution_name": "string",
  "routing_number": "string",
  "account_number": "string",
  "account_type": "CHECKING",
  "object_type": "string"
}

Update Counterparty

Request

This endpoint is used to update the status of a counterparty. For example, you can use it to unlink a counterparty that is no longer needed.

The request body takes an UpdateCounterpartyRequest object. On success, it returns the updated counterparty object.

Security
CodeBearer
Path
counterparty_idstring(uuid)(Counterparty Id)required
Bodyapplication/jsonrequired
status"UNLINKED" (any) or Status (null)(Status)
Any of:
any("UNLINKED")
curl -i -X PATCH \
  'https://api.business.jiko.io/api/v2/counterparties/{counterparty_id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "UNLINKED"
  }'

Responses

Successful Response

Bodyapplication/json
idstring(uuid)(Id)required
time_createdstring(date-time)(Time Created)required
statusstring(Status)required
Enum"PENDING""FAILED""LINKED""UNLINKED""CLOSED"
verificationany(Verification)required
verification.​idstring(uuid)(Id)required
verification.​descriptionDescription (string) or Description (null)(Description)required
Any of:
string(Description)
verification.​typeany(Type)required
Discriminator
Value "incoming_wire"
verification.​wire_idstring(uuid)(Wire Id)required
verification.​statusstring(Status)required
Enum"PENDING_REVIEW""APPROVED""REJECTED"
typeany(Type)required
Discriminator
Value "ach"
counterparty_namestring(Counterparty Name)required
institution_nameInstitution Name (string) or Institution Name (null)(Institution Name)required
Any of:
string(Institution Name)
routing_numberRouting Number (string) or Routing Number (null)(Routing Number)required
Any of:
string(Routing Number)
account_numberAccount Number (string) or Account Number (null)(Account Number)required
Any of:
string(Account Number)
account_typestring(Account Type)required
Enum"CHECKING""SAVINGS"
object_typestring(Object Type)read-onlyrequired
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "time_created": "2019-08-24T14:15:22Z",
  "status": "PENDING",
  "verification": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "description": "string",
    "type": "supporting_documents",
    "supporting_documents": [ … ],
    "status": "PENDING_REVIEW"
  },
  "type": "ach",
  "counterparty_name": "string",
  "institution_name": "string",
  "routing_number": "string",
  "account_number": "string",
  "account_type": "CHECKING",
  "object_type": "string"
}

Trading Strategies V2

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

Operations

© 2026 Jiko Technologies, Inc. All rights reserved.