Skip to main content

Set Lifecycle State

POST 

/identities/:identity-id/set-lifecycle-state

Use this API to set/update an identity's lifecycle state to the one provided and update the corresponding identity profile.

Request

Path Parameters

    identity-id stringrequired

    ID of the identity to update.

    Example: 2c9180857893f1290178944561990364

Body

required

    lifecycleStateId string

    ID of the lifecycle state to set.

Responses

The request was successfully accepted into the system.

Schema

    accountActivityId string

    ID of the IdentityRequest object that is generated when the workflow launches. To follow the IdentityRequest, you can provide this ID with a Get Account Activity request. The response will contain relevant information about the IdentityRequest, such as its status.

Loading...