Hosted vanity addresses
A vanity URL replaces your public key in hosted addresses with a readable name, for example /acme-lending/auto-loan-payment. Use it in links you print or share.
Before you start
A customer admin sets the slug in the portal under Vanity URL. The slug is your cobrand's name in hosted addresses.
A slug follows these rules:
- 3 to 40 characters.
- Lowercase letters
a-z, digits and single hyphens only. - It starts with a letter and doesn't end with a hyphen.
- It can't be a reserved name or a slug another cobrand holds.
- You can change it 5 times in any 30 days. Setting, renaming, reverting and removing all count.
Minimal example
https://<your hosted host>/<your slug>
https://<your hosted host>/<your slug>/auto-loan-payment
Replace the host and the slug, then open each address in a browser. The first shows the index page and the second a calculator page.
Options
| Address | Page |
|---|---|
/{slug} | The index page |
/{slug}/{calculatorKey} | A calculator page |
?locale= | The page language. A query string carries over to redirects. |
How the hosted site handles other forms of your slug:
| You open | Result |
|---|---|
| A slug with uppercase letters | A redirect to the lowercase slug. |
| An old slug of your cobrand | A single redirect to the current slug, or to /c/{publicKey} if you removed the vanity URL. |
| The current slug | The page. It has a rel="canonical" link to the slug address. |
| A slug nobody uses | The "This calculator link isn't available" page. |
Slugs change quickly. A new, renamed or removed slug applies within about 60 seconds.
Errors and limits
- The hosted site is a static site that can't send a
301. It redirects in the browser after it checks the slug, so a crawler may not see a301status. Error pages come with a200status. - While the platform can't read slugs, an address with a slug it hasn't seen shows "Calculators are temporarily unavailable, please try again shortly". Slugs it has seen keep working for up to 24 hours.
- The address
/c/{publicKey}keeps working after you set a slug.
| Limit | Value |
|---|---|
| Slug length | 3 to 40 characters |
| Slug changes | 5 in any rolling 30 days |
| Request rate | 1,200 requests a minute for each cobrand's public key. See Rate limits. |
Related API reference
Pages that use a vanity URL load their data from the embed endpoints. See Embed endpoints and allowed domains.