Get a background check

GET

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

Returns a background check with its application and candidate. Detailed result data is redacted for non-admin users.

AuthorizationBearer

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

checkIdstringRequiredformat: "uuid"

Background check detail.

background_checkobjectOptional

401

Unauthorized Error

404

Not Found Error

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	}

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