# 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.

Section: Transfer companies · Last updated: 2026-11-18

## Sign in with your integration account

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](https://developers.test.transferz.com/support/new).

Sign in at <https://developers.test.transferz.com/sign-in> with your integration account.

## Create an API key

Your system sends an API key in the `X-API-Key` header 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.

Create a key in Workspace › API keys (<https://developers.test.transferz.com/workspace/staging/api-keys>).

## Make your first call

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.

**Request:** [`GET /journeys`](https://developers.test.transferz.com/reference/transfer-companies/search-journeys)

```bash title="cURL"
curl --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'
```

```javascript title="JavaScript"
const response = await fetch("https://warpdrive.staging.transferz.com/transfercompanies/journeys?page=0&size=10", {
  method: "GET",
  headers: {
    Accept: "application/json",
    "X-API-Key": "YOUR_STAGING_API_KEY",
  },
});

const data = await response.json();
console.log(response.status, data);
```

```java title="Java"
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
  public static void main(String[] args) throws Exception {
    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://warpdrive.staging.transferz.com/transfercompanies/journeys?page=0&size=10"))
        .header("Accept", "application/json")
        .header("X-API-Key", "YOUR_STAGING_API_KEY")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();

    HttpResponse<String> response = HttpClient.newHttpClient()
        .send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.statusCode());
    System.out.println(response.body());
  }
}
```

```csharp title="C#"
using System.Net.Http;
using System.Text;

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://warpdrive.staging.transferz.com/transfercompanies/journeys?page=0&size=10");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("X-API-Key", "YOUR_STAGING_API_KEY");

using var response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

```php title="PHP"
<?php

$ch = curl_init('https://warpdrive.staging.transferz.com/transfercompanies/journeys?page=0&size=10');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Accept: application/json',
        'X-API-Key: YOUR_STAGING_API_KEY',
    ],
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);

echo $status, PHP_EOL, $response, PHP_EOL;
```

**Response (200):**

```json
{
  "pagination": { "currentPage": 0, "pageSize": 10, "totalPages": 0, "totalResults": 0 },
  "results": []
}
```

A `200` response 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](https://developers.test.transferz.com/workspace/staging/requests).

Send the request above from your terminal or your own code, then open the request log (<https://developers.test.transferz.com/workspace/staging/requests>) to see it arrive.

## What to build next

Follow these in order. Each guide ends with a link to the next.

1. [How a journey reaches you](https://developers.test.transferz.com/guides/transfer-companies/how-a-journey-reaches-you): How journeys reach a transfer company, by direct assignment or through the offer flow.
2. [Webhooks](https://developers.test.transferz.com/guides/essentials/webhooks): Receive events from Transferz, verify their signature, acknowledge them, and handle retries, order and duplicates.
3. [Receive journeys by webhook](https://developers.test.transferz.com/guides/transfer-companies/receive-journeys-by-webhook): Receive new, changed and unassigned journeys on your webhook endpoint.
4. [Look up and search journeys](https://developers.test.transferz.com/guides/transfer-companies/look-up-and-search-journeys): Get one journey by id or search your journeys with filters and pagination.
5. [Assign a driver and a vehicle](https://developers.test.transferz.com/guides/transfer-companies/assign-a-driver-and-vehicle): Assign, change or remove the driver and vehicle of a journey.
6. [Report journey progress](https://developers.test.transferz.com/guides/transfer-companies/report-journey-progress): Report driver underway, arrived and in progress, and send the driver's live position.
7. [Complete a journey](https://developers.test.transferz.com/guides/transfer-companies/complete-a-journey): Mark a journey as completed once the traveller has been dropped off.
8. [Handle changes and cancellations](https://developers.test.transferz.com/guides/transfer-companies/handle-changes-and-cancellations): Handle journey changes and cancellations that Transferz sends you.
9. [Going live](https://developers.test.transferz.com/guides/essentials/going-live): What to check before launch, the go-live checklist, and whom to contact before and after launch.

Also available, optional modules:

- [Accept or decline offers](https://developers.test.transferz.com/guides/transfer-companies/accept-or-decline-offers): Receive offers for journeys and accept or decline them with a reason.
- [Report a no-show or a delay](https://developers.test.transferz.com/guides/transfer-companies/report-a-no-show-or-delay): Report a traveller no-show or a driver who left the pickup, with photo evidence.
- [Update pickup information for shared journeys](https://developers.test.transferz.com/guides/transfer-companies/update-pickup-information): Update the pickup time and details of a shared journey.
- [Meet and greet](https://developers.test.transferz.com/guides/transfer-companies/meet-and-greet): Report that the host met the traveller for journeys with 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](https://developers.test.transferz.com/support/new).
- To see the whole flow without an account, try the
  [walk-through on sample data](https://developers.test.transferz.com/walkthrough/transfer-company).

## Related

### Endpoints

- [GET Search journeys](https://developers.test.transferz.com/reference/transfer-companies/search-journeys) (`GET /journeys`)
