Onboarding

Submit onboarding evidence

Records sandbox partner-submitted support-owner, business-authority, business-eligibility, or contract-signature evidence for service-provider onboarding and returns refreshed readiness. External URL: /v1/onboarding/evidence. Current Next.js implementation path: /api/platform/v1/onboarding/evidence. This sandbox-only mutating route requires Idempotency-Key and onboarding.write, requires current terms acceptance first, records partner assertions for manual live review, and never creates live credentials or bypasses operator approval. Business-eligibility submissions are cross-checked against the ACRA registered-entities dataset on data.gov.sg: a missing or de-registered UEN is rejected with the acra_registered_business gate, while a name mismatch or upstream outage is recorded for manual review.

post/onboarding/evidence

Request

  • Base URL: https://platform-api.homejourney.sg/v1
  • URL: https://platform-api.homejourney.sg/v1/onboarding/evidence
  • Auth: HTTP bearer

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

OR
OR
OR

Response

Partner-submitted evidence record and refreshed readiness contract. Live access still requires manual review.

idempotency_key_hashstring required
livemodefalse required
request_idstring required

Changes

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