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 method | Endpoint | Path Variable |
|---|
POST | /api/v1/onboardings/:id/events | id | uuid of the onboarding |
Authentication
Please see Using a Token for a detailed description of how to authenticate yourself with our API.
| Name | Value |
|---|
Content-Type | application/json |
Authorization | Bearer [token] |
Body
#
| Key | Description | Type | Required |
|---|
status | status of the event | enum | string | ✅ |
reason | optional reason which may be specified to describe the posted status further | string | 🟡 |
status possible enum values
#
| status |
|---|
initiated |
data_submitted |
review_pending |
data_incomplete |
credential_issued |
revocation_notice |
declined |
aborted |