This guide walks through how to use the Partner API to onboard non-business customers (if you are trying to onboard business customers onto your application, please read "Onboarding Businesses" instead).
As a regulated financial institution, Jiko is required to perform Customer Identification Program (CIP), Know Your Customer (KYC), and Know Your Business (KYB) checks on all applicants. Therefore, customers cannot be created directly using the Partner API — they are created automatically when an application is approved. The application process described below collects the information needed for these checks and is the only way to create customers in the system.
The individual onboarding system is based on Applications, which spawn a Customer once approved. An Application must contain sensitive user data that undergoes KYC (Know Your Customer) verification.
Three prerequisites must be fulfilled before creating an application (see Partner Obligations):
- Verify ownership of the phone number used in the application (e.g. via confirmation code).
- Verify ownership of the email address used in the application (e.g. via confirmation code).
- Display agreements provided by Jiko to the user, note the version number, and get time-stamped consent. The version and timestamp must be attached to the application. Re-fetch agreements for every new application to ensure the latest version is presented.
Initiate the onboarding process for a new individual customer by creating an Application. The application captures all required personal information — including name, date of birth, address, identification number, investment profile, and agreement consent — in a single request. Unlike business applications, all required fields must be provided at creation time.
Partner systems:
- Complete the prerequisites above (phone/email verification, agreement consent).
- Collect the individual's personal information (name, email, phone number, date of birth, identification number such as SSN, address, investment profile).
- Call Jiko's create application endpoint with the complete set of information.
- Receive the created application with its Jiko
idandstatus: "CREATED". - Store the application
idin internal systems for subsequent tracking.
| Step | Purpose | Jiko API Endpoints |
|---|---|---|
| 1 | Create a new Individual Application with the applicant's personal details. | POST /api/v1/applications/ |
Submit a completed Individual Application for KYC review. Once the application has been created with all required information, it is submitted for identity verification. Upon approval, a Customer is created with an account and a portal with routing and account numbers, ready to receive external ACH fund transfers.
After submission, the application may require identity verification documents. When status transitions to "DOCUMENTS_NEEDED", the response flags indicate which documents must be uploaded.
| Status | Description |
|---|---|
CREATED | Initial state of all applications. Call Apply to submit. |
SUBMITTED | The application is being processed. Poll Get Application or subscribe to webhooks to monitor status changes. |
DOCUMENTS_NEEDED | Identity verification documents are required. Upload them based on the flags in the response (see Uploading Documents below). Once all flags are cleared, the status moves to PENDING. |
PENDING | Required actions (e.g., document uploads) are complete. Apply again to re-submit for evaluation. |
MANUAL_REVIEW | The application is being reviewed manually. |
APPROVED | A Customer has been created. The customer_id field is populated. |
REJECTED | Final state. The application cannot be revived. |
Partner systems:
- Call Jiko's apply endpoint to submit the application for KYC review.
- Once successfully submitted, the application
statustransitions to"SUBMITTED". - Poll the application periodically or subscribe to webhooks (e.g.
application.approved,application.documents_needed) to track review progress. - If
statusis"DOCUMENTS_NEEDED", upload the required documents based on the verification flags (see below), then apply again once the status moves to"PENDING". - When
statusis"APPROVED", use thecustomer_idfrom the application to proceed with account setup.
| Step | Purpose | Jiko API Endpoints |
|---|---|---|
| 1 | Submit the application for KYC review. | POST /api/v1/applications/{application_id}/apply/ |
| 2 | Poll the application to track review progress and retrieve the customer_id upon approval. | GET /api/v1/applications/{application_id}/ |
| 3 | Upload a required identity verification document. | POST /api/v1/applications/{application_id}/documents/{document_type}/file/ |
When an application reaches the DOCUMENTS_NEEDED status, you must upload identity verification documents. Which documents to upload is determined by the boolean flags in the application response:
id_verification_documents_needed: Please upload:a
SELFIE, andone of the following:
both
ID_FRONTandID_BACK, ora
PASSPORT
identification_number_verification_document_needed: UploadIDENTIFICATION_NUMBER_VERIFICATION(e.g., SSN card, W-2, tax return).address_verification_document_needed: UploadADDRESS_VERIFICATION(e.g., recent utility bill, bank statement, lease agreement).
Partners implementing their own onboarding UX are required to perform proof of ownership — such as verifying government ID and a live photo match through a trusted vendor — to ensure the individual is the rightful owner of the submitted information (see Partner Obligations).
Once all flags have been cleared, the application status automatically transitions to PENDING. Call the Apply endpoint again to re-submit for evaluation.
| Step | Purpose | Jiko API Endpoints |
|---|---|---|
| 1 | Upload a document for the application. | POST /api/v1/applications/{application_id}/documents/{document_type}/file/ |
| 2 | Re-submit the application after documents are uploaded. | POST /api/v1/applications/{application_id}/apply/ |
The sandbox environment lets you test all application statuses without going through real KYC review. The first digit(s) of the identification_number (e.g. SSN) control which status the application transitions to after calling Apply:
| Prefix | Result after Apply |
|---|---|
2 | DOCUMENTS_NEEDED |
21 | id_verification_documents_needed set to true |
22 | identification_number_verification_document_needed set to true |
23 | address_verification_document_needed set to true |
24 | id_verification_documents_needed and identification_number_verification_document_needed set to true |
3 | MANUAL_REVIEW |
4 | APPROVED |
5 | REJECTED |
| Other | MANUAL_REVIEW |
For identification numbers starting with 2, the third digit controls the transition after uploading documents and re-applying:
- Starts with
2*1: Transitions toMANUAL_REVIEW - Otherwise: Transitions to
APPROVED
Retrieve the current state of an Individual Application at any point during the onboarding process. This supports tracking application progress, verifying submitted information, checking document request statuses, and determining when an application has been approved and a Customer has been created.
Partner systems:
- Call Jiko's get application endpoint with the application
id. - Review the
statusfield to determine the current stage of the application. - If
statusis"APPROVED", extract thecustomer_idto proceed with account operations. - If
statusis"DOCUMENTS_NEEDED", review thedocumentsarray and upload any documents withstatus: "PENDING_UPLOAD". - Propagate the application state to internal systems for tracking and reporting.
| Step | Purpose | Jiko API Endpoints |
|---|---|---|
| 1 | Retrieve the current state of an Individual Application. | GET /api/v1/applications/{application_id}/ |