Onboarding cases

Dossier public qui porte un onboarding company ou individual, ses données initiales et sa décision finale.

Objet métier

Vue d’ensemble

Les endpoints onboarding cases ouvrent, consultent et clôturent les dossiers d’onboarding. La création peut déclencher un parcours utilisateur selon la définition de processus associée.

Voir aussi la page du modèle métier onboarding_case pour la sémantique, les relations et le cycle de vie fonctionnel.

Contrat JSON

Objet `onboarding_case`

Les réponses utilisent l’identifiant préfixé obc_ et le champ object pour rendre le type explicite.

subject_typeenum

company ou individual. Requis à la création.

statusenum

open, completed ou cancelled.

decision_statusenum

pending, approved ou rejected.

company_id / contact_idstring

Objets métier résolus par le dossier.

process_instance_idstring

Instance de processus qui pilote actuellement le dossier.

process_statusenum

État dérivé de l’instance associée ; indépendant du statut et de la décision métier.

initial_dataobject

Données de préremplissage ou contexte métier.

dedupe_keystring

Clé métier optionnelle de déduplication.

REST

Endpoints

Méthode	Endpoint	Usage
POST	`/v1/onboarding-cases`	Ouvrir un dossier.
GET	`/v1/onboarding-cases`	Lister les dossiers, avec filtres merchant_id, status, decision_status, subject_type, company_id, contact_id ou dedupe_key.
GET	`/v1/onboarding-cases/search`	Retrouver le dernier dossier completed et approved pour une company.
GET	`/v1/onboarding-cases/{id}`	Récupérer un dossier avec ses checks.
POST	`/v1/onboarding-cases/{id}`	Mettre à jour ou clôturer le dossier.

Événements

Événements associés

Ces événements peuvent être consommés via les webhooks plateforme lorsque le compte est configuré pour les recevoir.

onboarding_case.completedonboarding_case.rejected

Comportement

Points d’attention

Un dossier finalisé ne peut plus être mis à jour.
Un dossier company approuvé doit être rattaché à une company.
Un dossier individual approuvé doit être rattaché à une company et à un contact.
Un retry, un fork correctif ou la reprise d’une étape hébergée peut remplacer process_instance_id par une nouvelle instance sans modifier automatiquement status ou decision_status.