Issuer API
API endpoint displaying Investments.
Api Key permission with required prefix "Api-Key"
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
unverified- Unverifiedprocessing- Processingpassed- Passedfailed- Failed
Multiple values may be separated by commas.
Multiple values may be separated by commas.
person- Personcompany- Companytrust- Trusttrust_ira- Trust Ira
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Which field to use when ordering the results.
A page number within the paginated result set.
Number of results to return per page.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
card- Cardwire- Wireira- IRAother- ACHcrypto- Crypto
Multiple values may be separated by commas.
A search term.
Multiple values may be separated by commas.
started- Startednot_received- Not Receivedpayment_failed- Payment Failedreceived- Receivedcancelled- Cancelledrefunded- Refundedinvested- Investedapproved- Approvednot_approved- Not Approvedaccepted- Acceptedaccepted_escrow_closed- Accepted Escrow Closed
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
123http://api.example.org/accounts/?page=4http://api.example.org/accounts/?page=2API endpoint displaying Investments.
Api Key permission with required prefix "Api-Key"
A unique integer value identifying this investment.
^-?\d{0,8}(?:\.\d{0,6})?$^-?\d{0,12}(?:\.\d{0,2})?$^-?\d{0,12}(?:\.\d{0,2})?$^-?\d{0,12}(?:\.\d{0,2})?$started- Startednot_received- Not Receivedpayment_failed- Payment Failedreceived- Receivedcancelled- Cancelledrefunded- Refundedinvested- Investedapproved- Approvednot_approved- Not Approvedaccepted- Acceptedaccepted_escrow_closed- Accepted Escrow Closed
Payment processor payment intent ID.
Return the investor individual name.
Payment method cleaned up.
Return True if the investor has signed.
Whether the investor was accredited at the time of investment.
Net worth of the investor at the time of investment
^-?\d{0,12}(?:\.\d{0,2})?$Annual Income of the investor at the time of investment
^-?\d{0,12}(?:\.\d{0,2})?$US Person status at the time of investment.
Whether the investor was exempt from backup withholding at the time of investment
We are required to collect this information by regulation CF.
^-?\d{0,12}(?:\.\d{0,2})?$Investor's browser type at the time of investment.
Are you an "accredited" investor (meaning do you earn over $200,000 per year, have a net worth of $1m or more, or are an institutional investor)?
net_worth- 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.income- I am an individual with 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.license- I am an individual with certifications or credentials issued by an accredited educational institution including, but not limited to, order holders in good standing of the FINRA Series 7, Series 65 and Series 82 licenses.fund_assets- I am investing on behalf of a fund that has over $5,000,000 in assets.fund_owners- I am investing on behalf of a fund and all owners are individually accredited investors.
net_worth- 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.income- I am an individual with 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.license- I am an individual with certifications or credentials issued by an accredited educational institution including, but not limited to, order holders in good standing of the FINRA Series 7, Series 65 and Series 82 licenses.fund_assets- I am investing on behalf of a fund that has over $5,000,000 in assets.fund_owners- I am investing on behalf of a fund and all owners are individually accredited investors.
missing_investor_entity- Missing Investor Entityinvalid_individual_tax_id_number- Invalid Individual Tax Id Numberinvalid_entity_tax_id_number- Invalid Entity Tax Id Numbercountry_not_allowed- Country Not Allowedmissing_investor_signature- Missing Investor Signaturepending_ai- Pending Aimissing_individual_investor_entity- Missing Individual Investor Entitywatchlist_processing- Watchlist Processingwatchlist_hits- Watchlist Hitskyc_country_not_managed_by_trulioo- Kyc Country Not Managed By Truliookyc_unverified- Kyc Unverifiedkyc_failed- Kyc Failedkyc_processing- Kyc Processingkyb_country_not_managed_by_trulioo- Kyb Country Not Managed By Truliookyb_unverified- Kyb Unverifiedkyb_processing- Kyb Processingkyb_failed- Kyb Faileddisallowed_us_state- Disallowed Us Stateupload_id_required- Upload Id Requiredupload_kyb_document_required- Upload Kyb Document Requiredover_invested_investment- Over Invested Investmentover_invested_offering- Over Invested Offeringira_payment_processing- Ira Payment Processingcustodial_account_not_approved- Custodial Account Not Approvedmissing_offering_document_upload- Missing Offering Document Uploadoffering_document_upload_to_review- Offering Document Upload To Reviewbeneficial_owners_missing- Beneficial Owners Missingbeneficial_owners_watchlist_processing- Beneficial Owners Watchlist Processingbeneficial_owners_watchlist_hits- Beneficial Owners Watchlist Hitsbeneficial_owners_upload_id_required- Beneficial Owners Upload Id Required
The number of bonus shares for the investment
All clearing failure statuses as a comma-separated list
^-?\d{0,12}(?:\.\d{0,2})?$The coupon code for extra bonus shares
The Percentage applied to compute the bonus shares
^-?\d{0,12}(?:\.\d{0,2})?$The quantity non-percent part applied to compute the bonus shares
^-?\d{0,12}(?:\.\d{0,2})?$The number of qualified shares if any
The price for the qualified shares if any
^-?\d{0,8}(?:\.\d{0,6})?$Return the investment statuses.
Example response: { "success": true, "message": "", "data": { "statuses": [ { "value": "received", "label": "Received", } ] } }
Api Key permission with required prefix "Api-Key"
Return an investment summary for the provided filters.
Token-based authentication using Firebase ID Token
List all the values of the provided fields.
Query Parameters: field: the comma-separated list of fields to query.
Api Key permission with required prefix "Api-Key"
Management of Investors.
Token-based authentication using Firebase ID Token
Multiple values may be separated by commas.
Which field to use when ordering the results.
A page number within the paginated result set.
Number of results to return per page.
A search term.
person- Personcompany- Companytrust- Trusttrust_ira- Trust Ira
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
123http://api.example.org/accounts/?page=4http://api.example.org/accounts/?page=2Management of Investors.
Token-based authentication using Firebase ID Token
A unique integer value identifying this investor.
List all the values of the provided fields.
Query Parameters: field: the comma-separated list of fields to query.
Token-based authentication using Firebase ID Token
Management of Offerings.
Api Key permission with required prefix "Api-Key"
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Which field to use when ordering the results.
A page number within the paginated result set.
Number of results to return per page.
A search term.
Multiple values may be separated by commas.
incomplete- Imcompletepending- Pendingopened- Openedclosed- Closedpaused- Paused
Multiple values may be separated by commas.
reg_a- Regulation Areg_d_506b- Regulation D 506(b)reg_d_506c- Regulation D 506(c)reg_s- Regulation Sreg_cf- Regulation Crowdfundingtest_the_waters- Test The Waters
Multiple values may be separated by commas.
123http://api.example.org/accounts/?page=4http://api.example.org/accounts/?page=2Management of Offerings.
Api Key permission with required prefix "Api-Key"
A unique integer value identifying this offering.
We add the serializer for issuer in regular read-only views.
reg_a- Regulation Areg_d_506b- Regulation D 506(b)reg_d_506c- Regulation D 506(c)reg_s- Regulation Sreg_cf- Regulation Crowdfundingtest_the_waters- Test The Waters
incomplete- Imcompletepending- Pendingopened- Openedclosed- Closedpaused- Paused
[Optional]
Type of securities (Class A Shares, Class B Non-Voting, etc.)
Shares- ShareUnits- Unit
Unit details (a "unit" may be 1 share and 1/2 of a warrant to purchase later shares bundled together)
The number of warrant per unit (if applicable)
The number of year from the issuer signature date to the expiration of the warrant. Business days are NOT taken into consideration. On February 29, if the delta in year is not 4 years we use the preceding non-business-day convention (February 28)
The number of month from the issuer signature date to the expiration of the warrant. Business days are NOT taken into consideration. We use the preceding non-business-day convention for 29-30-31 days when there is an ambiguity
Whether the investor is investing dollar amount or share quantity
The price per share or unit
^-?\d{0,8}(?:\.\d{0,6})?$Flat fee per investment, paid to issuance. Contact support to change.
^-?\d{0,12}(?:\.\d{0,2})?$Whether the investor is paying the Administrative Fee. If unchecked, the fee is collected before transfer to the issuer
[Optional] The number of share or unit in the offering
[Optional] The maximum currency amount that can be invested in a single investment
^-?\d{0,12}(?:\.\d{0,2})?$[Optional] The minimum currency amount that can be invested by a single investor
^-?\d{0,12}(?:\.\d{0,2})?$[Optional] The currency amount increment
^-?\d{0,12}(?:\.\d{0,2})?$The minimum investment amount for the investor to be able to make a wire transfer
^-?\d{0,12}(?:\.\d{0,2})?$Check to allow accredited investors
Check to allow non-accredited investors
^[-a-zA-Z0-9_]+$offering_circular- Offering Circularsubscription_agreement- Subscription Agreeementprivate_placement_memorandum- Private Placement Memorandumform_c- Form C
Whether to display the circular link/document
Default Number of shares displayed to make a transaction
Signature name
Select to opt-in for daily summary emails
List of daily summary email recipients
Select to opt-in for weekly summary emails
List of weekly summary email recipients
period (in days) for wire payment reminders.
Max number of emails sent for wire payment reminder.
period (in days) for investment reminders.
Max number of emails sent for investment reminder.
Text displayed for sms/email opt-in.
Default name used as sender for offering emails.
US/Pacific- Us PacificUS/Central- Us CentralUS/Eastern- Us EasternUTC- Utc
The Segment Dataset id for the calls.
Enabling automatic approval of investments will approve by the broker-dealer any investment that has no watchlist hits. This be functionally the same as manually approving the investment. By clicking "I am sure" you agree to approve any investments approved by the automated system.
Enabling automatic accepting of investments will accept any investment that meets your criteria once the trade review is completed by your broker-dealer. This will counter-sign the subscription agreement and be functionally the same as manually accepting the investment. By clicking "I am sure" you agree to honor any investments accepted by the automated system.
[Optional] Maximum amount allowed to auto-accept investment.
^-?\d{0,12}(?:\.\d{0,2})?$[Optional] Minimum amount allowed to auto-accept investment.
^-?\d{0,12}(?:\.\d{0,2})?$Whether a difference email template is used to send an 'investment started' email for investments above a investment threshold (configurable)
Minimum Amount to send a high value investment started email
^-?\d{0,12}(?:\.\d{0,2})?$Whether to enable the 'test the waters' feature or not
Default Amounts displayed for future test the water offerings.
Accent color for the offering website.
background Accent color for the offering website.
Accent color of activty elements for the offering website.
Select to opt-in for per-investment summary emails
List of per-investment summary email recipients
Select to opt-in for emails when users received the maximum number of emails for a given event
List of recipients for the max monitoring email event
Other platform investment notice (front-end field)
Other platform investment notice Text (front-end field)
Whether the investor must provide a phone number when investing
Regulatory Reg CF Minimum amount to raise before funds are collected from escrow. This is the filing Target Amount Raised.
^-?\d{0,12}(?:\.\d{0,2})?$The Offering Maximum amount raised for a Reg CF Offering.
^-?\d{0,12}(?:\.\d{0,2})?$The Offering Target amount raised for a Reg CF Offering.
^-?\d{0,12}(?:\.\d{0,2})?$The Reg CF oversubscription Amount.
^-?\d{0,12}(?:\.\d{0,2})?$The percentage of transfers to charge as reg CF fees.
^-?\d{0,10}(?:\.\d{0,4})?$Whether the Offering is archived - display only, everything else works as usual
The alignment of the logo during the investment flow
center- Centerleft- Leftright- Rightjustify- Justify
center- Centerleft- Leftright- Rightjustify- Justify
Whether to display the offering logo on the dashboard
Deadline to reach the minimum offering amount
Management of users.
Token-based authentication using Firebase ID Token
Multiple values may be separated by commas.
Which field to use when ordering the results.
A page number within the paginated result set.
Number of results to return per page.
A search term.
Multiple values may be separated by commas.
123http://api.example.org/accounts/?page=4http://api.example.org/accounts/?page=2Management of users.
Token-based authentication using Firebase ID Token
Management of User Creation.
Password Write-only attribute.
Management of users.
Token-based authentication using Firebase ID Token
A unique integer value identifying this user.
Management of User Creation.
Password Write-only attribute.
Management of users.
Token-based authentication using Firebase ID Token
A unique integer value identifying this user.
Management of User Creation.
Password Write-only attribute.
Management of User Creation.
Password Write-only attribute.
Last updated