API ReferenceBackground Checks

Submit a background check after consent

Records the candidate's consent and personal details, then submits the check to the screening vendor. The check must be in pending status with no prior consent.

Authentication

AuthorizationBearer

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

Path parameters

checkIdstringRequiredformat: "uuid"

Request

This endpoint expects an object.
ssnstringRequired
date_of_birthdateRequired
addressobjectRequired
consent_ip_addressstringOptional
consent_timestampdatetimeOptional
consent_document_urlstringOptionalformat: "uri"

Response

Check submitted to the vendor.
check_idstringOptionalformat: "uuid"
vendor_check_idstringOptional
statusstringOptional

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error