UPCS Help Center: tutorials and troubleshooting
Step-by-step tutorials for generating, finding and sharing UPCS codes, setting up store plugins and the API, and fixing common problems.
Getting started
First steps with UPCS: generating, finding and sharing a code.
What Is UPCS and Who Is It For?UPCS (Universal Post Code System) turns an exact spot on a map into a short code you can share. Learn what it does and who it helps.UPCS Quick Start: Your First Five MinutesGenerate, share and look up a UPCS code in a few steps. A short walkthrough for first-time users of upcs.io.How to Generate Your First UPCS CodeStep-by-step instructions for choosing a location on the UPCS map and getting its short code, plus tips for picking the right spot.Understanding the UPCS Code FormatA UPCS code uses the pattern CC-XXXX-XXXX: a country prefix and two blocks of characters for a 3 m by 3 m cell. Here is how to read one.How to Find a Location From a UPCS CodePaste a UPCS code into the search box or use the upcs.io address form to see the exact place on a lookup page with map options.How to Share a UPCS CodeThree simple ways to share a UPCS code: tell it, send it as text, or send the lookup page link so the recipient sees the map.
Using UPCS codes
Everyday tasks: sharing codes, getting directions, using codes for deliveries and orders.
How to Give a UPCS Code to a CourierMake deliveries easier by passing a courier your UPCS code or link, so they can open the exact drop-off spot on a map.Add a UPCS Code to an Order or Address NotePut your UPCS code in the note or address line 2 field when ordering online so the seller and courier can find the exact spot.How to Get Directions From a UPCS CodeUse Get Directions on the UPCS lookup page to plan a route to the exact spot a code points to. Steps for desktop and mobile.How to Open a UPCS Code in the MapUse Open in Map on the UPCS lookup page to see exactly where a code sits, zoom in and check the surroundings before you go.How to Copy the Share Link for a CodeCopy the share link from the UPCS lookup page so anyone can open your code and see the location in one tap, no typing needed.Use UPCS Coordinates in Another AppCopy the latitude and longitude of a UPCS code and paste them into another tool, such as a mapping or note-taking application.
Account
Signing in, your dashboard and saved locations.
Sign In to UPCS With a WhatsApp NumberSign in to UPCS using your WhatsApp number and a one-time code. Steps for signing in, and what you can do once you are in.Not Receiving Your One-Time CodeIf your UPCS one-time code does not arrive on WhatsApp, work through these general checks: number, connection, app and timing.Your UPCS Account Dashboard ExplainedWhat the UPCS account dashboard is for, how to reach it after signing in, and how it relates to My postcodes and your codes.Find Your Codes in My PostcodesMy postcodes is the area of your UPCS account where signed-in users find their codes. How to get there and how to use it.Keeping Track of Saved LocationsTips for organising the places you use often with UPCS: how to keep, name and reuse your codes so they are easy to find.How to Sign Out of Your UPCS AccountSign out of UPCS when you finish, especially on a shared or public device. Steps and what to expect after you sign out.
Business and plugins
Partner accounts, API keys and installing the store plugins.
How to Create a UPCS Partner AccountCreate a UPCS partner account to manage API keys and allowed origins for your website or online store. Here is how to sign up and what to do next.UPCS Partner Panel OverviewThe UPCS partner panel is where businesses manage API keys and allowed origins. See what it is used for and the tasks you will do there most often.How to Generate a UPCS API KeyGenerate a UPCS API key in the partner panel and learn how to store it safely before using it in a plugin or in your own server code.Disable or Delete a UPCS API KeyLearn how to disable or delete a UPCS API key in the partner panel, what stops working straight away, and how to replace a key safely.Use One UPCS API Key Across Plugins and CodeOne UPCS API key works in every plugin and in your own code. See when sharing a key is fine and when separate keys are the safer choice.Name and Separate API Keys for Each SiteA simple naming scheme and one-key-per-site approach make UPCS API keys easier to audit, rotate and switch off without affecting other sites.
API and developers
Embedding the map and calling the REST API.
Quick Start: Embed the UPCS Map on Your SiteEmbed the UPCS map in a few steps: register your origin, create a session on your server, then mount the map in your page and read the selected code.Create a UPCS Map Session From Your ServerCreate a short-lived UPCS map session with POST /v1/embed/sessions, pass your origin and optional ttl, and read the session token from the response.Mount the UPCS Map With UPCS.mountUPCS.mount renders the map in a page element. See the options for session token, height, center, zoom and style, the callbacks and how to destroy it.Read the UPCS Map Click ResponseThe onSelect callback receives the UPCS code, latitude, longitude, address, country code, cell bounds, saved status and share URL. See each field.Resolve Coordinates to a Code Server-to-ServerUse POST /v1/embed/resolve with latitude and longitude to get a UPCS code from your server without showing the map, and optionally save the result.Look Up a UPCS Code With the APICall GET /v1/upcs/lookup/{code} with your API key to get a code's location, map links and share URL. Unknown codes return 404.
Troubleshooting
Fixes for common errors and problems.
Fix UPCS Error 401 session_expiredThe 401 session_expired error means the short-lived embed session token has run out. Create a fresh session and reload the map to fix it.Fix UPCS Error 401 Invalid or Inactive API Key (key_inactive)A 401 Invalid or inactive API key error (or key_inactive on a running map) means your UPCS API key is disabled or expired. Find out how to check the key in the partner panel and restore or replace it.Fix UPCS Error 403 partner_requiredThe 403 partner_required error means the API key is not linked to a partner account. See how to set up a partner account and use its keys.Fix UPCS Error 403 origin_not_allowedThe 403 origin_not_allowed error means your website address is not registered in your partner account. Add the exact https origin under Allowed origins.Fix a Missing or Invalid UPCS x-api-keyA 401 response about the API key means the x-api-key header is missing or the key is wrong. Check the header name, the value and your server code.Fix UPCS Error: IP Address Not Allowed for KeyA 403 saying the IP address is not allowed means your server's IP does not match the key's restriction. Learn how to find the IP and correct the key.