Requests | Ledger Enterprise

Ledger Enterprise

Get request by id

get

This method returns the request that matches the entered ID + the corresponding challenge.

Authorizations

Path parameters

request_idintegerRequired

The request's ID.

Responses

200

Request object with corresponding challenge

application/json

404

RequestWithChallenge not found

application/json

get

GET /requests/{request_id} HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*

{
  "challenge": "{\"challenge\":\"eyJhbnRpcmVwbGF5IjoiQUM4NjY3QTU1Qjc0REQwMDI4QkU1N0YzMzBGNjVCQ0Y1M0UyODkzMDc4MzRBQkQxQ0VDNkYyOUFFNTIwNkI5MSIsImRhdGEiOnsidHJhbnNhY3Rpb25fZGF0YSI6eyJhY2NvdW50X25hbWUiOiJteSBidGMgYWNjb3VudCIsImFtb3VudCI6IjEwMDAiLCJjdXJyZW5jeSI6ImJpdGNvaW4gdGVzdG5ldCIsIm1heF9mZWVzIjoiNDAxOCIsInJlY2lwaWVudCI6InRiMXF5N3M5YzJ4d3F5NHF5dmowa3lxN2g1Z2g0cnhnZGxqZHMwdDludiJ9LCJ0cmFuc2FjdGlvbl90eXBlIjoiQklUQ09JTl9MSUtFX1NFTkQifSwidHlwZSI6IkFQUFJPVkVfVFJBTlNBQ1RJT04ifQ\",\"id\":6}",
  "created_by": 12,
  "created_on": "2025-05-30T17:43:13.103Z",
  "expires_at": "2025-05-30T17:43:13.103Z",
  "id": 1,
  "status": "PENDING_APPROVAL",
  "target_id": 10,
  "target_type": "TRANSACTION",
  "type": "CREATE_TRANSACTION",
  "used_admin_group": 1
}

Create Request

post

Use the following parameters to create a request.

Authorizations

Body

any ofOptional

Responses

200

Request result

application/json

400

Invalid request data

application/json

post

POST /requests HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 392

{
  "data": {
    "account_id": "101",
    "fees_strategy": {
      "data": {
        "fees_per_byte": "30"
      },
      "type": "CUSTOM"
    },
    "transaction_data": {
      "account_name": "ETH Wallet 1",
      "amount": "1267887898998",
      "currency": "bitcoin",
      "max_fees": "123908790",
      "recipient": "0x1234...abcd"
    },
    "transaction_type": "BITCOIN_LIKE_SEND"
  },
  "note": {
    "content": "some information about this transaction",
    "title": "a note title"
  },
  "type": "CREATE_TRANSACTION"
}

{
  "created_by": "{\"id\"=3}",
  "created_on": "2025-05-30T17:43:13.103Z",
  "expired_at": "2025-05-30T17:43:13.103Z",
  "id": 1,
  "status": "PENDING_APPROVAL",
  "target_id": 10,
  "target_type": "TEZOS_LIKE_TRANSACTION",
  "type": "CREATE_TRANSACTION",
  "used_admin_group": 1
}

List requests

get

Authorizations

Query parameters

pageinteger · min: 1Optional

Which page to fetch

Default: 1

pageSizeinteger · min: 1 · max: 30Optional

Page size to use

Default: 30

typestring · enumOptional

Search by request type

Possible values:

statestring · enumOptional

Search by request state

Possible values:

createdBystringOptional

reviewedBystringOptional

pendingBystringOptional

sortBystring · enumOptional

Sort by attribute

Default: createdAtPossible values:

sortOrderstring · enumOptional

Sort order

Default: ascPossible values:

Responses

200

Successful response

application/json

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

GET /rest/requests HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "page": 1,
  "next": 1,
  "prev": 1,
  "pageSize": 1,
  "total": 1,
  "results": [
    {
      "type": "UPDATE_QUORUM",
      "data": {
        "quorum": 1
      },
      "id": "text",
      "legacyId": 1,
      "state": "INITIAL",
      "reviewSteps": [
        {
          "stageName": "text",
          "quorum": 1
        }
      ],
      "currentStepIndex": 1,
      "expiredAt": "text",
      "targetId": "text",
      "note": {
        "title": "text",
        "content": "text"
      },
      "reviews": [
        {
          "stepIndex": 1,
          "userId": "text",
          "status": "PENDING",
          "createdAt": "text",
          "updatedAt": "text"
        }
      ],
      "createdAt": "text",
      "updatedAt": "text"
    }
  ]
}