---
title: "SDK: onboarding"
description: "The onboarding methods of the Overlane TypeScript SDK, with their signatures. Generated from the SDK types."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.overlane.app/llms.txt
> Use this file to discover all available pages before exploring further.

# SDK: onboarding

{/* Generated by apps/docs/scripts/generate.mjs (SDK pages from the TypeScript types in packages/sdk). Do not edit; run `pnpm --filter @overlane/docs gen`. */}

The `onboarding` area has 4 methods on the client. Each takes one object of path, query and body arguments and an optional `CallOptions`, and returns a promise of the response body. A refused call rejects with `OverlaneApiError` (see the [SDK index](/sdk/)).

## onboardingAdvance

Advance onboarding one step

- Request: `POST` on `/v1/tenants/{tenantId}/onboarding/advance`

```ts
onboardingAdvance(args: { tenantId: string; body: AdvanceRequest }, options?: CallOptions): Promise<AdvanceResponse>
```

## onboardingFunnel

Time from sign-up to the first reviewed agent change, for admins

- Request: `GET` on `/v1/tenants/{tenantId}/onboarding/funnel`

```ts
onboardingFunnel(args: { tenantId: string }, options?: CallOptions): Promise<FunnelReport>
```

## onboardingGet

Onboarding state for the team

- Request: `GET` on `/v1/tenants/{tenantId}/onboarding`

```ts
onboardingGet(args: { tenantId: string }, options?: CallOptions): Promise<OnboardingProgress>
```

## onboardingReview

The first AI review of onboarding

- Request: `GET` on `/v1/tenants/{tenantId}/onboarding/first-review`

```ts
onboardingReview(args: { tenantId: string }, options?: CallOptions): Promise<FirstReview>
```

Source: https://docs.overlane.app/sdk/onboarding/index.mdx