Create an unstake request

post https://your-protect-instance.example.com/api/rest/v1/requests/outgoing/xtz/unstake

This endpoint creates an outgoing unstake request for XTZ.
Required role: RequestCreator.extractRequestEntity

Responses

Response body

object

result

object

string

Unique identifier for the request.

tenantId

string

The ID of the Protect tenant where the request was created.

currency

string

The currency of the request.

envelope

string

This field is used internally by Protect for request signing and approvals. This field is signed and encrypted.

status

string

The status of the request. One of the following: CREATED, APPROVING, HSM_SIGNED, BROADCASTING, BROADCASTED, CONFIRMED, REJECTED

trails

array of objects

trails

object

string

ID for the event record.

userId

string

The ID of the user related to the audit event. For events that are not triggered by a user, 1 is used.

externalUserId

string

The external ID of the user related to the audit event. E.g., validator-core@taurusgroup.com corrosponds to user ID 1

action

string

The event being logged. E.g., broadcasting, hsm_signed, hsm_ready, approved, etc...

comment

string

Some more details about the event. This could be the transaction hash, or the ID or an error code associated with the event.

date

date-time

requestStatus

string

The status of the request at the time of the event. One of the following: CREATED, APPROVING, APPROVED, HSM_SIGNED, HSM_READY, BROADCASTING, BROADCASTED, CONFIRMED, REJECTED

signedRequests

array of objects

signedRequests

object

string

signedRequest

string

status

string

hash

string

block

int64

details

string

creationDate

date-time

updateDate

date-time

broadcastDate

date-time

confirmationDate

date-time

attributes

array of objects

attributes

object

string

key

string

value

string

contentType

string

creationDate

date-time

updateDate

date-time

metadata

object

attributes

array of objects

attributes

object

string

key

string

value

string

contentType

string

rule

string

approvers

object

type

string

Value used internally to distinguish between different types of blockchain transactions (e.g., staking, unstaking, transfer, delegate, etc)

currencyInfo

object

needsApprovalFrom

array of strings

List of groups that the request needs approval from.

needsApprovalFrom

requestBundleId

string

The ID of the request bundle. For more information on request bundles, see the our docs.

externalRequestId

string

Identifier for the request in the user's system. This must be unique.

travelRuleDataInput

object

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://your-protect-instance.example.com/api/rest/v1/requests/outgoing/xtz/unstake \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.

400Bad Request: indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, or deceptive request routing)

401Unauthorized: indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource

403Forbidden: indicates that the server understands the request but refuses to authorize it

404Not Found: indicates that the server cannot find the requested resource

500Internal Server Error: indicates that the server encountered an unexpected condition that prevented it from fulfilling the request

503Service Unavailable: indicates that the server is not ready to handle the request.

defaultAn unexpected error response.