Skip to main content
PATCH
Cancel an Entity Onboarding Request

Authorizations

Authorization
string
header
required

Access Token Authentication

Path Parameters

onboardingRequestId
string<uuid>
required

The id of the Entity Onboarding Request

Response

OK

Represents an onboarding request

action
object

Represents an action for an onboarding request

created
string<date-time>

The date and time the onboarding request was created.

data
object

Represents the data of an onboarding request

id
string<uuid>

The id of the onboarding request

principalId
string<uuid>

The id of the principal that initiated the onboarding request

requestType
enum<string>
Available options:
Collective,
Entity
returnUrl
string | null

The url where the User will be redirected to after completing the consent flow on the OEM page.

status
enum<string>
Available options:
Canceled,
Failed,
InProgress,
Pending,
Succeeded
errors
object[] | null

Errors that occurred during the processing of the onboarding request