Sign in

v3

latestOpenAPI 3.1.02026-07-3178343213.9 KB
actions

Retrieve an action

get/v1/actions/{id}

Path parameters

idstring required

Action ID

Query parameters

object_type'businesses' | 'watchlist_result' required

Type of object the action belongs to

object_idstring required

ID of the object the action belongs to

Headers

Authorizationstring required

Bearer authentication

Response

action found

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