Skip to main content

Delete User Account by ID

DELETE 
/v1/users/accounts/:id

Delete an user account. User account must have no operations registered. If not, it will be performed a soft delete.

Request​

Path Parameters

    id stringrequired

    User account ID.

Header Parameters

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

    x-product-uuid stringrequired

    The product ID is a UUID (v4) used to identify the Z.ro product configuration.

    x-product-target-user-uuid string

    The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Responses​

User account deleted.

Schema
    id stringrequired

    User account ID.

    state stringrequired

    Possible values: [pending, active, expired, deactivated]

    User state.

    created_at date-timerequired

    User created date.

    updated_at date-timerequired

    User updated date.

    deleted_at date-timerequired

    User deleted date.

Loading...