Sponsors · Become a sponsor
Making a business a sponsor: finding it, a draft saved as you go through five steps, showing you run it (a code sent to a work email at the website's domain, or a document a person reviews), submitting it for review, asking to join an existing sponsor's team, telling FundlyHub a sponsor is your business, and accepting a team or owner invite. Needs a signed-in session.
For businesses
What /sponsors/join shows beyond its own words, all of it real: the ambassador whose link brought the visitor (ref); the visitor's city (where the edge says they are, else their own city; the nearest with sponsors within 30 miles, else the one with the most) with its sponsor count and its most used sponsors' logos; and a sponsor's quote, shown only with consent once staff approved it. No city or no quote: null.
Parameters
Query Parameters
An ambassador's code, from /sponsors/join?ref=.
Responses
OK
The small map of a place
Redirects (302) to a signed Apple Maps snapshot of the street around a pin. 404 when no signing key is configured, and the page shows its pin tile instead.
Parameters
Query Parameters
The tile's side in CSS pixels.
32192"light""dark"Responses
The snapshot.
Tell me when sponsors open in my country
For a business outside the US. The person and the country; the message goes to their own email when sponsors open there, and nothing else.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Request Body
Responses
OK
What the Become a sponsor forms need
The categories with whether each may join, the Sponsor Terms version and the most unfinished drafts one person may have.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Responses
OK
My unfinished sponsors
Drafts and sponsors sent back for changes that the person started, newest first.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Responses
OK
Is this business already on FundlyHub?
Sponsors that may already be the business: the same Apple Maps place, the same website, or a close name; with whether the person is on its team, asked to join or claimed it. Apple Maps itself is searched in the browser. Drafts and sponsors under review are never shown to others.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Query Parameters
Responses
OK
Ask to join a sponsor's team
The owner or an admin decides. Needs a verified email.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Request Body
Responses
OK
It's my business — tell us
An ownership question a person at FundlyHub looks into, with proof the person runs the business (a document kept privately with the claim, never one of the sponsor's own). Needs a verified email.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Request Body
Responses
OK
The draft, as the five steps read it
Its page, locations, proof, owners, first perk and terms, and what still blocks submitting.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Responses
OK
Delete a draft
Only a draft that never went to review; only the person who started it (or staff for one staff added).
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Responses
Done
Save a step
The step the person is on; step 2's title, 25%-owners answer and statement; and any page fields (as PATCH /sponsors/{key}/manage/page). One request saves a step whole. A draft follows its name to a new address; a new legal name clears the statement.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Request Body
Responses
OK
Run the automatic checks before submitting
The state registry (California's at launch) and the sanctions lists, run while the review step is open so it can show them. They only add evidence; submitting runs them again.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Responses
OK
Show you run it: send a code to your work email
The address must be at the domain of the business's own website (website saves it first). Free email domains, and a website on another company's platform, can't prove it. 15 minutes, 5 tries.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Request Body
Responses
OK
Show you run it: enter the code
A right code records the proof (a sponsor_checks pass).
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Request Body
Responses
OK
Show you run it: upload a document
A business license, a state filing naming you, the IRS EIN letter... Kept private; a person reads it (about 2 business days). PDF, JPG, PNG or HEIC up to 7 MB, as base64; the type is read from the file.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Request Body
Responses
OK
Take back a document
Only one nobody has read yet.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The document.
Responses
OK
Who owns 25% or more
Everyone who owns 25% or more, screened against the U.S. Treasury's sanctions list; an empty list says no one does. Four at most.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Request Body
Responses
OK
Submit for review
The owner accepts the Sponsor Terms; the authority statement is the one confirmed on step 2, or authority_statement confirms it now. The application and the first perk go to a FundlyHub reviewer. Publishes sponsor.application_submitted.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Request Body
Responses
OK
Take the application back
While it waits for review; it becomes a draft again.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Responses
OK
A team or owner invite
What the invite page shows, for the caller: the sponsor, the role and locations, and whether accepting will work.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The invite token from the email link.
Responses
OK
Accept an invite
One of the person's verified emails must be the invited one. An owner invite also takes the 25%-owners answer, the Sponsor Terms and the authority statement, and sends the sponsor to review. Publishes sponsor.member_joined.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The invite token from the email link.
Request Body
Responses
OK
Decline an invite
Declining an owner invite hands the sponsor back to staff as a draft.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The invite token from the email link.
Responses
OK
My business invites
The team and owner invites waiting for the signed-in person, so they can join or decline in the app and not only from the email's link. An invite sent to their sign-in email while it is unconfirmed is listed under unconfirmed by address alone.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Responses
OK
Accept one of my business invites
The invite page's accept, by the invite's id. A team invite takes nothing; an owner invite takes the 25%-owners answer, the Sponsor Terms and the authority statement, and sends the sponsor to review. Publishes sponsor.member_joined.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
"uuid"Request Body
Responses
OK
Decline one of my business invites
The invite page's decline, by the invite's id. Declining an owner invite hands the sponsor back to staff as a draft.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
"uuid"Responses
OK
Does the owner still have to finish joining
When a super admin accepted the owner invite for this person, the sponsor waits for the owner's own answers. Pending while the sponsor is waiting for its owner, the caller is its owner, and nobody accepted its terms.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's page link or id.
Responses
OK
Finish joining as the owner
The rest of the owner invite, from the owner a super admin seated. Records who owns 25% or more, the Sponsor Terms and the authority statement, and sends the sponsor to review with a second reviewer. Publishes sponsor.application_submitted.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's page link or id.
Request Body
Responses
OK
Start a sponsor (a draft)
A draft saved as you go; the person who starts it is its owner. At most three unfinished drafts per person. ref is an ambassador code from /sponsors/join?ref=. Needs a verified email. is_sponsor: false starts a business that only lists help in Resources (/resources/join, "Add your business"; #2422): the same steps and checks (who runs it, the registry, sanctions, the 25%-owners answer, the terms) with no first perk and no sticker kits, and its home a storefront or a service-area or online location (never a private storefront). While sponsors are off and Resources are on, such a business can still be started here, finish its steps and use its workspace (#2426); a sponsor's draft, and a sponsor's perks and stickers, answer 403 until sponsors are on.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Request Body
Responses
OK