Sign in

v1

latestOpenAPI 3.0.22026-07-2667277423.4 KB
Platform Model

Live Application: Update

Updates the live application for the applicant merchant

patch/live_application/{merchant_id}

Path parameters

merchant_idstring required

A unique 25-character alphanumeric resource identifier.

Request body

locale'ja' | 'en' | 'ko'

For supported payment methods, sets the language of the instruction page.

service_agreement.agreed_to_tosboolean

Whether the merchant has agreed to KOMOJU's terms of service.

company_information.company_namestring

Registered legal name of the company.

company_information.company_phonestring

Company contact phone number.

company_information.company_country'AR' | 'AM' | 'AU' | 'AT' | 'BE' | 'BR' | 'BG' | 'CA' | 'KY' | 'CL' | 'CN' | 'CO' | 'CR' | 'HR' | 'CW' | 'CY' | 'CZ' | 'DK' | 'EC' | 'EE' | 'FI' | 'FR' | 'GE' | 'DE' | 'GI' | 'GR' | 'GU' | 'GG' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IE' | 'IM' | 'IL' | 'IT' | 'JP' | 'JE' | 'JO' | 'KR' | 'KW' | 'LV' | 'LI' | 'LT' | 'LU' | 'MO' | 'MY' | 'MT' | 'MX' | 'MD' | 'MC' | 'NL' | 'NZ' | 'NO' | 'OM' | 'PE' | 'PH' | 'PL' | 'PT' | 'PR' | 'QA' | 'RO' | 'RU' | 'SG' | 'SK' | 'SI' | 'ZA' | 'ES' | 'SE' | 'CH' | 'TW' | 'TH' | 'TR' | 'AE' | 'GB' | 'US' | 'UY' | 'VG' | 'VI'
company_information.corporation_type'sole_proprietor' | 'corporation'

Whether the business is a sole proprietorship or corporation.

company_information.company_postal_codestring

Postal code of the company's registered address.

company_information.company_prefecture_statestring

Prefecture or state of the company's registered address.

company_information.company_prefecture_state_kanastring

Prefecture or state in katakana.

company_information.company_citystring

City of the company's registered address.

company_information.company_city_kanastring

City name in katakana.

company_information.company_addressstring

Street address of the company.

company_information.industry_descriptionstring

Description of the industry the company operates in.

company_information.business_descriptionstring

Description of the company's business activities and products/services sold.

company_information.employee_numberstring

Number of employees at the company.

company_information.establishment_datestring

Date the company was established (YYYY-MM-DD format).

company_information.office_namestring

Name of the specific office or branch.

company_information.contact_emailstring

Primary contact email address for the company.

company_information.contact_phonestring

Primary contact phone number for the company.

company_information.incorporation_certificatesstring[]

File IDs of uploaded incorporation certificate documents.

company_information.registration_numberstring

Company registration number.

company_information.share_capital_amountinteger

Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).

company_information.share_capital_currency'JPY' | 'USD' | 'EUR' | 'TWD' | 'KRW' | 'PLN' | 'GBP' | 'HKD' | 'SGD' | 'NZD' | 'AUD' | 'IDR' | 'MYR' | 'PHP' | 'THB' | 'CNY' | 'BRL' | 'CHF' | 'CAD' | 'VND'

3-letter ISO currency code.

company_information.sole_proprietor_proofsstring[]

File IDs of uploaded sole proprietorship proof documents.

company_information.company_name_kanastring

Company name in katakana.

company_information.company_name_alphabetstring

Company name in alphanumeric (Roman) characters.

company_information.company_urlstring

URL of the company's website.

company_information.company_address_kanastring

Street address in katakana.

company_information.company_address_building_namestring

Building name portion of the company address.

company_information.company_address_building_name_kanastring

Building name in katakana.

representative_director_information.first_namestring

Representative director's first name.

representative_director_information.first_name_kanastring

Representative director's first name in katakana.

representative_director_information.last_namestring

Representative director's last name.

representative_director_information.last_name_kanastring

Representative director's last name in katakana.

representative_director_information.date_of_birthstring

Representative director's date of birth (YYYY-MM-DD format).

representative_director_information.gender'male' | 'female'

Representative director's gender.

representative_director_information.country'AR' | 'AM' | 'AU' | 'AT' | 'BE' | 'BR' | 'BG' | 'CA' | 'KY' | 'CL' | 'CN' | 'CO' | 'CR' | 'HR' | 'CW' | 'CY' | 'CZ' | 'DK' | 'EC' | 'EE' | 'FI' | 'FR' | 'GE' | 'DE' | 'GI' | 'GR' | 'GU' | 'GG' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IE' | 'IM' | 'IL' | 'IT' | 'JP' | 'JE' | 'JO' | 'KR' | 'KW' | 'LV' | 'LI' | 'LT' | 'LU' | 'MO' | 'MY' | 'MT' | 'MX' | 'MD' | 'MC' | 'NL' | 'NZ' | 'NO' | 'OM' | 'PE' | 'PH' | 'PL' | 'PT' | 'PR' | 'QA' | 'RO' | 'RU' | 'SG' | 'SK' | 'SI' | 'ZA' | 'ES' | 'SE' | 'CH' | 'TW' | 'TH' | 'TR' | 'AE' | 'GB' | 'US' | 'UY' | 'VG' | 'VI'
representative_director_information.postal_codestring

Postal code of the representative director's address.

representative_director_information.prefecture_statestring

Prefecture or state of the representative director's address.

representative_director_information.prefecture_state_kanastring

Prefecture or state in katakana.

representative_director_information.citystring

City of the representative director's address.

representative_director_information.city_kanastring

City name in katakana.

representative_director_information.addressstring

Street address of the representative director.

representative_director_information.address_kanastring

Street address in katakana.

representative_director_information.address_building_namestring

Building name portion of the representative director's address.

representative_director_information.address_building_name_kanastring

Building name in katakana.

representative_director_information.phonestring

Representative director's phone number.

applicant_information.first_namestring

Applicant's first name.

applicant_information.first_name_kanastring

Applicant's first name in katakana.

applicant_information.last_namestring

Applicant's last name.

applicant_information.last_name_kanastring

Applicant's last name in katakana.

applicant_information.country'AR' | 'AM' | 'AU' | 'AT' | 'BE' | 'BR' | 'BG' | 'CA' | 'KY' | 'CL' | 'CN' | 'CO' | 'CR' | 'HR' | 'CW' | 'CY' | 'CZ' | 'DK' | 'EC' | 'EE' | 'FI' | 'FR' | 'GE' | 'DE' | 'GI' | 'GR' | 'GU' | 'GG' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IE' | 'IM' | 'IL' | 'IT' | 'JP' | 'JE' | 'JO' | 'KR' | 'KW' | 'LV' | 'LI' | 'LT' | 'LU' | 'MO' | 'MY' | 'MT' | 'MX' | 'MD' | 'MC' | 'NL' | 'NZ' | 'NO' | 'OM' | 'PE' | 'PH' | 'PL' | 'PT' | 'PR' | 'QA' | 'RO' | 'RU' | 'SG' | 'SK' | 'SI' | 'ZA' | 'ES' | 'SE' | 'CH' | 'TW' | 'TH' | 'TR' | 'AE' | 'GB' | 'US' | 'UY' | 'VG' | 'VI'
applicant_information.gender'male' | 'female'

Applicant's gender.

applicant_information.date_of_birthstring

Applicant's date of birth (YYYY-MM-DD format).

applicant_information.identity_document_type'passport' | 'drivers_license' | 'id_card' | 'my_number_card'

Type of identity document submitted for verification.

applicant_information.identity_frontstring

File ID of the front side of the uploaded identity document.

applicant_information.identity_backstring

File ID of the back side of the uploaded identity document.

site_information.site_namestring

Name of the merchant's website or online store.

site_information.site_name_kanastring

Site name in katakana.

site_information.site_name_alphabetstring

Site name in alphanumeric (Roman) characters.

site_information.site_urlstring

URL of the merchant's online store.

site_information.establishment_datestring

Date the online store was established (YYYY-MM-DD format).

site_information.store_country'AR' | 'AM' | 'AU' | 'AT' | 'BE' | 'BR' | 'BG' | 'CA' | 'KY' | 'CL' | 'CN' | 'CO' | 'CR' | 'HR' | 'CW' | 'CY' | 'CZ' | 'DK' | 'EC' | 'EE' | 'FI' | 'FR' | 'GE' | 'DE' | 'GI' | 'GR' | 'GU' | 'GG' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IE' | 'IM' | 'IL' | 'IT' | 'JP' | 'JE' | 'JO' | 'KR' | 'KW' | 'LV' | 'LI' | 'LT' | 'LU' | 'MO' | 'MY' | 'MT' | 'MX' | 'MD' | 'MC' | 'NL' | 'NZ' | 'NO' | 'OM' | 'PE' | 'PH' | 'PL' | 'PT' | 'PR' | 'QA' | 'RO' | 'RU' | 'SG' | 'SK' | 'SI' | 'ZA' | 'ES' | 'SE' | 'CH' | 'TW' | 'TH' | 'TR' | 'AE' | 'GB' | 'US' | 'UY' | 'VG' | 'VI'
site_information.store_postal_codestring

Postal code of the store's physical location.

site_information.store_prefecture_statestring

Prefecture or state of the store's physical location.

site_information.store_prefecture_state_kanastring

Prefecture or state in katakana.

site_information.store_citystring

City of the store's physical location.

site_information.store_city_kanastring

City name in katakana.

site_information.store_addressstring

Street address of the store's physical location.

site_information.store_address_kanastring

Store street address in katakana.

site_information.store_building_namestring

Building name for the store's address.

site_information.store_building_name_kanastring

Building name in katakana.

site_information.site_product_descriptionstring

Description of the products or services sold on the site.

site_information.site_annual_salesinteger

Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).

site_information.site_annual_sales_currency'JPY' | 'USD' | 'EUR' | 'TWD' | 'KRW' | 'PLN' | 'GBP' | 'HKD' | 'SGD' | 'NZD' | 'AUD' | 'IDR' | 'MYR' | 'PHP' | 'THB' | 'CNY' | 'BRL' | 'CHF' | 'CAD' | 'VND'

3-letter ISO currency code.

site_information.site_average_transactional_valuestring

Average transaction value as a formatted string.

site_information.site_average_transactional_currency'JPY' | 'USD' | 'EUR' | 'TWD' | 'KRW' | 'PLN' | 'GBP' | 'HKD' | 'SGD' | 'NZD' | 'AUD' | 'IDR' | 'MYR' | 'PHP' | 'THB' | 'CNY' | 'BRL' | 'CHF' | 'CAD' | 'VND'

3-letter ISO currency code.

site_information.site_minimum_product_pricing_centsinteger

Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).

site_information.site_minimum_product_pricing_currency'JPY' | 'USD' | 'EUR' | 'TWD' | 'KRW' | 'PLN' | 'GBP' | 'HKD' | 'SGD' | 'NZD' | 'AUD' | 'IDR' | 'MYR' | 'PHP' | 'THB' | 'CNY' | 'BRL' | 'CHF' | 'CAD' | 'VND'

3-letter ISO currency code.

site_information.site_maximum_product_pricing_centsinteger

Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).

site_information.site_maximum_product_pricing_currency'JPY' | 'USD' | 'EUR' | 'TWD' | 'KRW' | 'PLN' | 'GBP' | 'HKD' | 'SGD' | 'NZD' | 'AUD' | 'IDR' | 'MYR' | 'PHP' | 'THB' | 'CNY' | 'BRL' | 'CHF' | 'CAD' | 'VND'

3-letter ISO currency code.

site_information.sctl_urlstring

URL of the merchant's Specified Commercial Transaction Law disclosure page.

site_information.sales_permit_requiredboolean

Whether a sales permit is required for the merchant's business type.

site_information.aup_acceptedboolean

Whether the merchant has accepted the Acceptable Use Policy.

site_information.industry_type'clothing_and_accessories' | 'computer_software' | 'consulting_services' | 'antique_shops' | 'arts_and_crafts' | 'auto_and_home_supplies' | 'beauty_products_and_cosmetics' | 'bedding_mattresses' | 'beer_wine_liquor' | 'bicycle_shops' | 'boat_dealers_marine_supplies' | 'book_shops' | 'bridal_wear_or_maternity_clothing' | 'chemicals_chemist_supplies' | 'children_infant_clothes' | 'clocks_watches_and_timepieces' | 'computers_and_peripherals' | 'convenience_stores_and_specialty_stores' | 'electric_razor_stores' | 'flower_shops_florists' | 'furniture_shops' | 'gift_souvenir_shops' | 'hardware_stores' | 'household_appliances' | 'jewelry_stores' | 'lawn_garden_supplies' | 'luggage_and_leather_goods' | 'magazines_newspapers' | 'mens_boys_clothing' | 'musical_instruments_pianos_and_sheet_music' | 'office_equipment_supplies' | 'pet_foods_supplies' | 'pet_shops' | 'photography_equipment' | 'record_stores' | 'secondhand_goods_used_goods' | 'sewing_needlework_fabric_and_piece_good_stores' | 'shoe_stores' | 'smartphone_sales' | 'sporting_goods' | 'sports_clothing' | 'stationery_stores' | 'toy_shops' | 'uniforms_suits' | 'womens_clothing' | 'adult_content' | 'digital_books_movies_and_music' | 'game_toy_and_hobby_shops' | 'mobile_apps' | 'online_music_streaming' | 'software' | 'software_as_a_service' | 'subscription_software' | 'candy_nut_and_confectionery' | 'catering_restaurants_and_other_food_delivery' | 'dairy_products' | 'eating_places_and_restaurants' | 'fast_food_restaurants' | 'food_stores' | 'frozen_meat_stores' | 'grocery_stores_supermarkets' | 'attorneys_solicitors_and_legal_services' | 'auctions' | 'business_services' | 'car_matching_services' | 'computer_modification_chips' | 'crowdfunding' | 'data_provisioning_services' | 'government_services' | 'mail_packing_services' | 'marketing_services' | 'online_data_storage_services' | 'printing_copy_and_fax_centers' | 'publishing_companies' | 'real_estate_agency' | 'seo' | 'solar_panel_installation' | 'telephone_communication' | 'virtual_private_network' | 'voiceoverip_voip_services' | 'waste_management_services' | 'web_design_services' | 'charities' | 'civic_fraternal_or_social_associations_non_profit' | 'country_clubs_nonprofit' | 'gun_clubs' | 'membership_organisations' | 'other_membership_organisations_nonprofit' | 'political_organisations_non_profit' | 'religious_organisations_non_profit' | 'garden_and_hardware_stores' | 'marriage_agency_services' | 'photography' | 'airlines_and_air_carriers' | 'cruise_lines' | 'hotel_auctions_one_day_sales' | 'rental_property' | 'timeshares' | 'cosmetic_surgery' | 'medical_and_dental_supplies' | 'opticians_contact_lenses_and_glasses' | 'pharmacies_and_chemists' | 'remote_medical_consultation' | 'self_diagnosis_kits' | 'business_and_secretarial_schools' | 'colleges_universities_professional_schools_and_junior_colleges' | 'correspondence_schools' | 'elementary_or_secondary_schools' | 'schools_and_education' | 'trade_and_vocational_schools' | 'amusement_parks' | 'arcades_video_game_establishments' | 'escort_services' | 'gambling' | 'lotteries_and_raffles' | 'movie_and_film_distribution' | 'museums_expositions' | 'theatrical_producers' | 'ticket_sales' | 'tourism' | 'car_truck_dealers' | 'car_repair_services' | 'commercial_equipment' | 'construction_materials_supplies' | 'locksmiths' | 'photo_printing_developing' | 'photography_art_and_graphics' | 'scrap_metal_dealers' | 'telecommunication_equipment' | 'warehouses_storage' | 'account_aggregation_services' | 'cfd_fx_trading' | 'cryptocurrencies' | 'currency_exchangers' | 'debt_collection_bailiffs_collection_agencies' | 'financial_claims_management' | 'financial_institutions' | 'foreign_exchange_and_travellers_cheques' | 'investment_advice_tipster_services' | 'money_service_business' | 'money_transfer_agencies_wire_transfers' | 'payment_service_provider' | 'precious_metals_and_stones_investments' | 'property_advice_and_investment' | 'property_investment_land_banking' | 'receivership_accounts' | 'security_brokers_and_dealers' | 'shares_and_unit_trust_brokers' | 'short_term_payday_loans' | 'stored_value_wallets_gift_cards' | 'tax_optimization_services' | 'wine_and_spirit_investments' | 'other_not_listed_category' | 'cannabis_seeds' | 'cbd_products' | 'direct_marketing' | 'door_to_door_sales_and_direct_selling' | 'identification_document_services' | 'jammers_and_radio_blockers' | 'liquidation_sales' | 'marketplaces' | 'multi_level_marketing_pyramid_schemes' | 'network_marketing' | 'research_chemicals_and_legal_highs' | 'tobacco' | 'weapons' | 'wholesale_drugs'
site_information.sales_permitsstring[]

File IDs of uploaded sales permit documents.

bank_account_information.zengin_bank_namestring

Name of the merchant's bank (Zengin network).

bank_account_information.zengin_bank_codestring

4-digit bank code in the Zengin network.

bank_account_information.zengin_branch_namestring

Name of the bank branch.

bank_account_information.zengin_branch_codestring

3-digit branch code.

bank_account_information.zengin_account_type'ordinary' | 'checking'

Type of bank account (ordinary or checking).

bank_account_information.zengin_account_numberstring

Bank account number.

bank_account_information.zengin_account_holder_kanastring

Account holder name in katakana as registered with the bank.

bank_account_information.transfer_type'domestic'

Type of bank transfer supported (currently only "domestic").

bank_account_information.currency'JPY' | 'USD' | 'EUR' | 'TWD' | 'KRW' | 'PLN' | 'GBP' | 'HKD' | 'SGD' | 'NZD' | 'AUD' | 'IDR' | 'MYR' | 'PHP' | 'THB' | 'CNY' | 'BRL' | 'CHF' | 'CAD' | 'VND'

3-letter ISO currency code.

bank_account_information.default_frequency'weekly' | 'monthly'

Example request

{
  "company_information.share_capital_currency": "JPY",
  "site_information.site_annual_sales_currency": "JPY",
  "site_information.site_average_transactional_currency": "JPY",
  "site_information.site_minimum_product_pricing_currency": "JPY",
  "site_information.site_maximum_product_pricing_currency": "JPY",
  "bank_account_information.currency": "JPY"
}

Response

Subsequent requests will specify errored fields or additional required fields

merchant_idstring required

A unique 25-character alphanumeric resource identifier.

status'not_applied' | 'incomplete' | 'pending' | 'accepted' | 'declined' required
payments_enabledboolean required

Whether payments have been enabled following application review.

payouts_enabledboolean required

Whether payouts have been enabled following application review.