Onboarding cases

Public case carrying company or individual onboarding, its initial data, and final decision.

Business object

Vue d’ensemble

Onboarding-case endpoints open, retrieve, and close onboarding cases. Creation may start a User Journey according to the associated process definition.

See also the business-model page onboarding_case for semantics, relationships, and functional lifecycle.

Contrat JSON

Objet `onboarding_case`

Responses use the prefixed identifier obc_ and the field object to make the type explicit.

subject_typeenum

`company` or `individual`. Required at creation.

statusenum

`open`, `completed`, or `cancelled`.

decision_statusenum

`pending`, `approved`, or `rejected`.

company_id / contact_idstring

Business objects resolved by the case.

process_instance_idstring

Process instance currently driving the case.

process_statusenum

State derived from the associated instance; independent from the case status and business decision.

initial_dataobject

Prefill data or business context.

dedupe_keystring

Optional business deduplication key.

REST

Endpoints

Method	Endpoint	Usage
POST	`/v1/onboarding-cases`	Open a case.
GET	`/v1/onboarding-cases`	List cases, with filters for `merchant_id`, `status`, `decision_status`, `subject_type`, `company_id`, `contact_id`, or `dedupe_key`.
GET	`/v1/onboarding-cases/search`	Find the latest completed and approved case for a company.
GET	`/v1/onboarding-cases/{id}`	Retrieve a case with its checks.
POST	`/v1/onboarding-cases/{id}`	Update or close the case.

Events

Associated events

These events can be consumed through platform webhooks when the account is configured to receive them.

onboarding_case.completedonboarding_case.rejected

Behavior

Points d’attention

A finalized case can no longer be updated.
An approved company case must be attached to a company.
An approved individual case must be attached to a company and contact.
A retry, corrective fork, or resumed hosted step may replace `process_instance_id` with a new instance without automatically changing `status` or `decision_status`.