Ledger Enterprise
API Documentation V2
API Documentation V2
  • Introduction
    • Getting Started
    • Overview
  • Guides
    • Authentication
    • Balance Reporting Bot
      • 1. Project setup
      • 2. Connect to revault-api
      • 3. Fetch accounts balances
      • 4. Conclusion
  • reference
    • API reference
      • Users
      • Accounts
        • Transactions
      • Groups
      • Whitelists
      • Policies
      • Entities
      • Requests
        • Generate registration challenge
        • Confirm registration challenge
        • Challenge
        • Approve
        • Reject
      • Auth
        • Token
          • Refresh
      • Permissions
        • Allowed actions
        • Resources
      • Assets
        • Currencies
        • Tokens
      • Tradelink
        • Network
          • Blueprint
    • Specification
Powered by GitBook
On this page
  1. reference
  2. API reference

Requests

PreviousEntitiesNextGenerate registration challenge

Get a request by ID

get
Authorizations
Path parameters
idstringRequired

Id of the request

Responses
200
Successful response
application/json
Responseany of
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
default
Error response
application/json
get
GET /rest/requests/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "type": "UPDATE_QUORUM",
  "data": {
    "quorum": 1
  },
  "id": "text",
  "legacyId": 1,
  "state": "INITIAL",
  "reviewSteps": [
    {
      "stageName": "text",
      "quorum": 1
    }
  ],
  "currentStepIndex": 1,
  "expiredAt": "2025-05-30T22:36:57.129Z",
  "targetId": "text",
  "reviews": [
    {
      "stepIndex": 1,
      "userId": "text",
      "status": "PENDING",
      "createdAt": "2025-05-30T22:36:57.129Z",
      "updatedAt": "2025-05-30T22:36:57.129Z"
    }
  ],
  "createdAt": "2025-05-30T22:36:57.129Z",
  "updatedAt": "2025-05-30T22:36:57.129Z"
}
  • GETList requests
  • POSTCreate a request
  • GETGet a request by ID

List requests

get
Authorizations
Query parameters
pageany ofOptional

Which page to fetch

Default: 1
notOptional
or
integer · min: 1Optional
pageSizeany ofOptional

Page size to use

Default: 30
notOptional
or
integer · min: 1 · max: 30Optional
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
default
Error response
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": "2025-05-30T22:36:57.129Z",
      "targetId": "text",
      "reviews": [
        {
          "stepIndex": 1,
          "userId": "text",
          "status": "PENDING",
          "createdAt": "2025-05-30T22:36:57.129Z",
          "updatedAt": "2025-05-30T22:36:57.129Z"
        }
      ],
      "createdAt": "2025-05-30T22:36:57.129Z",
      "updatedAt": "2025-05-30T22:36:57.129Z"
    }
  ]
}

Create a request

post
Body
requestany ofRequired
or
or
or
or
or
or
or
or
or
or
or
or
Responses
200
Successful response
application/json
Responseany of
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
default
Error response
application/json
post
POST /rest/requests HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 733

{
  "request": {
    "type": "CREATE_ADMIN",
    "data": {
      "name": "text",
      "deviceType": "PSD",
      "deviceUserId": "text",
      "registration": {
        "subState": "PENDING",
        "deviceData": {
          "name": "text",
          "psdModel": "BLUE",
          "pubKey": "text",
          "confidentialityKey": "text",
          "psdEphemeralKey": "text",
          "psdEphemeralKeyAttestation": {
            "codeHash": "text",
            "attestationPub": "text",
            "certificate": "text",
            "signature": "text"
          }
        },
        "challenge": {
          "challenge": "text",
          "ephemeralPublicKey": "text",
          "ephemeralPublicKeyAttestation": {
            "codeHash": "text",
            "attestationPub": "text",
            "certificate": "text",
            "signature": "text"
          },
          "handshake": "text",
          "handshakeAttestation": {
            "codeHash": "text",
            "attestationPub": "text",
            "certificate": "text",
            "signature": "text"
          },
          "u2fRegisterData": "text",
          "ciphertext": "text",
          "requestId": "text"
        }
      }
    }
  }
}
{
  "type": "UPDATE_QUORUM",
  "data": {
    "quorum": 1
  },
  "id": "text",
  "legacyId": 1,
  "state": "INITIAL",
  "reviewSteps": [
    {
      "stageName": "text",
      "quorum": 1
    }
  ],
  "currentStepIndex": 1,
  "expiredAt": "2025-05-30T22:36:57.129Z",
  "targetId": "text",
  "reviews": [
    {
      "stepIndex": 1,
      "userId": "text",
      "status": "PENDING",
      "createdAt": "2025-05-30T22:36:57.129Z",
      "updatedAt": "2025-05-30T22:36:57.129Z"
    }
  ],
  "createdAt": "2025-05-30T22:36:57.129Z",
  "updatedAt": "2025-05-30T22:36:57.129Z"
}