Investments

FREE
By amilcar_fundamerica
Updated 9 months ago
-/10
Popularity Score
-
Latency
-
Success Rate

Investments API Documentation

Investments are made when an investor wants to invest in an offering and send funds for said investment. Investments are probably the single most complex object in the system. It's important to understand all the status settings and payment methods involved.

An AML check is automatically processed on every single investment. When using our escrow service, this is not charged to your account. FundAmerica customer service will do a follow-up if there are any issues with the background check and may cancel the result if there are problems. The results of this background check are available to your account if you have requested permission and been accepted for processing AML checks on your account. Please see AML and Due Diligence for more information on this process and details on the API calls.

When an investment is made, customer service will review the details before changing the status type. They may even opt to cancel the investment if there is a problem. If you want to give immediate feedback to your investors, it's important to utilize webhooks for status updates.

Note: An offering must have accept_investments set to true to create investments, otherwise you will receive a 403 error. This is done by having an escrow service application accepted.

View API Details
POST/investments
PATCH/test_mode/investments/{id}
POST/investments

Investments

Authorization:

description

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
AuthorizationBASIC
REQUIREDdescription
Required Parameters
amountSTRING
REQUIREDInvestment Amount
equity_share_countSTRING
REQUIREDNumber of Shares Bought
offering_idSTRING
REQUIREDOffering ID
payment_methodSTRING
REQUIREDPayment Method
entity[city]STRING
REQUIREDEntity City
entity[country]STRING
REQUIREDEntity Country
entity[date_of_birth]STRING
REQUIREDInvestor's Date of Birth
entity[email]STRING
REQUIREDEntity's Email (e.g. Investor's Email)
entity[name]STRING
REQUIREDEntity (Investor) Name
entity[postal_code]STRING
REQUIREDEntity Postal Code
entity[region]STRING
REQUIREDEntity Region
entity[street_address_1]STRING
REQUIREDEntity's Address
entity[tax_id_number]STRING
REQUIREDEntity's (Investor) Social Security Number
entity[phone]STRING
REQUIREDEntity Phone Number
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication