Select reporter reporting intents

POST

https://api.sureshake.com/v2/reporter/reporting-intent-selection

Request body JSON required

entityId
string
required
format: uuid

intentId
string
required
maxLength: 120 · minLength: 1 · pattern: ^[a-z0-9][a-z0-9_-]*$

Returns

200

Default Response

JSON

data
object
required
- selection
  object
  required
  id
  string
  required
  format: uuid
  entityId
  string
  required
  format: uuid
  onboardingSessionId
  string
  or null
  required
  format: uuid
  intentId
  string
  required
  maxLength: 120 · minLength: 1 · pattern: ^[a-z0-9][a-z0-9_-]*$
  selectedByUserId
  string
  or null
  required
  minLength: 1
  selectedAt
  string
  required
  format: date-time
  createdAt
  string
  required
  format: date-time
  updatedAt
  string
  required
  format: date-time
  intent
  optional
  object
  or null
  id
  string
  required
  maxLength: 120 · minLength: 1 · pattern: ^[a-z0-9][a-z0-9_-]*$
  name
  string
  required
  maxLength: 160 · minLength: 1
  description
  string
  required
  maxLength: 1000 · minLength: 1
  category
  string
  required
  maxLength: 120 · minLength: 1
  version
  string
  required
  maxLength: 80 · minLength: 1
  source
  predefined
  or
  custom
  required
  forkedFromIntentId
  string
  or null
  required
  maxLength: 120 · minLength: 1 · pattern: ^[a-z0-9][a-z0-9_-]*$
  enabled
  boolean
  required
  createdAt
  string
  required
  format: date-time
  updatedAt
  string
  required
  format: date-time
  entityId
  optional
  string
  or null
  format: uuid
  schema
  optional
  object
  default: {}
  goldenDocuments
  optional
  array of
  object
  id
  string
  required
  maxLength: 120 · minLength: 1 · pattern: ^[a-z0-9][a-z0-9_-]*$
  label
  string
  required
  maxLength: 180 · minLength: 1
  documentRole
  string
  required
  maxLength: 120 · minLength: 1
  sourceType
  string
  required
  maxLength: 120 · minLength: 1
  privacyClassification
  generated_sample
  or
  synthetic_redacted
  or
  redacted_customer_approved
  required
  fixturePath
  optional
  string
  maxLength: 1000 · minLength: 1
  artifact
  optional
  object
  artifactId
  optional
  string
  maxLength: 240 · minLength: 1
  artifactType
  optional
  string
  maxLength: 120 · minLength: 1
  storageKey
  optional
  string
  maxLength: 1000 · minLength: 1
  checksumSha256
  optional
  string
  maxLength: 128 · minLength: 1
  mimeType
  optional
  string
  maxLength: 160 · minLength: 1
  expectedOutputSummary
  optional
  string
  maxLength: 2000 · minLength: 1
  approvalStatus
  optional
  approved
  default: "approved"
  approvedByUserId
  optional
  string
  maxLength: 160 · minLength: 1
  approvedAt
  optional
  string
  format: date-time
  tags
  optional
  array of
  string
  maxLength: 80 · minLength: 1 · default: []
  authoringState
  optional
  draft
  or
  ready
  default: "ready"
- session
  object
  required
  state
  profile_required
  or
  entity_required
  or
  reputation_pending
  or
  agent_identity_pending
  or
  accounting_provider_required
  or
  accounting_authorization_required
  +6 more
  required
  nextAction
  complete_profile
  or
  create_entity
  or
  review_reputation
  or
  create_agent_identity
  or
  select_accounting_provider
  or
  authorize_accounting_provider
  +6 more
  or null
  required
  blockingReason
  profile_incomplete
  or
  entity_missing
  or
  admin_operator_link_missing
  or
  reputation_score_unavailable
  or
  agent_identity_not_ready
  or
  accounting_provider_missing
  +5 more
  or null
  required
  updatedAt
  string
  required
  format: date-time
  id
  string
  required
  format: uuid
  userId
  string
  required
  minLength: 1
  startedAt
  string
  required
  format: date-time
  completedSteps
  optional
  array of
  profile_completed
  or
  entity_created
  or
  admin_operator_linked
  or
  reputation_score_initialized
  or
  agent_identity_requested
  or
  agent_identity_registered
  +8 more
  default: []
  entityId
  optional
  string
  or null
  format: uuid
  skippedSteps
  optional
  array of
  company
  or
  accounting
  default: []
  completedAt
  optional
  string
  or null
  format: date-time
  failedAt
  optional
  string
  or null
  format: date-time
  milestones
  optional
  array of
  object
  default: []
  milestone
  profile_completed
  or
  entity_created
  or
  admin_operator_linked
  or
  reputation_score_initialized
  or
  agent_identity_requested
  or
  agent_identity_registered
  +8 more
  required
  completedAt
  string
  required
  format: date-time
  actorUserId
  optional
  string
  or null
  minLength: 1
  entityId
  optional
  string
  or null
  format: uuid
  metadata
  optional
  map of
  unknown
  default: {}
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

422

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}