---
title: "Get All Onboardings"
method: GET
path: "/v2/onboarding/"
tags: ["onboarding"]
---

# Get All Onboardings

`GET /v2/onboarding/`

1) Get Partner from request
2) Get Partner Onboardings and filter (pcid or external id) if needed
3) Return a list of onboardings with their id and consumer data

## Query parameters

- `page` integer
- `page_size` integer
- `search` string
- `consumer_id` string, required
- `consumer_pcid` string, required

## Headers

- `Authorization` string, required

## Response `200`

- OnboardingGetAllOnboardingsResponse200
  - `count` integer, required
  - `next` string, uri, nullable
  - `previous` string, uri, nullable
  - `results` OnboardResponse[], required
    - `id` string, uuid, required
    - `status` string, required
    - `consumer` OnboardResponseConsumer, required
      - `id` string, uuid, required
      - `pcid` string, required
      - `external_id` string, uuid
      - `mla_status` boolean, required
      - `first_name` string, nullable
      - `last_name` string, nullable
      - `email` string, email, nullable
      - `is_active` boolean
      - `kyc_status` string
      - `phone_number` string, required
      - `date_of_birth` string, required
      - `tax_id_type` string, required
      - `tax_identifier` string, nullable
      - `address_line1` string, required
      - `address_line2` string, required
      - `address_city` string, required
      - `address_state` string, required
      - `address_zip` string, required
      - `credit_lines` string, nullable
    - `kyc` OnboardResponseKyc, required
      - `inquiry_ids` string[], nullable, required
      - `fallback_inquiry_id` string, required
      - `inquiry_template_id` string, required
    - `e_sign` OnboardResponseESign, required
      - `agreement_accepted` boolean, required
      - `agreement_accepted_date` string, date-time, nullable, required
    - `underwriting` OnboardResponseUnderwriting, required
      - `result` string, required
      - `data` string, required
      - `errors` unknown[], nullable, required
        - unknown
    - `product` OnboardResponseProduct, required
      - `product_id` string, required
      - `product_configuration` OnboardResponseProductProductConfiguration, required
    - `previous_steps` OnboardResponsePreviousStepsItems[], required
      - `slug` string, required
      - `url` string, required
    - `current_steps` OnboardResponseCurrentStepsItems[], nullable, required
      - `slug` string, required
      - `url` string, required
    - `metadata` OnboardResponseMetadata, required

---

[API](https://skmtc.net/upwardli/apis/api-reference.md) · [All operations](https://skmtc.net/upwardli/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/upwardli/api-reference/revisions/8a237f1f704f/schema)