Glossary
Terms as the API uses them. Where Wefunder's internal name differs, the API name wins.
Platform
Offering
What a company is raising in: one round, with its security, terms, minimum, target, and
status. External id prefix ofr_. An offering belongs to exactly one company. Wefunder's
own site calls this a round or a campaign; the API always says offering.
Company
The issuer behind an offering, with its public page, pitch, updates, and Q&A. Prefix co_.
Syndicate
An investor group led by one or more managers, with members, deals, and a portfolio.
Prefix syn_. A syndicate member has prefix mem_.
Deal
An offering as seen from inside a syndicate: the syndicate's allocation, its investors, and its close and finalize steps.
Investment
A single investor's commitment to an offering. Prefix inv_. The API exposes one
investment record shape everywhere: status, amounts in cents, shares, and the
investor when the token holds read:investors:pii.
Reservation (Testing the Waters)
A non-binding indication of interest in a round that is not yet allowed to take money.
testing_the_waters: true on the offering, status: reserved on the record. User-facing
copy must say reserve and reservation here, never invest or investment.
Portfolio
An investor's holdings across offerings: a summary plus per-offering positions.
Campaign
In GET /campaigns and the attribution endpoints, a founder's fundraising campaign for
attribution purposes. Elsewhere prefer offering.
Access
Application
Your registered app in the developer portal, with a test client and a live client.
Prefix app_.
Organization
The tenant that owns applications and their credentials. Developers belong to an
organization with a role. Prefix org_.
Scope
An OAuth permission, such as read:profile or write:syndicates. Tokens carry the
scopes the user granted. See Scopes.
Installation
The link between your application and one company or syndicate that has chosen to use
it. Prefix inst_. Installing on your own nouns is immediate; installing on someone
else's requires app review. See Installations.
Intent
A proposed write that a human approves before it runs. Agents and integrations propose;
a person with authority approves or rejects. Prefix int_. See Intents.
Activity
The audit trail of what tokens did on a resource. Prefix evt_ on platform events.
See Activity.
Connected app
An application a user has authorized. Users list and revoke them through the API and on their Wefunder settings page.
Mechanics
Cursor
An opaque token for paging a list and, on GET /investments, for resuming a sync. Pass
back meta.next_cursor unchanged. Never parse or construct one.
Idempotency key
A value sent in the Idempotency-Key header on a write so a retry returns the original
result instead of repeating the action. Scoped to your application and the user, 24 hours.
Supported on POST /intents and the other writes that document it.
Request id
The request_id in every error body, prefix req_. Quote it when you write to support.
Webhook endpoint
A URL you register to receive events, with its signing secret. Prefix whe_. A single
attempt to deliver an event is a delivery, prefix whd_.
Wefunder-Version
The header that names the dated API version a request is written against. See Versioning.
Statuses
Investment record
reserved (a reservation), active (committed, not yet executed), executed
(complete), canceled, converted (rolled into another investment; see converted_to).
Offering
upcoming, open, closed, canceled.
Portfolio position
active, failed, exited.
Regulatory terms you will see in payloads
Reg CF
SEC Regulation Crowdfunding. Lets a company raise up to $5M in a year from anyone
through a funding portal like Wefunder. exemption: reg_cf.
Reg D
SEC Regulation D, private placements to accredited investors. exemption: reg_d. Some
Reg D offerings are visible only to accredited users; a read:public key never sees them.
Accredited investor
An investor meeting the SEC's income, net worth, or credential tests. Offerings restricted to accredited investors appear to a user token only when that user qualifies.
SAFE, convertible note, equity, revenue share, debt
The intended_security.type values an offering can carry. Money and price fields on all
of them are decimal strings.
External id prefixes
| Prefix | Resource |
|---|---|
ofr_ | Offering |
co_ | Company |
inv_ | Investment |
syn_ | Syndicate |
mem_ | Syndicate member |
app_ | Application |
org_ | Organization |
inst_ | Installation |
int_ | Intent |
evt_ | Platform event |
whe_ | Webhook endpoint |
whd_ | Webhook delivery |
cmt_ | Comment (Q&A, updates) |
file_ | File |
ref_ | Referral code |
req_ | Request id |