Skip to main content
POST
/
api
/
v1
/
hr
/
compliance
/
onboarding-flow
/
{employeeId}
/
terminate
cURL
curl -sS -X POST "$FLUIDE_BASE_URL/api/v1/hr/compliance/onboarding-flow/string/terminate" \
  -H "Authorization: Bearer $FLUIDE_ACCESS_TOKEN" \
  -H "X-Fluide-Api-Key: $FLUIDE_API_KEY" \
  -H "X-Fluide-Client-Id: fluide-developer" \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "success": true,
  "message": "Operation completed successfully",
  "data": {}
}

Authorizations

​
Authorization
string
header
required

Access token JWT. Use as Authorization: Bearer . In the API playground, paste the JWT only.

​
X-Fluide-Api-Key
string
header
default:fl_dev_your_key
required

Developer API key (fl_dev_...). Required on every API call with a machine access token.

​
X-Fluide-Client-Id
string
header
default:fluide-developer
required

First-party client audience. Must match the fluide_client_id claim on the JWT. Use fluide-developer for Connect.

Path Parameters

​
employeeId
string
required

employeeId identifier

Body

application/json
​
reasonCode
enum<string>
required
Available options:
CANDIDATE_WITHDREW,
OFFER_RESCINDED,
FAILED_PREBOARDING_CHECKS,
DUPLICATE_HIRE,
OTHER
​
acknowledgedConsequences
boolean
required

Must be true: confirms the actor is authorized to stop onboarding and understands separation workflow may follow.

​
notes
string
Maximum string length: 4000
​
secondApproverUserId
string<uuid>

Optional second approver (HRBP / legal designee) when organizational policy requires two-person control.

Response

Terminate Onboarding Flow — created

​
success
boolean
required

Whether the request succeeded

Example:

true

​
message
string
required

Human-readable outcome message (localized when i18n is configured)

Example:

"Operation completed successfully"

​
data
object

Endpoint-specific payload