Getting started as a transfer company
Make your first call to the Transferz staging API from your own system. You need the onboarding email from Transferz. About 10 minutes.
0 of 3 steps done
Transferz set up two staging accounts for you and emailed the details. Your person account is for you. Your integration account (
…@integrations.staging.transferz.com) is the one your system uses. API keys and request recording belong to the account that creates them, so do every step on this page signed in with the integration account.The first time you sign in, Transferz asks you to choose a new password. Nobody can receive email at the integration address, so "Forgot password" doesn't work for it. If you lose the password, ask Transferz in a support ticket.
Sign in to start
Use the integration account from your onboarding email.
Access is set up by Transferz. No email yet? Contact your Transferz contact.
Your system sends an API key in the
X-API-Keyheader of every call. The key belongs to the account that creates it: here, your integration account. Store it in your secret store, never in source code or browser code. A key expires three months after it was last used.Available after you sign in with your integration account (step 1).
List the journeys assigned to your company. Send the request from your terminal or your own code, not from this portal: the point is to prove that your system can reach Transferz staging with your key.
GET /journeysReferenceSign in to fill in your staging key. Sign incurl --request GET \ --url 'https://warpdrive.staging.transferz.com/transfercompanies/journeys?page=0&size=10' \ --header 'Accept: application/json' \ --header 'X-API-Key: YOUR_STAGING_API_KEY'Hide example response
Sample data
Response 200{ "pagination": { "currentPage": 0, "pageSize": 10, "totalPages": 0, "totalResults": 0 }, "results": []}A
200response with an empty page:"results": []and"totalResults": 0. An empty list is the correct result: there are no journeys for your company on staging yet. You create test journeys later in Workspace › Test data.This page sees your call through request recording: a copy of each call made with this account's API keys (method, path, status, duration, and the request and response bodies). Transferz switched it on for your integration account when it set the account up, and you'll use it to debug while you build. If it's off, this step offers to turn it on. Calls made in the first few seconds after recording starts or a key is created are not recorded, so wait a few seconds before you make a call. Every recorded call is in Workspace › Request log.
Not listening
Sign in with your integration account first (step 1).
On your phone? Send the request from your computer. This page keeps listening while it's open.
Got an error in your terminal?
A call without a valid key of this account can't be linked to you, so this page may not see it. These are the usual causes.
Status Likely cause Fix 401 The X-API-Key header is missing, or the key is wrong, deleted or expired. Copy the key again, or create a new one in step 2. The header name is X-API-Key. 403 The key's account can't use this API or this company. Check that the key comes from your integration account and that you call the Transfer Companies API (…/transfercompanies), not the Partners API. 400 A required parameter is missing or invalid. Send page and size as numbers, for example page=0&size=10. 404 Wrong base URL or path. Use https://warpdrive.staging.transferz.com/transfercompanies/journeys. It's "transfercompanies", one word, no hyphen. 429 Too many requests in a short time. Wait a minute and send it once more. 5xx Staging had a problem. Send it again in a minute. If it keeps failing, check the staging status. API status
What to build next
Follow these in order. Each guide ends with a link to the next.
- How a journey reaches youHow journeys reach a transfer company, by direct assignment or through the offer flow.
- WebhooksReceive events from Transferz, verify their signature, acknowledge them, and handle retries, order and duplicates.
- Receive journeys by webhookReceive new, changed and unassigned journeys on your webhook endpoint.
- Look up and search journeysGet one journey by id or search your journeys with filters and pagination.
- Assign a driver and a vehicleAssign, change or remove the driver and vehicle of a journey.
- Report journey progressReport driver underway, arrived and in progress, and send the driver's live position.
- Complete a journeyMark a journey as completed once the traveller has been dropped off.
- Handle changes and cancellationsHandle journey changes and cancellations that Transferz sends you.
- Going liveWhat to check before launch, the go-live checklist, and whom to contact before and after launch.
Also available: Optional modules · Accept or decline offers · Report a no-show or a delay · Update pickup information for shared journeys · Meet and greet
Stuck?
- Ask AI answers from these docs. Open it with ⌘I or the Ask AI button in the header.
- For anything about your accounts or staging, ask Transferz in a support ticket.
- To see the whole flow without an account, try the walk-through on sample data.