Skip to content

Jiko Partner API (Version: fd60d28d)

Introduction

Welcome to the Jiko API Reference! Jiko enables you to integrate money storage and movement, backed by the safety and security of US Treasury Bills. Use the Partner API if you are building an application that embeds Jiko’s services and offers Jiko products to your own customers. The Partner API will then enable your application to interact with Jiko on behalf of your customers.


At the core of our platform is the Jiko Pocket: a pair consisting of a bank account and a brokerage account. When money is deposited into a Pocket, the funds are automatically invested in T-bills. When a payment or withdrawal is made, T-bills are immediately liquidated and used as cash. Customers can have multiple Pockets, and each Pocket is associated with a single T-bill maturity: 4-week, 13-week, 26-week or 52-week.


The API Reference covers everything you need to build a full application leveraging the Jiko platform:


  • Onboarding customers
  • Funding Pockets via ACH or Wire
  • Viewing and managing Pockets (including monthly statements and trade confirmations)
  • Making payments and transfers via ACH, Wire, On-Us (Book) Transfer or Debit Card

When you’re ready to start building, please contact us at partner.support@jiko.io to request sandbox access.

Download OpenAPI description
Languages
Servers
Production server
https://{partner}.partner-api.jikoservices.com
Sandbox server
https://{partner}.sandbox-api.jikoservices.com

Accounts

Use these endpoints to view Account information. Jiko Accounts (also known as Pockets) consist of a bank account and a brokerage account. When funds are deposited into a Pocket, they’re immediately invested in T-bills.


In the API interface, the Account object encapsulates both accounts and can be treated as a single account to deposit to or withdraw from.

Operations

Customers

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

Operations

Transactions

Use these endpoints to view Transactions of funds moving in and out of Jiko Accounts, 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

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

Statements

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

Operations

Manage Cards

Use these endpoints to view and manage Card information.

Operations

Physical Cards

Use these endpoints to create, view, and manage Physical Debit Cards.

Operations

Virtual Cards

Use these endpoints to create, view, and manage Virtual Debit Cards.

Operations

Businesses

Use these endpoints to initiate, manage, and complete KYB for Businesses. When an application has status: “APPROVED”, a Customer is created for the Business. Customers can have multiple Pockets.

Operations

Individuals

Use these endpoints to initiate, manage, and complete KYC for Individuals. When an application has status: “APPROVED”, a Customer is created for the Individual. Customers can have multiple Pockets.

Operations

Create Application

Request

Create an application. You must apply to potentially create a customer using the application, assuming KYC is successful.


When creating an application, keep in mind that customers must be at least 18 years old to open an account with Jiko.

Security
HTTPBearer
Headers
x-jiko-idempotencystring(uuid)(X-Jiko-Idempotency)required
x-jiko-signaturestring(X-Jiko-Signature)required
Bodyapplication/jsonrequired
identification_numberstring(Identification Number)required

Applicant's Identification number

nameobject(Name)required

Applicant's full name

name.​first_namestring(First Name)<= 50 charactersrequired

First Name

name.​middle_nameMiddle Name (string) or Middle Name (null)(Middle Name)

Middle Name

Any of:

Middle Name

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

Last Name

emailstring(email)(Email)required

Applicant's email address

date_of_birthstring(date)(Date Of Birth)required

Applicant's date of birth

investment_profileEmployedInvestmentProfile (object) or IndependentInvestmentProfile (object) or RetiredInvestmentProfile (object) or StudentInvestmentProfile (object) or UnemployedInvestmentProfile (object)(InvestmentProfile)required
One of:
investment_profile.​incomestring(Income)required

Applicant's estimated annual income in USD.

Enum"BELOW_50K""BETWEEN_50K_AND_100K""BETWEEN_100K_AND_250K""OVER_250K"
investment_profile.​net_worthstring(Net Worth)required

Applicant's estimated average personal net worth in USD.

Enum"BELOW_50K""BETWEEN_50K_AND_200K""BETWEEN_200K_AND_1M""BETWEEN_1M_AND_5M""OVER_5M"
investment_profile.​bd_associationBd Association (string) or Bd Association (null)(Bd Association)

Name of broker-dealer association or employment. Disclosure is required by law if applicable, else, leave empty

Any of:

Name of broker-dealer association or employment. Disclosure is required by law if applicable, else, leave empty

<= 200 characters
string(Bd Association)<= 200 characters
investment_profile.​director_policy_maker_of_companyDirector Policy Maker Of Company (string) or Director Policy Maker Of Company (null)(Director Policy Maker Of Company)

Name of company where customer is director or policy maker. Disclosure is required by law if applicable, otherwise, leave empty

Any of:

Name of company where customer is director or policy maker. Disclosure is required by law if applicable, otherwise, leave empty

<= 200 characters
string(Director Policy Maker Of Company)<= 200 characters
investment_profile.​occupationstring(Occupation)[ 2 .. 200 ] charactersrequired

Applicant's occupation. Needs to be filled out if employment status is Employed.

investment_profile.​employment_statusany(Employment Status)required
Value "EMPLOYED"
agreement_consentobject(AgreementConsent)required

Consent object for agreements

agreement_consent.​versionstring(Version)required

Agreement version

agreement_consent.​timestampstring(date-time)(Timestamp)required

Timestamp of applicant's acknowledgement of the agreements

originally_onboarded_atOriginally Onboarded At (string) or Originally Onboarded At (null)(Originally Onboarded At)

Original onboarding time of applicant

Any of:

Original onboarding time of applicant

string(date-time)(Originally Onboarded At)
identification_typestring(Identification Type)

Type type of identification provided in the identification_number field. The options are

  • SSN: Social security number
  • TIN: Tax ID number
  • DRIVERS_LICENSE: A driver's license number
  • PASSPORT: A passport number

Note: This field will be made mandatory in a future release. Currently defaults to SSN.

Default "SSN"
Enum"SSN""PASSPORT""TIN""DRIVERS_LICENSE"
identification_number_issuing_countryIdentification Number Issuing Country (string) or Identification Number Issuing Country (null)(Identification Number Issuing Country)

The country that issued the applicant's identification number. Country in ISO-3166 Alpha-2 format. Note: This field will be made mandatory in a future releases.

Default "US"
Any of:

The country that issued the applicant's identification number. Country in ISO-3166 Alpha-2 format. Note: This field will be made mandatory in a future releases.

string(Identification Number Issuing Country)
Default "US"
addressobject(ISOAddress)required

Address object

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")

phone_numberstring(Phone Number)required

Applicant's phone number. Note: It will be required to include country codes in accordance to the E.164 spec in a future release, or ^\+[1-9]\d{1,14}$.

citizenship_countryCitizenship Country (string) or Citizenship Country (null)(Citizenship Country)

The applicant's citizenship country in ISO-3166 Alpha-2 format.

Default "US"
Any of:

The applicant's citizenship country in ISO-3166 Alpha-2 format.

string(Citizenship Country)
Default "US"
curl -i -X POST \
  https://your-partner-name.partner-api.jikoservices.com/api/v1/applications/ \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-jiko-idempotency: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-jiko-signature: string' \
  -d '{
    "identification_number": "999999999",
    "name": {
      "first_name": "Jiko",
      "last_name": "Customer"
    },
    "email": "jiko@example.com",
    "date_of_birth": "1970-01-01",
    "investment_profile": {
      "income": "BETWEEN_100K_AND_250K",
      "net_worth": "BETWEEN_1M_AND_5M",
      "occupation": "Investor",
      "employment_status": "EMPLOYED"
    },
    "agreement_consent": {
      "version": "1",
      "timestamp": "2023-01-01T12:00:00Z"
    },
    "phone_number": "+14155550100",
    "address": {
      "street_address": "2000 Allston Way",
      "city": "Berkeley",
      "postal_code": "94701",
      "state": "CA",
      "country": "USA"
    }
  }'

Responses

Successful Response

Bodyapplication/json
idstring(uuid)(Id)required
time_createdstring(date-time)(Time Created)required
updated_atstring(date-time)(Updated At)required
phone_numberstring(Phone Number)required

Applicant's phone number. Note: It will be required to include country codes in accordance to the E.164 spec in a future release, or ^\+[1-9]\d{1,14}$.

agreement_consentobject(AgreementConsent)required
agreement_consent.​versionstring(Version)required

Agreement version

agreement_consent.​timestampstring(date-time)(Timestamp)required

Timestamp of applicant's acknowledgement of the agreements

exception_reasonsArray of strings(Exception Reasons)
Default []
emailstring(email)(Email)required
statusstring(Status)required
Enum"CREATED""PENDING""SUBMITTED""DOCUMENTS_NEEDED""APPROVED""REJECTED""MANUAL_REVIEW"
nameName (object) or nullrequired
Any of:
name.​first_namestring(First Name)<= 50 charactersrequired

First Name

name.​middle_nameMiddle Name (string) or Middle Name (null)(Middle Name)

Middle Name

Any of:

Middle Name

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

Last Name

date_of_birthDateOfBirth (object) or nullrequired
Any of:
date_of_birth.​date_of_birthstring(date)(Date Of Birth)required
investment_profileInvestmentProfile (any) or nullrequired
Any of:
investment_profile.​incomestring(Income)required

Applicant's estimated annual income in USD.

Enum"BELOW_50K""BETWEEN_50K_AND_100K""BETWEEN_100K_AND_250K""OVER_250K"
investment_profile.​net_worthstring(Net Worth)required

Applicant's estimated average personal net worth in USD.

Enum"BELOW_50K""BETWEEN_50K_AND_200K""BETWEEN_200K_AND_1M""BETWEEN_1M_AND_5M""OVER_5M"
investment_profile.​bd_associationBd Association (string) or Bd Association (null)(Bd Association)

Name of broker-dealer association or employment. Disclosure is required by law if applicable, else, leave empty

Any of:

Name of broker-dealer association or employment. Disclosure is required by law if applicable, else, leave empty

<= 200 characters
string(Bd Association)<= 200 characters
investment_profile.​director_policy_maker_of_companyDirector Policy Maker Of Company (string) or Director Policy Maker Of Company (null)(Director Policy Maker Of Company)

Name of company where customer is director or policy maker. Disclosure is required by law if applicable, otherwise, leave empty

Any of:

Name of company where customer is director or policy maker. Disclosure is required by law if applicable, otherwise, leave empty

<= 200 characters
string(Director Policy Maker Of Company)<= 200 characters
investment_profile.​occupationstring(Occupation)[ 2 .. 200 ] charactersrequired

Applicant's occupation. Needs to be filled out if employment status is Employed.

investment_profile.​employment_statusany(Employment Status)required
Discriminator
Value "EMPLOYED"
customer_idCustomer Id (string) or Customer Id (null)(Customer Id)

null until application status is APPROVED

Any of:

null until application status is APPROVED

string(uuid)(Customer Id)
documentsArray of objects(Documents)
id_verification_documents_neededboolean(Id Verification Documents Needed)required
identification_number_verification_document_neededboolean(Identification Number Verification Document Needed)required
address_verification_document_neededboolean(Address Verification Document Needed)required
addressobject(ISOAddress)required

Address object

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")

citizenship_countryCitizenship Country (string) or Citizenship Country (null)(Citizenship Country)

The applicant's citizenship country in ISO-3166 Alpha-2 format.

Default "US"
Any of:

The applicant's citizenship country in ISO-3166 Alpha-2 format.

string(Citizenship Country)
Default "US"
identification_number_issuing_countryIdentification Number Issuing Country (string) or Identification Number Issuing Country (null)(Identification Number Issuing Country)

The country that issued the applicant's identification number. Country in ISO-3166 Alpha-2 format. Note: This field will be made mandatory in a future releases.

Default "US"
Any of:

The country that issued the applicant's identification number. Country in ISO-3166 Alpha-2 format. Note: This field will be made mandatory in a future releases.

string(Identification Number Issuing Country)
Default "US"
object_typestring(Object Type)read-onlyrequired
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "time_created": "2023-01-01T12:00:00Z", "updated_at": "2023-01-01T13:00:00Z", "status": "CREATED", "exception_reasons": [], "phone_number": "+14155550100", "agreement_consent": { "version": "1", "timestamp": "2023-01-01T12:00:00Z" }, "email": "jiko@example.com", "name": { "first_name": "Jiko", "last_name": "Customer" }, "date_of_birth": { "date_of_birth": "1970-01-01" }, "investment_profile": { "income": "BETWEEN_100K_AND_250K", "net_worth": "BETWEEN_1M_AND_5M", "occupation": "Investor", "employment_status": "EMPLOYED" }, "documents": [], "id_verification_documents_needed": false, "identification_number_verification_document_needed": false, "address_verification_document_needed": false, "address": { "street_address": "2000 Allston Way", "city": "Berkeley", "postal_code": "94701", "state": "CA", "country": "US" }, "citizenship_country": "US", "identification_number_issuing_country": "US", "object_type": "InternationalApplication" }

Get Application

Request

Fetch and observe an existing application.

Security
HTTPBearer
Path
application_idstring(uuid)(Application Id)required
Headers
x-jiko-idempotencystring(uuid)(X-Jiko-Idempotency)required
x-jiko-signaturestring(X-Jiko-Signature)required
curl -i -X GET \
  'https://your-partner-name.partner-api.jikoservices.com/api/v1/applications/{application_id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-jiko-idempotency: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-jiko-signature: string'

Responses

Successful Response

Bodyapplication/json
idstring(uuid)(Id)required
time_createdstring(date-time)(Time Created)required
updated_atstring(date-time)(Updated At)required
phone_numberstring(Phone Number)required

Applicant's phone number. Note: It will be required to include country codes in accordance to the E.164 spec in a future release, or ^\+[1-9]\d{1,14}$.

agreement_consentobject(AgreementConsent)required
agreement_consent.​versionstring(Version)required

Agreement version

agreement_consent.​timestampstring(date-time)(Timestamp)required

Timestamp of applicant's acknowledgement of the agreements

exception_reasonsArray of strings(Exception Reasons)
Default []
emailstring(email)(Email)required
statusstring(Status)required
Enum"CREATED""PENDING""SUBMITTED""DOCUMENTS_NEEDED""APPROVED""REJECTED""MANUAL_REVIEW"
nameName (object) or nullrequired
Any of:
name.​first_namestring(First Name)<= 50 charactersrequired

First Name

name.​middle_nameMiddle Name (string) or Middle Name (null)(Middle Name)

Middle Name

Any of:

Middle Name

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

Last Name

date_of_birthDateOfBirth (object) or nullrequired
Any of:
date_of_birth.​date_of_birthstring(date)(Date Of Birth)required
investment_profileInvestmentProfile (any) or nullrequired
Any of:
investment_profile.​incomestring(Income)required

Applicant's estimated annual income in USD.

Enum"BELOW_50K""BETWEEN_50K_AND_100K""BETWEEN_100K_AND_250K""OVER_250K"
investment_profile.​net_worthstring(Net Worth)required

Applicant's estimated average personal net worth in USD.

Enum"BELOW_50K""BETWEEN_50K_AND_200K""BETWEEN_200K_AND_1M""BETWEEN_1M_AND_5M""OVER_5M"
investment_profile.​bd_associationBd Association (string) or Bd Association (null)(Bd Association)

Name of broker-dealer association or employment. Disclosure is required by law if applicable, else, leave empty

Any of:

Name of broker-dealer association or employment. Disclosure is required by law if applicable, else, leave empty

<= 200 characters
string(Bd Association)<= 200 characters
investment_profile.​director_policy_maker_of_companyDirector Policy Maker Of Company (string) or Director Policy Maker Of Company (null)(Director Policy Maker Of Company)

Name of company where customer is director or policy maker. Disclosure is required by law if applicable, otherwise, leave empty

Any of:

Name of company where customer is director or policy maker. Disclosure is required by law if applicable, otherwise, leave empty

<= 200 characters
string(Director Policy Maker Of Company)<= 200 characters
investment_profile.​occupationstring(Occupation)[ 2 .. 200 ] charactersrequired

Applicant's occupation. Needs to be filled out if employment status is Employed.

investment_profile.​employment_statusany(Employment Status)required
Discriminator
Value "EMPLOYED"
customer_idCustomer Id (string) or Customer Id (null)(Customer Id)

null until application status is APPROVED

Any of:

null until application status is APPROVED

string(uuid)(Customer Id)
documentsArray of objects(Documents)
id_verification_documents_neededboolean(Id Verification Documents Needed)required
identification_number_verification_document_neededboolean(Identification Number Verification Document Needed)required
address_verification_document_neededboolean(Address Verification Document Needed)required
addressobject(ISOAddress)required

Address object

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")

citizenship_countryCitizenship Country (string) or Citizenship Country (null)(Citizenship Country)

The applicant's citizenship country in ISO-3166 Alpha-2 format.

Default "US"
Any of:

The applicant's citizenship country in ISO-3166 Alpha-2 format.

string(Citizenship Country)
Default "US"
identification_number_issuing_countryIdentification Number Issuing Country (string) or Identification Number Issuing Country (null)(Identification Number Issuing Country)

The country that issued the applicant's identification number. Country in ISO-3166 Alpha-2 format. Note: This field will be made mandatory in a future releases.

Default "US"
Any of:

The country that issued the applicant's identification number. Country in ISO-3166 Alpha-2 format. Note: This field will be made mandatory in a future releases.

string(Identification Number Issuing Country)
Default "US"
object_typestring(Object Type)read-onlyrequired
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "time_created": "2023-01-01T12:00:00Z", "updated_at": "2023-01-01T13:00:00Z", "status": "CREATED", "exception_reasons": [], "phone_number": "+14155550100", "agreement_consent": { "version": "1", "timestamp": "2023-01-01T12:00:00Z" }, "email": "jiko@example.com", "name": { "first_name": "Jiko", "last_name": "Customer" }, "date_of_birth": { "date_of_birth": "1970-01-01" }, "investment_profile": { "income": "BETWEEN_100K_AND_250K", "net_worth": "BETWEEN_1M_AND_5M", "occupation": "Investor", "employment_status": "EMPLOYED" }, "documents": [], "id_verification_documents_needed": false, "identification_number_verification_document_needed": false, "address_verification_document_needed": false, "address": { "street_address": "2000 Allston Way", "city": "Berkeley", "postal_code": "94701", "state": "CA", "country": "US" }, "citizenship_country": "US", "identification_number_issuing_country": "US", "object_type": "InternationalApplication" }

Apply

Request

Initiate automatic KYC. Transitions the application from CREATED status to SUBMITTED status. Once the async KYC process is completed, the application will move from SUBMITTED to another status.

Security
HTTPBearer
Path
application_idstring(uuid)(Application Id)required
Headers
x-jiko-idempotencystring(uuid)(X-Jiko-Idempotency)required
x-jiko-signaturestring(X-Jiko-Signature)required
curl -i -X POST \
  'https://your-partner-name.partner-api.jikoservices.com/api/v1/applications/{application_id}/apply/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-jiko-idempotency: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-jiko-signature: string'

Responses

Successful Response

Bodyapplication/json
idstring(uuid)(Id)required
time_createdstring(date-time)(Time Created)required
updated_atstring(date-time)(Updated At)required
phone_numberstring(Phone Number)required

Applicant's phone number. Note: It will be required to include country codes in accordance to the E.164 spec in a future release, or ^\+[1-9]\d{1,14}$.

agreement_consentobject(AgreementConsent)required
agreement_consent.​versionstring(Version)required

Agreement version

agreement_consent.​timestampstring(date-time)(Timestamp)required

Timestamp of applicant's acknowledgement of the agreements

exception_reasonsArray of strings(Exception Reasons)
Default []
emailstring(email)(Email)required
statusstring(Status)required
Enum"CREATED""PENDING""SUBMITTED""DOCUMENTS_NEEDED""APPROVED""REJECTED""MANUAL_REVIEW"
nameName (object) or nullrequired
Any of:
name.​first_namestring(First Name)<= 50 charactersrequired

First Name

name.​middle_nameMiddle Name (string) or Middle Name (null)(Middle Name)

Middle Name

Any of:

Middle Name

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

Last Name

date_of_birthDateOfBirth (object) or nullrequired
Any of:
date_of_birth.​date_of_birthstring(date)(Date Of Birth)required
investment_profileInvestmentProfile (any) or nullrequired
Any of:
investment_profile.​incomestring(Income)required

Applicant's estimated annual income in USD.

Enum"BELOW_50K""BETWEEN_50K_AND_100K""BETWEEN_100K_AND_250K""OVER_250K"
investment_profile.​net_worthstring(Net Worth)required

Applicant's estimated average personal net worth in USD.

Enum"BELOW_50K""BETWEEN_50K_AND_200K""BETWEEN_200K_AND_1M""BETWEEN_1M_AND_5M""OVER_5M"
investment_profile.​bd_associationBd Association (string) or Bd Association (null)(Bd Association)

Name of broker-dealer association or employment. Disclosure is required by law if applicable, else, leave empty

Any of:

Name of broker-dealer association or employment. Disclosure is required by law if applicable, else, leave empty

<= 200 characters
string(Bd Association)<= 200 characters
investment_profile.​director_policy_maker_of_companyDirector Policy Maker Of Company (string) or Director Policy Maker Of Company (null)(Director Policy Maker Of Company)

Name of company where customer is director or policy maker. Disclosure is required by law if applicable, otherwise, leave empty

Any of:

Name of company where customer is director or policy maker. Disclosure is required by law if applicable, otherwise, leave empty

<= 200 characters
string(Director Policy Maker Of Company)<= 200 characters
investment_profile.​occupationstring(Occupation)[ 2 .. 200 ] charactersrequired

Applicant's occupation. Needs to be filled out if employment status is Employed.

investment_profile.​employment_statusany(Employment Status)required
Discriminator
Value "EMPLOYED"
customer_idCustomer Id (string) or Customer Id (null)(Customer Id)

null until application status is APPROVED

Any of:

null until application status is APPROVED

string(uuid)(Customer Id)
documentsArray of objects(Documents)
id_verification_documents_neededboolean(Id Verification Documents Needed)required
identification_number_verification_document_neededboolean(Identification Number Verification Document Needed)required
address_verification_document_neededboolean(Address Verification Document Needed)required
addressobject(ISOAddress)required

Address object

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")

citizenship_countryCitizenship Country (string) or Citizenship Country (null)(Citizenship Country)

The applicant's citizenship country in ISO-3166 Alpha-2 format.

Default "US"
Any of:

The applicant's citizenship country in ISO-3166 Alpha-2 format.

string(Citizenship Country)
Default "US"
identification_number_issuing_countryIdentification Number Issuing Country (string) or Identification Number Issuing Country (null)(Identification Number Issuing Country)

The country that issued the applicant's identification number. Country in ISO-3166 Alpha-2 format. Note: This field will be made mandatory in a future releases.

Default "US"
Any of:

The country that issued the applicant's identification number. Country in ISO-3166 Alpha-2 format. Note: This field will be made mandatory in a future releases.

string(Identification Number Issuing Country)
Default "US"
object_typestring(Object Type)read-onlyrequired
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "time_created": "2023-01-01T12:00:00Z", "updated_at": "2023-01-01T13:00:00Z", "status": "DOCUMENTS_NEEDED", "exception_reasons": [], "phone_number": "+14155550100", "agreement_consent": { "version": "1", "timestamp": "2023-01-01T12:00:00Z" }, "email": "jiko@example.com", "name": { "first_name": "Jiko", "last_name": "Customer" }, "date_of_birth": { "date_of_birth": "1970-01-01" }, "investment_profile": { "income": "BETWEEN_100K_AND_250K", "net_worth": "BETWEEN_1M_AND_5M", "occupation": "Investor", "employment_status": "EMPLOYED" }, "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e", "documents": [ {}, {}, {}, {} ], "id_verification_documents_needed": true, "identification_number_verification_document_needed": false, "address_verification_document_needed": false, "address": { "street_address": "2000 Allston Way", "city": "Berkeley", "postal_code": "94701", "state": "CA", "country": "US" }, "citizenship_country": "US", "identification_number_issuing_country": "US", "object_type": "InternationalApplication" }

Events

Use these endpoints to view Events.

Operations

Health

Use these endpoints to setup automatic health checks for the Partner API.

Operations

Sandbox

Use these endpoints to initiate sandbox functionality.

Operations

Security

Use these endpoints to authenticate requests to the Jiko API.

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

Webhooks

Webhooks

Reports

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

Use these endpoints to interact with Reports.

Operations

ACH

Use these endpoints to create, view, and manage ACH Transfers.

Operations

Counterparties

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

On-Us Transfers

Use these endpoints to create and view On-Us (Book) Transfers between Jiko accounts.

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

Wires

Use this endpoint to initiate Wire Transfers.

Operations

Pockets

Operations

Trading Strategies

Operations

Transactions V2

Operations

Health

Use these endpoints to setup automatic health checks for the Partner API.

Operations

Counterparties V2

Operations