actions
Create an action on an object
post/v1/actions
Headers
Authorizationstring required
Bearer authentication
Request body
object_type'businesses' | 'watchlist_result' required
Type of object to perform the action on
object_idstring uuid required
ID of the object to perform the action on
type'add_sources' | 'add_attributes' | 'verify_tin' | 'decision' | 'dismissal' required
The type of action to perform
notestring
Optional text note describing the reason for the action
thread_idstring uuid
Optional operator thread ID used to resolve an action actor
run_idstring uuid
Optional operator run ID used to resolve an action actor
payloadobject required
Action-specific parameters (varies by action type)
Response
action created - verify TIN
idstring uuid required
type'add_sources' | 'add_attributes' | 'update_address_risk' | 'verify_tin' | 'decision' | 'dismissal' required
The action type that was performed
object_type'Business' | 'Watchlist::Result' required
The type of object the action was performed on
object_idstring uuid required
The ID of the object the action was performed on
created_atstring date-time required
notestring nullable
Optional text note describing the reason for the action
metadataobject
Additional metadata associated with the action