Aller au contenu principal

API Onboarding

Ressources SANDBOX​

➡️ Swagger Tenant Public API
➡️ Télécharger la collection Postman Onboarding
➡️ Ouvrir dans Postman ↗

Les API d'onboarding sont exposées par la Tenant Public API et permettent de créer les unités légales rattachées à un tenant puis de piloter leur parcours d'onboarding.

Cette API est spécifique à myBCS / BCSolutions : elle ne correspond pas à une API AFNOR.

Principales opérations​

  • créer une unité légale racine ;
  • lister et consulter les unités légales ;
  • démarrer ou reprendre un onboarding ;
  • consulter l'état courant ;
  • consulter l'historique de progression ;
  • redémarrer un onboarding expiré ;
  • demander la clôture et la réconciliation du parcours.

Routes principales​

POST /v1/onboarding/legal-units
GET  /v1/onboarding/legal-units
GET  /v1/onboarding/legal-units/{legalUnitId}
POST /v1/onboarding/legal-units/{legalUnitId}/start
GET  /v1/onboarding/legal-units/{legalUnitId}/state
GET  /v1/onboarding/legal-units/{legalUnitId}/history
POST /v1/onboarding/legal-units/{legalUnitId}/restart
POST /v1/onboarding/legal-units/{legalUnitId}/close