> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.upwardli.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.upwardli.com/_mcp/server.

# Get All Onboardings

GET https://api.upwardli.com/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

Reference: https://developers.upwardli.com/api-access/api-reference/onboarding/get-all-onboardings

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://api.upwardli.com` (Production, default)
- `https://api-sandbox.upwardli.com` (Sandbox)

## Request

### Query parameters

- `page` (integer, optional) — A page number within the paginated result set.
- `page_size` (integer, optional) — Number of results to return per page.
- `search` (string, optional) — A search term.
- `consumer_id` (string, required) — Consumer ID
- `consumer_pcid` (string, required) — Consumer PCID

## Response

### 200

- `count` (integer, required)
- `results` (list of OnboardResponse, required)
- `next` (string, optional, nullable)
- `previous` (string, optional, nullable)

## Types

### OnboardResponse

- `id` (string, required)
- `status` (string, required)
- `consumer` (OnboardResponseConsumer, required)
- `kyc` (OnboardResponseKyc, required)
- `e_sign` (OnboardResponseESign, required)
- `underwriting` (OnboardResponseUnderwriting, required)
- `product` (OnboardResponseProduct, required)
- `previous_steps` (list of OnboardResponsePreviousStepsItems, required)
- `current_steps` (list of OnboardResponseCurrentStepsItems, required, nullable)
- `metadata` (OnboardResponseMetadata, required, nullable)

### OnboardResponseConsumer

- `id` (string, required)
- `pcid` (string, required)
- `mla_status` (boolean, required)
- `external_id` (string, optional)
- `first_name` (string, optional, nullable)
- `last_name` (string, optional, nullable)
- `email` (string, optional, nullable)
- `is_active` (boolean, optional)
- `kyc_status` (string, optional)
- `phone_number` (string, optional)
- `date_of_birth` (string, optional)
- `tax_id_type` (string, optional)
- `tax_identifier` (string, optional, nullable)
- `address_line1` (string, optional)
- `address_line2` (string, optional)
- `address_city` (string, optional)
- `address_state` (string, optional)
- `address_zip` (string, optional)
- `credit_lines` (string, optional, nullable)

### OnboardResponseKyc

- `inquiry_ids` (list of string, required, nullable)
- `fallback_inquiry_id` (string, required)
- `inquiry_template_id` (string, required)
- `errors` (string, optional)

### OnboardResponseESign

- `agreement_accepted` (boolean, required)
- `agreement_accepted_date` (string, required, nullable)

### OnboardResponseUnderwriting

- `result` (string, required)
- `data` (string, required)
- `errors` (list of any, required, nullable)

### OnboardResponseProduct

- `product_id` (string, required)
- `product_configuration` (OnboardResponseProductProductConfiguration, required, nullable)

### OnboardResponsePreviousStepsItems

- `slug` (string, required)
- `url` (string, required)

### OnboardResponseCurrentStepsItems

- `slug` (string, required)
- `url` (string, required)

### OnboardResponseMetadata

### OnboardResponseProductProductConfiguration

## Examples

**Response**

```json
{
  "count": 123,
  "results": [
    {
      "id": "string",
      "status": "string",
      "consumer": {
        "id": "string",
        "pcid": "string",
        "mla_status": true,
        "external_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "string",
        "is_active": true,
        "kyc_status": "string",
        "phone_number": "string",
        "date_of_birth": "string",
        "tax_id_type": "string",
        "tax_identifier": "string",
        "address_line1": "string",
        "address_line2": "string",
        "address_city": "string",
        "address_state": "string",
        "address_zip": "string",
        "credit_lines": "string"
      },
      "kyc": {
        "inquiry_ids": [
          "string"
        ],
        "fallback_inquiry_id": "string",
        "inquiry_template_id": "string",
        "errors": "string"
      },
      "e_sign": {
        "agreement_accepted": true,
        "agreement_accepted_date": "2024-01-15T09:30:00Z"
      },
      "underwriting": {
        "result": "string",
        "data": "string",
        "errors": [
          null
        ]
      },
      "product": {
        "product_id": "string",
        "product_configuration": {}
      },
      "previous_steps": [
        {
          "slug": "string",
          "url": "string"
        }
      ],
      "current_steps": [
        {
          "slug": "string",
          "url": "string"
        }
      ],
      "metadata": {}
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}
```

**SDK Code**

```python
import requests

url = "https://api.upwardli.com/v2/onboarding/"

querystring = {"consumer_id":"consumer_id","consumer_pcid":"consumer_pcid"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.upwardli.com/v2/onboarding/?consumer_id=consumer_id&consumer_pcid=consumer_pcid';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.upwardli.com/v2/onboarding/?consumer_id=consumer_id&consumer_pcid=consumer_pcid"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.upwardli.com/v2/onboarding/?consumer_id=consumer_id&consumer_pcid=consumer_pcid")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.upwardli.com/v2/onboarding/?consumer_id=consumer_id&consumer_pcid=consumer_pcid")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.upwardli.com/v2/onboarding/?consumer_id=consumer_id&consumer_pcid=consumer_pcid', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.upwardli.com/v2/onboarding/?consumer_id=consumer_id&consumer_pcid=consumer_pcid");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.upwardli.com/v2/onboarding/?consumer_id=consumer_id&consumer_pcid=consumer_pcid")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```