# KYB Flows

### Discover KYB Flows for Your Organization

Use these endpoints to discover which KYB flows are available to your organization before creating a KYB case.

Both endpoints:

* Require the `x-api-key` header
* Return a JSON array
* Return `[]` when no matching flows exist
* Only return flows that belong to the authenticated organization

### Response Shape

Each flow is returned with the same minimal shape:

```json
[
  {
    "id": "680dbf0d3f6c8d7f0a123456",
    "country": "US",
    "default": true
  }
]
```

| Field     | Type    | Description                                                                       |
| --------- | ------- | --------------------------------------------------------------------------------- |
| `id`      | string  | The KYB flow ID to pass as the `flow` value when creating a KYB case              |
| `country` | string  | The country associated with the flow                                              |
| `default` | boolean | Whether this flow is marked as the default flow for that organization and country |

## List All KYB Flows

Retrieve every KYB flow available to the authenticated organization.

#### Endpoint

* **Method**: `GET`
* **URL**: `/kyb/flows`
* **Authentication**: Required (`x-api-key` header)

#### Example Request

```bash
curl -X GET https://api.voveid.com/kyb/flows \
  -H "accept: application/json" \
  -H "x-api-key: YOUR_API_KEY"
```

#### Example Response

```json
[
  {
    "id": "680dbf0d3f6c8d7f0a123456",
    "country": "US",
    "default": true
  },
  {
    "id": "680dbf0d3f6c8d7f0a654321",
    "country": "GB",
    "default": false
  }
]
```

## List Default KYB Flows

Retrieve only KYB flows where `default = true` for the authenticated organization.

#### Endpoint

* **Method**: `GET`
* **URL**: `/kyb/flows/default`
* **Authentication**: Required (`x-api-key` header)

#### Example Request

```bash
curl -X GET https://api.voveid.com/kyb/flows/default \
  -H "accept: application/json" \
  -H "x-api-key: YOUR_API_KEY"
```

#### Example Response

```json
[
  {
    "id": "680dbf0d3f6c8d7f0a123456",
    "country": "US",
    "default": true
  }
]
```

### When to Use Each Endpoint

* Use `GET /kyb/flows` when you want to show all available KYB flow options for the organization.
* Use `GET /kyb/flows/default` when you only need the default flow set and want to avoid hardcoding flow IDs.

### Related Documentation

* [KYB Overview](/docs/kyb-know-your-business/kyb-overview.md) - Understand the KYB verification flow
* [Create KYB Case](/docs/kyb-know-your-business/kyb-create-case.md) - Use a returned `flow` ID to create a KYB case
* [KYB Case Management](/docs/kyb-know-your-business/kyb-case-management.md) - Retrieve and manage created KYB cases


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.voveid.com/docs/kyb-know-your-business/kyb-flows.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.