### Query Documentation Example Source: https://choice-bank.gitbook.io/choice-bank/deposit/earn-interest Example of how to perform an HTTP GET request to query the documentation dynamically using the 'ask' query parameter. ```http GET https://choice-bank.gitbook.io/choice-bank/deposit/earn-interest.md?ask= ``` -------------------------------- ### Query Documentation via GET Request Source: https://choice-bank.gitbook.io/choice-bank/deposit/deposit-from-m-pesa This example demonstrates how to query the documentation dynamically by making an HTTP GET request to the page URL with an 'ask' query parameter. The question should be specific and self-contained. ```http GET https://choice-bank.gitbook.io/choice-bank/deposit/deposit-from-m-pesa.md?ask= ``` -------------------------------- ### Dynamic Documentation Query Example Source: https://choice-bank.gitbook.io/choice-bank/account/wallet-account/onboard Perform an HTTP GET request to query documentation dynamically using the 'ask' query parameter. ```http GET https://choice-bank.gitbook.io/choice-bank/account/wallet-account/onboard.md?ask= ``` -------------------------------- ### Query Documentation Example Source: https://choice-bank.gitbook.io/choice-bank/account/account-management/add-more-personal-accounts To get additional information not directly present on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and self-contained. ```http GET https://choice-bank.gitbook.io/choice-bank/account/account-management/add-more-personal-accounts.md?ask= ``` -------------------------------- ### Dynamic Documentation Query Example Source: https://choice-bank.gitbook.io/choice-bank/transfer/bank-transfer-rtgs-eft/api-details Perform an HTTP GET request on the current page URL with the `ask` query parameter to query documentation dynamically. The question should be specific and self-contained. ```HTTP GET https://choice-bank.gitbook.io/choice-bank/transfer/bank-transfer-rtgs-eft/api-details.md?ask= ``` -------------------------------- ### Dynamic Documentation Query Example Source: https://choice-bank.gitbook.io/choice-bank/account/sme-account/add-sme-accounts-create-vas To get additional information not directly available on the page, perform an HTTP GET request on the current page URL with the `ask` query parameter. The question should be specific and self-contained. ```http GET https://choice-bank.gitbook.io/choice-bank/account/sme-account/add-sme-accounts-create-vas.md?ask= ``` -------------------------------- ### Initiate Onboarding Request Source: https://choice-bank.gitbook.io/choice-bank/account/current-account Call this endpoint to start the onboarding process for a new current account. ```APIDOC ## POST /onboarding/submitOnboardingRequest ### Description Initiates an onboarding request for a current account by submitting text information. ### Method POST ### Endpoint /onboarding/submitOnboardingRequest ``` -------------------------------- ### Querying Documentation via GET Request Source: https://choice-bank.gitbook.io/choice-bank/getting-started/sandbox-environment Demonstrates how to dynamically query the documentation by making an HTTP GET request to the page URL with an 'ask' query parameter. This is useful for retrieving specific information not explicitly present on the page. ```http GET https://choice-bank.gitbook.io/choice-bank/getting-started/sandbox-environment.md?ask= ``` -------------------------------- ### Query Documentation with a Question Source: https://choice-bank.gitbook.io/choice-bank/otp/confirm-otp Perform an HTTP GET request to the documentation index with the 'ask' parameter to get a direct answer to your question. ```http GET https://choice-bank.gitbook.io/choice-bank/otp/api-details.md?ask= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://choice-bank.gitbook.io/choice-bank/getting-started/faqs Perform an HTTP GET request to the current page URL with the 'ask' query parameter to dynamically query the documentation. The question should be specific and self-contained. ```http GET https://choice-bank.gitbook.io/choice-bank/getting-started/faqs.md?ask= ``` -------------------------------- ### Dynamic Documentation Query (HTTP GET) Source: https://choice-bank.gitbook.io/choice-bank/notifications/callback-notifications/scenarios-pay-ins-outs To get additional information not directly present on a page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and self-contained. ```http GET https://choice-bank.gitbook.io/choice-bank/notifications/callback-notifications/scenarios-pay-ins-outs.md?ask= ``` -------------------------------- ### Query Documentation with HTTP GET Source: https://choice-bank.gitbook.io/choice-bank/getting-started Perform an HTTP GET request on a page URL with the `ask` query parameter to dynamically query the documentation. Use this for specific questions, clarifications, or to retrieve related sections not explicitly on the current page. ```http GET https://choice-bank.gitbook.io/choice-bank/getting-started.md?ask= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://choice-bank.gitbook.io/choice-bank/appendix To get information not explicitly present on a page, perform an HTTP GET request to the current page URL with the `ask` query parameter. The question should be specific and self-contained. ```http GET https://choice-bank.gitbook.io/choice-bank/appendix.md?ask= ``` -------------------------------- ### Query Documentation with 'ask' Parameter Source: https://choice-bank.gitbook.io/choice-bank/account/wallet-account/image-specifications Perform an HTTP GET request to query documentation dynamically. Use the 'ask' query parameter with a specific, self-contained question in natural language to get direct answers and relevant excerpts. ```HTTP GET https://choice-bank.gitbook.io/choice-bank/account/wallet-account/image-specifications.md?ask= ``` -------------------------------- ### Query Documentation via GET Request Source: https://choice-bank.gitbook.io/choice-bank/account/account-management/change-contact-details To get additional information not present on the page, perform an HTTP GET request to the current page URL with the 'ask' query parameter. ```http GET https://choice-bank.gitbook.io/choice-bank/account/account-management/change-contact-details.md?ask= ``` -------------------------------- ### Query Documentation Dynamically Source: https://choice-bank.gitbook.io/choice-bank/appendix/lookup-apis Perform an HTTP GET request on the current page URL with the 'ask' query parameter to get answers to specific questions. The question should be self-contained and in natural language. ```http GET https://choice-bank.gitbook.io/choice-bank/appendix/lookup-apis.md?ask= ``` -------------------------------- ### Query Documentation via GET Request Source: https://choice-bank.gitbook.io/choice-bank/transfer/m-pesa-paybill-till-b2b/api-details To get additional information not directly present on the page, perform an HTTP GET request to the page URL with an 'ask' query parameter containing your question. ```http GET https://choice-bank.gitbook.io/choice-bank/transfer/m-pesa-paybill-till-b2b/api-details.md?ask= ``` -------------------------------- ### Querying Documentation Dynamically Source: https://choice-bank.gitbook.io/choice-bank/merchant/imt-transfer To get additional information not explicitly present on a page, make an HTTP GET request to the page URL with an 'ask' query parameter containing your question. ```http GET https://choice-bank.gitbook.io/choice-bank/merchant/imt-transfer.md?ask= ``` -------------------------------- ### Query Documentation Dynamically Source: https://choice-bank.gitbook.io/choice-bank/account/sme-account/account-administrators To get more information not directly on this page, perform an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and in natural language. ```http GET https://choice-bank.gitbook.io/choice-bank/account/sme-account/account-administrators.md?ask= ``` -------------------------------- ### Query Documentation Dynamically Source: https://choice-bank.gitbook.io/choice-bank/account/wallet-account/upgrade-to-current To get additional information not explicitly on this page, perform an HTTP GET request to the current page URL with the `ask` query parameter. The question should be specific and in natural language. ```http GET https://choice-bank.gitbook.io/choice-bank/account/wallet-account/upgrade-to-current.md?ask= ``` -------------------------------- ### Query Documentation Dynamically Source: https://choice-bank.gitbook.io/choice-bank/transfer/cny-transfer To get additional information not directly present on the page, make an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and self-contained. ```http GET https://choice-bank.gitbook.io/choice-bank/transfer/cny-transfer.md?ask= ``` -------------------------------- ### Onboarding Request Error Response Source: https://choice-bank.gitbook.io/choice-bank/account/current-account/onboard This is an example of an error response, such as an invalid signature. ```json { "code": "12005", "msg": "Invalid signature" } ``` -------------------------------- ### Initiate SME Onboarding Request Source: https://choice-bank.gitbook.io/choice-bank/account/sme-account Call this endpoint to start the SME onboarding process. Users will select their SME type and OTP delivery method. ```APIDOC ## Initiate Onboarding Request ### Description Initiates an onboarding request for an SME account. The user selects their SME type and preferred OTP delivery method (SMS or email). ### Method POST ### Endpoint `/onboarding/business/applyForSmeOnboarding` ### Response #### Success Response (200) - **onboardingRequestId** (string) - The unique identifier for the onboarding request. - **status** (string) - The initial status of the onboarding request, typically `1-SUBMITTED`. ``` -------------------------------- ### Initiate Wallet Account Onboarding Source: https://choice-bank.gitbook.io/choice-bank/account/wallet-account Initiates the onboarding process for a new wallet account by submitting user information. ```APIDOC ## POST /onboarding/v3/submitEasyOnboardingRequest ### Description Call this endpoint to initiate an onboarding request for a wallet account by submitting the required text information. ### Method POST ### Endpoint /onboarding/v3/submitEasyOnboardingRequest ``` -------------------------------- ### Submit Easy Onboarding Request Source: https://choice-bank.gitbook.io/choice-bank/account/wallet-account/onboard Use this endpoint to onboard a new client and submit their KYC information. Requires user details, identification documents, and photos. ```json { "onboardingRequestId": "" } ``` ```json { "code": "12005", "msg": "Invalid signature" } ``` -------------------------------- ### Get List of CNY Transfers Source: https://choice-bank.gitbook.io/choice-bank/transfer/cny-transfer Use this endpoint to get an account-specific list of CNY Express transfers. ```APIDOC ## Get List of CNY Transfers ### Description Use this endpoint to get an account-specific list of CNY Express transfers. ### Method POST ### Endpoint /query/getCnyTransList ### Parameters #### Request Body - **userId** (string) - Required - Unique identifier of the user in your system. - **accountId** (string) - Required - Payer Account Number - **startTime** (long) - Required - UTC timestamp in milliseconds - **endTime** (long) - Required - UTC timestamp in milliseconds - **pageNo** (string) - Required - Number of pages to be returned - **pageSize** (string) - Required - Number of records per page to return ### Response #### Success Response (00000) - **code** (string) - Completion status code. - **msg** (string) - Completion message. - **sender** (string) - Identifier of the sender service. - **requestId** (string) - Unique identifier for the request. - **locale** (string) - Locale of the response. - **data** (object) - Contains the transfer list and total rows. - **result** (array) - List of CNY transfer objects. - **applicationId** (string) - Application ID. - **payerAccountId** (string) - Payer Account ID. - **beneficiaryType** (string) - Beneficiary type. - **beneficiaryName** (string) - Name of the beneficiary bank. - **beneficiaryCountryCode** (string) - Beneficiary country code. - **beneficiaryBankCode** (string) - Bank code. - **beneficiaryBankName** (string) - Bank name. - **beneficiaryIdNumber** (string) - Registration ID number. - **beneficiaryBankAddress** (string) - Bank address. - **beneficiaryAccountId** (string) - Beneficiary account ID. - **paymentPurpose** (string) - Purpose of the payment. - **messageToBeneficiary** (string) - Message sent to the beneficiary. - **remark** (string) - Remark associated with the transfer. - **amount** (string) - Total amount of the transfer. - **status** (integer) - Status of the transfer. - **createTime** (long) - Timestamp when the transfer was created. - **completedTime** (long) - Timestamp when the transfer was completed (null if not completed). - **totalRows** (integer) - Total number of rows available. - **timestamp** (long) - Timestamp of the response generation. - **salt** (string) - Salt used for signature generation. - **signature** (string) - Signature of the response. ### Request Example ```json { "userId": "string", "accountId": "string", "startTime": 0, "endTime": 0, "pageNo": "string", "pageSize": "string" } ``` ### Response Example ```json { "code": "00000", "msg": "Completed successfully", "sender": "apigw.baas.choice", "requestId": "MYWAGEPAYac110c7d24a119443c52b6d90", "locale": "en_KE", "data": { "result": [ { "applicationId": "CERI1680870648924160008212", "payerAccountId": "46013000093962", "beneficiaryType": "1", "beneficiaryName": "beneficiaryName", "beneficiaryCountryCode": "ZAF", "beneficiaryBankCode": "AHZYRCB", "beneficiaryBankName": "安徽枞阳农村商业银行", "beneficiaryIdNumber": "1523452345", "beneficiaryBankAddress": "安徽枞阳", "beneficiaryAccountId": "1345634565", "paymentPurpose": "PURCHASE_GOODS", "messageToBeneficiary": "messageToBeneficiary", "remark": "46012000012311", "amount": "10.0000", "status": -1, "createTime": 1769757057000, "completedTime": null } ], "totalRows": 5 }, "timestamp": 1769762521608, "salt": "b3_&!#f&Xb!h6Tdt$v1FYI4dRr5Yd*wR", "signature": "e8bae60d95e2fe3f54775435a67c7fb8d05785125a1fef60efac80c2a8d553b9" } ``` ``` -------------------------------- ### Initiate SME Onboarding Request Source: https://choice-bank.gitbook.io/choice-bank/account/sme-account/onboard Use this POST endpoint to start the SME onboarding process. The onboarding status will be set to 1 upon successful initiation. Ensure all required parameters, including userId, countryCode, mobile, businessType, and otpType, are provided. ```json { "onboardingRequestId": "ONBRD02681f54fc342000" } ``` -------------------------------- ### Get Interbank Transfer List Source: https://choice-bank.gitbook.io/choice-bank/transfer/bank-transfer-rtgs-eft/api-details Use this endpoint to get the list of large volume interbank transfers. ```APIDOC ## POST /trans/getInterBankTransferList ### Description Use this endpoint to get the list of large volume interbank transfers. ### Method POST ### Endpoint /trans/getInterBankTransferList ### Parameters #### Request Body - **clientId** (String) - Required - Client ID. - **accountId** (string) - Required - Account number. - **startTime** (long) - Required - Start time. - **endTime** (long) - Required - End time. - **pageNo** (int) - Required - Page number. - **pageSize** (int) - Required - Page size. ### Response #### Success Response (200) - **result** (array) - Description not provided. - **applicationId** (string) - Description not provided. - **accountId** (string) - Description not provided. - **type** (string) - 1-Domestic Fund Transfer; 2-Cross-border Fund Transfer. - **currency** (string) - Description not provided. - **amount** (string) - Description not provided. - **createTime** (string) - Description not provided. - **status** (string) - Description not provided. ### Request Example ```json { "clientId": "String", "accountId": "string", "startTime": 0, "endTime": 0, "pageNo": 0, "pageSize": 0 } ``` ### Response Example ```json { "result": [ { "applicationId": "", "accountId": "", "type": "", "currency": "", "amount": "", "createTime": "", "status": "" } ] } ``` ``` -------------------------------- ### Initiate SME Onboarding Request Source: https://choice-bank.gitbook.io/choice-bank/account/sme-account/onboard Use this endpoint to initiate an SME onboarding. Once called successfully, the onboarding achieves onboardingStatus = 1. ```APIDOC ## POST /onboarding/business/applyForSmeOnboarding ### Description Initiates an SME onboarding request. Upon successful initiation, the onboarding status will be set to 1. ### Method POST ### Endpoint /onboarding/business/applyForSmeOnboarding ### Parameters #### Request Body - **userId** (string) - Required - Unique string generated by partner to identify the user in their system. - **countryCode** (string) - Required - Country code of the mobile being used to onboard. - **mobile** (string) - Required - The mobile number that the customer is using to onboard. - **email** (string) - Conditional - Email address of the customer. Mandatory when otpType = EMAIL. - **businessType** (integer) - Required - Type of business: 1 - Sole Proprietorship, 2 - Limited Liability Company, 3 - Partnership, 4 - NGO / CBO. - **otpType** (string) - Required - Type of OTP: SMS or EMAIL. ### Response #### Success Response (200) - **onboardingRequestId** (string) - The unique identifier for the onboarding request. #### Response Example ```json { "onboardingRequestId": "ONBRD02681f54fc342000" } ``` ``` -------------------------------- ### Query Documentation Dynamically Source: https://choice-bank.gitbook.io/choice-bank/merchant Perform an HTTP GET request to query the documentation dynamically using the 'ask' query parameter. The question should be specific and self-contained. ```HTTP GET https://choice-bank.gitbook.io/choice-bank/merchant.md?ask= ``` -------------------------------- ### Dynamically Query Documentation Source: https://choice-bank.gitbook.io/choice-bank/transfer/bulk-transfer To get additional information not present on the page, make an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and self-contained. ```HTTP GET https://choice-bank.gitbook.io/choice-bank/transfer/bulk-transfer.md?ask= ``` -------------------------------- ### Ask a Question via Documentation Index Source: https://choice-bank.gitbook.io/choice-bank/account/current-account/closing-individual-account Use this GET request to query the documentation index with a specific question. The response includes direct answers and relevant excerpts. ```http GET https://choice-bank.gitbook.io/choice-bank/account/current-account/close-an-individual-account.md?ask= ``` -------------------------------- ### Dynamic Documentation Query Source: https://choice-bank.gitbook.io/choice-bank/transfer/general-transfer Perform an HTTP GET request with the 'ask' query parameter to dynamically query this documentation. Use this for clarifications or to retrieve related information not explicitly present on the page. ```http GET https://choice-bank.gitbook.io/choice-bank/transfer/general-transfer.md?ask= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://choice-bank.gitbook.io/choice-bank/deposit/deposit-from-banks Use this method to dynamically query the documentation. Append the 'ask' query parameter with your question to the current page URL. The response will include a direct answer and relevant excerpts. ```HTTP GET https://choice-bank.gitbook.io/choice-bank/deposit/deposit-from-banks.md?ask= ``` -------------------------------- ### Query Documentation with 'ask' Parameter Source: https://choice-bank.gitbook.io/choice-bank/account/wallet-account To get additional information not directly on the page, perform an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and self-contained. ```http GET https://choice-bank.gitbook.io/choice-bank/account/wallet-account.md?ask= ``` -------------------------------- ### Perform HTTP GET Request to Query Documentation Source: https://choice-bank.gitbook.io/choice-bank/account/account-management/generate-statements Use this method to ask questions about the documentation. The question should be specific and self-contained. The response includes the answer and relevant excerpts. ```http GET https://choice-bank.gitbook.io/choice-bank/account/account-management/generate-statements.md?ask= ``` -------------------------------- ### Create a new wallet Source: https://choice-bank.gitbook.io/choice-bank/account/wallet-account/onboard Use this endpoint to onboard a new client and submit its KYC information. ```APIDOC ## POST /onboarding/v3/submitEasyOnboardingRequest ### Description Use this endpoint to onboard a new client and submit its KYC information. ### Method POST ### Endpoint /onboarding/v3/submitEasyOnboardingRequest ### Parameters #### Request Body - **userId** (string) - Required - Unique string what identifies the user in your system - **firstName** (string) - Required - First name of the onboarding customer - **middleName** (string) - Optional - middle name of the onboarding customer - **lastName** (string) - Required - last name of the onboarding customer - **birthday** (string) - Required - Date of Birth; yyyy-mm-dd - **gender** (integer) - Required - 0 - Female, 1 - Male - **countryCode** (string) - Required - The country code of the mobile, that the customer is using to onboard - **mobile** (string) - Required - The mobile number that the customer is using to onboard - **idType** (string) - Required - Type of the document that the customer is using to onboard. 101 - (Kenya) National ID, 102 - (Kenya) Alien ID, 103 - Passport - **idNumber** (string) - Required - ID Number of National ID/Passport/Alien ID - **address** (string) - Optional - Physical address of the onboarding customer - **kraPin** (string) - Optional - KRA PIN / Tax Number - **email** (string) - Optional - Email address of the customer - **frontSidePhoto** (string) - Required - Base64 string representation of Front side of ID document - **backSidePhoto** (string) - Required - Base64 string representation of back side of ID document - **selfiePhoto** (string) - Required - Base 64 string ### Response #### Success Response (200) - **onboardingRequestId** (string) - Unique onboarding request ID we assigned #### Error Response - **code** (string) - Error code - **msg** (string) - Error message ### Request Example ```json { "userId": "string", "firstName": "string", "middleName": "string", "lastName": "string", "birthday": "yyyy-mm-dd", "gender": 0, "countryCode": "string", "mobile": "string", "idType": "101", "idNumber": "string", "address": "string", "kraPin": "string", "email": "string", "frontSidePhoto": "string", "backSidePhoto": "string", "selfiePhoto": "string" } ``` ### Response Example #### Success Response (200) ```json { "onboardingRequestId": "" } ``` #### Error Response ```json { "code": "12005", "msg": "Invalid signature" } ``` ``` -------------------------------- ### Query LLC Onboarding Info Source: https://choice-bank.gitbook.io/choice-bank/account/query-onboarding-info Use this endpoint to get the onboarding information & media already submitted for the LLC type of SME. ```APIDOC ## POST /onboarding/business/getCompanyOnboardingInfo ### Description Retrieves onboarding information and media for LLC type SMEs. ### Method POST ### Endpoint /onboarding/business/getCompanyOnboardingInfo ### Parameters #### Query Parameters - **onboardingRequestId** (String) - Required - A unique string generated by Choice to identify a certain onboarding request ### Response #### Success Response (200) - **onboardingRequestId** (String) - Description - **smeName** (String) - Description - **businessType** (String) - Description (1-Sole Proprietorship; 2-LLC; 3-Partnership; 5-NGO/CBO) - **countryCode** (String) - Description - **mobile** (String) - Description - **email** (String) - Description - **krapin** (String) - Description - **businessCertificateNumber** (String) - Description - **channel** (String) - Description - **channelUserId** (String) - Description - **onboardingMediaInfos** (Array) - Description - **shareholdersMemberInfos** (Array) - Description - **shareholdersCompanyInfos** (Array) - Description - **status** (String) - Description - **rejectReasonIds** (Array) - Description - **rejectReasonMsgs** (Array) - Description - **createTime** (String) - Description - **auditTime** (String) - Description - **businessIndustry** (String) - Description - **specifyIndustry** (String) - Description - **businessAddress** (String) - Description ### Response Example ```json { "onboardingRequestId": "00000", "smeName": "", "businessType": "", "countryCode": "", "mobile": "", "email": "", "krapin": "", "businessCertificateNumber": "", "channel": "", "channelUserId": "", "onboardingMediaInfos": [ { "fileUrl": "", "mediaType": "", "contentType": "", "fileTypeId": "", "fileKey": "", "fileId": "" } ], "shareholdersMemberInfos": [ { "memberId": "", "countryCode": "", "mobile": "", "idType": "", "idNumber": "", "firstName": "", "middleName": "", "lastName": "", "fullName": "", "kraPin": "", "idFrontFileUrl": "", "idFrontFileType": "", "selfieFileUrl": "", "selfieFileType": "", "idBackFileUrl": "", "idBackFileType": "", "kraPinFileUrl": "", "kraPinFileType": "" } ], "shareholdersCompanyInfos": [ { "companyId": "", "companyName": "", "registrationFileKey": "", "registrationFileUrl": "", "registrationFileType": "" } ], "status": "", "rejectReasonIds": [], "rejectReasonMsgs": [], "createTime": "", "auditTime": "", "businessIndustry": "", "specifyIndustry": "", "businessAddress": "" } ``` ``` -------------------------------- ### Get FX Request Status Source: https://choice-bank.gitbook.io/choice-bank/transfer/foreign-exchange Queries the status of a foreign exchange request. ```APIDOC ## GET /query/v2/getFxRequestStatus ### Description Queries the status of a foreign exchange request. ### Method GET ### Endpoint /query/v2/getFxRequestStatus ``` -------------------------------- ### Submit Onboarding Documents Source: https://choice-bank.gitbook.io/choice-bank/account/current-account Uploads the necessary documents for the onboarding process. Documents must be submitted within 30 minutes of initiating the request. ```APIDOC ## POST /onboarding/uploadMedia ### Description Submits onboarding documents required for account creation. Refer to the 'Documents' table for a list of required files and their types. ### Method POST ### Endpoint /onboarding/uploadMedia ### Warning Documents must be submitted within 30 minutes of initiating the onboarding request, or the request will expire. ``` -------------------------------- ### Submit Company Onboarding Request Source: https://choice-bank.gitbook.io/choice-bank/account/sme-account/onboard Use this endpoint to onboard a new limited liability company and submit its KYB information. ```APIDOC ## POST /onboarding/business/submitCompanyOnboardingRequest ### Description Use this endpoint to onboard a new limited liability company and submits its KYB information. ### Method POST ### Endpoint /onboarding/business/submitCompanyOnboardingRequest ### Parameters #### Request Body - **onboardingRequestId** (string) - Required - Unique onboarding request ID we assigned - **businessName** (string) - Required - Business's name - **businessCerNum** (string) - Required - Business certificate number - **kraPin** (string) - Required - KRA PIN / Tax Number of the business - **operatingMode** (integer) - Required - 1 - Singly, 2 - Either to sign, 3 - Any Two to Sign, 4 - All of Us Jointly - **businessAddress** (string) - Required - Physical address of the onboarding business - **businessIndustry** (string) - Required - Captures the industry the business is operating in. Please submit the number representing the business sector. (1 - Agriculture and Agribusiness, 2 - Manufacturing and Processing, 3 - Construction and Engineering, 4 - Retail and Wholesale Trade, 5 - Information and Communication Technology, 6 - Tourism and Hospitality, 7 - Health and Wellness Services, 8 - Education and Training, 9 - Financial Services, 10 - Professional Services, 11 - Creative Industries, 12 - Renewable Energy and Environmental Conservation, 13 - Transport and Logistics, 14 - Food and Beverage, 15 - Textiles and Apparel, 16 - Automotive and Engineering Services, 17 - Beauty and Personal Care, 18 - Real Estate and Property Development, 19 - Consulting and Business Services, 20 - Social Enterprises and NGOs, 21 - Others, please specify) - **specifyIndustry** (string) - Optional - Mandatory when businessIndustry == Others ### Response #### Success Response (200) - **code** (string) - Response code - **msg** (string) - Response message #### Response Example ```json { "code": "00000", "msg": "Completed successfully" } ``` #### Error Response - **code** (string) - Response code - **msg** (string) - Response message #### Response Example ```json { "code": "12005", "msg": "Invalid signature" } ``` ``` -------------------------------- ### Perform HTTP GET Request with 'ask' Parameter Source: https://choice-bank.gitbook.io/choice-bank/appendix/type-status-ids Use this method to query the documentation dynamically when information is not directly available. The question should be specific and self-contained. ```http GET https://choice-bank.gitbook.io/choice-bank/appendix/type-status-ids.md?ask= ``` -------------------------------- ### Get All Accounts of a Client Source: https://choice-bank.gitbook.io/choice-bank/account/account-management Retrieves a list of all accounts associated with a specific user ID. ```APIDOC ## POST /account/queryAccountListByUserId ### Description Use this endpoint to get a list of all API-onboarded accounts tied to a particular User ID. ### Method POST ### Endpoint /account/queryAccountListByUserId ### Parameters #### Request Body - **userId** (string) - Required - Unique string you assigned to identify the user(s) ### Response #### Success Response (200) - **accounts** (array) - Description - **accountId** (string) - Description - **accountName** (string) - Description - **currency** (string) - Description - **accountType** (string) - Description - C001-Current Account, C002-Wallet Account, C004-Loan Account, C006-Fixed Deposit Account, B001-SME Account, B005-Business Loan Account, B006-Business Fixed Deposit Account - **dormantStatus** (string) - Description - 0-Normal; 1-Dormant; - **freezeStatus** (string) - Description - 0-Normal; 1-Frozen; ### Response Example ```json { "accounts": [ { "accountId": "", "accountName": "", "currency": "", "accountType": "", "dormantStatus": "", "freezeStatus": "" } ] } ``` ``` -------------------------------- ### Get Onboarding Result Source: https://choice-bank.gitbook.io/choice-bank/account/sme-account Retrieve the onboarding result based on the type of business entity. ```APIDOC ## GET /onboarding/business/getStoreOnboardingInfo ### Description Retrieves the onboarding information for a Sole Proprietorship. ### Method GET ### Endpoint /onboarding/business/getStoreOnboardingInfo ### Response (No specific response schema provided in the source) ``` ```APIDOC ## GET /onboarding/business/getCompanyOnboardingInfo ### Description Retrieves the onboarding information for a Limited Liability Company. ### Method GET ### Endpoint /onboarding/business/getCompanyOnboardingInfo ### Response (No specific response schema provided in the source) ``` ```APIDOC ## GET /onboarding/business/getOrganisationOnboardingInfo ### Description Retrieves the onboarding information for an NGO/CBO. ### Method GET ### Endpoint /onboarding/business/getOrganisationOnboardingInfo ### Response (No specific response schema provided in the source) ``` ```APIDOC ## GET /onboarding/business/getPartnershipOnboardingInfo ### Description Retrieves the onboarding information for a Partnership Company. ### Method GET ### Endpoint /onboarding/business/getPartnershipOnboardingInfo ### Response (No specific response schema provided in the source) ```