Personal Information
POST /api/v1/personal_information
Create Personal Information
Creates a new personal 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/personal_information \
-u sk_123456: \
-d "representative_first_name=%E8%8A%B1%E5%AD%90" \
-d "representative_first_name_kana=%E3%83%8F%E3%83%8A%E3%82%B3" \
-d "representative_last_name=%E5%8F%A4%E8%8C%82%E6%A8%B9" \
-d "representative_last_name_kana=%E3%82%B3%E3%83%A2%E3%82%B8%E3%83%A5" \
-d "representative_dob=2020-08-02" \
-d "representative_gender=female" \
-d "representative_country=JP" \
-d "representative_postal_code=1000003" \
-d "representative_prefecture_state=%E6%9D%B1%E4%BA%AC" \
-d "representative_prefecture_state_kana=%E3%83%88%E3%82%A6%E3%82%AD%E3%83%A7%E3%82%A6" \
-d "representative_city=%E5%8D%83%E4%BB%A3%E7%94%B0%E5%8C%BA" \
-d "representative_city_kana=%E3%83%81%E3%83%A8%E3%83%80%E3%82%AF" \
-d "representative_address=%E4%B8%80%E3%83%84%E6%A9%8B1-222-30" \
-d "representative_address_kana=%E3%83%92%E3%83%88%E3%83%84%E3%83%90%E3%82%B71-222-30" \
-d "representative_address_building_name=%E5%8F%A4%E8%8C%82%E6%A8%B9%E3%83%93%E3%83%AB8F" \
-d "representative_address_building_name_kana=%E3%82%B3%E3%83%A2%E3%82%B8%E3%83%A5%E3%83%93%E3%83%AB8F" \
-d "representative_phone=03-9999-9999" \
-d "identity_front=cyvy7vo7fcguome6ippe9wy74" \
-d "identity_back=9juboj2232rdb84hasmdbrt54" 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({
'representative_first_name': '花子',
'representative_first_name_kana': 'ハナコ',
'representative_last_name': '古茂樹',
'representative_last_name_kana': 'コモジュ',
'representative_dob': '2020-08-02',
'representative_gender': 'female',
'representative_country': 'JP',
'representative_postal_code': '1000003',
'representative_prefecture_state': '東京',
'representative_prefecture_state_kana': 'トウキョウ',
'representative_city': '千代田区',
'representative_city_kana': 'チヨダク',
'representative_address': '一ツ橋1-222-30',
'representative_address_kana': 'ヒトツバシ1-222-30',
'representative_address_building_name': '古茂樹ビル8F',
'representative_address_building_name_kana': 'コモジュビル8F',
'representative_phone': '03-9999-9999',
'identity_front': 'cyvy7vo7fcguome6ippe9wy74',
'identity_back': '9juboj2232rdb84hasmdbrt54'
});
var post_options = {
host: 'komoju.com',
port: '443',
path: '/api/v1/live_application/personal_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/personal_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 = {
representative_first_name: "花子",
representative_first_name_kana: "ハナコ",
representative_last_name: "古茂樹",
representative_last_name_kana: "コモジュ",
representative_dob: "2020-08-02",
representative_gender: "female",
representative_country: "JP",
representative_postal_code: "1000003",
representative_prefecture_state: "東京",
representative_prefecture_state_kana: "トウキョウ",
representative_city: "千代田区",
representative_city_kana: "チヨダク",
representative_address: "一ツ橋1-222-30",
representative_address_kana: "ヒトツバシ1-222-30",
representative_address_building_name: "古茂樹ビル8F",
representative_address_building_name_kana: "コモジュビル8F",
representative_phone: "03-9999-9999",
identity_front: "cyvy7vo7fcguome6ippe9wy74",
identity_back: "9juboj2232rdb84hasmdbrt54"
}
res = https.post(
uri.path,
body.to_json,
headers
)
puts res.body{
"resource": "personal_information",
"status": "pending",
"created_at": "2021-03-03T11:10:30.000+09:00",
"updated_at": "2021-03-03T11:10:32.000+09:00",
"representative_first_name": "花子",
"representative_first_name_kana": "ハナコ",
"representative_last_name": "古茂樹",
"representative_last_name_kana": "コモジュ",
"representative_dob": "2020-08-02",
"representative_gender": "female",
"representative_country": "JP",
"representative_postal_code": "1000003",
"representative_prefecture_state": "東京",
"representative_prefecture_state_kana": "トウキョウ",
"representative_city": "千代田区",
"representative_city_kana": "チヨダク",
"representative_address": "一ツ橋1-222-30",
"representative_address_kana": "ヒトツバシ1-222-30",
"representative_address_building_name": "古茂樹ビル8F",
"representative_address_building_name_kana": "コモジュビル8F",
"representative_phone": "03-9999-9999"
}Params
| Param name | Description |
|---|---|
representative_first_nameoptional |
First name of the Representative Director |
representative_first_name_kanaoptional |
First name (represented in Japanese kana) of the Representative Director |
representative_last_nameoptional |
Last name of the Representative Director |
representative_last_name_kanaoptional |
Last name (represented in Japanese kana) of the Representative Director |
representative_doboptional |
Date of birth of the Representative Director |
representative_genderoptional |
Gender of the Representative Director |
representative_countryoptional |
The country of the Representative Director - Residence Address |
representative_postal_codeoptional |
The postal code of the Representative Director - Residence Address |
representative_prefecture_stateoptional |
The prefecture or state of the Representative Director - Residence Address |
representative_cityoptional |
The city of the Representative Director - Residence Address |
representative_addressoptional |
The address of the Representative Director - Residence Address |
representative_address_kanaoptional |
The address represented in Japanese kana of the Representative Director - Residence Address |
representative_phoneoptional |
The phone of the Representative Director - Residence Address |
identity_frontoptional |
A file ID returned by the the File API. Please upload, via the File API, a picture or scan of the front side of a government issued photo ID document (passport, residence card, or driver's license). Ensure the information is clearly displayed. For passports, the front side is sufficient. |
identity_backoptional |
A file ID returned by the the File API. Please upload, via the File API, a picture or scan of the back side of a government issued photo ID document (passport, residence card, or driver's license). Ensure the information is clearly displayed. For passports, the front side is sufficient. |
GET /api/v1/personal_information
Show Personal Information
Show the fields of an existing personal 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/personal_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/personal_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/personal_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{
"resource": "personal_information",
"status": "pending",
"created_at": "2021-03-03T11:10:30.000+09:00",
"updated_at": "2021-03-03T11:10:32.000+09:00",
"representative_first_name": "花子",
"representative_first_name_kana": "ハナコ",
"representative_last_name": "古茂樹",
"representative_last_name_kana": "コモジュ",
"representative_dob": "2020-08-02",
"representative_gender": "female",
"representative_country": "JP",
"representative_postal_code": "1000003",
"representative_prefecture_state": "東京",
"representative_prefecture_state_kana": "トウキョウ",
"representative_city": "千代田区",
"representative_city_kana": "チヨダク",
"representative_address": "一ツ橋1-222-30",
"representative_address_kana": "ヒトツバシ1-222-30",
"representative_address_building_name": "古茂樹ビル8F",
"representative_address_building_name_kana": "コモジュビル8F",
"representative_phone": "03-9999-9999"
}
PATCH /api/v1/personal_information
Update Personal Information
Update the fields of an existing personal 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/personal_information \
-u sk_123456: \
-d "representative_first_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({
'representative_first_name': 'I am changing this in this request'
});
var patch_options = {
host: 'komoju.com',
port: '443',
path: '/api/v1/live_application/personal_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/personal_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 = {
representative_first_name: "I am changing this in this request"
}
res = https.patch(
uri.path,
body.to_json,
headers
)
puts res.body{
"resource": "personal_information",
"status": "pending",
"created_at": "2021-03-03T11:10:30.000+09:00",
"updated_at": "2021-03-03T11:10:32.000+09:00",
"representative_first_name": "I am changing this in this request",
"representative_first_name_kana": "ハナコ",
"representative_last_name": "古茂樹",
"representative_last_name_kana": "コモジュ",
"representative_dob": "2020-08-02",
"representative_gender": "female",
"representative_country": "JP",
"representative_postal_code": "1000003",
"representative_prefecture_state": "東京",
"representative_prefecture_state_kana": "トウキョウ",
"representative_city": "千代田区",
"representative_city_kana": "チヨダク",
"representative_address": "一ツ橋1-222-30",
"representative_address_kana": "ヒトツバシ1-222-30",
"representative_address_building_name": "古茂樹ビル8F",
"representative_address_building_name_kana": "コモジュビル8F",
"representative_phone": "03-9999-9999"
}Params
| Param name | Description |
|---|---|
representative_first_nameoptional |
First name of the Representative Director |
representative_first_name_kanaoptional |
First name (represented in Japanese kana) of the Representative Director |
representative_last_nameoptional |
Last name of the Representative Director |
representative_last_name_kanaoptional |
Last name (represented in Japanese kana) of the Representative Director |
representative_doboptional |
Date of birth of the Representative Director |
representative_genderoptional |
Gender of the Representative Director |
representative_countryoptional |
The country of the Representative Director - Residence Address |
representative_postal_codeoptional |
The postal code of the Representative Director - Residence Address |
representative_prefecture_stateoptional |
The prefecture or state of the Representative Director - Residence Address |
representative_cityoptional |
The city of the Representative Director - Residence Address |
representative_addressoptional |
The address of the Representative Director - Residence Address |
representative_address_kanaoptional |
The address represented in Japanese kana of the Representative Director - Residence Address |
representative_phoneoptional |
The phone of the Representative Director - Residence Address |
identity_frontoptional |
A file ID returned by the the File API. Please upload, via the File API, a picture or scan of the front side of a government issued photo ID document (passport, residence card, or driver's license). Ensure the information is clearly displayed. For passports, the front side is sufficient. |
identity_backoptional |
A file ID returned by the the File API. Please upload, via the File API, a picture or scan of the back side of a government issued photo ID document (passport, residence card, or driver's license). Ensure the information is clearly displayed. For passports, the front side is sufficient. |