List background check pipelines

GET

https://api.confirm.global/api/v1/background-checks/pipelines

GET

/api/v1/background-checks/pipelines

$ curl https://api.confirm.global/api/v1/background-checks/pipelines \
>      -H "Authorization: Bearer <token>"

1 {
2   "success": true,
3   "data": [
4     {
5       "id": "string",
6       "org_id": "string",
7       "name": "string",
8       "description": "string",
9       "execution_mode": "string",
10       "is_active": true,
11       "enrichment_pipeline_steps": [
12         {
13           "service_id": "string",
14           "step_order": 1,
15           "condition_type": "string",
16           "is_required": true,
17           "is_blocking": true,
18           "service": {
19             "id": "string",
20             "service_code": "string",
21             "service_name": "string",
22             "service_category": "string",
23             "cost_cents": 1,
24             "is_instant": true,
25             "vendor": {
26               "vendor_code": "string",
27               "vendor_name": "string"
28             }
29           }
30         }
31       ]
32     }
33   ]
34 }

Returns active background check pipeline templates (global plus your organization’s), including their ordered steps and services.

Authentication

AuthorizationBearer

Supabase-issued user JWT. Send as Authorization Bearer header. Dedicated API keys are planned for a future release.

Query parameters

org_idstringOptionalformat: "uuid"

Include this organization's templates alongside global ones.

Response

Pipeline templates.

successbooleanOptional

datalist of objectsOptional

Errors

400

Bad Request Error

401

Unauthorized Error