KoreConX External API
KoreConX Captable API is intended for Issuer companies to send the captable data for both Reg A and Reg CF to the KoreConx All-in-One Platform. Authentication - Please add the following to the header of every request: X-API-KEY : "API_KEY provided by KoreConX.com"
Request Body:
content-type: Application/json
Schema Definition :
“KCX_Platform_ID”: integer | required| ex:”4321” |Provided by KoreConX,
“KCX_Listing_ID”: integer | required| ex:”4321” |Provided by KoreConX,
“source_button_id”: string | required | ex:”ExampleInvestNowButton” |Investment Button ID or Investment Landing Page ID,
“offering_type”: string | required | value:”RegA+” |any one from options: RegA+, RegCF, RegD, RegS,
“investor_email_id”: string | required | ex:”investor@example.com” |Investor Email ID,
“number_of_shares”: whole number | required | ex.”200”| Number of Shares,
“investment_amount”: Decimal number | required |ex: “1000.00”| must be USD with two decimal point,
“investment_date”: datetime | required |ex: “2022-04-20 22:22:22”| Format: YYYY-MM-DD HH:MM:SS,
“investing_as”: string | required |ex: “jt_in_common”| any one from options: person, jt_right_of_survivorship, jt_in_common, tenants_by_entirety, company, trust,
“investor_first_name”: string | required |ex: “Mary”| Investor First Name,
“investor_middle_name”: string | optional |ex: “Elizabeth”| Investor Middle Name,
“investor_last_name”: string | required |ex: “Smith”| Investor Last Name,
“investor_mobile_phone”: string | required |ex: “999-999-9999”| Investor Mobile Phone Number,
“investor_address1”: string | required |ex: “1234 My Street”| Investor Address Line 1,
“investor_address2”: string | optional |ex: “APT 4321”| Investor Address Line 2,
“investor_city”: string | required |ex: “Kingston”| Investor Address City,
“investor_state”: string | required |ex: “NY”| Investor Address two/three letter state code,
“investor_country”: string | required |ex: “US”| Investor Address two letter country code,
“investor_zip”: string | required |ex: “12401”| Investor Address Zip Code,
“investor_dob”: date | required |ex: “1980-04-20”| Investor must be 18 years of age or above at the time of the investment. Format: YYYY-MM-DD,
“investor_national_id_number”: string | required |ex: “123456789”| Investor SSN, SIN or any other National ID number,
“investor_national_id_country”: string | required |ex: “US”| Investor SSN, SIN or any other National ID two letter country code,
Provide at least one either Driver License Details or Passport Details or BOTH
“investor_driver_license_number”: string | required if passport details not provided |ex: “123456789”| Investor Driver License Number,
“investor_driver_license_expiry_date”: date | required if ‘investor_driver_license_number’ provided |ex: “2030-04-20”| Investor Driver License Expiry Date must be a future date compared to the date of investment. Format: YYYY-MM-DD,
“investor_driver_license_state”: string | required if ‘investor_driver_license_number’ provided |ex: “NY”| Investor Driver License two/three letter state code,
“investor_driver_license_country”: string | required if ‘investor_driver_license_number’ provided |ex: “US”| Investor Driver License two letter country code,
“investor_passport_number”: string | required if driver license details not provided |ex: “123456789”| Investor Passport Number,
“investor_passport_expiry_date”: date | required if ‘investor_passport_number’ provided |ex: “2030-04-20”| Investor Passport Expiry Date must be a future date compared to the date of investment. Format: YYYY-MM-DD,
“investor_passport_country”: string | required if ‘investor_passport_number’ provided |ex: “US”| Investor Passport two letter country code,
Enter Company or Trust information in Investor Institution Fields when ‘investing_as’ : ‘company’ or ‘trust’
“investor_institution_name”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “ABC Name”| Company Name or Trust Name,
“investor_institution_tax_id_number”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “4321”| Tax ID Number of Company or Trust,
“investor_institution_formation_date”: date | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “1980-04-20”| Company or Trust Formation Date. Format: YYYY-MM-DD,
“investor_institution_formation_state”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “NY”| Company or Trust Formation two/three letter state code,
“investor_institution_contact_first_name”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “John”| Company or Trust Contact First Name,
“investor_institution_contact_last_name”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “Smith”| Company or Trust Contact Last Name,
“investor_institution_contact_position”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “CEO”| Company or Trust Contact Position,
“investor_institution_address1”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “4321 My Street”| Company or Trust Address Line 1,
“investor_institution_address2”: string | optional |ex: “APT 1234”| Company or Trust Address Line 2,
“investor_institution_city”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “Kingston”| Company or Trust Address City,
“investor_institution_state”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “NY”| Company or Trust Address two/three letter state code,
“investor_institution_country”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “US”| Company or Trust Address two letter country code,
“investor_institution_zip”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “12401”| Company or Trust Address Zip Code,
Enter Company information only in Investor Company Fields when ‘investing_as’ : ‘company’
“investor_company_legal_extension”: string | required if ‘investing_as’ : ‘company’ |ex: “CORP”| Company Legal Extension Code in UPPERCASE,
COMPANY LEGAL EXTENSION TABLE
‘CODE’ => ‘EXTENSION’
‘NLE’ => ‘(No Legal Extension/Entity)’,
‘LLC’ => ‘Limited Liability Company (LLC)’,
‘CORP’ => ‘Corporation (CORP)’,
‘INC’ => ‘Incorporated (INC)’,
‘LLP’ => ‘Limited Liability Partners (LLP)’,
‘PLC’ => ‘Public Limited Company (PLC)’,
‘PBC’ => ‘Public Benefit Corporation (PBC)’,
‘LTD’ => ‘Limited Company (Ltd)’,
‘CO’ => ‘Company (Co.)’,
‘PC’ => ‘Professional Corporation (PC)’,
‘FND’ => ‘Foundation (FND)’,
‘ILP’ => ‘Incorporated Limited Partnership (ILP)’,
‘VCLP’ => ‘Venture Capital Limited Partnership (VCLP)’,
‘ESVCLP’ => ‘Early-stage Venture Capital Limited Partnership (ESVCLP)’,
‘AFOF’ => ‘Australian Venture Capital Fund of Funds (AFOF)’,
‘VCMP’ => ‘Venture Capital Management Partnership (VCMP)’,
‘NL’ => ‘No Liability (NL)’,
‘PTY LTD’ => ‘Proprietary Limited Company (PTY LTD)’,
‘PTY’ => ‘Unlimited Proprietary (PTY)’,
‘LTC’ => ‘Look-Through Company (LTC)’,
‘JSC’ => ‘Joint-Stock Company (JSC)’,
‘LP’ => ‘Limited Partnership (LP)’,
‘FC’ => ‘Foreign Company (FC)’,
‘IE’ => ‘Individual Establishment (IE)’,
‘PTE LTD’ => ‘Private Limited Company (PTE LTD)’,
‘SDN BHD’ => ‘Sendirian Berhad (SDN BHD)’,
‘SP’ => ‘Sole Proprietorship (SP)’,
‘P’ => ‘Partnership (P)’,
‘BHD’ => ‘Berhad (BHD)’,
‘SSC’ => ‘Singapore Subsidiary Company (SSC)’,
‘CIC’ => ‘Community Interest Company (CIC)’,
‘CIO’ => ‘Charitable Incorporated Organisation (CIO)’,
‘SLP’ => ‘Scottish Limited Partnerships (SLP)’,
‘PUC’ => ‘Private Unlimited Company (PUC)’,
‘PC LBS’ => ‘Private Company Limited by Shares (PC LBS)’,
‘PC LBG’ => ‘Private Company Limited by Guarantee (PC LGS)’,
‘IPS’ => ‘Industrial and Provident Society (IPS)’,
‘CO OP’ => ‘Co-operative (CO OP)’,
‘PUBC’ => ‘Public Company’,
‘CLBNSC’ => ‘Company limited By Guarantee Not Having a Share Capital (CLBNSC)’,
‘SMC’ => ‘Single Member Company (SMC)’,
‘UC’ => ‘Unlimited Company (UC)’,
‘UCITS’ => ‘Undertakings for Collective Investment in Transferable Securities (UCITS)’,
‘HUF’ => ‘Hindu Undivided Family (HUF)’,
‘DC’ => ‘Dormant Company (DC)’,
‘FOB’ => ‘Family Owned Business (FOB)’,
‘SC’ => ‘Small Company (SC)’,
‘PSU’ => ‘Public Sector Undertaking (PSU)’,
‘OPC’ => ‘One-person company (OPC)’,
‘IC’ => ‘Incorporation Company (IC)’,
‘BT’ => ‘Business Trust (BT)’,
‘CC’ => ‘Close corporation (CC)’,
‘PLLC’ => ‘Professional Limited Liability Company (PLLC)’,
‘LTD GTE’ => ‘Limited by Guarantee (LTD GTE)’
“investor_company_type”: string | required if ‘investing_as’ : ‘company’ |ex: “PRI”| Company Type Code in UPPERCASE,
COMPANY TYPES TABLE
‘CODE’ => ‘TYPE’
‘PRI’ => ‘Private’,
‘PUB’ => ‘Public’,
‘NPO’ => ‘Not For Profit’,
‘FND’ => ‘Foundation’,
‘CHR’ => ‘Registered Charity’,
‘CDO’ => ‘Condominium Board’,
‘CRU’ => ‘Credit Union’,
‘CRO’ => ‘Crown Corporation’,
‘STR’ => ‘Strata Board’
“investor_company_sector”: string | required if ‘investing_as’ : ‘company’ |ex: “1770”| Company Sector Code,
COMPANY SECTORS TABLE
‘CODE’ => ‘SECTOR’
‘0500’ => ‘Oil & Gas’,
‘0530’ => ‘Oil & Gas Producers’,
‘0533’ => ‘Exploration & Production’,
‘0537’ => ‘Integrated Oil & Gas’,
‘0570’ => ‘Oil Equipment, Services & Distribution’,
‘0573’ => ‘Oil Equipment & Services’,
‘0577’ => ‘Pipelines’,
‘0580’ => ‘Alternative Energy’,
‘0583’ => ‘Renewable Energy Equipment’,
‘0587’ => ‘Alternative Fuels’,
‘1300’ => ‘Chemicals’,
‘1353’ => ‘Commodity Chemicals’,
‘1357’ => ‘Specialty Chemicals’,
‘1700’ => ‘Basic Resources’,
‘1730’ => ‘Forestry & Paper’,
‘1733’ => ‘Forestry’,
‘1737’ => ‘Paper’,
‘1750’ => ‘Industrial Metals & Mining’,
‘1753’ => ‘Aluminum’,
‘1755’ => ‘Nonferrous Metals’,
‘1757’ => ‘Iron & Steel’,
‘1770’ => ‘Mining’,
‘1771’ => ‘Coal’,
‘1773’ => ‘Diamonds & Gemstones’,
‘1775’ => ‘General Mining’,
‘1777’ => ‘Gold Mining’,
‘1779’ => ‘Platinum & Precious Metals’,
‘2300’ => ‘Construction & Materials’,
‘2353’ => ‘Building Materials & Fixtures’,
‘2357’ => ‘Heavy Construction’,
‘2700’ => ‘Industrial Goods & Services’,
‘2710’ => ‘Aerospace & Defense’,
‘2713’ => ‘Aerospace’,
‘2717’ => ‘Defense’,
‘2720’ => ‘General Industrials’,
‘2723’ => ‘Containers & Packaging’,
‘2727’ => ‘Diversified Industrials’,
‘2730’ => ‘Electronic & Electrical Equipment’,
‘2733’ => ‘Electrical Components & Equipment’,
‘2737’ => ‘Electronic Equipment’,
‘2750’ => ‘Industrial Engineering’,
‘2753’ => ‘Commercial Vehicles & Trucks’,
‘2757’ => ‘Industrial Machinery’,
‘2770’ => ‘Industrial Transportation’,
‘2771’ => ‘Delivery Services’,
‘2773’ => ‘Marine Transportation’,
‘2775’ => ‘Railroads’,
‘2777’ => ‘Transportation Services’,
‘2779’ => ‘Trucking’,
‘2790’ => ‘Support Services’,
‘2791’ => ‘Business Support Services’,
‘2793’ => ‘Business Training & Employment Agencies’,
‘2795’ => ‘Financial Administration’,
‘2797’ => ‘Industrial Suppliers’,
‘2799’ => ‘Waste & Disposal Services’,
‘3300’ => ‘Automobiles & Parts’,
‘3353’ => ‘Automobiles’,
‘3355’ => ‘Auto Parts’,
‘3357’ => ‘Tires’,
‘3500’ => ‘Food & Beverage’,
‘3530’ => ‘Beverages’,
‘3533’ => ‘Brewers’,
‘3535’ => ‘Distillers & Vintners’,
‘3537’ => ‘Soft Drinks’,
‘3570’ => ‘Food Producers’,
‘3573’ => ‘Farming & Fishing’,
‘3577’ => ‘Food Products’,
‘3700’ => ‘Personal & Household Goods’,
‘3720’ => ‘Household Goods & Home Construction’,
‘3722’ => ‘Durable Household Products’,
‘3724’ => ‘Nondurable Household Products’,
‘3726’ => ‘Furnishings’,
‘3728’ => ‘Home Construction’,
‘3740’ => ‘Leisure Goods’,
‘3743’ => ‘Consumer Electronics’,
‘3745’ => ‘Recreational Products’,
‘3747’ => ‘Toys’,
‘3760’ => ‘Personal Goods’,
‘3763’ => ‘Clothing & Accessories’,
‘3765’ => ‘Footwear’,
‘3767’ => ‘Personal Products’,
‘3780’ => ‘Tobacco’,
‘4500’ => ‘Health Care’,
‘4530’ => ‘Health Care Equipment & Services’,
‘4533’ => ‘Health Care Provvalueers’,
‘4535’ => ‘Medical Equipment’,
‘4537’ => ‘Medical Supplies’,
‘4570’ => ‘Pharmaceuticals & Biotechnology’,
‘4573’ => ‘Biotechnology’,
‘4577’ => ‘Pharmaceuticals’,
‘5300’ => ‘Retail’,
‘5330’ => ‘Food & Drug Retailers’,
‘5333’ => ‘Drug Retailers’,
‘5337’ => ‘Food Retailers & Wholesalers’,
‘5370’ => ‘General Retailers’,
‘5371’ => ‘Apparel Retailers’,
‘5373’ => ‘Broadline Retailers’,
‘5375’ => ‘Home Improvement Retailers’,
‘5377’ => ‘Specialized Consumer Services’,
‘5379’ => ‘Specialty Retailers’,
‘5500’ => ‘Media’,
‘5553’ => ‘Broadcasting & Entertainment’,
‘5555’ => ‘Media Agencies’,
‘5557’ => ‘Publishing’,
‘5700’ => ‘Travel & Leisure’,
‘5750’ => ‘Travel & Leisure’,
‘5751’ => ‘Airlines’,
‘5752’ => ‘Gambling’,
‘5753’ => ‘Hotels’,
‘5755’ => ‘Recreational Services’,
‘5757’ => ‘Restaurants & Bars’,
‘5759’ => ‘Travel & Tourism’,
‘6500’ => ‘Telecommunications’,
‘6530’ => ‘Fixed Line Telecommunications’,
‘6570’ => ‘Mobile Telecommunications’,
‘7530’ => ‘Electricity’,
‘7535’ => ‘Conventional Electricity’,
‘7537’ => ‘Alternative Electricity’,
‘7570’ => ‘Gas, Water & Multiutilities’,
‘7573’ => ‘Gas Distribution’,
‘7575’ => ‘Multiutilities’,
‘7577’ => ‘Water’,
‘8300’ => ‘Banks’,
‘8500’ => ‘Insurance’,
‘8530’ => ‘Nonlife Insurance’,
‘8532’ => ‘Full Line Insurance’,
‘8534’ => ‘Insurance Brokers’,
‘8536’ => ‘Property & Casualty Insurance’,
‘8538’ => ‘Reinsurance’,
‘8570’ => ‘Life Insurance’,
‘8600’ => ‘Real Estate’,
‘8630’ => ‘Real Estate Investment & Services’,
‘8637’ => ‘Real Estate Services’,
‘8670’ => ‘Real Estate Investment Trusts’,
‘8671’ => ‘Industrial & Office REITs’,
‘8672’ => ‘Retail REITs’,
‘8673’ => ‘Resvalueential REITs’,
‘8674’ => ‘Diversified REITs’,
‘8675’ => ‘Specialty REITs’,
‘8676’ => ‘Mortgage REITs’,
‘8677’ => ‘Hotel & Lodging REITs’,
‘8700’ => ‘Financial Services’,
‘8771’ => ‘Asset Managers’,
‘8773’ => ‘Consumer Finance’,
‘8775’ => ‘Specialty Finance’,
‘8777’ => ‘Investment Services’,
‘8779’ => ‘Mortgage Finance’,
‘8900’ => ‘Equity/Non-Equity Investment Instruments’,
‘8980’ => ‘Equity Investment Instruments’,
‘8990’ => ‘Nonequity Investment Instruments’,
‘9500’ => ‘Technology’,
‘9530’ => ‘Software & Computer Services’,
‘9533’ => ‘Computer Services’,
‘9535’ => ‘Internet’,
‘9537’ => ‘Software’,
‘9570’ => ‘Technology Hardware & Equipment’,
‘9572’ => ‘Computer Hardware’,
‘9574’ => ‘Electronic Office Equipment’,
‘9576’ => ‘Semiconductors’,
‘9578’ => ‘Telecommunications Equipment’,
Enter Joint Investor information in Joint Investor Fields when ‘investing_as’ : ‘jt_right_of_survivorship’, ‘jt_in_common’, ‘tenants_by_entirety’
“joint_investor_first_name”: string | required if ‘investing_as’ : ‘jt_right_of_survivorship’, ‘jt_in_common’, ‘tenants_by_entirety’ |ex: “Jim”| Joint Investor First Name,
“joint_investor_middle_name”: string | optional |ex: “Smith”| Joint Investor Middle Name,
“joint_investor_last_name”: string | required if ‘investing_as’ : ‘jt_right_of_survivorship’, ‘jt_in_common’, ‘tenants_by_entirety’ |ex: “Brown”| Joint Investor Last Name,
“joint_investor_email_address”: string | required if ‘investing_as’ : ‘jt_right_of_survivorship’, ‘jt_in_common’, ‘tenants_by_entirety’ |ex: “jt_investor@example.com”| Joint Investor Email Address,
“joint_investor_phone”: string | required if ‘investing_as’ : ‘jt_right_of_survivorship’, ‘jt_in_common’, ‘tenants_by_entirety’ |ex: “888-888-8888”| Joint Investor Phone Number,
“investor_accredited”: boolean | required |ex: “0”| “0” or “1”,
“investor_net_worth”: numeric | required |ex: “100000”| Investor Net Worth,
“investor_annual_income”: numeric | required |ex: “100000”| Investor Annual Income,
“investor_accredited_qualification”: integer | required if ‘investor_accredited’ : ‘1’ |ex: “0”| value must be any one from options: 0, 1, 2, 3
INVESTOR ACCREDITED QUALIFICATION VALUES DEFINITION
0 => 401k/Other: I have an individual net worth, or joint net worth with my spouse, that exceeds $1 million including any IRA’s, 401K’s, and other retirement accounts, but excluding the net value of my primary residence.
1 => Income/Asset: I am an individual with an income of over $200,000 in each of the last two years, or joint income with my spouse exceeding $300,000 in those years, and I reasonably expect at least the same this year.
2 => Registered Person: You hold any of the following licenses from the Financial Industry Regulatory Authority (FINRA): Series 7, Series 82, or Series 65.
3 => Internal: You A director, executive officer, or general partner of the company selling the securities, or any director, executive officer, or general partner of a general partner of that issuer or a knowledgeable employee.
“financial_advisor”: boolean | optional |ex: “true”| true or false,
“financial_advisor_name”: string | required if ‘financial_advisor’ : ‘true’ |ex: “Bob Smith”| Financial Advisor Name,
“financial_advisor_email_id”: email | required if ‘financial_advisor’ : ‘true’ |ex: “financial_advisor@example.com”| Financial Advisor Email ID,
Enter Payment Information in the related fields
“funding_method”: string | required |ex: “electronic_cheque”| must be any one from options: ‘electronic_cheque’, ‘credit_card’, ‘mail_cheque’, ‘wire_transfer’, ‘crypto’, ‘Invest through Self-Directed IRA’,
“is_bank_token”: boolean | required if ‘funding_method’ : ‘electronic_cheque’ (Payment Method: Bank is available as Token or The Account Details) |ex: “0”| “0” or “1”,
“payment_method_token”: string | required if ‘funding_method’ : ‘credit_card’, ‘electronic_cheque’ (Only if ‘is_bank_token’: ‘1’, Payment Method is Bank Token) |ex: “ABCDXXXXX”| Credit Card Auth Token or Bank Token,
“bank_name”: string | required if ‘funding_method’ : ‘electronic_cheque’, ‘is_bank_token’: ‘0’ |ex: “ABC Bank”| Bank Name,
“account_type”: string | required if ‘funding_method’ : ‘electronic_cheque’, ‘is_bank_token’: ‘0’ |ex: “chequing”| must be any one from options: ‘chequing’, ‘savings’,
“account_number”: string | required if ‘funding_method’ : ‘electronic_cheque’, ‘is_bank_token’: ‘0’ |ex: “123456789”| Account Number,
“routing_number”: string | required if ‘funding_method’ : ‘electronic_cheque’, ‘is_bank_token’: ‘0’ |ex: “4321”| Routing Number,
“name_on_account”: string | required if ‘funding_method’ : ‘electronic_cheque’, ‘is_bank_token’: ‘0’ |ex: “Mary Smith”| Name on Account,
Responses :
When ‘investing_as’ : ‘jt_right_of_survivorship’, ‘jt_in_common’, ‘tenants_by_entirety’
201
“success” : true,
“KCX_Investment_Ref_ID” : “Some_Investment_Ref_ID”,
“KCX_Joint_Group_ID” : “Some_Joint_Group_ID”,
“KCX_Joint_Holder_ID” : “Some_Joint_Holder_ID”,
“KCX_Investor_ID” : “Some_Investor_ID”
When ‘investing_as’ : ‘person’, ‘company’, ‘trust’
201
“success” : true,
“KCX_Investment_Ref_ID” : “Some_Investment_Ref_ID”,
“KCX_Investor_ID” : “Some_Investor_ID”
Failures:
401
“success” : false,
“message” : “Access Denied.”401
“success” : false,
“message” : “Invalid Credentials.”422
“success” : false,
“message” : “The given data was invalid.”
“errors” : “Validation errors”500
“success” : false,
“message” : “Failed to update investment.”
None
None
Testing Token
{
"KCX_Platform_ID": "",
"KCX_Listing_ID": "",
"source_button_id": "",
"offering_type": "RegA+",
"investor_email_id": "",
"number_of_shares": "",
"investment_amount": "",
"investment_date": "",
"investing_as": "",
"investor_first_name": "",
"investor_middle_name": "",
"investor_last_name": "",
"investor_mobile_phone": "",
"investor_address1": "",
"investor_address2": "",
"investor_city": "",
"investor_state": "",
"investor_country": "",
"investor_zip": "",
"investor_dob": "",
"investor_national_id_number": "",
"investor_national_id_country": "",
"investor_driver_license_number": "",
"investor_driver_license_expiry_date": "",
"investor_driver_license_state": "",
"investor_driver_license_country": "",
"investor_passport_number": "",
"investor_passport_expiry_date": "",
"investor_passport_country": "",
"investor_institution_name": "",
"investor_institution_tax_id_number": "",
"investor_institution_formation_date": "",
"investor_institution_formation_state": "",
"investor_institution_contact_first_name": "",
"investor_institution_contact_last_name": "",
"investor_institution_contact_position": "",
"investor_institution_address1": "",
"investor_institution_address2": "",
"investor_institution_city": "",
"investor_institution_state": "",
"investor_institution_country": "",
"investor_institution_zip": "",
"investor_company_legal_extension": "",
"investor_company_type": "",
"investor_company_sector": "",
"joint_investor_first_name": "",
"joint_investor_middle_name": "",
"joint_investor_last_name": "",
"joint_investor_email_address": "",
"joint_investor_phone": "",
"investor_accredited": "",
"investor_accredited_qualification": "",
"investor_net_worth": "",
"investor_annual_income": "",
"financial_advisor": "",
"financial_advisor_name": "",
"financial_advisor_email_id": "",
"funding_method": "",
"is_bank_token": "",
"payment_method_token": "",
"bank_name": "",
"account_type": "",
"account_number": "",
"routing_number": "",
"name_on_account": ""
}
POST https://compliance-api-sandbox.koreconx.com/api/compliance-api/add-investment
{
"KCX_Platform_ID": "",
"KCX_Listing_ID": "",
"source_button_id": "",
"offering_type": "RegA+",
"investor_email_id": "",
"number_of_shares": "",
"investment_amount": "",
"investment_date": "",
"investing_as": "",
"investor_first_name": "",
"investor_middle_name": "",
"investor_last_name": "",
"investor_mobile_phone": "",
"investor_address1": "",
"investor_address2": "",
"investor_city": "",
"investor_state": "",
"investor_country": "",
"investor_zip": "",
"investor_dob": "",
"investor_national_id_number": "",
"investor_national_id_country": "",
"investor_driver_license_number": "",
"investor_driver_license_expiry_date": "",
"investor_driver_license_state": "",
"investor_driver_license_country": "",
"investor_passport_number": "",
"investor_passport_expiry_date": "",
"investor_passport_country": "",
"investor_institution_name": "",
"investor_institution_tax_id_number": "",
"investor_institution_formation_date": "",
"investor_institution_formation_state": "",
"investor_institution_contact_first_name": "",
"investor_institution_contact_last_name": "",
"investor_institution_contact_position": "",
"investor_institution_address1": "",
"investor_institution_address2": "",
"investor_institution_city": "",
"investor_institution_state": "",
"investor_institution_country": "",
"investor_institution_zip": "",
"investor_company_legal_extension": "",
"investor_company_type": "",
"investor_company_sector": "",
"joint_investor_first_name": "",
"joint_investor_middle_name": "",
"joint_investor_last_name": "",
"joint_investor_email_address": "",
"joint_investor_phone": "",
"investor_accredited": "",
"investor_accredited_qualification": "",
"investor_net_worth": "",
"investor_annual_income": "",
"financial_advisor": "",
"financial_advisor_name": "",
"financial_advisor_email_id": "",
"funding_method": "",
"is_bank_token": "",
"payment_method_token": "",
"bank_name": "",
"account_type": "",
"account_number": "",
"routing_number": "",
"name_on_account": ""
}
Request Body:
content-type: Application/json
Schema Definition :
“KCX_Platform_ID”: integer | required| ex:”4321” |Provided by KoreConX,
“KCX_Listing_ID”: integer | required| ex:”4321” |Provided by KoreConX,
“source_button_id”: string | required | ex:”ExampleInvestNowButton” |Investment Button ID or Investment Landing Page ID,
“offering_type”: string | required | value:”RegCF” |any one from options: RegA+, RegCF, RegD, RegS,
“investor_email_id”: string | required | ex:”investor@example.com” |Investor Email ID,
“number_of_shares”: whole number | required | ex.”200”| Number of Shares,
“investment_amount”: Decimal number | required |ex: “1000.00”| must be USD with two decimal point,
“investment_date”: datetime | required |ex: “2022-04-20 22:22:22”| Format: YYYY-MM-DD HH:MM:SS,
“investing_as”: string | required |ex: “jt_in_common”| any one from options: person, jt_right_of_survivorship, jt_in_common, tenants_by_entirety, company, trust,
“investor_first_name”: string | required |ex: “Mary”| Investor First Name,
“investor_middle_name”: string | optional |ex: “Elizabeth”| Investor Middle Name,
“investor_last_name”: string | required |ex: “Smith”| Investor Last Name,
“investor_mobile_phone”: string | required |ex: “999-999-9999”| Investor Mobile Phone Number,
“investor_address1”: string | required |ex: “1234 My Street”| Investor Address Line 1,
“investor_address2”: string | optional |ex: “APT 4321”| Investor Address Line 2,
“investor_city”: string | required |ex: “Kingston”| Investor Address City,
“investor_state”: string | required |ex: “NY”| Investor Address two/three letter state code,
“investor_country”: string | required |ex: “US”| Investor Address two letter country code,
“investor_zip”: string | required |ex: “12401”| Investor Address Zip Code,
“investor_dob”: date | required |ex: “1980-04-20”| Investor must be 18 years of age or above at the time of the investment. Format: YYYY-MM-DD,
“investor_national_id_number”: string | required |ex: “123456789”| Investor SSN, SIN or any other National ID number,
“investor_national_id_country”: string | required |ex: “US”| Investor SSN, SIN or any other National ID two letter country code,
Provide at least one either Driver License Details or Passport Details or BOTH
“investor_driver_license_number”: string | required if passport details not provided |ex: “123456789”| Investor Driver License Number,
“investor_driver_license_expiry_date”: date | required if ‘investor_driver_license_number’ provided |ex: “2030-04-20”| Investor Driver License Expiry Date must be a future date compared to the date of investment. Format: YYYY-MM-DD,
“investor_driver_license_state”: string | required if ‘investor_driver_license_number’ provided |ex: “NY”| Investor Driver License two/three letter state code,
“investor_driver_license_country”: string | required if ‘investor_driver_license_number’ provided |ex: “US”| Investor Driver License two letter country code,
“investor_passport_number”: string | required if driver license details not provided |ex: “123456789”| Investor Passport Number,
“investor_passport_expiry_date”: date | required if ‘investor_passport_number’ provided |ex: “2030-04-20”| Investor Passport Expiry Date must be a future date compared to the date of investment. Format: YYYY-MM-DD,
“investor_passport_country”: string | required if ‘investor_passport_number’ provided |ex: “US”| Investor Passport two letter country code,
Enter Company or Trust information in Investor Institution Fields when ‘investing_as’ : ‘company’ or ‘trust’
“investor_institution_name”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “ABC Name”| Company Name or Trust Name,
“investor_institution_tax_id_number”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “4321”| Tax ID Number of Company or Trust,
“investor_institution_formation_date”: date | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “1980-04-20”| Company or Trust Formation Date. Format: YYYY-MM-DD,
“investor_institution_formation_state”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “NY”| Company or Trust Formation two/three letter state code,
“investor_institution_contact_first_name”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “John”| Company or Trust Contact First Name,
“investor_institution_contact_last_name”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “Smith”| Company or Trust Contact Last Name,
“investor_institution_contact_position”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “CEO”| Company or Trust Contact Position,
“investor_institution_address1”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “4321 My Street”| Company or Trust Address Line 1,
“investor_institution_address2”: string | optional |ex: “APT 1234”| Company or Trust Address Line 2,
“investor_institution_city”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “Kingston”| Company or Trust Address City,
“investor_institution_state”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “NY”| Company or Trust Address two/three letter state code,
“investor_institution_country”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “US”| Company or Trust Address two letter country code,
“investor_institution_zip”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “12401”| Company or Trust Address Zip Code,
Enter Company information only in Investor Company Fields when ‘investing_as’ : ‘company’
“investor_company_legal_extension”: string | required if ‘investing_as’ : ‘company’ |ex: “CORP”| Company Legal Extension Code in UPPERCASE,
COMPANY LEGAL EXTENSION TABLE
‘CODE’ => ‘EXTENSION’
‘NLE’ => ‘(No Legal Extension/Entity)’,
‘LLC’ => ‘Limited Liability Company (LLC)’,
‘CORP’ => ‘Corporation (CORP)’,
‘INC’ => ‘Incorporated (INC)’,
‘LLP’ => ‘Limited Liability Partners (LLP)’,
‘PLC’ => ‘Public Limited Company (PLC)’,
‘PBC’ => ‘Public Benefit Corporation (PBC)’,
‘LTD’ => ‘Limited Company (Ltd)’,
‘CO’ => ‘Company (Co.)’,
‘PC’ => ‘Professional Corporation (PC)’,
‘FND’ => ‘Foundation (FND)’,
‘ILP’ => ‘Incorporated Limited Partnership (ILP)’,
‘VCLP’ => ‘Venture Capital Limited Partnership (VCLP)’,
‘ESVCLP’ => ‘Early-stage Venture Capital Limited Partnership (ESVCLP)’,
‘AFOF’ => ‘Australian Venture Capital Fund of Funds (AFOF)’,
‘VCMP’ => ‘Venture Capital Management Partnership (VCMP)’,
‘NL’ => ‘No Liability (NL)’,
‘PTY LTD’ => ‘Proprietary Limited Company (PTY LTD)’,
‘PTY’ => ‘Unlimited Proprietary (PTY)’,
‘LTC’ => ‘Look-Through Company (LTC)’,
‘JSC’ => ‘Joint-Stock Company (JSC)’,
‘LP’ => ‘Limited Partnership (LP)’,
‘FC’ => ‘Foreign Company (FC)’,
‘IE’ => ‘Individual Establishment (IE)’,
‘PTE LTD’ => ‘Private Limited Company (PTE LTD)’,
‘SDN BHD’ => ‘Sendirian Berhad (SDN BHD)’,
‘SP’ => ‘Sole Proprietorship (SP)’,
‘P’ => ‘Partnership (P)’,
‘BHD’ => ‘Berhad (BHD)’,
‘SSC’ => ‘Singapore Subsidiary Company (SSC)’,
‘CIC’ => ‘Community Interest Company (CIC)’,
‘CIO’ => ‘Charitable Incorporated Organisation (CIO)’,
‘SLP’ => ‘Scottish Limited Partnerships (SLP)’,
‘PUC’ => ‘Private Unlimited Company (PUC)’,
‘PC LBS’ => ‘Private Company Limited by Shares (PC LBS)’,
‘PC LBG’ => ‘Private Company Limited by Guarantee (PC LGS)’,
‘IPS’ => ‘Industrial and Provident Society (IPS)’,
‘CO OP’ => ‘Co-operative (CO OP)’,
‘PUBC’ => ‘Public Company’,
‘CLBNSC’ => ‘Company limited By Guarantee Not Having a Share Capital (CLBNSC)’,
‘SMC’ => ‘Single Member Company (SMC)’,
‘UC’ => ‘Unlimited Company (UC)’,
‘UCITS’ => ‘Undertakings for Collective Investment in Transferable Securities (UCITS)’,
‘HUF’ => ‘Hindu Undivided Family (HUF)’,
‘DC’ => ‘Dormant Company (DC)’,
‘FOB’ => ‘Family Owned Business (FOB)’,
‘SC’ => ‘Small Company (SC)’,
‘PSU’ => ‘Public Sector Undertaking (PSU)’,
‘OPC’ => ‘One-person company (OPC)’,
‘IC’ => ‘Incorporation Company (IC)’,
‘BT’ => ‘Business Trust (BT)’,
‘CC’ => ‘Close corporation (CC)’,
‘PLLC’ => ‘Professional Limited Liability Company (PLLC)’,
‘LTD GTE’ => ‘Limited by Guarantee (LTD GTE)’
“investor_company_type”: string | required if ‘investing_as’ : ‘company’ |ex: “PRI”| Company Type Code in UPPERCASE,
COMPANY TYPES TABLE
‘CODE’ => ‘TYPE’
‘PRI’ => ‘Private’,
‘PUB’ => ‘Public’,
‘NPO’ => ‘Not For Profit’,
‘FND’ => ‘Foundation’,
‘CHR’ => ‘Registered Charity’,
‘CDO’ => ‘Condominium Board’,
‘CRU’ => ‘Credit Union’,
‘CRO’ => ‘Crown Corporation’,
‘STR’ => ‘Strata Board’
“investor_company_sector”: string | required if ‘investing_as’ : ‘company’ |ex: “1770”| Company Sector Code,
COMPANY SECTORS TABLE
‘CODE’ => ‘SECTOR’
‘0500’ => ‘Oil & Gas’,
‘0530’ => ‘Oil & Gas Producers’,
‘0533’ => ‘Exploration & Production’,
‘0537’ => ‘Integrated Oil & Gas’,
‘0570’ => ‘Oil Equipment, Services & Distribution’,
‘0573’ => ‘Oil Equipment & Services’,
‘0577’ => ‘Pipelines’,
‘0580’ => ‘Alternative Energy’,
‘0583’ => ‘Renewable Energy Equipment’,
‘0587’ => ‘Alternative Fuels’,
‘1300’ => ‘Chemicals’,
‘1353’ => ‘Commodity Chemicals’,
‘1357’ => ‘Specialty Chemicals’,
‘1700’ => ‘Basic Resources’,
‘1730’ => ‘Forestry & Paper’,
‘1733’ => ‘Forestry’,
‘1737’ => ‘Paper’,
‘1750’ => ‘Industrial Metals & Mining’,
‘1753’ => ‘Aluminum’,
‘1755’ => ‘Nonferrous Metals’,
‘1757’ => ‘Iron & Steel’,
‘1770’ => ‘Mining’,
‘1771’ => ‘Coal’,
‘1773’ => ‘Diamonds & Gemstones’,
‘1775’ => ‘General Mining’,
‘1777’ => ‘Gold Mining’,
‘1779’ => ‘Platinum & Precious Metals’,
‘2300’ => ‘Construction & Materials’,
‘2353’ => ‘Building Materials & Fixtures’,
‘2357’ => ‘Heavy Construction’,
‘2700’ => ‘Industrial Goods & Services’,
‘2710’ => ‘Aerospace & Defense’,
‘2713’ => ‘Aerospace’,
‘2717’ => ‘Defense’,
‘2720’ => ‘General Industrials’,
‘2723’ => ‘Containers & Packaging’,
‘2727’ => ‘Diversified Industrials’,
‘2730’ => ‘Electronic & Electrical Equipment’,
‘2733’ => ‘Electrical Components & Equipment’,
‘2737’ => ‘Electronic Equipment’,
‘2750’ => ‘Industrial Engineering’,
‘2753’ => ‘Commercial Vehicles & Trucks’,
‘2757’ => ‘Industrial Machinery’,
‘2770’ => ‘Industrial Transportation’,
‘2771’ => ‘Delivery Services’,
‘2773’ => ‘Marine Transportation’,
‘2775’ => ‘Railroads’,
‘2777’ => ‘Transportation Services’,
‘2779’ => ‘Trucking’,
‘2790’ => ‘Support Services’,
‘2791’ => ‘Business Support Services’,
‘2793’ => ‘Business Training & Employment Agencies’,
‘2795’ => ‘Financial Administration’,
‘2797’ => ‘Industrial Suppliers’,
‘2799’ => ‘Waste & Disposal Services’,
‘3300’ => ‘Automobiles & Parts’,
‘3353’ => ‘Automobiles’,
‘3355’ => ‘Auto Parts’,
‘3357’ => ‘Tires’,
‘3500’ => ‘Food & Beverage’,
‘3530’ => ‘Beverages’,
‘3533’ => ‘Brewers’,
‘3535’ => ‘Distillers & Vintners’,
‘3537’ => ‘Soft Drinks’,
‘3570’ => ‘Food Producers’,
‘3573’ => ‘Farming & Fishing’,
‘3577’ => ‘Food Products’,
‘3700’ => ‘Personal & Household Goods’,
‘3720’ => ‘Household Goods & Home Construction’,
‘3722’ => ‘Durable Household Products’,
‘3724’ => ‘Nondurable Household Products’,
‘3726’ => ‘Furnishings’,
‘3728’ => ‘Home Construction’,
‘3740’ => ‘Leisure Goods’,
‘3743’ => ‘Consumer Electronics’,
‘3745’ => ‘Recreational Products’,
‘3747’ => ‘Toys’,
‘3760’ => ‘Personal Goods’,
‘3763’ => ‘Clothing & Accessories’,
‘3765’ => ‘Footwear’,
‘3767’ => ‘Personal Products’,
‘3780’ => ‘Tobacco’,
‘4500’ => ‘Health Care’,
‘4530’ => ‘Health Care Equipment & Services’,
‘4533’ => ‘Health Care Provvalueers’,
‘4535’ => ‘Medical Equipment’,
‘4537’ => ‘Medical Supplies’,
‘4570’ => ‘Pharmaceuticals & Biotechnology’,
‘4573’ => ‘Biotechnology’,
‘4577’ => ‘Pharmaceuticals’,
‘5300’ => ‘Retail’,
‘5330’ => ‘Food & Drug Retailers’,
‘5333’ => ‘Drug Retailers’,
‘5337’ => ‘Food Retailers & Wholesalers’,
‘5370’ => ‘General Retailers’,
‘5371’ => ‘Apparel Retailers’,
‘5373’ => ‘Broadline Retailers’,
‘5375’ => ‘Home Improvement Retailers’,
‘5377’ => ‘Specialized Consumer Services’,
‘5379’ => ‘Specialty Retailers’,
‘5500’ => ‘Media’,
‘5553’ => ‘Broadcasting & Entertainment’,
‘5555’ => ‘Media Agencies’,
‘5557’ => ‘Publishing’,
‘5700’ => ‘Travel & Leisure’,
‘5750’ => ‘Travel & Leisure’,
‘5751’ => ‘Airlines’,
‘5752’ => ‘Gambling’,
‘5753’ => ‘Hotels’,
‘5755’ => ‘Recreational Services’,
‘5757’ => ‘Restaurants & Bars’,
‘5759’ => ‘Travel & Tourism’,
‘6500’ => ‘Telecommunications’,
‘6530’ => ‘Fixed Line Telecommunications’,
‘6570’ => ‘Mobile Telecommunications’,
‘7530’ => ‘Electricity’,
‘7535’ => ‘Conventional Electricity’,
‘7537’ => ‘Alternative Electricity’,
‘7570’ => ‘Gas, Water & Multiutilities’,
‘7573’ => ‘Gas Distribution’,
‘7575’ => ‘Multiutilities’,
‘7577’ => ‘Water’,
‘8300’ => ‘Banks’,
‘8500’ => ‘Insurance’,
‘8530’ => ‘Nonlife Insurance’,
‘8532’ => ‘Full Line Insurance’,
‘8534’ => ‘Insurance Brokers’,
‘8536’ => ‘Property & Casualty Insurance’,
‘8538’ => ‘Reinsurance’,
‘8570’ => ‘Life Insurance’,
‘8600’ => ‘Real Estate’,
‘8630’ => ‘Real Estate Investment & Services’,
‘8637’ => ‘Real Estate Services’,
‘8670’ => ‘Real Estate Investment Trusts’,
‘8671’ => ‘Industrial & Office REITs’,
‘8672’ => ‘Retail REITs’,
‘8673’ => ‘Resvalueential REITs’,
‘8674’ => ‘Diversified REITs’,
‘8675’ => ‘Specialty REITs’,
‘8676’ => ‘Mortgage REITs’,
‘8677’ => ‘Hotel & Lodging REITs’,
‘8700’ => ‘Financial Services’,
‘8771’ => ‘Asset Managers’,
‘8773’ => ‘Consumer Finance’,
‘8775’ => ‘Specialty Finance’,
‘8777’ => ‘Investment Services’,
‘8779’ => ‘Mortgage Finance’,
‘8900’ => ‘Equity/Non-Equity Investment Instruments’,
‘8980’ => ‘Equity Investment Instruments’,
‘8990’ => ‘Nonequity Investment Instruments’,
‘9500’ => ‘Technology’,
‘9530’ => ‘Software & Computer Services’,
‘9533’ => ‘Computer Services’,
‘9535’ => ‘Internet’,
‘9537’ => ‘Software’,
‘9570’ => ‘Technology Hardware & Equipment’,
‘9572’ => ‘Computer Hardware’,
‘9574’ => ‘Electronic Office Equipment’,
‘9576’ => ‘Semiconductors’,
‘9578’ => ‘Telecommunications Equipment’,
Enter Joint Investor information in Joint Investor Fields when ‘investing_as’ : ‘jt_right_of_survivorship’, ‘jt_in_common’, ‘tenants_by_entirety’
“joint_investor_first_name”: string | required if ‘investing_as’ : ‘jt_right_of_survivorship’, ‘jt_in_common’, ‘tenants_by_entirety’ |ex: “Jim”| Joint Investor First Name,
“joint_investor_middle_name”: string | optional |ex: “Smith”| Joint Investor Middle Name,
“joint_investor_last_name”: string | required if ‘investing_as’ : ‘jt_right_of_survivorship’, ‘jt_in_common’, ‘tenants_by_entirety’ |ex: “Brown”| Joint Investor Last Name,
“joint_investor_email_address”: string | required if ‘investing_as’ : ‘jt_right_of_survivorship’, ‘jt_in_common’, ‘tenants_by_entirety’ |ex: “jt_investor@example.com”| Joint Investor Email Address,
“joint_investor_phone”: string | required if ‘investing_as’ : ‘jt_right_of_survivorship’, ‘jt_in_common’, ‘tenants_by_entirety’ |ex: “888-888-8888”| Joint Investor Phone Number,
“investor_accredited”: boolean | required |ex: “0”| “0” or “1”,
“investor_net_worth”: numeric | required |ex: “100000”| Investor Net Worth,
“investor_annual_income”: numeric | required |ex: “100000”| Investor Annual Income,
“investment_in_last_twelve_months”: numeric | optional if ‘offering_type’ : ‘RegCF’ |ex: “100000”| Investment In Last Twelve Months,
“investor_accredited_qualification”: integer | required if ‘investor_accredited’ : ‘1’ |ex: “0”| value must be any one from options: 0, 1, 2, 3
INVESTOR ACCREDITED QUALIFICATION VALUES DEFINITION
0 => 401k/Other: I have an individual net worth, or joint net worth with my spouse, that exceeds $1 million including any IRA’s, 401K’s, and other retirement accounts, but excluding the net value of my primary residence.
1 => Income/Asset: I am an individual with an income of over $200,000 in each of the last two years, or joint income with my spouse exceeding $300,000 in those years, and I reasonably expect at least the same this year.
2 => Registered Person: You hold any of the following licenses from the Financial Industry Regulatory Authority (FINRA): Series 7, Series 82, or Series 65.
3 => Internal: You A director, executive officer, or general partner of the company selling the securities, or any director, executive officer, or general partner of a general partner of that issuer or a knowledgeable employee.
“financial_advisor”: boolean | optional |ex: “true”| true or false,
“financial_advisor_name”: string | required if ‘financial_advisor’ : ‘true’ |ex: “Bob Smith”| Financial Advisor Name,
“financial_advisor_email_id”: email | required if ‘financial_advisor’ : ‘true’ |ex: “financial_advisor@example.com”| Financial Advisor Email ID,
Enter Payment Information in the related fields
“funding_method”: string | required |ex: “electronic_cheque”| must be any one from options: ‘electronic_cheque’, ‘credit_card’, ‘mail_cheque’, ‘wire_transfer’, ‘crypto’, ‘Invest through Self-Directed IRA’,
“is_bank_token”: boolean | required if ‘funding_method’ : ‘electronic_cheque’ (Payment Method: Bank is available as Token or The Account Details) |ex: “0”| “0” or “1”,
“payment_method_token”: string | required if ‘funding_method’ : ‘credit_card’, ‘electronic_cheque’ (Only if ‘is_bank_token’: ‘1’, Payment Method is Bank Token) |ex: “ABCDXXXXX”| Credit Card Auth Token or Bank Token,
“bank_name”: string | required if ‘funding_method’ : ‘electronic_cheque’, ‘is_bank_token’: ‘0’ |ex: “ABC Bank”| Bank Name,
“account_type”: string | required if ‘funding_method’ : ‘electronic_cheque’, ‘is_bank_token’: ‘0’ |ex: “chequing”| must be any one from options: ‘chequing’, ‘savings’,
“account_number”: string | required if ‘funding_method’ : ‘electronic_cheque’, ‘is_bank_token’: ‘0’ |ex: “123456789”| Account Number,
“routing_number”: string | required if ‘funding_method’ : ‘electronic_cheque’, ‘is_bank_token’: ‘0’ |ex: “4321”| Routing Number,
“name_on_account”: string | required if ‘funding_method’ : ‘electronic_cheque’, ‘is_bank_token’: ‘0’ |ex: “Mary Smith”| Name on Account,
Responses :
When ‘investing_as’ : ‘jt_right_of_survivorship’, ‘jt_in_common’, ‘tenants_by_entirety’
201
“success” : true,
“KCX_Investment_Ref_ID” : “Some_Investment_Ref_ID”,
“KCX_Joint_Group_ID” : “Some_Joint_Group_ID”,
“KCX_Joint_Holder_ID” : “Some_Joint_Holder_ID”,
“KCX_Investor_ID” : “Some_Investor_ID”
When ‘investing_as’ : ‘person’, ‘company’, ‘trust’
201
“success” : true,
“KCX_Investment_Ref_ID” : “Some_Investment_Ref_ID”,
“KCX_Investor_ID” : “Some_Investor_ID”
Failures:
401
“success” : false,
“message” : “Access Denied.”401
“success” : false,
“message” : “Invalid Credentials.”422
“success” : false,
“message” : “The given data was invalid.”
“errors” : “Validation errors”500
“success” : false,
“message” : “Failed to update investment.”
None
None
Testing Token
{
"KCX_Platform_ID": "",
"KCX_Listing_ID": "",
"source_button_id": "",
"offering_type": "RegCF",
"investor_email_id": "",
"number_of_shares": "",
"investment_amount": "",
"investment_date": "",
"investing_as": "",
"investor_first_name": "",
"investor_middle_name": "",
"investor_last_name": "",
"investor_mobile_phone": "",
"investor_address1": "",
"investor_address2": "",
"investor_city": "",
"investor_state": "",
"investor_country": "",
"investor_zip": "",
"investor_dob": "",
"investor_national_id_number": "",
"investor_national_id_country": "",
"investor_driver_license_number": "",
"investor_driver_license_expiry_date": "",
"investor_driver_license_state": "",
"investor_driver_license_country": "",
"investor_passport_number": "",
"investor_passport_expiry_date": "",
"investor_passport_country": "",
"investor_institution_name": "",
"investor_institution_tax_id_number": "",
"investor_institution_formation_date": "",
"investor_institution_formation_state": "",
"investor_institution_contact_first_name": "",
"investor_institution_contact_last_name": "",
"investor_institution_contact_position": "",
"investor_institution_address1": "",
"investor_institution_address2": "",
"investor_institution_city": "",
"investor_institution_state": "",
"investor_institution_country": "",
"investor_institution_zip": "",
"investor_company_legal_extension": "",
"investor_company_type": "",
"investor_company_sector": "",
"joint_investor_first_name": "",
"joint_investor_middle_name": "",
"joint_investor_last_name": "",
"joint_investor_email_address": "",
"joint_investor_phone": "",
"investor_accredited": "",
"investor_accredited_qualification": "",
"investor_net_worth": "",
"investor_annual_income": "",
"investment_in_last_twelve_months": "",
"financial_advisor": "",
"financial_advisor_name": "",
"financial_advisor_email_id": "",
"funding_method": "",
"is_bank_token": "",
"payment_method_token": "",
"bank_name": "",
"account_type": "",
"account_number": "",
"routing_number": "",
"name_on_account": ""
}
POST https://compliance-api-sandbox.koreconx.com/api/compliance-api/add-investment
{
"KCX_Platform_ID": "",
"KCX_Listing_ID": "",
"source_button_id": "",
"offering_type": "RegCF",
"investor_email_id": "",
"number_of_shares": "",
"investment_amount": "",
"investment_date": "",
"investing_as": "",
"investor_first_name": "",
"investor_middle_name": "",
"investor_last_name": "",
"investor_mobile_phone": "",
"investor_address1": "",
"investor_address2": "",
"investor_city": "",
"investor_state": "",
"investor_country": "",
"investor_zip": "",
"investor_dob": "",
"investor_national_id_number": "",
"investor_national_id_country": "",
"investor_driver_license_number": "",
"investor_driver_license_expiry_date": "",
"investor_driver_license_state": "",
"investor_driver_license_country": "",
"investor_passport_number": "",
"investor_passport_expiry_date": "",
"investor_passport_country": "",
"investor_institution_name": "",
"investor_institution_tax_id_number": "",
"investor_institution_formation_date": "",
"investor_institution_formation_state": "",
"investor_institution_contact_first_name": "",
"investor_institution_contact_last_name": "",
"investor_institution_contact_position": "",
"investor_institution_address1": "",
"investor_institution_address2": "",
"investor_institution_city": "",
"investor_institution_state": "",
"investor_institution_country": "",
"investor_institution_zip": "",
"investor_company_legal_extension": "",
"investor_company_type": "",
"investor_company_sector": "",
"joint_investor_first_name": "",
"joint_investor_middle_name": "",
"joint_investor_last_name": "",
"joint_investor_email_address": "",
"joint_investor_phone": "",
"investor_accredited": "",
"investor_accredited_qualification": "",
"investor_net_worth": "",
"investor_annual_income": "",
"investment_in_last_twelve_months": "",
"financial_advisor": "",
"financial_advisor_name": "",
"financial_advisor_email_id": "",
"funding_method": "",
"is_bank_token": "",
"payment_method_token": "",
"bank_name": "",
"account_type": "",
"account_number": "",
"routing_number": "",
"name_on_account": ""
}
Request Body:
content-type: Application/json
Schema Definition :
“KCX_Platform_ID”: integer | required| ex:”4321” |Provided by KoreConX,
“KCX_Listing_ID”: integer | required| ex:”4321” |Provided by KoreConX,
“source_button_id”: string | required | ex:”ExampleInvestNowButton” |Investment Button ID or Investment Landing Page ID,
“offering_type”: string | required | value:”RegD” |any one from options: RegA+, RegCF, RegD, RegS,
“investor_email_id”: string | required | ex:”investor@example.com” |Investor Email ID,
“number_of_shares”: whole number | required | ex.”200”| Number of Shares,
“investment_amount”: Decimal number | required |ex: “1000.00”| must be USD with two decimal point,
“investment_date”: datetime | required |ex: “2022-04-20 22:22:22”| Format: YYYY-MM-DD HH:MM:SS,
“investing_as”: string | required |ex: “jt_in_common”| any one from options: person, jt_right_of_survivorship, jt_in_common, tenants_by_entirety, company, trust,
“investor_first_name”: string | required |ex: “Mary”| Investor First Name,
“investor_middle_name”: string | optional |ex: “Elizabeth”| Investor Middle Name,
“investor_last_name”: string | required |ex: “Smith”| Investor Last Name,
“investor_mobile_phone”: string | required |ex: “999-999-9999”| Investor Mobile Phone Number,
“investor_address1”: string | required |ex: “1234 My Street”| Investor Address Line 1,
“investor_address2”: string | optional |ex: “APT 4321”| Investor Address Line 2,
“investor_city”: string | required |ex: “Kingston”| Investor Address City,
“investor_state”: string | required |ex: “NY”| Investor Address two/three letter state code,
“investor_country”: string | required |ex: “US”| Investor Address two letter country code,
“investor_zip”: string | required |ex: “12401”| Investor Address Zip Code,
“investor_dob”: date | required |ex: “1980-04-20”| Investor must be 18 years of age or above at the time of the investment. Format: YYYY-MM-DD,
“investor_national_id_number”: string | required |ex: “123456789”| Investor SSN, SIN or any other National ID number,
“investor_national_id_country”: string | required |ex: “US”| Investor SSN, SIN or any other National ID two letter country code,
Provide at least one either Driver License Details or Passport Details or BOTH
“investor_driver_license_number”: string | required if passport details not provided |ex: “123456789”| Investor Driver License Number,
“investor_driver_license_expiry_date”: date | required if ‘investor_driver_license_number’ provided |ex: “2030-04-20”| Investor Driver License Expiry Date must be a future date compared to the date of investment. Format: YYYY-MM-DD,
“investor_driver_license_state”: string | required if ‘investor_driver_license_number’ provided |ex: “NY”| Investor Driver License two/three letter state code,
“investor_driver_license_country”: string | required if ‘investor_driver_license_number’ provided |ex: “US”| Investor Driver License two letter country code,
“investor_passport_number”: string | required if driver license details not provided |ex: “123456789”| Investor Passport Number,
“investor_passport_expiry_date”: date | required if ‘investor_passport_number’ provided |ex: “2030-04-20”| Investor Passport Expiry Date must be a future date compared to the date of investment. Format: YYYY-MM-DD,
“investor_passport_country”: string | required if ‘investor_passport_number’ provided |ex: “US”| Investor Passport two letter country code,
Enter Company or Trust information in Investor Institution Fields when ‘investing_as’ : ‘company’ or ‘trust’
“investor_institution_name”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “ABC Name”| Company Name or Trust Name,
“investor_institution_tax_id_number”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “4321”| Tax ID Number of Company or Trust,
“investor_institution_formation_date”: date | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “1980-04-20”| Company or Trust Formation Date. Format: YYYY-MM-DD,
“investor_institution_formation_state”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “NY”| Company or Trust Formation two/three letter state code,
“investor_institution_contact_first_name”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “John”| Company or Trust Contact First Name,
“investor_institution_contact_last_name”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “Smith”| Company or Trust Contact Last Name,
“investor_institution_contact_position”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “CEO”| Company or Trust Contact Position,
“investor_institution_address1”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “4321 My Street”| Company or Trust Address Line 1,
“investor_institution_address2”: string | optional |ex: “APT 1234”| Company or Trust Address Line 2,
“investor_institution_city”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “Kingston”| Company or Trust Address City,
“investor_institution_state”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “NY”| Company or Trust Address two/three letter state code,
“investor_institution_country”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “US”| Company or Trust Address two letter country code,
“investor_institution_zip”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “12401”| Company or Trust Address Zip Code,
Enter Company information only in Investor Company Fields when ‘investing_as’ : ‘company’
“investor_company_legal_extension”: string | required if ‘investing_as’ : ‘company’ |ex: “CORP”| Company Legal Extension Code in UPPERCASE,
COMPANY LEGAL EXTENSION TABLE
‘CODE’ => ‘EXTENSION’
‘NLE’ => ‘(No Legal Extension/Entity)’,
‘LLC’ => ‘Limited Liability Company (LLC)’,
‘CORP’ => ‘Corporation (CORP)’,
‘INC’ => ‘Incorporated (INC)’,
‘LLP’ => ‘Limited Liability Partners (LLP)’,
‘PLC’ => ‘Public Limited Company (PLC)’,
‘PBC’ => ‘Public Benefit Corporation (PBC)’,
‘LTD’ => ‘Limited Company (Ltd)’,
‘CO’ => ‘Company (Co.)’,
‘PC’ => ‘Professional Corporation (PC)’,
‘FND’ => ‘Foundation (FND)’,
‘ILP’ => ‘Incorporated Limited Partnership (ILP)’,
‘VCLP’ => ‘Venture Capital Limited Partnership (VCLP)’,
‘ESVCLP’ => ‘Early-stage Venture Capital Limited Partnership (ESVCLP)’,
‘AFOF’ => ‘Australian Venture Capital Fund of Funds (AFOF)’,
‘VCMP’ => ‘Venture Capital Management Partnership (VCMP)’,
‘NL’ => ‘No Liability (NL)’,
‘PTY LTD’ => ‘Proprietary Limited Company (PTY LTD)’,
‘PTY’ => ‘Unlimited Proprietary (PTY)’,
‘LTC’ => ‘Look-Through Company (LTC)’,
‘JSC’ => ‘Joint-Stock Company (JSC)’,
‘LP’ => ‘Limited Partnership (LP)’,
‘FC’ => ‘Foreign Company (FC)’,
‘IE’ => ‘Individual Establishment (IE)’,
‘PTE LTD’ => ‘Private Limited Company (PTE LTD)’,
‘SDN BHD’ => ‘Sendirian Berhad (SDN BHD)’,
‘SP’ => ‘Sole Proprietorship (SP)’,
‘P’ => ‘Partnership (P)’,
‘BHD’ => ‘Berhad (BHD)’,
‘SSC’ => ‘Singapore Subsidiary Company (SSC)’,
‘CIC’ => ‘Community Interest Company (CIC)’,
‘CIO’ => ‘Charitable Incorporated Organisation (CIO)’,
‘SLP’ => ‘Scottish Limited Partnerships (SLP)’,
‘PUC’ => ‘Private Unlimited Company (PUC)’,
‘PC LBS’ => ‘Private Company Limited by Shares (PC LBS)’,
‘PC LBG’ => ‘Private Company Limited by Guarantee (PC LGS)’,
‘IPS’ => ‘Industrial and Provident Society (IPS)’,
‘CO OP’ => ‘Co-operative (CO OP)’,
‘PUBC’ => ‘Public Company’,
‘CLBNSC’ => ‘Company limited By Guarantee Not Having a Share Capital (CLBNSC)’,
‘SMC’ => ‘Single Member Company (SMC)’,
‘UC’ => ‘Unlimited Company (UC)’,
‘UCITS’ => ‘Undertakings for Collective Investment in Transferable Securities (UCITS)’,
‘HUF’ => ‘Hindu Undivided Family (HUF)’,
‘DC’ => ‘Dormant Company (DC)’,
‘FOB’ => ‘Family Owned Business (FOB)’,
‘SC’ => ‘Small Company (SC)’,
‘PSU’ => ‘Public Sector Undertaking (PSU)’,
‘OPC’ => ‘One-person company (OPC)’,
‘IC’ => ‘Incorporation Company (IC)’,
‘BT’ => ‘Business Trust (BT)’,
‘CC’ => ‘Close corporation (CC)’,
‘PLLC’ => ‘Professional Limited Liability Company (PLLC)’,
‘LTD GTE’ => ‘Limited by Guarantee (LTD GTE)’
“investor_company_type”: string | required if ‘investing_as’ : ‘company’ |ex: “PRI”| Company Type Code in UPPERCASE,
COMPANY TYPES TABLE
‘CODE’ => ‘TYPE’
‘PRI’ => ‘Private’,
‘PUB’ => ‘Public’,
‘NPO’ => ‘Not For Profit’,
‘FND’ => ‘Foundation’,
‘CHR’ => ‘Registered Charity’,
‘CDO’ => ‘Condominium Board’,
‘CRU’ => ‘Credit Union’,
‘CRO’ => ‘Crown Corporation’,
‘STR’ => ‘Strata Board’
“investor_company_sector”: string | required if ‘investing_as’ : ‘company’ |ex: “1770”| Company Sector Code,
COMPANY SECTORS TABLE
‘CODE’ => ‘SECTOR’
‘0500’ => ‘Oil & Gas’,
‘0530’ => ‘Oil & Gas Producers’,
‘0533’ => ‘Exploration & Production’,
‘0537’ => ‘Integrated Oil & Gas’,
‘0570’ => ‘Oil Equipment, Services & Distribution’,
‘0573’ => ‘Oil Equipment & Services’,
‘0577’ => ‘Pipelines’,
‘0580’ => ‘Alternative Energy’,
‘0583’ => ‘Renewable Energy Equipment’,
‘0587’ => ‘Alternative Fuels’,
‘1300’ => ‘Chemicals’,
‘1353’ => ‘Commodity Chemicals’,
‘1357’ => ‘Specialty Chemicals’,
‘1700’ => ‘Basic Resources’,
‘1730’ => ‘Forestry & Paper’,
‘1733’ => ‘Forestry’,
‘1737’ => ‘Paper’,
‘1750’ => ‘Industrial Metals & Mining’,
‘1753’ => ‘Aluminum’,
‘1755’ => ‘Nonferrous Metals’,
‘1757’ => ‘Iron & Steel’,
‘1770’ => ‘Mining’,
‘1771’ => ‘Coal’,
‘1773’ => ‘Diamonds & Gemstones’,
‘1775’ => ‘General Mining’,
‘1777’ => ‘Gold Mining’,
‘1779’ => ‘Platinum & Precious Metals’,
‘2300’ => ‘Construction & Materials’,
‘2353’ => ‘Building Materials & Fixtures’,
‘2357’ => ‘Heavy Construction’,
‘2700’ => ‘Industrial Goods & Services’,
‘2710’ => ‘Aerospace & Defense’,
‘2713’ => ‘Aerospace’,
‘2717’ => ‘Defense’,
‘2720’ => ‘General Industrials’,
‘2723’ => ‘Containers & Packaging’,
‘2727’ => ‘Diversified Industrials’,
‘2730’ => ‘Electronic & Electrical Equipment’,
‘2733’ => ‘Electrical Components & Equipment’,
‘2737’ => ‘Electronic Equipment’,
‘2750’ => ‘Industrial Engineering’,
‘2753’ => ‘Commercial Vehicles & Trucks’,
‘2757’ => ‘Industrial Machinery’,
‘2770’ => ‘Industrial Transportation’,
‘2771’ => ‘Delivery Services’,
‘2773’ => ‘Marine Transportation’,
‘2775’ => ‘Railroads’,
‘2777’ => ‘Transportation Services’,
‘2779’ => ‘Trucking’,
‘2790’ => ‘Support Services’,
‘2791’ => ‘Business Support Services’,
‘2793’ => ‘Business Training & Employment Agencies’,
‘2795’ => ‘Financial Administration’,
‘2797’ => ‘Industrial Suppliers’,
‘2799’ => ‘Waste & Disposal Services’,
‘3300’ => ‘Automobiles & Parts’,
‘3353’ => ‘Automobiles’,
‘3355’ => ‘Auto Parts’,
‘3357’ => ‘Tires’,
‘3500’ => ‘Food & Beverage’,
‘3530’ => ‘Beverages’,
‘3533’ => ‘Brewers’,
‘3535’ => ‘Distillers & Vintners’,
‘3537’ => ‘Soft Drinks’,
‘3570’ => ‘Food Producers’,
‘3573’ => ‘Farming & Fishing’,
‘3577’ => ‘Food Products’,
‘3700’ => ‘Personal & Household Goods’,
‘3720’ => ‘Household Goods & Home Construction’,
‘3722’ => ‘Durable Household Products’,
‘3724’ => ‘Nondurable Household Products’,
‘3726’ => ‘Furnishings’,
‘3728’ => ‘Home Construction’,
‘3740’ => ‘Leisure Goods’,
‘3743’ => ‘Consumer Electronics’,
‘3745’ => ‘Recreational Products’,
‘3747’ => ‘Toys’,
‘3760’ => ‘Personal Goods’,
‘3763’ => ‘Clothing & Accessories’,
‘3765’ => ‘Footwear’,
‘3767’ => ‘Personal Products’,
‘3780’ => ‘Tobacco’,
‘4500’ => ‘Health Care’,
‘4530’ => ‘Health Care Equipment & Services’,
‘4533’ => ‘Health Care Provvalueers’,
‘4535’ => ‘Medical Equipment’,
‘4537’ => ‘Medical Supplies’,
‘4570’ => ‘Pharmaceuticals & Biotechnology’,
‘4573’ => ‘Biotechnology’,
‘4577’ => ‘Pharmaceuticals’,
‘5300’ => ‘Retail’,
‘5330’ => ‘Food & Drug Retailers’,
‘5333’ => ‘Drug Retailers’,
‘5337’ => ‘Food Retailers & Wholesalers’,
‘5370’ => ‘General Retailers’,
‘5371’ => ‘Apparel Retailers’,
‘5373’ => ‘Broadline Retailers’,
‘5375’ => ‘Home Improvement Retailers’,
‘5377’ => ‘Specialized Consumer Services’,
‘5379’ => ‘Specialty Retailers’,
‘5500’ => ‘Media’,
‘5553’ => ‘Broadcasting & Entertainment’,
‘5555’ => ‘Media Agencies’,
‘5557’ => ‘Publishing’,
‘5700’ => ‘Travel & Leisure’,
‘5750’ => ‘Travel & Leisure’,
‘5751’ => ‘Airlines’,
‘5752’ => ‘Gambling’,
‘5753’ => ‘Hotels’,
‘5755’ => ‘Recreational Services’,
‘5757’ => ‘Restaurants & Bars’,
‘5759’ => ‘Travel & Tourism’,
‘6500’ => ‘Telecommunications’,
‘6530’ => ‘Fixed Line Telecommunications’,
‘6570’ => ‘Mobile Telecommunications’,
‘7530’ => ‘Electricity’,
‘7535’ => ‘Conventional Electricity’,
‘7537’ => ‘Alternative Electricity’,
‘7570’ => ‘Gas, Water & Multiutilities’,
‘7573’ => ‘Gas Distribution’,
‘7575’ => ‘Multiutilities’,
‘7577’ => ‘Water’,
‘8300’ => ‘Banks’,
‘8500’ => ‘Insurance’,
‘8530’ => ‘Nonlife Insurance’,
‘8532’ => ‘Full Line Insurance’,
‘8534’ => ‘Insurance Brokers’,
‘8536’ => ‘Property & Casualty Insurance’,
‘8538’ => ‘Reinsurance’,
‘8570’ => ‘Life Insurance’,
‘8600’ => ‘Real Estate’,
‘8630’ => ‘Real Estate Investment & Services’,
‘8637’ => ‘Real Estate Services’,
‘8670’ => ‘Real Estate Investment Trusts’,
‘8671’ => ‘Industrial & Office REITs’,
‘8672’ => ‘Retail REITs’,
‘8673’ => ‘Resvalueential REITs’,
‘8674’ => ‘Diversified REITs’,
‘8675’ => ‘Specialty REITs’,
‘8676’ => ‘Mortgage REITs’,
‘8677’ => ‘Hotel & Lodging REITs’,
‘8700’ => ‘Financial Services’,
‘8771’ => ‘Asset Managers’,
‘8773’ => ‘Consumer Finance’,
‘8775’ => ‘Specialty Finance’,
‘8777’ => ‘Investment Services’,
‘8779’ => ‘Mortgage Finance’,
‘8900’ => ‘Equity/Non-Equity Investment Instruments’,
‘8980’ => ‘Equity Investment Instruments’,
‘8990’ => ‘Nonequity Investment Instruments’,
‘9500’ => ‘Technology’,
‘9530’ => ‘Software & Computer Services’,
‘9533’ => ‘Computer Services’,
‘9535’ => ‘Internet’,
‘9537’ => ‘Software’,
‘9570’ => ‘Technology Hardware & Equipment’,
‘9572’ => ‘Computer Hardware’,
‘9574’ => ‘Electronic Office Equipment’,
‘9576’ => ‘Semiconductors’,
‘9578’ => ‘Telecommunications Equipment’,
Enter Joint Investor information in Joint Investor Fields when ‘investing_as’ : ‘jt_right_of_survivorship’, ‘jt_in_common’, ‘tenants_by_entirety’
“joint_investor_first_name”: string | required if ‘investing_as’ : ‘jt_right_of_survivorship’, ‘jt_in_common’, ‘tenants_by_entirety’ |ex: “Jim”| Joint Investor First Name,
“joint_investor_middle_name”: string | optional |ex: “Smith”| Joint Investor Middle Name,
“joint_investor_last_name”: string | required if ‘investing_as’ : ‘jt_right_of_survivorship’, ‘jt_in_common’, ‘tenants_by_entirety’ |ex: “Brown”| Joint Investor Last Name,
“joint_investor_email_address”: string | required if ‘investing_as’ : ‘jt_right_of_survivorship’, ‘jt_in_common’, ‘tenants_by_entirety’ |ex: “jt_investor@example.com”| Joint Investor Email Address,
“joint_investor_phone”: string | required if ‘investing_as’ : ‘jt_right_of_survivorship’, ‘jt_in_common’, ‘tenants_by_entirety’ |ex: “888-888-8888”| Joint Investor Phone Number,
“investor_accredited”: boolean | required |ex: “0”| “0” or “1”,
“investor_accredited_qualification”: integer | required if ‘investor_accredited’ : ‘1’ |ex: “0”| value must be any one from options: 0, 1, 2, 3
INVESTOR ACCREDITED QUALIFICATION VALUES DEFINITION
0 => 401k/Other: I have an individual net worth, or joint net worth with my spouse, that exceeds $1 million including any IRA’s, 401K’s, and other retirement accounts, but excluding the net value of my primary residence.
1 => Income/Asset: I am an individual with an income of over $200,000 in each of the last two years, or joint income with my spouse exceeding $300,000 in those years, and I reasonably expect at least the same this year.
2 => Registered Person: You hold any of the following licenses from the Financial Industry Regulatory Authority (FINRA): Series 7, Series 82, or Series 65.
3 => Internal: You A director, executive officer, or general partner of the company selling the securities, or any director, executive officer, or general partner of a general partner of that issuer or a knowledgeable employee.
“regd_accredited_investor_verification”: string | required if ‘offering_type’ : ‘RegD’ |ex: “lawyer”| value must be any one from options: ‘lawyer’, ‘cpa’, ‘broker-dealer’, ‘advisor’, ‘third-party’, ‘registered-person’, ‘income-verification’, ‘asset-verification’,
“investor_net_worth”: numeric | required |ex: “100000”| Investor Net Worth,
“investor_annual_income”: numeric | required |ex: “100000”| Investor Annual Income,
“financial_advisor”: boolean | optional |ex: “true”| true or false,
“financial_advisor_name”: string | required if ‘financial_advisor’ : ‘true’ |ex: “Bob Smith”| Financial Advisor Name,
“financial_advisor_email_id”: email | required if ‘financial_advisor’ : ‘true’ |ex: “financial_advisor@example.com”| Financial Advisor Email ID,
Enter Payment Information in the related fields
“funding_method”: string | required |ex: “electronic_cheque”| must be any one from options: ‘electronic_cheque’, ‘credit_card’, ‘mail_cheque’, ‘wire_transfer’, ‘crypto’, ‘Invest through Self-Directed IRA’,
“is_bank_token”: boolean | required if ‘funding_method’ : ‘electronic_cheque’ (Payment Method: Bank is available as Token or The Account Details) |ex: “0”| “0” or “1”,
“payment_method_token”: string | required if ‘funding_method’ : ‘credit_card’, ‘electronic_cheque’ (Only if ‘is_bank_token’: ‘1’, Payment Method is Bank Token) |ex: “ABCDXXXXX”| Credit Card Auth Token or Bank Token,
“bank_name”: string | required if ‘funding_method’ : ‘electronic_cheque’, ‘is_bank_token’: ‘0’ |ex: “ABC Bank”| Bank Name,
“account_type”: string | required if ‘funding_method’ : ‘electronic_cheque’, ‘is_bank_token’: ‘0’ |ex: “chequing”| must be any one from options: ‘chequing’, ‘savings’,
“account_number”: string | required if ‘funding_method’ : ‘electronic_cheque’, ‘is_bank_token’: ‘0’ |ex: “123456789”| Account Number,
“routing_number”: string | required if ‘funding_method’ : ‘electronic_cheque’, ‘is_bank_token’: ‘0’ |ex: “4321”| Routing Number,
“name_on_account”: string | required if ‘funding_method’ : ‘electronic_cheque’, ‘is_bank_token’: ‘0’ |ex: “Mary Smith”| Name on Account,
Responses :
When ‘investing_as’ : ‘jt_right_of_survivorship’, ‘jt_in_common’, ‘tenants_by_entirety’
201
“success” : true,
“KCX_Investment_Ref_ID” : “Some_Investment_Ref_ID”,
“KCX_Joint_Group_ID” : “Some_Joint_Group_ID”,
“KCX_Joint_Holder_ID” : “Some_Joint_Holder_ID”,
“KCX_Investor_ID” : “Some_Investor_ID”
When ‘investing_as’ : ‘person’, ‘company’, ‘trust’
201
“success” : true,
“KCX_Investment_Ref_ID” : “Some_Investment_Ref_ID”,
“KCX_Investor_ID” : “Some_Investor_ID”
Failures:
401
“success” : false,
“message” : “Access Denied.”401
“success” : false,
“message” : “Invalid Credentials.”422
“success” : false,
“message” : “The given data was invalid.”
“errors” : “Validation errors”500
“success” : false,
“message” : “Failed to update investment.”
None
None
Testing Token
{
"KCX_Platform_ID": "",
"KCX_Listing_ID": "",
"source_button_id": "",
"offering_type": "RegD",
"investor_email_id": "",
"number_of_shares": "",
"investment_amount": "",
"investment_date": "",
"investing_as": "",
"investor_first_name": "",
"investor_middle_name": "",
"investor_last_name": "",
"investor_mobile_phone": "",
"investor_address1": "",
"investor_address2": "",
"investor_city": "",
"investor_state": "",
"investor_country": "",
"investor_zip": "",
"investor_dob": "",
"investor_national_id_number": "",
"investor_national_id_country": "",
"investor_driver_license_number": "",
"investor_driver_license_expiry_date": "",
"investor_driver_license_state": "",
"investor_driver_license_country": "",
"investor_passport_number": "",
"investor_passport_expiry_date": "",
"investor_passport_country": "",
"investor_institution_name": "",
"investor_institution_tax_id_number": "",
"investor_institution_formation_date": "",
"investor_institution_formation_state": "",
"investor_institution_contact_first_name": "",
"investor_institution_contact_last_name": "",
"investor_institution_contact_position": "",
"investor_institution_address1": "",
"investor_institution_address2": "",
"investor_institution_city": "",
"investor_institution_state": "",
"investor_institution_country": "",
"investor_institution_zip": "",
"investor_company_legal_extension": "",
"investor_company_type": "",
"investor_company_sector": "",
"joint_investor_first_name": "",
"joint_investor_middle_name": "",
"joint_investor_last_name": "",
"joint_investor_email_address": "",
"joint_investor_phone": "",
"investor_accredited": "",
"investor_accredited_qualification": "",
"regd_accredited_investor_verification": "",
"investor_net_worth": "",
"investor_annual_income": "",
"financial_advisor": "",
"financial_advisor_name": "",
"financial_advisor_email_id": "",
"funding_method": "",
"is_bank_token": "",
"payment_method_token": "",
"bank_name": "",
"account_type": "",
"account_number": "",
"routing_number": "",
"name_on_account": ""
}
POST https://compliance-api-sandbox.koreconx.com/api/compliance-api/add-investment
{
"KCX_Platform_ID": "",
"KCX_Listing_ID": "",
"source_button_id": "",
"offering_type": "RegD",
"investor_email_id": "",
"number_of_shares": "",
"investment_amount": "",
"investment_date": "",
"investing_as": "",
"investor_first_name": "",
"investor_middle_name": "",
"investor_last_name": "",
"investor_mobile_phone": "",
"investor_address1": "",
"investor_address2": "",
"investor_city": "",
"investor_state": "",
"investor_country": "",
"investor_zip": "",
"investor_dob": "",
"investor_national_id_number": "",
"investor_national_id_country": "",
"investor_driver_license_number": "",
"investor_driver_license_expiry_date": "",
"investor_driver_license_state": "",
"investor_driver_license_country": "",
"investor_passport_number": "",
"investor_passport_expiry_date": "",
"investor_passport_country": "",
"investor_institution_name": "",
"investor_institution_tax_id_number": "",
"investor_institution_formation_date": "",
"investor_institution_formation_state": "",
"investor_institution_contact_first_name": "",
"investor_institution_contact_last_name": "",
"investor_institution_contact_position": "",
"investor_institution_address1": "",
"investor_institution_address2": "",
"investor_institution_city": "",
"investor_institution_state": "",
"investor_institution_country": "",
"investor_institution_zip": "",
"investor_company_legal_extension": "",
"investor_company_type": "",
"investor_company_sector": "",
"joint_investor_first_name": "",
"joint_investor_middle_name": "",
"joint_investor_last_name": "",
"joint_investor_email_address": "",
"joint_investor_phone": "",
"investor_accredited": "",
"investor_accredited_qualification": "",
"regd_accredited_investor_verification": "",
"investor_net_worth": "",
"investor_annual_income": "",
"financial_advisor": "",
"financial_advisor_name": "",
"financial_advisor_email_id": "",
"funding_method": "",
"is_bank_token": "",
"payment_method_token": "",
"bank_name": "",
"account_type": "",
"account_number": "",
"routing_number": "",
"name_on_account": ""
}
Request Body:
content-type: Application/json
Schema Definition :
“KCX_Platform_ID”: integer | required| ex:”4321” |Provided by KoreConX,
“KCX_Listing_ID”: integer | required| ex:”4321” |Provided by KoreConX,
“source_button_id”: string | required | ex:”ExampleInvestNowButton” |Investment Button ID or Investment Landing Page ID,
“offering_type”: string | required | value:”RegS” |any one from options: RegA+, RegCF, RegD, RegS,
“investor_email_id”: string | required | ex:”investor@example.com” |Investor Email ID,
“number_of_shares”: whole number | required | ex.”200”| Number of Shares,
“investment_amount”: Decimal number | required |ex: “1000.00”| must be USD with two decimal point,
“investment_date”: datetime | required |ex: “2022-04-20 22:22:22”| Format: YYYY-MM-DD HH:MM:SS,
“investing_as”: string | required |ex: “jt_in_common”| any one from options: person, jt_right_of_survivorship, jt_in_common, tenants_by_entirety, company, trust,
“investor_first_name”: string | required |ex: “Mary”| Investor First Name,
“investor_middle_name”: string | optional |ex: “Elizabeth”| Investor Middle Name,
“investor_last_name”: string | required |ex: “Smith”| Investor Last Name,
“investor_mobile_phone”: string | required |ex: “999-999-9999”| Investor Mobile Phone Number,
“investor_address1”: string | required |ex: “1234 My Street”| Investor Address Line 1,
“investor_address2”: string | optional |ex: “APT 4321”| Investor Address Line 2,
“investor_city”: string | required |ex: “Kingston”| Investor Address City,
“investor_state”: string | required |ex: “NY”| Investor Address two/three letter state code,
“investor_country”: string | required |ex: “US”| Investor Address two letter country code,
“investor_zip”: string | required |ex: “12401”| Investor Address Zip Code,
“investor_dob”: date | required |ex: “1980-04-20”| Investor must be 18 years of age or above at the time of the investment. Format: YYYY-MM-DD,
“investor_national_id_number”: string | required |ex: “123456789”| Investor SSN, SIN or any other National ID number,
“investor_national_id_country”: string | required |ex: “US”| Investor SSN, SIN or any other National ID two letter country code,
Provide at least one either Driver License Details or Passport Details or BOTH
“investor_driver_license_number”: string | required if passport details not provided |ex: “123456789”| Investor Driver License Number,
“investor_driver_license_expiry_date”: date | required if ‘investor_driver_license_number’ provided |ex: “2030-04-20”| Investor Driver License Expiry Date must be a future date compared to the date of investment. Format: YYYY-MM-DD,
“investor_driver_license_state”: string | required if ‘investor_driver_license_number’ provided |ex: “NY”| Investor Driver License two/three letter state code,
“investor_driver_license_country”: string | required if ‘investor_driver_license_number’ provided |ex: “US”| Investor Driver License two letter country code,
“investor_passport_number”: string | required if driver license details not provided |ex: “123456789”| Investor Passport Number,
“investor_passport_expiry_date”: date | required if ‘investor_passport_number’ provided |ex: “2030-04-20”| Investor Passport Expiry Date must be a future date compared to the date of investment. Format: YYYY-MM-DD,
“investor_passport_country”: string | required if ‘investor_passport_number’ provided |ex: “US”| Investor Passport two letter country code,
Enter Company or Trust information in Investor Institution Fields when ‘investing_as’ : ‘company’ or ‘trust’
“investor_institution_name”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “ABC Name”| Company Name or Trust Name,
“investor_institution_tax_id_number”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “4321”| Tax ID Number of Company or Trust,
“investor_institution_formation_date”: date | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “1980-04-20”| Company or Trust Formation Date. Format: YYYY-MM-DD,
“investor_institution_formation_state”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “NY”| Company or Trust Formation two/three letter state code,
“investor_institution_contact_first_name”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “John”| Company or Trust Contact First Name,
“investor_institution_contact_last_name”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “Smith”| Company or Trust Contact Last Name,
“investor_institution_contact_position”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “CEO”| Company or Trust Contact Position,
“investor_institution_address1”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “4321 My Street”| Company or Trust Address Line 1,
“investor_institution_address2”: string | optional |ex: “APT 1234”| Company or Trust Address Line 2,
“investor_institution_city”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “Kingston”| Company or Trust Address City,
“investor_institution_state”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “NY”| Company or Trust Address two/three letter state code,
“investor_institution_country”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “US”| Company or Trust Address two letter country code,
“investor_institution_zip”: string | required if ‘investing_as’ : ‘company’ or ‘trust’ |ex: “12401”| Company or Trust Address Zip Code,
Enter Company information only in Investor Company Fields when ‘investing_as’ : ‘company’
“investor_company_legal_extension”: string | required if ‘investing_as’ : ‘company’ |ex: “CORP”| Company Legal Extension Code in UPPERCASE,
COMPANY LEGAL EXTENSION TABLE
‘CODE’ => ‘EXTENSION’
‘NLE’ => ‘(No Legal Extension/Entity)’,
‘LLC’ => ‘Limited Liability Company (LLC)’,
‘CORP’ => ‘Corporation (CORP)’,
‘INC’ => ‘Incorporated (INC)’,
‘LLP’ => ‘Limited Liability Partners (LLP)’,
‘PLC’ => ‘Public Limited Company (PLC)’,
‘PBC’ => ‘Public Benefit Corporation (PBC)’,
‘LTD’ => ‘Limited Company (Ltd)’,
‘CO’ => ‘Company (Co.)’,
‘PC’ => ‘Professional Corporation (PC)’,
‘FND’ => ‘Foundation (FND)’,
‘ILP’ => ‘Incorporated Limited Partnership (ILP)’,
‘VCLP’ => ‘Venture Capital Limited Partnership (VCLP)’,
‘ESVCLP’ => ‘Early-stage Venture Capital Limited Partnership (ESVCLP)’,
‘AFOF’ => ‘Australian Venture Capital Fund of Funds (AFOF)’,
‘VCMP’ => ‘Venture Capital Management Partnership (VCMP)’,
‘NL’ => ‘No Liability (NL)’,
‘PTY LTD’ => ‘Proprietary Limited Company (PTY LTD)’,
‘PTY’ => ‘Unlimited Proprietary (PTY)’,
‘LTC’ => ‘Look-Through Company (LTC)’,
‘JSC’ => ‘Joint-Stock Company (JSC)’,
‘LP’ => ‘Limited Partnership (LP)’,
‘FC’ => ‘Foreign Company (FC)’,
‘IE’ => ‘Individual Establishment (IE)’,
‘PTE LTD’ => ‘Private Limited Company (PTE LTD)’,
‘SDN BHD’ => ‘Sendirian Berhad (SDN BHD)’,
‘SP’ => ‘Sole Proprietorship (SP)’,
‘P’ => ‘Partnership (P)’,
‘BHD’ => ‘Berhad (BHD)’,
‘SSC’ => ‘Singapore Subsidiary Company (SSC)’,
‘CIC’ => ‘Community Interest Company (CIC)’,
‘CIO’ => ‘Charitable Incorporated Organisation (CIO)’,
‘SLP’ => ‘Scottish Limited Partnerships (SLP)’,
‘PUC’ => ‘Private Unlimited Company (PUC)’,
‘PC LBS’ => ‘Private Company Limited by Shares (PC LBS)’,
‘PC LBG’ => ‘Private Company Limited by Guarantee (PC LGS)’,
‘IPS’ => ‘Industrial and Provident Society (IPS)’,
‘CO OP’ => ‘Co-operative (CO OP)’,
‘PUBC’ => ‘Public Company’,
‘CLBNSC’ => ‘Company limited By Guarantee Not Having a Share Capital (CLBNSC)’,
‘SMC’ => ‘Single Member Company (SMC)’,
‘UC’ => ‘Unlimited Company (UC)’,
‘UCITS’ => ‘Undertakings for Collective Investment in Transferable Securities (UCITS)’,
‘HUF’ => ‘Hindu Undivided Family (HUF)’,
‘DC’ => ‘Dormant Company (DC)’,
‘FOB’ => ‘Family Owned Business (FOB)’,
‘SC’ => ‘Small Company (SC)’,
‘PSU’ => ‘Public Sector Undertaking (PSU)’,
‘OPC’ => ‘One-person company (OPC)’,
‘IC’ => ‘Incorporation Company (IC)’,
‘BT’ => ‘Business Trust (BT)’,
‘CC’ => ‘Close corporation (CC)’,
‘PLLC’ => ‘Professional Limited Liability Company (PLLC)’,
‘LTD GTE’ => ‘Limited by Guarantee (LTD GTE)’
“investor_company_type”: string | required if ‘investing_as’ : ‘company’ |ex: “PRI”| Company Type Code in UPPERCASE,
COMPANY TYPES TABLE
‘CODE’ => ‘TYPE’
‘PRI’ => ‘Private’,
‘PUB’ => ‘Public’,
‘NPO’ => ‘Not For Profit’,
‘FND’ => ‘Foundation’,
‘CHR’ => ‘Registered Charity’,
‘CDO’ => ‘Condominium Board’,
‘CRU’ => ‘Credit Union’,
‘CRO’ => ‘Crown Corporation’,
‘STR’ => ‘Strata Board’
“investor_company_sector”: string | required if ‘investing_as’ : ‘company’ |ex: “1770”| Company Sector Code,
COMPANY SECTORS TABLE
‘CODE’ => ‘SECTOR’
‘0500’ => ‘Oil & Gas’,
‘0530’ => ‘Oil & Gas Producers’,
‘0533’ => ‘Exploration & Production’,
‘0537’ => ‘Integrated Oil & Gas’,
‘0570’ => ‘Oil Equipment, Services & Distribution’,
‘0573’ => ‘Oil Equipment & Services’,
‘0577’ => ‘Pipelines’,
‘0580’ => ‘Alternative Energy’,
‘0583’ => ‘Renewable Energy Equipment’,
‘0587’ => ‘Alternative Fuels’,
‘1300’ => ‘Chemicals’,
‘1353’ => ‘Commodity Chemicals’,
‘1357’ => ‘Specialty Chemicals’,
‘1700’ => ‘Basic Resources’,
‘1730’ => ‘Forestry & Paper’,
‘1733’ => ‘Forestry’,
‘1737’ => ‘Paper’,
‘1750’ => ‘Industrial Metals & Mining’,
‘1753’ => ‘Aluminum’,
‘1755’ => ‘Nonferrous Metals’,
‘1757’ => ‘Iron & Steel’,
‘1770’ => ‘Mining’,
‘1771’ => ‘Coal’,
‘1773’ => ‘Diamonds & Gemstones’,
‘1775’ => ‘General Mining’,
‘1777’ => ‘Gold Mining’,
‘1779’ => ‘Platinum & Precious Metals’,
‘2300’ => ‘Construction & Materials’,
‘2353’ => ‘Building Materials & Fixtures’,
‘2357’ => ‘Heavy Construction’,
‘2700’ => ‘Industrial Goods & Services’,
‘2710’ => ‘Aerospace & Defense’,
‘2713’ => ‘Aerospace’,
‘2717’ => ‘Defense’,
‘2720’ => ‘General Industrials’,
‘2723’ => ‘Containers & Packaging’,
‘2727’ => ‘Diversified Industrials’,
‘2730’ => ‘Electronic & Electrical Equipment’,
‘2733’ => ‘Electrical Components & Equipment’,
‘2737’ => ‘Electronic Equipment’,
‘2750’ => ‘Industrial Engineering’,
‘2753’ => ‘Commercial Vehicles & Trucks’,
‘2757’ => ‘Industrial Machinery’,
‘2770’ => ‘Industrial Transportation’,
‘2771’ => ‘Delivery Services’,
‘2773’ => ‘Marine Transportation’,
‘2775’ => ‘Railroads’,
‘2777’ => ‘Transportation Services’,
‘2779’ => ‘Trucking’,
‘2790’ => ‘Support Services’,
‘2791’ => ‘Business Support Services’,
‘2793’ => ‘Business Training & Employment Agencies’,
‘2795’ => ‘Financial Administration’,
‘2797’ => ‘Industrial Suppliers’,
‘2799’ => ‘Waste & Disposal Services’,
‘3300’ => ‘Automobiles & Parts’,
‘3353’ => ‘Automobiles’,
‘3355’ => ‘Auto Parts’,
‘3357’ => ‘Tires’,
‘3500’ => ‘Food & Beverage’,
‘3530’ => ‘Beverages’,
‘3533’ => ‘Brewers’,
‘3535’ => ‘Distillers & Vintners’,
‘3537’ => ‘Soft Drinks’,
‘3570’ => ‘Food Producers’,
‘3573’ => ‘Farming & Fishing’,
‘3577’ => ‘Food Products’,
‘3700’ => ‘Personal & Household Goods’,
‘3720’ => ‘Household Goods & Home Construction’,
‘3722’ => ‘Durable Household Products’,
‘3724’ => ‘Nondurable Household Products’,
‘3726’ => ‘Furnishings’,
‘3728’ => ‘Home Construction’,
‘3740’ => ‘Leisure Goods’,
‘3743’ => ‘Consumer Electronics’,
‘3745’ => ‘Recreational Products’,
‘3747’ => ‘Toys’,
‘3760’ => ‘Personal Goods’,
‘3763’ => ‘Clothing & Accessories’,
‘3765’ => ‘Footwear’,
‘3767’ => ‘Personal Products’,
‘3780’ => ‘Tobacco’,
‘4500’ => ‘Health Care’,
‘4530’ => ‘Health Care Equipment & Services’,
‘4533’ => ‘Health Care Provvalueers’,
‘4535’ => ‘Medical Equipment’,
‘4537’ => ‘Medical Supplies’,
‘4570’ => ‘Pharmaceuticals & Biotechnology’,
‘4573’ => ‘Biotechnology’,
‘4577’ => ‘Pharmaceuticals’,
‘5300’ => ‘Retail’,
‘5330’ => ‘Food & Drug Retailers’,
‘5333’ => ‘Drug Retailers’,
‘5337’ => ‘Food Retailers & Wholesalers’,
‘5370’ => ‘General Retailers’,
‘5371’ => ‘Apparel Retailers’,
‘5373’ => ‘Broadline Retailers’,
‘5375’ => ‘Home Improvement Retailers’,
‘5377’ => ‘Specialized Consumer Services’,
‘5379’ => ‘Specialty Retailers’,
‘5500’ => ‘Media’,
‘5553’ => ‘Broadcasting & Entertainment’,
‘5555’ => ‘Media Agencies’,
‘5557’ => ‘Publishing’,
‘5700’ => ‘Travel & Leisure’,
‘5750’ => ‘Travel & Leisure’,
‘5751’ => ‘Airlines’,
‘5752’ => ‘Gambling’,
‘5753’ => ‘Hotels’,
‘5755’ => ‘Recreational Services’,
‘5757’ => ‘Restaurants & Bars’,
‘5759’ => ‘Travel & Tourism’,
‘6500’ => ‘Telecommunications’,
‘6530’ => ‘Fixed Line Telecommunications’,
‘6570’ => ‘Mobile Telecommunications’,
‘7530’ => ‘Electricity’,
‘7535’ => ‘Conventional Electricity’,
‘7537’ => ‘Alternative Electricity’,
‘7570’ => ‘Gas, Water & Multiutilities’,
‘7573’ => ‘Gas Distribution’,
‘7575’ => ‘Multiutilities’,
‘7577’ => ‘Water’,
‘8300’ => ‘Banks’,
‘8500’ => ‘Insurance’,
‘8530’ => ‘Nonlife Insurance’,
‘8532’ => ‘Full Line Insurance’,
‘8534’ => ‘Insurance Brokers’,
‘8536’ => ‘Property & Casualty Insurance’,
‘8538’ => ‘Reinsurance’,
‘8570’ => ‘Life Insurance’,
‘8600’ => ‘Real Estate’,
‘8630’ => ‘Real Estate Investment & Services’,
‘8637’ => ‘Real Estate Services’,
‘8670’ => ‘Real Estate Investment Trusts’,
‘8671’ => ‘Industrial & Office REITs’,
‘8672’ => ‘Retail REITs’,
‘8673’ => ‘Resvalueential REITs’,
‘8674’ => ‘Diversified REITs’,
‘8675’ => ‘Specialty REITs’,
‘8676’ => ‘Mortgage REITs’,
‘8677’ => ‘Hotel & Lodging REITs’,
‘8700’ => ‘Financial Services’,
‘8771’ => ‘Asset Managers’,
‘8773’ => ‘Consumer Finance’,
‘8775’ => ‘Specialty Finance’,
‘8777’ => ‘Investment Services’,
‘8779’ => ‘Mortgage Finance’,
‘8900’ => ‘Equity/Non-Equity Investment Instruments’,
‘8980’ => ‘Equity Investment Instruments’,
‘8990’ => ‘Nonequity Investment Instruments’,
‘9500’ => ‘Technology’,
‘9530’ => ‘Software & Computer Services’,
‘9533’ => ‘Computer Services’,
‘9535’ => ‘Internet’,
‘9537’ => ‘Software’,
‘9570’ => ‘Technology Hardware & Equipment’,
‘9572’ => ‘Computer Hardware’,
‘9574’ => ‘Electronic Office Equipment’,
‘9576’ => ‘Semiconductors’,
‘9578’ => ‘Telecommunications Equipment’,
Enter Joint Investor information in Joint Investor Fields when ‘investing_as’ : ‘jt_right_of_survivorship’, ‘jt_in_common’, ‘tenants_by_entirety’
“joint_investor_first_name”: string | required if ‘investing_as’ : ‘jt_right_of_survivorship’, ‘jt_in_common’, ‘tenants_by_entirety’ |ex: “Jim”| Joint Investor First Name,
“joint_investor_middle_name”: string | optional |ex: “Smith”| Joint Investor Middle Name,
“joint_investor_last_name”: string | required if ‘investing_as’ : ‘jt_right_of_survivorship’, ‘jt_in_common’, ‘tenants_by_entirety’ |ex: “Brown”| Joint Investor Last Name,
“joint_investor_email_address”: string | required if ‘investing_as’ : ‘jt_right_of_survivorship’, ‘jt_in_common’, ‘tenants_by_entirety’ |ex: “jt_investor@example.com”| Joint Investor Email Address,
“joint_investor_phone”: string | required if ‘investing_as’ : ‘jt_right_of_survivorship’, ‘jt_in_common’, ‘tenants_by_entirety’ |ex: “888-888-8888”| Joint Investor Phone Number,
“investor_accredited”: boolean | required |ex: “0”| “0” or “1”,
“investor_accredited_qualification”: integer | required if ‘investor_accredited’ : ‘1’ |ex: “0”| value must be any one from options: 0, 1, 2, 3
INVESTOR ACCREDITED QUALIFICATION VALUES DEFINITION
0 => 401k/Other: I have an individual net worth, or joint net worth with my spouse, that exceeds $1 million including any IRA’s, 401K’s, and other retirement accounts, but excluding the net value of my primary residence.
1 => Income/Asset: I am an individual with an income of over $200,000 in each of the last two years, or joint income with my spouse exceeding $300,000 in those years, and I reasonably expect at least the same this year.
2 => Registered Person: You hold any of the following licenses from the Financial Industry Regulatory Authority (FINRA): Series 7, Series 82, or Series 65.
3 => Internal: You A director, executive officer, or general partner of the company selling the securities, or any director, executive officer, or general partner of a general partner of that issuer or a knowledgeable employee.
“investor_net_worth”: numeric | required |ex: “100000”| Investor Net Worth,
“investor_annual_income”: numeric | required |ex: “100000”| Investor Annual Income,
“financial_advisor”: boolean | optional |ex: “true”| true or false,
“financial_advisor_name”: string | required if ‘financial_advisor’ : ‘true’ |ex: “Bob Smith”| Financial Advisor Name,
“financial_advisor_email_id”: email | required if ‘financial_advisor’ : ‘true’ |ex: “financial_advisor@example.com”| Financial Advisor Email ID,
Enter Payment Information in the related fields
“funding_method”: string | required |ex: “electronic_cheque”| must be any one from options: ‘electronic_cheque’, ‘credit_card’, ‘mail_cheque’, ‘wire_transfer’, ‘crypto’, ‘Invest through Self-Directed IRA’,
“is_bank_token”: boolean | required if ‘funding_method’ : ‘electronic_cheque’ (Payment Method: Bank is available as Token or The Account Details) |ex: “0”| “0” or “1”,
“payment_method_token”: string | required if ‘funding_method’ : ‘credit_card’, ‘electronic_cheque’ (Only if ‘is_bank_token’: ‘1’, Payment Method is Bank Token) |ex: “ABCDXXXXX”| Credit Card Auth Token or Bank Token,
“bank_name”: string | required if ‘funding_method’ : ‘electronic_cheque’, ‘is_bank_token’: ‘0’ |ex: “ABC Bank”| Bank Name,
“account_type”: string | required if ‘funding_method’ : ‘electronic_cheque’, ‘is_bank_token’: ‘0’ |ex: “chequing”| must be any one from options: ‘chequing’, ‘savings’,
“account_number”: string | required if ‘funding_method’ : ‘electronic_cheque’, ‘is_bank_token’: ‘0’ |ex: “123456789”| Account Number,
“routing_number”: string | required if ‘funding_method’ : ‘electronic_cheque’, ‘is_bank_token’: ‘0’ |ex: “4321”| Routing Number,
“name_on_account”: string | required if ‘funding_method’ : ‘electronic_cheque’, ‘is_bank_token’: ‘0’ |ex: “Mary Smith”| Name on Account,
Responses :
When ‘investing_as’ : ‘jt_right_of_survivorship’, ‘jt_in_common’, ‘tenants_by_entirety’
201
“success” : true,
“KCX_Investment_Ref_ID” : “Some_Investment_Ref_ID”,
“KCX_Joint_Group_ID” : “Some_Joint_Group_ID”,
“KCX_Joint_Holder_ID” : “Some_Joint_Holder_ID”,
“KCX_Investor_ID” : “Some_Investor_ID”
When ‘investing_as’ : ‘person’, ‘company’, ‘trust’
201
“success” : true,
“KCX_Investment_Ref_ID” : “Some_Investment_Ref_ID”,
“KCX_Investor_ID” : “Some_Investor_ID”
Failures:
401
“success” : false,
“message” : “Access Denied.”401
“success” : false,
“message” : “Invalid Credentials.”422
“success” : false,
“message” : “The given data was invalid.”
“errors” : “Validation errors”500
“success” : false,
“message” : “Failed to update investment.”
None
None
Testing Token
{
"KCX_Platform_ID": "",
"KCX_Listing_ID": "",
"source_button_id": "",
"offering_type": "RegS",
"investor_email_id": "",
"number_of_shares": "",
"investment_amount": "",
"investment_date": "",
"investing_as": "",
"investor_first_name": "",
"investor_middle_name": "",
"investor_last_name": "",
"investor_mobile_phone": "",
"investor_address1": "",
"investor_address2": "",
"investor_city": "",
"investor_state": "",
"investor_country": "",
"investor_zip": "",
"investor_dob": "",
"investor_national_id_number": "",
"investor_national_id_country": "",
"investor_driver_license_number": "",
"investor_driver_license_expiry_date": "",
"investor_driver_license_state": "",
"investor_driver_license_country": "",
"investor_passport_number": "",
"investor_passport_expiry_date": "",
"investor_passport_country": "",
"investor_institution_name": "",
"investor_institution_tax_id_number": "",
"investor_institution_formation_date": "",
"investor_institution_formation_state": "",
"investor_institution_contact_first_name": "",
"investor_institution_contact_last_name": "",
"investor_institution_contact_position": "",
"investor_institution_address1": "",
"investor_institution_address2": "",
"investor_institution_city": "",
"investor_institution_state": "",
"investor_institution_country": "",
"investor_institution_zip": "",
"investor_company_legal_extension": "",
"investor_company_type": "",
"investor_company_sector": "",
"joint_investor_first_name": "",
"joint_investor_middle_name": "",
"joint_investor_last_name": "",
"joint_investor_email_address": "",
"joint_investor_phone": "",
"investor_accredited": "",
"investor_accredited_qualification": "",
"investor_net_worth": "",
"investor_annual_income": "",
"financial_advisor": "",
"financial_advisor_name": "",
"financial_advisor_email_id": "",
"funding_method": "",
"is_bank_token": "",
"payment_method_token": "",
"bank_name": "",
"account_type": "",
"account_number": "",
"routing_number": "",
"name_on_account": ""
}
POST https://compliance-api-sandbox.koreconx.com/api/compliance-api/add-investment
{
"KCX_Platform_ID": "",
"KCX_Listing_ID": "",
"source_button_id": "",
"offering_type": "RegS",
"investor_email_id": "",
"number_of_shares": "",
"investment_amount": "",
"investment_date": "",
"investing_as": "",
"investor_first_name": "",
"investor_middle_name": "",
"investor_last_name": "",
"investor_mobile_phone": "",
"investor_address1": "",
"investor_address2": "",
"investor_city": "",
"investor_state": "",
"investor_country": "",
"investor_zip": "",
"investor_dob": "",
"investor_national_id_number": "",
"investor_national_id_country": "",
"investor_driver_license_number": "",
"investor_driver_license_expiry_date": "",
"investor_driver_license_state": "",
"investor_driver_license_country": "",
"investor_passport_number": "",
"investor_passport_expiry_date": "",
"investor_passport_country": "",
"investor_institution_name": "",
"investor_institution_tax_id_number": "",
"investor_institution_formation_date": "",
"investor_institution_formation_state": "",
"investor_institution_contact_first_name": "",
"investor_institution_contact_last_name": "",
"investor_institution_contact_position": "",
"investor_institution_address1": "",
"investor_institution_address2": "",
"investor_institution_city": "",
"investor_institution_state": "",
"investor_institution_country": "",
"investor_institution_zip": "",
"investor_company_legal_extension": "",
"investor_company_type": "",
"investor_company_sector": "",
"joint_investor_first_name": "",
"joint_investor_middle_name": "",
"joint_investor_last_name": "",
"joint_investor_email_address": "",
"joint_investor_phone": "",
"investor_accredited": "",
"investor_accredited_qualification": "",
"investor_net_worth": "",
"investor_annual_income": "",
"financial_advisor": "",
"financial_advisor_name": "",
"financial_advisor_email_id": "",
"funding_method": "",
"is_bank_token": "",
"payment_method_token": "",
"bank_name": "",
"account_type": "",
"account_number": "",
"routing_number": "",
"name_on_account": ""
}
Request Body:
content-type: Application/json
Schema Definition :
“KCX_Platform_ID”: integer | required| ex:”4321” |Provided by KoreConX,
“KCX_Joint_Group_ID”: string | required | ex:”4321DCBA” |Provided in Add Investment response,
“KCX_Joint_Holder_ID”: string | required | ex:”4321DCBA” |Provided in Add Investment response,
“KCX_Investment_Ref_ID”: string | required | ex:”4321DCBA” |Provided in Add Investment response,
“investor_email_id”: string | required | ex:”investor@example.com” |Same Joint Investor Email ID provided in Add Investment request,
“investing_as”: string | required |value: “joint_holder”| Always ‘joint_holder’ only
“investor_first_name”: string | required |ex: “Mary”| Investor First Name,
“investor_middle_name”: string | optional |ex: “Elizabeth”| Investor Middle Name,
“investor_last_name”: string | required |ex: “Smith”| Investor Last Name,
“investor_mobile_phone”: string | required |ex: “999-999-9999”| Investor Mobile Phone Number,
“investor_address1”: string | required |ex: “1234 My Street”| Investor Address Line 1,
“investor_address2”: string | optional |ex: “APT 4321”| Investor Address Line 2,
“investor_city”: string | required |ex: “Kingston”| Investor Address City,
“investor_state”: string | required |ex: “NY”| Investor Address two/three letter state code,
“investor_country”: string | required |ex: “US”| Investor Address two letter country code,
“investor_zip”: string | required |ex: “12401”| Investor Address Zip Code,
“investor_dob”: date | required |ex: “1980-04-20”| Investor must be 18 years of age or above at the time of the investment. Format: YYYY-MM-DD,
“investor_national_id_number”: string | required |ex: “123456789”| Investor SSN, SIN or any other National ID number,
“investor_national_id_country”: string | required |ex: “US”| Investor SSN, SIN or any other National ID two letter country code,
Provide at least one either Driver License Details or Passport Details or BOTH
“investor_driver_license_number”: string | required if passport details not provided |ex: “123456789”| Investor Driver License Number,
“investor_driver_license_expiry_date”: date | required if ‘investor_driver_license_number’ provided |ex: “2030-04-20”| Investor Driver License Expiry Date must be a future date compared to the date of investment. Format: YYYY-MM-DD,
“investor_driver_license_state”: string | required if ‘investor_driver_license_number’ provided |ex: “NY”| Investor Driver License two/three letter state code,
“investor_driver_license_country”: string | required if ‘investor_driver_license_number’ provided |ex: “US”| Investor Driver License two letter country code,
“investor_passport_number”: string | required if driver license details not provided |ex: “123456789”| Investor Passport Number,
“investor_passport_expiry_date”: date | required if ‘investor_passport_number’ provided |ex: “2030-04-20”| Investor Passport Expiry Date must be a future date compared to the date of investment. Format: YYYY-MM-DD,
“investor_passport_country”: string | required if ‘investor_passport_number’ provided |ex: “US”| Investor Passport two letter country code,
Responses :
201
“success” : true,
Failures:
401
“success” : false,
“message” : “Access Denied.”401
“success” : false,
“message” : “Invalid Credentials.”422
“success” : false,
“message” : “The given data was invalid.”
“errors” : “Validation errors”404
“success” : false,
“message” : “Entity not found. Investment Id & Joint Group Id don’t match the records.”500
“success” : false,
“message” : “Failed to update investment.”
None
None
Testing Token
{
"KCX_Platform_ID": "",
"KCX_Joint_Group_ID": "",
"KCX_Joint_Holder_ID": "",
"KCX_Investment_Ref_ID": "",
"investor_email_id": "",
"investing_as": "joint_holder",
"investor_first_name": "",
"investor_middle_name": "",
"investor_last_name": "",
"investor_mobile_phone": "",
"investor_address1": "",
"investor_address2": "",
"investor_city": "",
"investor_state": "",
"investor_country": "",
"investor_zip": "",
"investor_dob": "",
"investor_national_id_number": "",
"investor_national_id_country": "",
"investor_driver_license_number": "",
"investor_driver_license_expiry_date": "",
"investor_driver_license_state": "",
"investor_driver_license_country": "",
"investor_passport_number": "",
"investor_passport_expiry_date": "",
"investor_passport_country": ""
}
POST https://compliance-api-sandbox.koreconx.com/api/compliance-api/add-jointholder
{
"KCX_Platform_ID": "",
"KCX_Joint_Group_ID": "",
"KCX_Joint_Holder_ID": "",
"KCX_Investment_Ref_ID": "",
"investor_email_id": "",
"investing_as": "joint_holder",
"investor_first_name": "",
"investor_middle_name": "",
"investor_last_name": "",
"investor_mobile_phone": "",
"investor_address1": "",
"investor_address2": "",
"investor_city": "",
"investor_state": "",
"investor_country": "",
"investor_zip": "",
"investor_dob": "",
"investor_national_id_number": "",
"investor_national_id_country": "",
"investor_driver_license_number": "",
"investor_driver_license_expiry_date": "",
"investor_driver_license_state": "",
"investor_driver_license_country": "",
"investor_passport_number": "",
"investor_passport_expiry_date": "",
"investor_passport_country": ""
}
Request Body:
content-type: Application/json
Schema Definition :
“KCX_Investment_Ref_ID”: string | required | ex:”4321DCBA” |Provided in Add Investment response,
Responses :
200
“success” : true,
“KCX_Investment_Ref_ID” : “Some_Investment_Ref_ID”
“investment_payment_status” : “Some_Payment_Status”
Failures:
401
“success” : false,
“message” : “Access Denied.”401
“success” : false,
“message” : “Invalid Credentials.”422
“success” : false,
“message” : “The given data was invalid.”
“errors” : “Validation errors”404
“success” : false,
“message” : “Entity not found. Investment Id doesn’t match the records.”500
“success” : false,
“message” : “Failed to get investment payment status.”
None
None
Testing Token
{
"KCX_Investment_Ref_ID": ""
}
POST https://compliance-api-sandbox.koreconx.com/api/compliance-api/get-payment-status
{
"KCX_Investment_Ref_ID": ""
}
Request Body:
content-type: Application/json
Schema Definition :
“KCX_Listing_ID”: integer | required| ex:”4321” |Provided by KoreConX
Responses :
200
“success” : true,
“report” : “investment”
“investments” : [
{
“FirstName”: “John”,
“MiddleName”: “Smith”,
“LastName”: “Doe”,
“Email”: “jsd@example.com”,
“Address1”: “ABC Street”,
“Address2”: “”,
“City”: “Miami”,
“PostalCode”: “10001”,
“ProvinceOrState”: “FL”,
“Country”: “US”,
“Ira”: “0”,
“TypeOfInvestment”: “credit_card”,
“InvestmentAmount”: “200.00”,
“NumberOfShares”: “10”,
“Status”: “Closed”,
“DateOfInvestment”: “2022-01-26 20:56:01”,
“DateApproved”: “2022-01-26 20:56:49”,
“DateClosed”: “2022-01-31 16:34:29”,
“AccreditedInvestor”: “0”,
“IndividualNetWorth”: “0”,
“NetWorth”: “100000”,
“AnnualIncome”: “80000”,
“Phone”: “8888888888”,
“InvestedAs”: “person”,
“PaymentStatus”: “”,
“InvoiceNumber”: “99999”,
“KycStatus”: “Under Review”,
“ButtonId”: “ButtonContent”
}
]
Failures:
401
“success” : false,
“message” : “Access Denied.”401
“success” : false,
“message” : “Invalid Credentials.”422
“success” : false,
“message” : “The given data was invalid.”,
“errors” : “Validation errors”404
“success” : false,
“message” : “No records found for the given Listing Id.”500
“success” : false,
“message” : “Failed to generate investment report.”
None
None
None
{
"KCX_Listing_ID": ""
}
POST https://platform.koreconx.com/api/external/reports/investment
{
"KCX_Listing_ID": ""
}
Request Body:
content-type: Application/json
Schema Definition :
“KCX_Listing_ID”: integer | required| ex:”4321” |Provided by KoreConX
Responses :
200
“success” : true,
“report” : “abandoned”,
“investments” : [
{
“ButtonId”: “BtnInvestMenu”,
“DateOfInvestment”: “2022-01-26 17:28:15”,
“FirstName”: null,
“MiddleName”: null,
“LastName”: null,
“Email”: “abc@example.com”,
“InvestmentAmount”: “200.00”,
“Step”: “1”,
“Ira”: “0”,
“HearAboutUsFrom”: “Other”,
“CustomFieldsValues”: “[]“,
“Phone”: “8888888888”,
“Status”: null,
“Origin”: null,
“Referrer”: null
}
]
Failures:
401
“success” : false,
“message” : “Access Denied.”401
“success” : false,
“message” : “Invalid Credentials.”422
“success” : false,
“message” : “The given data was invalid.”,
“errors” : “Validation errors”404
“success” : false,
“message” : “No records found for the given Listing Id.”500
“success” : false,
“message” : “Failed to generate abandoned report.”
None
None
None
{
"KCX_Listing_ID": ""
}
POST https://platform.koreconx.com/api/external/reports/abandoned
{
"KCX_Listing_ID": ""
}
Request Body:
content-type: Application/json
Schema Definition :
“issuer_id” : number| required | example: 123
“title”: string | optional | example: “Mr.”
“first_name”: string | required | example: “Gary”,
“middle_name”: string | optional | example: “”,
“last_name”: string | required | example: “Miller”,
“suffix”: string | optional | example: “” ,
“email”: string | required | example: “garykg@gmail.com”,
“address1”: string | required | example: “123 Main Street”,
“address2”: string | optional | example: “336”,
“city”: string | required | example: “New York”,
“state”: string | required | example: “NY”| must be 2/3 letter state code,
“zip”: string | required | example: “10022”,
“country”: string | required | example: “USA”| must be 2/3 letter country code
“mobile”: string | required | example: “8135551212”,
“dob”: string | required | example: “2000-12-12”| must be in YYYY-MM-DD format,
“tin” : string | required | example: 123456789,
“gender”: string | optional | example: “M”| “M” or “F”,
“national_id_name”: string |required | example: “sin”| Should be SSN, SIN, etc.
“national_id”: string | required | example: “111223333”,
“driver_license”: string | optional | example: “G111223333”,
“dl_expiry_date”: string | optional |example: “2025-10-15” | must be in YYYY-MM-DD format,
“dl_issuing_state”: string | optional | example: “FL”| must be 2/3 letter state code,
“dl_issuing_country”: string | optional | example: “US”| must be 2/3 letter country,
“passport_number”: string | optional | example: “P11122333”,
“passport_expiry_date”: string | optional (required if used as an Id)|example: “2025-10-15”| must be in YYYY-MM-DD format,
“passport_issuing_state”: string | optional | example: “NY”| must be 2/3 letters state co,
“passport_issuing_country”: string | optional | example: “US”| must be 2/3 letter country code,
“accredited”: string | optional | example: must be “Yes” or “No”,
“accredited_method”: string | optional | example: Must be “Net Worth” or “Income” only
“annual_income”: string | optional| example: “125000.00” (in USD, two decimal point)
“net_worth”: string | optional| example: “245000.00” (in USD , two decimal point) ,
“tax_jurisdiction_country”: string | optional | example: “US” or “non-US” only ,
“backup_withholding_exemption”: string | optional | example: “Yes” or “No” only ,
“perjufy_certification”: string | optional | example: Must be “Yes” ,
“kyc_entity_id”: string | optional | example: “99787654632” | From the list provided by Koreconx ,
“kyc_date”: string | optional | example:”2021-01-23” | must be in YYYY-MM-DD format,
“kyc_transaction_id”: string| optional | example: “33879278765462322”,
“kyc_status”: string| optional | example: “Approved” | must be “Approved”,
“compliance_verifier_id”: string| optioanal | example: “273846612” | provided by koreconx,
“compliance_officer_id”: string| optional | example: “55362547” | provided by koreconx,
“financial_advisor_first_name”: string| optional | example: “John”,
“financial_advisor_middle_name”: string| optional | example: “”,
“financial_advisor_last_name”: string| optional | example: “Doe”,
“financial_advisor_phone”: string| optional | example: “4785551212”,
“financial_advisor_email”: string| optional | example: “test@gmail.com“
Responses :
200 : “success” : true
422 : “success” : false , errors: validation errors
400 : “success” : false , error: could not insert data
{
"issuer_id" : 123,
"title": "",
"first_name":"Gary",
"middle_name": "",
"last_name": "Miller",
"suffix": "",
"email": "roy@gmail.com",
"address1": "123 Main Street",
"address2": "",
"city": "New York",
"state": "NY",
"zip": "10022",
"country": "USA",
"mobile": "8135551212",
"dob" : "2001-01-01",
"tin": "123456789",
"gender" : "",
"national_id_name" : "sin",
"national_id" : "123456789",
"driver_license" : "",
"dl_expiry_date" : "",
"dl_issuing_state": "",
"dl_issuing_country" : "",
"passport_number" : "",
"passport_expiry_date" : "",
"passport_issuing_state" : "",
"passport_issuing_country" : "",
"accredited" : "",
"accredited_method" : "",
"annual_income" : "",
"net_worth" : "",
"tax_jurisdiction_country" : "",
"backup_withholding_exemption" : "",
"perjufy_certification" : "",
"kyc_entity_id" : "",
"kyc_date" : "",
"kyc_transaction_id" : "",
"kyc_status" : "",
"compliance_verifier_id" : "",
"compliance_officer_id" : "",
"financial_advisor_first_name": "",
"financial_advisor_middle_name" : "",
"financial_advisor_last_name" : "",
"financial_advisor_phone" : "",
"financial_advisor_email" : ""
}
POST https://api.captable.sandbox.koreconx.com/api/v1/regcf/investor
{
"issuer_id" : 123,
"title": "",
"first_name":"Gary",
"middle_name": "",
"last_name": "Miller",
"suffix": "",
"email": "roy@gmail.com",
"address1": "123 Main Street",
"address2": "",
"city": "New York",
"state": "NY",
"zip": "10022",
"country": "USA",
"mobile": "8135551212",
"dob" : "2001-01-01",
"tin": "123456789",
"gender" : "",
"national_id_name" : "sin",
"national_id" : "123456789",
"driver_license" : "",
"dl_expiry_date" : "",
"dl_issuing_state": "",
"dl_issuing_country" : "",
"passport_number" : "",
"passport_expiry_date" : "",
"passport_issuing_state" : "",
"passport_issuing_country" : "",
"accredited" : "",
"accredited_method" : "",
"annual_income" : "",
"net_worth" : "",
"tax_jurisdiction_country" : "",
"backup_withholding_exemption" : "",
"perjufy_certification" : "",
"kyc_entity_id" : "",
"kyc_date" : "",
"kyc_transaction_id" : "",
"kyc_status" : "",
"compliance_verifier_id" : "",
"compliance_officer_id" : "",
"financial_advisor_first_name": "",
"financial_advisor_middle_name" : "",
"financial_advisor_last_name" : "",
"financial_advisor_phone" : "",
"financial_advisor_email" : ""
}
{
"success": false,
"error": "You have an investor with this email"
}
Request Body:
content-type: Application/json
Schema Definition :
“investment_id”: string| required| ex:”3564”|must be unique,
“investor_email”: string | required| ex:”garykg@gmail.com”,
“issuer_id”: integer | required | ex.”889876”| pre-registered and ID provided to Captable API Client,
“regulation” : string | required| ex: “RegCF
“hold_period” : number | required | ex: 12 | number of months
“amount_invested”: string | required |ex: “1000.00”| must be USD with two decimal point,
“investment_type”: string | required | ex: “Equity” | must be Debt, Equity, Warrants, Safe, CrowdSafe,or Promissory
“equity_type”: string | required | ex:”Common”| Common , Preferred, Class A, Units, etc ,
“investment_description”: string | optional | ex. “Optional description”
“number_of_shares”: integer | required |ex. 200,
“share_price”: string | required |ex.”5.00”| must be USD with two decimal point,
“investment_date”: string| required| ex.”2020-10-21”|must be in YYYY-MM-DD format ,
“investing_as”: string | required | ex. “Company” | Must be one of: Individual, Company, Trust,
“voting_rights”: string | required | ex. “Yes”| only “Yes” or “No”,
“referral”: string | optional| ex. “LinkedIn” | Choose from LinkedIn, Facebook, Twitter, Instagram, News Release, Television, Friend, Our Company, Other,
“funding_method”: string | required | ex. “ACH-pull”| must be ACH-pull, ACH-push, CC, Wire, Mail-in-Cheque, or Crypto,
“bank_routing_number”: string | optional | ex.”075000051” ,
“bank_name”: string | optional | ex. “BMO Bank”,
“bank_account_number”: integer | optional | ex.7890 | last four digits of bank account,
“cc_type”: string | optional | ex. “Visa”,
“cc_number”: string | optional | ex. 1253 | last four digits,
“crypto_name”: string | optional | ex. “BTC”| BTC, LTC, ETH, BCH, etc ,
“company_legal_name”: string | optional (required if invested as Company/Trust)| ex. “ACME” ,
“company_legal_extension “: string | optional (required if invested as Company/Trust)| ex. “LLC”| Choose from Corp, Inc, LLC, LLP, etc.,
“organization_type”: string | optional | ex. “Private Company”| choose from Non-Profit, Private Company, Public Company, Foundation, Registered Charity, Condominium Board, Credit Union, Crown Corporation, Strata Board,
“company_address1”: string | optional (required if invested as Company/Trust)| ex.”10 Crescent Place”| Street Address,
“company_address2”: string |optional | ex.231| Apt, suite number”,
“company_city”: string |optional (required if invested as Company/Trust)| ex. “New York”,
“company_state”: string |optional (required if invested as Company/Trust)| ex. “NY”| must be 2/3 letter code,
“company_zip”: string | optional (required if invested as Company/Trust)| ex.”11006”,
“company_country”: string | optional (required if invested as Company/Trust)| ex. “US”| must be 2/3 letter code,
“company_phone”: string | optional (required if invested as Company/Trust)| ex.”2125551212”,
“company_tax_id_type”: string | optional (required if invested as Company/Trust)| ex. “TIN”| TIN, ITIN, EIN in the US, or other types of tax ids in other countries,
“company_tax_id”: string | optional (required if invested as Company/Trust)| ex.”22098787654”,
“company_formation_date”: string | optional | ex.”2012-10-23”| must be in YYYY-MM-DD,
“company_formation_state”: string |optional | ex. “NY”| must be 2/3 letter state or province code,
“ira_designation”: string |required| ex. “Yes”| Must be “Yes”/”No”/”N/A”,
“ira_contribution_year”: string |optional | ex. “2020”,
“ira_account_name”: string | optional (required if ira_designation is “Yes”)| ex.”some name”,
“ira_account_number”: integer | optional (required if ira_designation is “Yes”)| ex. 123
“ira_company_name” : string | optional (required if ira_designation is “Yes”)| ex. Abc Company
“ira_company_address” : string | optional (required if ira_designation is “Yes”)| ex. 123 King Street
“ira_ein” : string | optional (required if ira_designation is “Yes”)| ex. 123456789
“ira_company_email” : string | optional | ex. abc@abc.com
“ira_company_phone” : string | optional | ex. 6477458932
Responses :
200 : “success” : true , “investment_id” : “some_id”
422 : “success” : false , errors: validation errors
400 : “success” : false , error: could not insert data
{
"investment_id" : "3246",
"investor_email" : "garykg@gmail.com",
"issuer_id" : "123",
"amount_invested" : "1000.00",
"investment_type": "Equity",
"regulation" : "RegCF",
"hold_period": 15,
"equity_type" : "Common",
"investment_description" : "",
"number_of_shares" : 200,
"share_price" : "5.00",
"investment_date" : "2020-10-21",
"investing_as" : "Company",
"voting_rights" : "yes",
"referral" : "",
"funding_method" : "ACH-pull",
"bank_routing_number": "",
"bank_name" : "",
"bank_account_number" : "",
"cc_type" : "",
"cc_number" : "",
"crypto_name" : "",
"company_legal_name" : "ACME",
"company_legal_extension" : "LLC",
"organization_type" : "Private Company",
"company_address1" : "10 Crescent Place",
"company_address2" : "",
"company_city" : "New York",
"company_state": "NY",
"company_zip" : "11006",
"company_country" : "US",
"company_phone" : "2125551212",
"company_tax_id_type" : "",
"company_tax_id" : "22098787654",
"company_formation_date" : "2012-10-23",
"company_formation_state" : "NY",
"ira_designation" : "Yes",
"ira_company_name" : "Company ABC",
"ira_company_address" : "125, King Street",
"ira_ein": "123456789",
"ira_account_name" : "some_name",
"ira_account_number" : "123456",
"ira_company_email" : "abc@abc.com",
"ira_company_phone": "6477458923"
}
POST https://api.captable.sandbox.koreconx.com/api/v1/regcf/investment
{
"investment_id" : "3246",
"investor_email" : "garykg@gmail.com",
"issuer_id" : "123",
"amount_invested" : "1000.00",
"investment_type": "Equity",
"regulation" : "RegCF",
"hold_period": 15,
"equity_type" : "Common",
"investment_description" : "",
"number_of_shares" : 200,
"share_price" : "5.00",
"investment_date" : "2020-10-21",
"investing_as" : "Company",
"voting_rights" : "yes",
"referral" : "",
"funding_method" : "ACH-pull",
"bank_routing_number": "",
"bank_name" : "",
"bank_account_number" : "",
"cc_type" : "",
"cc_number" : "",
"crypto_name" : "",
"company_legal_name" : "ACME",
"company_legal_extension" : "LLC",
"organization_type" : "Private Company",
"company_address1" : "10 Crescent Place",
"company_address2" : "",
"company_city" : "New York",
"company_state": "NY",
"company_zip" : "11006",
"company_country" : "US",
"company_phone" : "2125551212",
"company_tax_id_type" : "",
"company_tax_id" : "22098787654",
"company_formation_date" : "2012-10-23",
"company_formation_state" : "NY",
"ira_designation" : "Yes",
"ira_company_name" : "Company ABC",
"ira_company_address" : "125, King Street",
"ira_ein": "123456789",
"ira_account_name" : "some_name",
"ira_account_number" : "123456",
"ira_company_email" : "abc@abc.com",
"ira_company_phone": "6477458923"
}
{
"success": true,
"koreconx_investment_id": 185
}
Request Body:
content-type: Application/json
Schema Definition :
“email” : string | required | ex. ‘john@doe.com’ | email address fo the share holder
“issuer_id”: integer | required | ex. 10000 | provided by Kore
Responses :
200 : “success” : true
422 : “success” : false , errors: validation errors
400 : “success” : false , error: could not insert data
{
"email" : "snehashis@koreconx.com",
"issuer_id" : "12679"
}
POST https://preprod.koreconx.com/api/captable/investments
{
"email" : "snehashis@koreconx.com",
"issuer_id" : "12679"
}
{
"holdings": [
{
"equity_id": "23428",
"name": "Sneashis Roy",
"date_of_transaction": "2021-02-11 00:00:00",
"holding_type": "shares",
"quantity": "500",
"price": "1.0000000000",
"total_investment": "500.00",
"payment_type": "ACH",
"regulation": null,
"share_holders_right": "Voting",
"invested_as": "an Individual",
"hold_period": null,
"company_legal_name": ""
},
{
"equity_id": "23861",
"name": "Sneashis Roy",
"date_of_transaction": "2023-01-12 00:00:00",
"holding_type": "shares",
"quantity": "1000",
"price": "1.0000000000",
"total_investment": "1000.00",
"payment_type": null,
"regulation": null,
"share_holders_right": "Voting",
"invested_as": "an Individual",
"hold_period": null,
"company_legal_name": ""
},
{
"equity_id": "23862",
"name": "Sneashis Roy",
"date_of_transaction": "2023-01-12 00:00:00",
"holding_type": "shares",
"quantity": "1000",
"price": "1.0000000000",
"total_investment": "1000.00",
"payment_type": null,
"regulation": null,
"share_holders_right": "Voting",
"invested_as": "an Individual",
"hold_period": null,
"company_legal_name": ""
}
]
}
Request Body:
content-type: Application/json
Schema Definition :
“email” : string | required | ex. ‘john@doe.com’ | email address fo the share holder
“issuer_id”: integer | required | ex. 10000 | provided by Kore
Responses :
200 : “success” : true
422 : “success” : false , errors: validation errors
400 : “success” : false , error: could not insert data
{
"email" : "snehashis@koreconx.com",
"issuer_id" : "12679"
}
POST https://preprod.koreconx.com/api/captable/transfer-list
{
"email" : "snehashis@koreconx.com",
"issuer_id" : "12679"
}
{
"message": "Transfers fetched successfully.",
"data": [
{
"id": 1236608,
"created_at": "Wed, Oct 16, 2024 4:01 PM",
"total": 10,
"ip_address": "142.113.197.204",
"status": "Pending Review",
"address": {
"address_line_1": null,
"address_line_2": null,
"region": [],
"country": [],
"city": null
},
"dob": null,
"first_name": null,
"last_name": null,
"middle_name": null,
"relationship": "",
"email": null,
"mobile_number": null,
"holding_type": "shares",
"company": {
"legal_entity": "INC",
"company_name": "ABC",
"country": "USA",
"state": "NY",
"city": "NY",
"address_1": "123 Main Street",
"address_2": null,
"postal": "1000007",
"ceo_first_name": "John",
"ceo_middle_name": null,
"ceo_last_name": "Doe",
"ceo_dob": "2001-01-01",
"ceo_email": "John@doe.com",
"ceo_country": "USA",
"ceo_city": "NY",
"ceo_state": "NY",
"ceo_address_1": "123 Second Street",
"ceo_address_2": null,
"ceo_postal": "100020030"
}
},
{
"id": 1236607,
"created_at": "Wed, Oct 16, 2024 3:59 PM",
"total": 10,
"ip_address": "142.113.197.204",
"status": "Pending Review",
"address": {
"address_line_1": null,
"address_line_2": null,
"region": [],
"country": [],
"city": null
},
"dob": null,
"first_name": null,
"last_name": null,
"middle_name": null,
"relationship": "",
"email": null,
"mobile_number": null,
"holding_type": "shares",
"company": {
"legal_entity": "INC",
"company_name": "ABC",
"country": "USA",
"state": "NY",
"city": "NY",
"address_1": "123 Main Street",
"address_2": null,
"postal": "1000007",
"ceo_first_name": "John",
"ceo_middle_name": null,
"ceo_last_name": "Doe",
"ceo_dob": "2001-01-01",
"ceo_email": "John@doe.com",
"ceo_country": "USA",
"ceo_city": "NY",
"ceo_state": "NY",
"ceo_address_1": "123 Second Street",
"ceo_address_2": null,
"ceo_postal": "100020030"
}
},
{
"id": 1236606,
"created_at": "Tue, Oct 15, 2024 10:54 PM",
"total": 10,
"ip_address": "142.113.197.204",
"status": "Pending Review",
"address": {
"address_line_1": null,
"address_line_2": null,
"region": [],
"country": [],
"city": null
},
"dob": null,
"first_name": null,
"last_name": null,
"middle_name": null,
"relationship": "",
"email": null,
"mobile_number": null,
"holding_type": "shares",
"company": {
"legal_entity": "INC",
"company_name": "ABC",
"country": "USA",
"state": "NY",
"city": "NY",
"address_1": "123 Main Street",
"address_2": null,
"postal": "1000007",
"ceo_first_name": "John",
"ceo_middle_name": null,
"ceo_last_name": "Doe",
"ceo_dob": "2001-01-01",
"ceo_email": "John@doe.com",
"ceo_country": "USA",
"ceo_city": "NY",
"ceo_state": "NY",
"ceo_address_1": "123 Second Street",
"ceo_address_2": null,
"ceo_postal": "100020030"
}
},
{
"id": 1236605,
"created_at": "Tue, Oct 15, 2024 10:53 PM",
"total": 10,
"ip_address": "142.113.197.204",
"status": "Pending Review",
"address": {
"address_line_1": null,
"address_line_2": null,
"region": [],
"country": [],
"city": null
},
"dob": null,
"first_name": null,
"last_name": null,
"middle_name": null,
"relationship": "",
"email": null,
"mobile_number": null,
"holding_type": "shares",
"company": null
},
{
"id": 1236604,
"created_at": "Tue, Oct 15, 2024 10:49 PM",
"total": 10,
"ip_address": "142.113.197.204",
"status": "Pending Review",
"address": {
"address_line_1": null,
"address_line_2": null,
"region": [],
"country": [],
"city": null
},
"dob": null,
"first_name": null,
"last_name": null,
"middle_name": null,
"relationship": "",
"email": null,
"mobile_number": null,
"holding_type": "shares",
"company": null
},
{
"id": 1236603,
"created_at": "Tue, Oct 15, 2024 10:47 PM",
"total": 10,
"ip_address": "142.113.197.204",
"status": "Pending Review",
"address": {
"address_line_1": null,
"address_line_2": null,
"region": [],
"country": [],
"city": null
},
"dob": null,
"first_name": null,
"last_name": null,
"middle_name": null,
"relationship": "",
"email": null,
"mobile_number": null,
"holding_type": "shares",
"company": null
},
{
"id": 1236602,
"created_at": "Tue, Oct 15, 2024 10:46 PM",
"total": 10,
"ip_address": "142.113.197.204",
"status": "Pending Review",
"address": {
"address_line_1": null,
"address_line_2": null,
"region": [],
"country": [],
"city": null
},
"dob": null,
"first_name": null,
"last_name": null,
"middle_name": null,
"relationship": "",
"email": null,
"mobile_number": null,
"holding_type": "shares",
"company": null
},
{
"id": 1236601,
"created_at": "Tue, Oct 15, 2024 10:40 PM",
"total": 10,
"ip_address": "142.113.197.204",
"status": "Pending Review",
"address": {
"address_line_1": null,
"address_line_2": null,
"region": [],
"country": [],
"city": null
},
"dob": null,
"first_name": null,
"last_name": null,
"middle_name": null,
"relationship": "",
"email": null,
"mobile_number": null,
"holding_type": "shares",
"company": null
},
{
"id": 1236598,
"created_at": "Tue, Oct 15, 2024 8:21 PM",
"total": 10,
"ip_address": "142.113.197.204",
"status": "Pending Review",
"address": {
"address_line_1": "123 Main Street",
"address_line_2": "23",
"region": {
"id": "NY",
"name": "NY"
},
"country": {
"id": "USA",
"name": "United States"
},
"city": "NY"
},
"dob": "2001-01-01",
"first_name": "John",
"last_name": "Doe",
"middle_name": null,
"relationship": "son",
"email": "test+1@test.com",
"mobile_number": "6477458976",
"holding_type": "shares",
"company": null
},
{
"id": 1236597,
"created_at": "Tue, Oct 15, 2024 8:13 PM",
"total": 10,
"ip_address": "142.113.197.204",
"status": "Pending Review",
"address": {
"address_line_1": "123 Main Street",
"address_line_2": "23",
"region": {
"id": "NY",
"name": "NY"
},
"country": {
"id": "USA",
"name": "United States"
},
"city": "NY"
},
"dob": "2001-01-01",
"first_name": "John",
"last_name": "Doe",
"middle_name": null,
"relationship": "son",
"email": "test+1@test.com",
"mobile_number": "6477458976",
"holding_type": "shares",
"company": null
},
{
"id": 1236596,
"created_at": "Tue, Oct 15, 2024 7:56 PM",
"total": 10,
"ip_address": "142.113.197.204",
"status": "Pending Review",
"address": {
"address_line_1": "123 Main Street",
"address_line_2": "23",
"region": {
"id": "NY",
"name": "NY"
},
"country": {
"id": "USA",
"name": "United States"
},
"city": "NY"
},
"dob": "2001-01-01",
"first_name": "John",
"last_name": "Doe",
"middle_name": null,
"relationship": "son",
"email": "test+1@test.com",
"mobile_number": "6477458976",
"holding_type": "shares",
"company": null
},
{
"id": 1236592,
"created_at": "Wed, Oct 9, 2024 7:21 PM",
"total": 10,
"ip_address": "142.113.197.204",
"status": "Pending Review",
"address": {
"address_line_1": "123 Main Street",
"address_line_2": "23",
"region": {
"id": "NY",
"name": "NY"
},
"country": {
"id": "USA",
"name": "United States"
},
"city": "NY"
},
"dob": "2001-01-01",
"first_name": "John",
"last_name": "Doe",
"middle_name": null,
"relationship": "son",
"email": "test+1@test.com",
"mobile_number": "6477458976",
"holding_type": "shares",
"company": null
},
{
"id": 1236590,
"created_at": "Wed, Oct 2, 2024 8:47 PM",
"total": 10,
"ip_address": "142.113.197.204",
"status": "Pending Review",
"address": {
"address_line_1": "123 Main Street",
"address_line_2": "23",
"region": {
"id": "NY",
"name": "NY"
},
"country": {
"id": "USA",
"name": "United States"
},
"city": "NY"
},
"dob": "2001-01-01",
"first_name": "John",
"last_name": "Doe",
"middle_name": null,
"relationship": "son",
"email": "test+1@test.com",
"mobile_number": "6477458976",
"holding_type": "shares",
"company": null
},
{
"id": 1236589,
"created_at": "Wed, Oct 2, 2024 8:30 PM",
"total": 10,
"ip_address": "142.113.197.204",
"status": "Pending Review",
"address": {
"address_line_1": "123 Main Street",
"address_line_2": "23",
"region": {
"id": "NY",
"name": "NY"
},
"country": {
"id": "USA",
"name": "United States"
},
"city": "NY"
},
"dob": "2001-01-01",
"first_name": "John",
"last_name": "Doe",
"middle_name": null,
"relationship": "son",
"email": "test+1@test.com",
"mobile_number": "6477458976",
"holding_type": "shares",
"company": null
},
{
"id": 1236588,
"created_at": "Wed, Oct 2, 2024 8:20 PM",
"total": 10,
"ip_address": "142.113.197.204",
"status": "Pending Review",
"address": {
"address_line_1": "123 Main Street",
"address_line_2": "23",
"region": {
"id": "NY",
"name": "NY"
},
"country": {
"id": "USA",
"name": "United States"
},
"city": "NY"
},
"dob": "2001-01-01",
"first_name": "John",
"last_name": "Doe",
"middle_name": null,
"relationship": "son",
"email": "test+1@test.com",
"mobile_number": "6477458976",
"holding_type": "shares",
"company": null
},
{
"id": 1236587,
"created_at": "Wed, Oct 2, 2024 8:11 PM",
"total": 10,
"ip_address": "142.113.197.204",
"status": "Pending Review",
"address": {
"address_line_1": "123 Main Street",
"address_line_2": "23",
"region": {
"id": "NY",
"name": "NY"
},
"country": {
"id": "USA",
"name": "United States"
},
"city": "NY"
},
"dob": "2001-01-01",
"first_name": "John",
"last_name": "Doe",
"middle_name": null,
"relationship": "son",
"email": "test+1@test.com",
"mobile_number": "6477458976",
"holding_type": "shares",
"company": null
},
{
"id": 1236583,
"created_at": "Thu, Apr 6, 2023 2:20 PM",
"total": 10,
"ip_address": "142.114.126.69",
"status": "Pending Review",
"address": {
"address_line_1": null,
"address_line_2": null,
"region": {
"id": "ON",
"name": "Ontario"
},
"country": {
"id": "CA",
"name": "Canada"
},
"city": "Toronto"
},
"dob": null,
"first_name": "Snehashis",
"last_name": "Roy",
"middle_name": null,
"relationship": "Wife",
"email": "sutapasen.bd@gmail.com",
"mobile_number": "+1 647-745-8430",
"holding_type": "shares",
"company": null
},
{
"id": 11,
"created_at": "Thu, Jan 20, 2022 9:23 PM",
"total": 10,
"ip_address": "76.64.121.233",
"status": "Pending Review",
"address": {
"address_line_1": null,
"address_line_2": null,
"region": {
"id": "ON",
"name": "Ontario"
},
"country": {
"id": "CA",
"name": "Canada"
},
"city": "Toronto"
},
"dob": null,
"first_name": "Snehashis",
"last_name": "Roy",
"middle_name": null,
"relationship": "Wife",
"email": "sutapasen.bd@gmail.com",
"mobile_number": "+1 647-745-8430",
"holding_type": "shares",
"company": null
}
]
}
Request Body:
content-type: Application/json
Schema Definition :
“initiator_email” : string| required| ex:”jon@test.com”| a valid email address of the Share Holder,
“issuer_id” : integer | required | ex: 123 | issuer_id provided by Kore,
“equity_id” : integer | required | ex: 23861 | unique id of the holding received from ‘Get Holdings by Investor’ call,
“transferee_type”: string | required | ex: “trust” | must be one of the following: individual, trust, company
“relationship” : string | optional (only required when transferee type is individual :| ex: “son” | relationship of the transferee to the holder .
“amount” : string | required | ex. “10” | number of holding to be transferred,
“street_line_1” : string | optional (only required when transferee type is individual) | ex: “123 Main Street” | street address of the individual transferee,
“street_line_2” : string | optional | ex. “23” | Apartment number, etc,
“region” : string | optional (only required when transferee type is individual ) | ex: “NY” | State or Province of the individual transferee
“city” : string | optional (only required when transferee type is individual )| ex: “NY” | City of the individual transferee,
“country” : string | optional (only required when transferee type is individual )| ex: “US” | Iso code of the country of the individual transferee”USA”,
“first_name” : string | optional (only required when transferee type is individual ) | ex: “John” | First name of the individual transferee,
“last_name” : string | optional (only required when transferee type is individual ) | ex: “Doe” | Last name of the individual transferee,
“dob” : string | optional (only required when transferee type is individual ) | ex: “2001-01-01” | Date of birth of the individual transferee ,
“phone_number” : string | optional (only required when transferee type is individual ) | ex: “6477458976” | Phone Number of the individual transferee ,
“email” : string | optional (only required when transferee type is individual ) | ex: “test+1@test.com” | Email Address of the individual transferee ,
“company” : These fileds are related to the transferee . Fields are optional ( only required if the transferee type is trust or company)
“legal_entity” : string | optional | ex. “INC” ,
“company_name” : string | optional | ex. “ABC”,
“country” : string | optional | ex. “US” | iso code of the country
“state” : string | optional | ex. “NY”,
“city” : string | optional | ex. “NY”,
“address_1” : string | optional | ex. “123 Main Street”,
“address_2” : string | optional | ex. “21” | apt / suite number , etc,
“postal” : string | optional | ex. “1000007”,
“ceo_first_name” : string | optional | ex. “John” | first name of the ceo of the company,
“ceo_middle_name” : string | optional | ex. “M.” | Middle name of the ceo of the company,,
“ceo_last_name” : string | optional | ex. “Doe” | Last name of the ceo of the company,
“ceo_dob” : string | optional | ex. “2001-01-01” | Date of birth of the ceo of the company,
“ceo_email” : string | optional | ex. “John@doe.com” | email address of the ceo of the company,
“ceo_country” : string | optional | ex. “US” | iso code of the country of the ceo,
“ceo_city” : string | optional | ex. “NY” | city of the ceo,
“ceo_state” : string | optional | ex. “NY” | state/province of the ceo,
“ceo_address_1” : string | optional | ex. “123 Second Street” | street address of the ceo,
“ceo_address_2” : string | optional | ex. “12” | Apt/Suite of the ceo,
“ceo_postal” : string | optional | ex. “100020030” | postal code of the ceo
Responses :
200 : “success” : true
422 : “success” : false , errors: validation errors
400 : “success” : false , error: could not insert data
{
"initiator_email": "snehashis@koreconx.com",
"issuer_id" : 12679,
"equity_id" : 23861,
"transferee_type": "trust",
"relationship" : "son",
"amount" : "10",
"street_line_1" : "123 Main Street",
"street_line_2" : "23",
"region" : "NY",
"city" : "NY",
"country" : "USA",
"first_name" : "John",
"last_name" : "Doe",
"dob" : "2001-01-01",
"phone_number" : "6477458976",
"email" : "test+1@test.com",
"company" : {
"legal_entity" : "INC",
"company_name" : "ABC",
"country" : "USA",
"state" : "NY",
"city" : "NY",
"address_1" : "123 Main Street",
"address_2" : "",
"postal" : "1000007",
"ceo_first_name" : "John",
"ceo_middle_name" : "",
"ceo_last_name" : "Doe",
"ceo_dob" : "2001-01-01",
"ceo_email" : "John@doe.com",
"ceo_country" : "USA",
"ceo_city" : "NY",
"ceo_state" : "NY",
"ceo_address_1" : "123 Second Street",
"ceo_address_2" : "",
"ceo_postal" : "100020030"}
}
POST https://preprod.koreconx.com/api/captable/transfer
{
"initiator_email": "snehashis@koreconx.com",
"issuer_id" : 12679,
"equity_id" : 23861,
"transferee_type": "trust",
"relationship" : "son",
"amount" : "10",
"street_line_1" : "123 Main Street",
"street_line_2" : "23",
"region" : "NY",
"city" : "NY",
"country" : "USA",
"first_name" : "John",
"last_name" : "Doe",
"dob" : "2001-01-01",
"phone_number" : "6477458976",
"email" : "test+1@test.com",
"company" : {
"legal_entity" : "INC",
"company_name" : "ABC",
"country" : "USA",
"state" : "NY",
"city" : "NY",
"address_1" : "123 Main Street",
"address_2" : "",
"postal" : "1000007",
"ceo_first_name" : "John",
"ceo_middle_name" : "",
"ceo_last_name" : "Doe",
"ceo_dob" : "2001-01-01",
"ceo_email" : "John@doe.com",
"ceo_country" : "USA",
"ceo_city" : "NY",
"ceo_state" : "NY",
"ceo_address_1" : "123 Second Street",
"ceo_address_2" : "",
"ceo_postal" : "100020030"}
}
{
"message": "Transfers created successfully.",
"data": {
"equity_transfer_id": 1236610
}
}