Company Information

>>>

POST /api/v1/company_information
Create Company Information

Creates a new company information record for the onboarding live application of the currently authenticated merchant.

betaThis API is a pre-release. Please contact KOMOJU to obtain more usage instructions before using it.

Examples

  • cURL
  • Node.js
  • Ruby
curl -X POST https://komoju.com/api/v1/live_application/company_information \
  -u sk_123456: \
  -d "company_name=McKenzie" \
  -d "company_name_kana=%E3%83%87%E3%82%B8%E3%82%AB" \
  -d "company_name_alphabet=Degica" \
  -d "registration_number=9258244461478" \
  -d "company_phone=(283)%20842-4687%20x670" \
  -d "company_country=JP" \
  -d "company_postal_code=89330-7963" \
  -d "company_prefecture_state=New%20York" \
  -d "company_city=Moenshire" \
  -d "company_address=9727%20Ziemann%20Fords" \
  -d "company_address_kana=%EF%BD%B6%EF%BE%80%EF%BD%B6%EF%BE%85" \
  -d "company_address_building_name=Apt.%20371" \
  -d "company_address_building_name_kana=%EF%BD%B6%EF%BE%80%EF%BD%B6%EF%BE%85" \
  -d "company_url=https%3A%2F%2Fexample.com%2Fa%2Fb" \
  -d "industry_description=Government%20Agency" \
  -d "business_description=Education%20Management" \
  -d "employee_number=506" \
  -d "establishment_date=2020-03-13" \
  -d "office_name=Frami-Murphy" \
  -d "contact_email=britneygorczany@miller.biz" \
  -d "contact_phone=679.978.4134" \
  -d "corporation_type=corporation" \
  -d "share_capital_amount=1234" \
  -d "share_capital_currency=JPY" \
  -d "incorporation_certificates[]=7estyza4j4a5s1wdqhhe0r4f7" 
var querystring = require('querystring');
var https = require('https');
var secret_key = 'sk_123456'
var auth = 'Basic ' + Buffer.from(secret_key + ':').toString('base64');
var post_data = querystring.stringify({
  'company_name': 'McKenzie',
  'company_name_kana': 'デジカ',
  'company_name_alphabet': 'Degica',
  'registration_number': '9258244461478',
  'company_phone': '(283) 842-4687 x670',
  'company_country': 'JP',
  'company_postal_code': '89330-7963',
  'company_prefecture_state': 'New York',
  'company_city': 'Moenshire',
  'company_address': '9727 Ziemann Fords',
  'company_address_kana': 'カタカナ',
  'company_address_building_name': 'Apt. 371',
  'company_address_building_name_kana': 'カタカナ',
  'company_url': 'https://example.com/a/b',
  'industry_description': 'Government Agency',
  'business_description': 'Education Management',
  'employee_number': '506',
  'establishment_date': '2020-03-13',
  'office_name': 'Frami-Murphy',
  'contact_email': 'britneygorczany@miller.biz',
  'contact_phone': '679.978.4134',
  'corporation_type': 'corporation',
  'share_capital_amount': '1234',
  'share_capital_currency': 'JPY',
  'incorporation_certificates[]': '7estyza4j4a5s1wdqhhe0r4f7'
});

var post_options = {
  host: 'komoju.com',
  port: '443',
  path: '/api/v1/live_application/company_information',
  method: 'POST',
  headers: {
    'Authorization': auth,
    'Content-Length': Buffer.byteLength(post_data)
  }
};

var post_req = https.request(post_options, function(res) {
    res.setEncoding('utf8');
    res.on('data', function (chunk) {
        console.log(chunk);
    });
});

post_req.write(post_data);
post_req.end();
require 'uri'
require 'net/https'
require 'json'
require 'base64'
require 'pp'
uri = URI.parse('https://komoju.com/api/v1/live_application/company_information')
https = Net::HTTP.new(uri.host, uri.port)
https.use_ssl = true
secret_key = 'sk_123456'
auth = Base64.encode64("#{secret_key}:")
headers = {
  'Content-Type' => 'application/json',
  'Authorization' => "Basic #{auth}"
}

body = {
  company_name: "McKenzie",
  company_name_kana: "デジカ",
  company_name_alphabet: "Degica",
  registration_number: "9258244461478",
  company_phone: "(283) 842-4687 x670",
  company_country: "JP",
  company_postal_code: "89330-7963",
  company_prefecture_state: "New York",
  company_city: "Moenshire",
  company_address: "9727 Ziemann Fords",
  company_address_kana: "カタカナ",
  company_address_building_name: "Apt. 371",
  company_address_building_name_kana: "カタカナ",
  company_url: "https://example.com/a/b",
  industry_description: "Government Agency",
  business_description: "Education Management",
  employee_number: "506",
  establishment_date: "2020-03-13",
  office_name: "Frami-Murphy",
  contact_email: "britneygorczany@miller.biz",
  contact_phone: "679.978.4134",
  corporation_type: "corporation",
  share_capital_amount: "1234",
  share_capital_currency: "JPY",
  incorporation_certificates: ["7estyza4j4a5s1wdqhhe0r4f7"]
}

res = https.post(
  uri.path,
  body.to_json,
  headers
)

puts res.body
{
  "id": "62dwxa760ohtfxn44xs35eol0",
  "resource": "company_information",
  "status": "pending",
  "created_at": "2021-03-01T13:07:08.000+09:00",
  "updated_at": "2021-03-01T13:07:08.000+09:00",
  "company_name": "McKenzie",
  "company_name_kana": "デジカ",
  "company_name_alphabet": "Degica",
  "registration_number": "9258244461478",
  "share_capital_amount": 1234,
  "share_capital_currency": "JPY",
  "company_phone": "(283) 842-4687 x670",
  "company_country": "JP",
  "company_postal_code": "89330-7963",
  "company_prefecture_state": "New York",
  "company_prefecture_state_kana": null,
  "company_city": "Moenshire",
  "company_city_kana": null,
  "company_address": "9727 Ziemann Fords",
  "company_address_kana": "カタカナ",
  "company_address_building_name": "Apt. 371",
  "company_address_building_name_kana": "カタカナ",
  "company_url": "https://example.com/a/b",
  "industry_description": "Government Agency",
  "business_description": "Education Management",
  "employee_number": 506,
  "establishment_date": "2020-03-13",
  "office_name": "Frami-Murphy",
  "contact_email": "britneygorczany@miller.biz",
  "contact_phone": "679.978.4134",
  "corporation_type": "corporation",
  "incorporation_certificates": [
    "7estyza4j4a5s1wdqhhe0r4f7"
  ],
  "sole_proprietor_proofs": [

  ]
}

Params

Param name Description
company_country
optional

Company Country of the General Information.

Must be one of the following values (i.e. represented in ISO 3166-1 alpha-2)
  • TJ
  • ST
  • MS
  • AE
  • NL
  • LU
  • BZ
  • BO
  • UY
  • SA
  • CI
  • MF
  • TF
  • AI
  • QA
  • SX
  • BV
  • PG
  • KG
  • GQ
  • EH
  • NU
  • PR
  • GD
  • KR
  • HM
  • SM
  • SL
  • CD
  • MK
  • TR
  • DZ
  • GE
  • PS
  • GP
  • PF
  • NA
  • TG
  • DO
  • AQ
  • CH
  • MG
  • FO
  • VG
  • GI
  • BN
  • LA
  • IS
  • EE
  • UM
  • LT
  • MR
  • AD
  • HU
  • TK
  • MY
  • AO
  • CV
  • NF
  • BE
  • PT
  • GB
  • IM
  • US
  • HK
  • AZ
  • CC
  • ML
  • SK
  • VU
  • TL
  • HR
  • SR
  • CZ
  • PM
  • LS
  • WS
  • KM
  • IT
  • BI
  • WF
  • GN
  • SG
  • CO
  • CN
  • AW
  • MA
  • FI
  • VA
  • KY
  • BH
  • PY
  • EC
  • LR
  • PL
  • OM
  • MT
  • SS
  • DE
  • TM
  • SJ
  • TT
  • IL
  • BD
  • NR
  • LK
  • NG
  • BQ
  • MX
  • CW
  • SI
  • MN
  • CA
  • AX
  • VN
  • TW
  • JP
  • IO
  • RO
  • BG
  • GU
  • BR
  • AM
  • ZM
  • DJ
  • JE
  • AT
  • CM
  • SE
  • FJ
  • KZ
  • GL
  • GY
  • CX
  • MW
  • ZA
  • TO
  • CY
  • MV
  • PN
  • RW
  • KN
  • BJ
  • ET
  • GM
  • TZ
  • VC
  • FK
  • MC
  • AU
  • CL
  • DK
  • FR
  • TC
  • MZ
  • NE
  • GT
  • LI
  • NP
  • BF
  • PW
  • KW
  • IN
  • GA
  • TV
  • MO
  • SH
  • MD
  • CK
  • AR
  • SC
  • IE
  • ES
  • LB
  • BM
  • RE
  • KI
  • AG
  • MQ
  • SV
  • JO
  • TH
  • MH
  • CG
  • GF
  • BA
  • YT
  • GS
  • KE
  • PE
  • BT
  • SZ
  • CR
  • TD
  • DM
  • NC
  • GR
  • GG
  • HN
  • VI
  • CF
  • SN
  • AF
  • MP
  • PH
  • BY
  • LV
  • NO
  • EG
  • IQ
  • LC
  • NZ
  • BL
  • UZ
  • ID
  • ER
  • FM
  • SB
  • ME
  • AS

corporation_type
optional

Corporation Type of the General Information. Must be either corporation or sole_proprietor.

company_name
optional

Company Name of the General Information

company_name_kana
optional

Company Name of the General Information represented in Japanese Kana

company_name_alphabet
optional

Company Name of the General Information represented in Alphabet

share_capital_amount
optional

Company Share Capital Amount of the General Information

share_capital_currency
optional

Company Share Capital Currency of the General Information

registration_number
optional

Registration Number of the General Information

company_phone
optional

Company Phone of the General Information

company_postal_code
optional

Postal Code of the Company Address

company_prefecture_state
optional

Prefecture/State of the Company Address

company_city
optional

City of the Company Address

company_address
optional

Address of the Company Address

company_address_kana
optional

Address of the Company Address represented in Japanese Kana

company_address_building_name
optional

Building Name of the Company Addressd

company_address_building_name_kana
optional

Building Name of the Company Address represented in Japanese Kana

company_url
optional

Company URL of the Business Information

industry_description
optional

Industry of the Business Information

business_description
optional

Business description of the Business Information

employee_number
optional

Number of employees of the Business Information

establishment_date
optional

Establishment Date of the Business Information

office_name
optional

Customer Support Department Name of the Contact Information

contact_email
optional

Customer Support Contact E-mail Address of the Contact Information

contact_phone
optional

Customer Support Phone of the Contact Information

incorporation_certificates
optional

An arrary of file ID. Please upload a copy of your company's incorporation certificate/extract of business registration via the File API. After uploading, please provide the ID of file returned by the File API.
This field is not needed when corporation type is sole proprietors.

sole_proprietor_proofs
optional

An arrary of file ID. Please upload your proof of registration of Sole-Proprietorship via the File API. After uploading, please provide the ID of file returned by the File API.
This field is not needed when corporation type is corporation.

>>>

GET /api/v1/company_information
Show Company Information

Show the fields of an existing company information record for the onboarding live application of the currently authenticated merchant.

betaThis API is a pre-release. Please contact KOMOJU to obtain more usage instructions before using it.

Examples

  • cURL
  • Node.js
  • Ruby
curl -X GET https://komoju.com/api/v1/live_application/company_information \
  -u sk_123456:
var https = require('https');
var secret_key = 'sk_123456'
var auth = 'Basic ' + Buffer.from(secret_key + ':').toString('base64');
var get_options = {
  host: 'komoju.com',
  port: '443',
  path: '/api/v1/live_application/company_information',
  method: 'GET',
  headers: {
    'Authorization': auth
  }
};

var get_req = https.request(get_options, function(res) {
    res.setEncoding('utf8');
    res.on('data', function (chunk) {
        console.log(chunk);
    });
});

get_req.end();
require 'uri'
require 'net/https'
require 'json'
require 'base64'
require 'pp'
uri = URI.parse('https://komoju.com/api/v1/live_application/company_information')
https = Net::HTTP.new(uri.host, uri.port)
https.use_ssl = true
secret_key = 'sk_123456'
auth = Base64.encode64("#{secret_key}:")
headers = {
  'Content-Type' => 'application/json',
  'Authorization' => "Basic #{auth}"
}

res = https.get(uri.path, headers)
puts res.body
{
  "id": "62dwxa760ohtfxn44xs35eol0",
  "resource": "company_information",
  "status": "pending",
  "created_at": "2021-03-01T13:07:08.000+09:00",
  "updated_at": "2021-03-01T13:07:08.000+09:00",
  "company_name": "McKenzie",
  "company_name_kana": "デジカ",
  "company_name_alphabet": "Degica",
  "registration_number": "9258244461478",
  "share_capital_amount": 1234,
  "share_capital_currency": "JPY",
  "company_phone": "(283) 842-4687 x670",
  "company_country": "JP",
  "company_postal_code": "89330-7963",
  "company_prefecture_state": "New York",
  "company_prefecture_state_kana": null,
  "company_city": "Moenshire",
  "company_city_kana": null,
  "company_address": "9727 Ziemann Fords",
  "company_address_kana": "カタカナ",
  "company_address_building_name": "Apt. 371",
  "company_address_building_name_kana": "カタカナ",
  "company_url": "https://example.com/a/b",
  "industry_description": "Government Agency",
  "business_description": "Education Management",
  "employee_number": 506,
  "establishment_date": "2020-03-13",
  "office_name": "Frami-Murphy",
  "contact_email": "britneygorczany@miller.biz",
  "contact_phone": "679.978.4134",
  "corporation_type": "corporation",
  "incorporation_certificates": [
    "7estyza4j4a5s1wdqhhe0r4f7"
  ],
  "sole_proprietor_proofs": [

  ]
}
>>>

PATCH /api/v1/company_information
Update Company Information

Update the fields of an existing company information record for the onboarding live application of the currently authenticated merchant.

betaThis API is a pre-release. Please contact KOMOJU to obtain more usage instructions before using it.

Examples

  • cURL
  • Node.js
  • Ruby
curl -X PATCH https://komoju.com/api/v1/live_application/company_information \
  -u sk_123456: \
  -d "name=I%20am%20changing%20this%20in%20this%20request" 
var querystring = require('querystring');
var https = require('https');
var secret_key = 'sk_123456'
var auth = 'Basic ' + Buffer.from(secret_key + ':').toString('base64');
var patch_data = querystring.stringify({
  'name': 'I am changing this in this request'
});

var patch_options = {
  host: 'komoju.com',
  port: '443',
  path: '/api/v1/live_application/company_information',
  method: 'PATCH',
  headers: {
    'Authorization': auth,
    'Content-Length': Buffer.byteLength(patch_data)
  }
};

var patch_req = https.request(patch_options, function(res) {
    res.setEncoding('utf8');
    res.on('data', function (chunk) {
        console.log(chunk);
    });
});

patch_req.write(patch_data);
patch_req.end();
require 'uri'
require 'net/https'
require 'json'
require 'base64'
require 'pp'
uri = URI.parse('https://komoju.com/api/v1/live_application/company_information')
https = Net::HTTP.new(uri.host, uri.port)
https.use_ssl = true
secret_key = 'sk_123456'
auth = Base64.encode64("#{secret_key}:")
headers = {
  'Content-Type' => 'application/json',
  'Authorization' => "Basic #{auth}"
}

body = {
  name: "I am changing this in this request"
}

res = https.patch(
  uri.path,
  body.to_json,
  headers
)

puts res.body
{
  "id": "62dwxa760ohtfxn44xs35eol0",
  "resource": "company_information",
  "status": "pending",
  "created_at": "2021-03-01T13:07:08.000+09:00",
  "updated_at": "2021-03-01T13:07:08.000+09:00",
  "company_name": "I am changing this in this request",
  "company_name_kana": "デジカ",
  "company_name_alphabet": "Degica",
  "registration_number": "9258244461478",
  "share_capital_amount": 1234,
  "share_capital_currency": "JPY",
  "company_phone": "(283) 842-4687 x670",
  "company_country": "JP",
  "company_postal_code": "89330-7963",
  "company_prefecture_state": "New York",
  "company_prefecture_state_kana": null,
  "company_city": "Moenshire",
  "company_city_kana": null,
  "company_address": "9727 Ziemann Fords",
  "company_address_kana": "カタカナ",
  "company_address_building_name": "Apt. 371",
  "company_address_building_name_kana": "カタカナ",
  "company_url": "https://example.com/a/b",
  "industry_description": "Government Agency",
  "business_description": "Education Management",
  "employee_number": 506,
  "establishment_date": "2020-03-13",
  "office_name": "Frami-Murphy",
  "contact_email": "britneygorczany@miller.biz",
  "contact_phone": "679.978.4134",
  "corporation_type": "corporation",
  "incorporation_certificates": [
    "7estyza4j4a5s1wdqhhe0r4f7"
  ],
  "sole_proprietor_proofs": [

  ]
}

Params

Param name Description
company_country
optional

Company Country of the General Information.

Must be one of the following values (i.e. represented in ISO 3166-1 alpha-2)
  • TJ
  • ST
  • MS
  • AE
  • NL
  • LU
  • BZ
  • BO
  • UY
  • SA
  • CI
  • MF
  • TF
  • AI
  • QA
  • SX
  • BV
  • PG
  • KG
  • GQ
  • EH
  • NU
  • PR
  • GD
  • KR
  • HM
  • SM
  • SL
  • CD
  • MK
  • TR
  • DZ
  • GE
  • PS
  • GP
  • PF
  • NA
  • TG
  • DO
  • AQ
  • CH
  • MG
  • FO
  • VG
  • GI
  • BN
  • LA
  • IS
  • EE
  • UM
  • LT
  • MR
  • AD
  • HU
  • TK
  • MY
  • AO
  • CV
  • NF
  • BE
  • PT
  • GB
  • IM
  • US
  • HK
  • AZ
  • CC
  • ML
  • SK
  • VU
  • TL
  • HR
  • SR
  • CZ
  • PM
  • LS
  • WS
  • KM
  • IT
  • BI
  • WF
  • GN
  • SG
  • CO
  • CN
  • AW
  • MA
  • FI
  • VA
  • KY
  • BH
  • PY
  • EC
  • LR
  • PL
  • OM
  • MT
  • SS
  • DE
  • TM
  • SJ
  • TT
  • IL
  • BD
  • NR
  • LK
  • NG
  • BQ
  • MX
  • CW
  • SI
  • MN
  • CA
  • AX
  • VN
  • TW
  • JP
  • IO
  • RO
  • BG
  • GU
  • BR
  • AM
  • ZM
  • DJ
  • JE
  • AT
  • CM
  • SE
  • FJ
  • KZ
  • GL
  • GY
  • CX
  • MW
  • ZA
  • TO
  • CY
  • MV
  • PN
  • RW
  • KN
  • BJ
  • ET
  • GM
  • TZ
  • VC
  • FK
  • MC
  • AU
  • CL
  • DK
  • FR
  • TC
  • MZ
  • NE
  • GT
  • LI
  • NP
  • BF
  • PW
  • KW
  • IN
  • GA
  • TV
  • MO
  • SH
  • MD
  • CK
  • AR
  • SC
  • IE
  • ES
  • LB
  • BM
  • RE
  • KI
  • AG
  • MQ
  • SV
  • JO
  • TH
  • MH
  • CG
  • GF
  • BA
  • YT
  • GS
  • KE
  • PE
  • BT
  • SZ
  • CR
  • TD
  • DM
  • NC
  • GR
  • GG
  • HN
  • VI
  • CF
  • SN
  • AF
  • MP
  • PH
  • BY
  • LV
  • NO
  • EG
  • IQ
  • LC
  • NZ
  • BL
  • UZ
  • ID
  • ER
  • FM
  • SB
  • ME
  • AS

corporation_type
optional

Corporation Type of the General Information. Must be either corporation or sole_proprietor.

company_name
optional

Company Name of the General Information

company_name_kana
optional

Company Name of the General Information represented in Japanese Kana

company_name_alphabet
optional

Company Name of the General Information represented in Alphabet

share_capital_amount
optional

Company Share Capital Amount of the General Information

share_capital_currency
optional

Company Share Capital Currency of the General Information

registration_number
optional

Registration Number of the General Information

company_phone
optional

Company Phone of the General Information

company_postal_code
optional

Postal Code of the Company Address

company_prefecture_state
optional

Prefecture/State of the Company Address

company_city
optional

City of the Company Address

company_address
optional

Address of the Company Address

company_address_kana
optional

Address of the Company Address represented in Japanese Kana

company_address_building_name
optional

Building Name of the Company Addressd

company_address_building_name_kana
optional

Building Name of the Company Address represented in Japanese Kana

company_url
optional

Company URL of the Business Information

industry_description
optional

Industry of the Business Information

business_description
optional

Business description of the Business Information

employee_number
optional

Number of employees of the Business Information

establishment_date
optional

Establishment Date of the Business Information

office_name
optional

Customer Support Department Name of the Contact Information

contact_email
optional

Customer Support Contact E-mail Address of the Contact Information

contact_phone
optional

Customer Support Phone of the Contact Information

incorporation_certificates
optional

An arrary of file ID. Please upload a copy of your company's incorporation certificate/extract of business registration via the File API. After uploading, please provide the ID of file returned by the File API.
This field is not needed when corporation type is sole proprietors.

sole_proprietor_proofs
optional

An arrary of file ID. Please upload your proof of registration of Sole-Proprietorship via the File API. After uploading, please provide the ID of file returned by the File API.
This field is not needed when corporation type is corporation.