Initiate a background check

POST

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

Creates a pending background check for an application and returns a consent URL for the candidate to complete.

AuthorizationBearer

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

This endpoint expects an object.

application_idstringRequiredformat: "uuid"

checks_requestedlist of enumsRequired

documents_requiredlist of stringsOptional

Background check created.

background_checkobjectOptional

consent_urlstringOptionalformat: "uri"

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

$	curl -X POST https://api.confirm.global/api/v1/background-checks \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"application_id": "string",
>	"checks_requested": [
>	"identity_verification"
>	]
>	}'

1	{
2	"background_check": {
3	"check_id": "string",
4	"org_id": "string",
5	"application_id": "string",
6	"candidate_id": "string",
7	"check_type": "identity_verification",
8	"status": "string",
9	"vendor_check_id": "string",
10	"consent_given": true,
11	"consent_given_at": "2024-01-15T09:30:00Z",
12	"submitted_at": "2024-01-15T09:30:00Z",
13	"completed_at": "2024-01-15T09:30:00Z",
14	"created_at": "2024-01-15T09:30:00Z"
15	},
16	"consent_url": "string"
17	}