---
title: "Get Onboarding"
method: GET
path: "/recipients/{recipient_id}/onboardings/{onboarding_id}"
---

# Get Onboarding

`GET /recipients/{recipient_id}/onboardings/{onboarding_id}`

## Request

- Base URL: `https://api-sandbox.y.uno/v1`
- URL: `https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}`
- Auth: API key in header `PUBLIC-API-KEY` and API key in header `PRIVATE-SECRET-KEY`
- TypeScript: <https://skmtc.dev/y/apis/ai-caller/docs/recipients/:recipient_id/onboardings/:onboarding_id/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `recipient_id` string, required
- `onboarding_id` string, required

## Response `200`

Onboarding details retrieved successfully

- object
  - `id` string: The unique identifier of the onboarding
  - `account_id` string: Unique id of the account in Yuno
  - `recipient_id` string: The unique identifier of the recipient
  - `type` 'PREVIOUSLY_ONBOARDED' | 'ONE_STEP_ONBOARDING' | 'TWO_STEP_ONBOARDING': Type of onboarding flow
  - `workflow` 'HOSTED_BY_PROVIDER' | 'HOSTED_BY_YUNO' | 'DIRECT': Workflow of the onboarding
  - `status` string: Current status of the onboarding
  - `callback_url` string, uri: URL to redirect after the onboarding process
  - `provider` object
    - `id` string: Provider id
    - `connection_id` string: Id of the connection in Yuno
    - `recipient_id` string: The unique identifier of the provider's recipient
  - `created_at` string, date-time: Onboarding creation date
  - `updated_at` string, date-time: Onboarding last update date

## Other responses

- `401`: Unauthorized
- `403`: Forbidden

---

[API](https://skmtc.dev/y/apis/ai-caller.md) - [All operations](https://skmtc.dev/y/apis/ai-caller/llms.txt) - [OpenAPI document](https://skmtc.dev/y/apis/ai-caller/revisions/05b629819b49?raw)