Ctrl+K

Register Contract Requirement

post/api/v2/internal/organization/{organizationId}/enterprise/{enterpriseId}/contract-requirement

Records that the given enterprise is required to sign the specified contract. Idempotent — re-registering the same requirement is a no-op, and re-registering a contract that has already been signed does not flip the row back to 'required'.

Called by identity-service when a user opts in to Accredited Investor at the enterprise level (see CAAS-1463). The endpoint is unused in production until that consumer ships; see CAAS-1438.

Path Parameters

  • organizationIdstringRequired
    The organization ID
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
    Min length: >= 1 characters
  • enterpriseIdstringRequired
    The enterprise ID
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
    Min length: >= 1 characters

Request Body

contractType string required
The contract that the enterprise is required to sign.
Allowed value: accredited-investor-cl
Example: "accredited-investor-cl"

200 Response

ok boolean required
Allowed value: true

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

401 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

403 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

404 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id