---
title: "Create a new flow"
method: POST
path: "/v1/flows"
tags: ["Flow"]
---

# Create a new flow

`POST /v1/flows`

## Request

- Base URL: `/` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/v1/flows`
- Auth: API key in header `Authorization`

Create a new screening flow

## Request body

- V1CreateFlowRequest
  - `flow` V1FlowCreationDTO
    - `name` string
    - `steps` V1StepCreationDTO[]
      - `id` string
      - `options` V1StepOptions
        - `skippable` boolean
    - `options` V1FlowOptions
      - `runCreditCheck` V1RunCreditCheck
        - `provider` string[]

## Response `200`

A successful response.

- V1CreateFlowResponse
  - `flowId` string

## Other responses

- `default`: An unexpected error response.

## Changes

- **2025-06-03** `d073d48df6b1`: 1 info
  - added the new optional request property `flow/options`
- **2025-02-03** `54a00ab0965e`: 2 info
  - api tag `Flow` added
  - api tag `Property` removed
- **2025-02-03** `ab4f2018e446`: 1 info
  - endpoint added
- **2025-02-03** `d22701eae819`: 1 breaking
  - api path removed without deprecation
- **2025-02-03** `ab4f2018e446`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/getcove/apis/proto-screening-v2-screening-proto/changes/v1/flows/post.md)

---

[API](https://skmtc.dev/getcove/apis/proto-screening-v2-screening-proto.md) - [All operations](https://skmtc.dev/getcove/apis/proto-screening-v2-screening-proto/llms.txt) - [OpenAPI document](https://skmtc.dev/getcove/apis/proto-screening-v2-screening-proto/revisions/9d9f9d9f0188?raw)