Create Onboarding Event

Create Onboarding Events #

The create onboarding events endpoint allows you to create new ‘events’ related to an onboarding - An event represents a state change on an onboarding and may be used to reflect what the current state of an onboarding is.

Request #

Method #

Request methodEndpointPath Variable
POST/api/v1/onboardings/:id/eventsid | uuid of the onboarding

Headers #

Authentication
Please see Using a Token for a detailed description of how to authenticate yourself with our API.
NameValue
Content-Typeapplication/json

Body #

KeyDescriptionTypeRequired
statusstatus of the eventenum | string
reasonoptional reason which may be specified to describe the posted status furtherstring🟡

status possible enum values #

status
initiated
data_submitted
review_pending
data_incomplete
credential_issued
revocation_notice
declined
aborted