Conveyancing

Prepare a sandbox conveyancing matter review action

Prepares a deterministic sandbox matter-update draft or document-request checklist when the authenticated automation client has conveyancing.matters.write, sends confirm_prepare: true, and provides an Idempotency-Key. External URL: /v1/conveyancing/matters/{id}/actions. Current Next.js implementation path: /api/platform/v1/conveyancing/matters/[id]/actions. The route accepts only prepare_matter_update_draft and prepare_document_request_checklist, requires an active sandbox matter and responsible-lawyer review, and exposes no API confirmation or execution route. It never mutates the matter, submits documents or e-stamping, releases funds, handles client money, returns legal or tax action, exposes sensitive fields, or calls an external system. Unsupported writes fail strict request validation. Conveyancing pilot posture remains marketplace orchestration only, legal advice and client-money or trust-account handling remain deferred, and partner-status publication remains private-first.

post/conveyancing/matters/{id}/actions

Request

  • Base URL: https://platform-api.homejourney.sg/v1
  • URL: https://platform-api.homejourney.sg/v1/conveyancing/matters/{id}/actions
  • Auth: HTTP bearer

Path parameters

idstring required

Sandbox transaction/conveyancing matter fixture ID.

Headers

X-Correlation-Idstring

Optional partner-provided correlation ID echoed into request evidence.

Idempotency-Keystring required

Required for mutating platform routes. Accepted format: 8 to 128 ASCII characters matching [A-Za-z0-9._:-]+.

Request body

action'prepare_matter_update_draft' | 'prepare_document_request_checklist' required
confirm_preparetrue required

Must be true to prepare review-only sandbox output.

Response

Sandbox transaction/conveyancing response.

oktrue required
action'prepare_matter_update_draft' | 'prepare_document_request_checklist' required
action_idstring required
status'prepared' required
required_scope'conveyancing.matters.write' required
idempotency_requiredtrue required
livemodefalse required
request_idstring required

Changes

No recorded changes to this operation across all 1 revision of this API.