Ctrl+K

Partial update for the Get Started card

patch/api/usermanagement/v1/users/{userId}/properties/get-started-card

Used by the FE to dismiss the card (dismissedAt) or mark UI-only actions complete (viewActivityLog, explorePolicies, etc.). Server-completed actions never un-complete via this endpoint — completion only advances forward.

Path Parameters

  • userIdstringRequired
    External user ID

Request Body

guidedChecklist object
track string required
Guided checklist track
Allowed values: A B
roles array[string]
The user's roles in the requested organization, resolved at read time from role-user membership. Used by the server to filter visible steps. Values written via PUT/PATCH are stored but overwritten on GET by the resolved values, so this field always reflects the user's current roles in the org rather than a stored snapshot.
productInterests array[string]
User product interests
steps array[object]
Checklist steps
computedAt string <date-time>required
When the checklist was last computed
completedAt string <date-time>
When the checklist was completed
dismissedAt string <date-time>
When the checklist was dismissed
firstLoginState object
First-login stepper state (FA1)
roleIdentification string
Role selected during the first-login stepper
Allowed values: executive operational
delegationFlowCompleted boolean
True when the delegation step is complete
isReturningUser boolean
True if this user is a platform admin on another BitGo enterprise
stepperCompletedAt string <date-time>
When the full stepper flow was completed
organizationId string
Organization associated with this stepper state
productInterest array[string]
Product interests selected during the stepper
enterpriseId string
Enterprise associated with this stepper state
getStartedCard object
Dashboard Get Started card state
onboardingType string required
Onboarding type derived from enterprise KYB/KYC state
Allowed values: sales_led organic
userType string required
User type — drives super-user organic fixed action set
Allowed values: business_entity individual
isSuperUser boolean required
Whether the user holds all seven super-user roles
roles array[string]
Snapshot of the user's roles at compute time
actions array[object]
A single action within the Get Started card
computedAt string <date-time>required
When this card was generated
dismissedAt string <date-time>
When the user dismissed the card

200 Response

userId string required
External user ID
guidedChecklist object
track string required
Guided checklist track
Allowed values: A B
roles array[string]
The user's roles in the requested organization, resolved at read time from role-user membership. Used by the server to filter visible steps. Values written via PUT/PATCH are stored but overwritten on GET by the resolved values, so this field always reflects the user's current roles in the org rather than a stored snapshot.
productInterests array[string]
User product interests
steps array[object]
Checklist steps
computedAt string <date-time>required
When the checklist was last computed
completedAt string <date-time>
When the checklist was completed
dismissedAt string <date-time>
When the checklist was dismissed
firstLoginState object
First-login stepper state (FA1)
roleIdentification string
Role selected during the first-login stepper
Allowed values: executive operational
delegationFlowCompleted boolean
True when the delegation step is complete
isReturningUser boolean
True if this user is a platform admin on another BitGo enterprise
stepperCompletedAt string <date-time>
When the full stepper flow was completed
organizationId string
Organization associated with this stepper state
productInterest array[string]
Product interests selected during the stepper
enterpriseId string
Enterprise associated with this stepper state
getStartedCard object
Dashboard Get Started card state
onboardingType string required
Onboarding type derived from enterprise KYB/KYC state
Allowed values: sales_led organic
userType string required
User type — drives super-user organic fixed action set
Allowed values: business_entity individual
isSuperUser boolean required
Whether the user holds all seven super-user roles
roles array[string]
Snapshot of the user's roles at compute time
actions array[object]
A single action within the Get Started card
computedAt string <date-time>required
When this card was generated
dismissedAt string <date-time>
When the user dismissed the card
createdDate string <date-time>required
When the record was created
modifiedDate string <date-time>required
When the record was last modified