Read an intent

Retrieves an intent identified by the provided handle. If the intent with the provided handle doesn't exist, API will return 404 error.

GET
/intents/{id}

Authorization

AuthorizationBearer <token>

JWT signed by private key. The presence of this token is not mandatory. It becomes required through the configuration of authorization access rules that requires a token to grant access. Once sent, the token is validated for its format, signature and expiration, regardless of the presence of access rules.

In: header

Path Parameters

idaddress | luid

The unique identifier of the record - it is luid or handle (address).

Header Parameters

x-ledger?handle | luid

The unique identifier of ledger in context for multi tenant requests.

Response Body

fetch("http://localhost:3000/v2/intents/string", {
  headers: {
    "x-ledger": "string"
  }
})

{
  "hash": "f586b2bbd8f4a08bcbf180c95e23dccfa2445c00e0b4089ea569fcda7feb0478",
  "data": {
    "handle": "wsXqY3mGjR1Hwb6ttXNSi",
    "claims": [
      {
        "action": "transfer",
        "amount": 10000,
        "source": {
          "custom": {
            "name": "Ole",
            "idType": "nidn",
            "idNumber": "sqW_LI7J",
            "entityType": "individual"
          },
          "handle": "svgs:452203815337@teslabank.io"
        },
        "symbol": {
          "handle": "usd"
        },
        "target": {
          "custom": {
            "name": "Brianne",
            "idType": "nidn",
            "idNumber": "KbSZuIhn",
            "entityType": "individual"
          },
          "handle": "tran:254085257323@minka.io"
        }
      }
    ],
    "schema": "transfer",
    "access": [
      {
        "action": "any",
        "signer": {
          "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
        }
      }
    ],
    "config": {
      "commit": "auto"
    }
  },
  "luid": "$int.-084781dXNN8wWR8D",
  "meta": {
    "proofs": [
      {
        "custom": {
          "moment": "2025-04-02T05:10:31.616Z",
          "status": "created"
        },
        "digest": "c0d2343289ae589204a80587ae6cd7236ec14cb7d07f89c278f681559e0c75cb",
        "method": "ed25519-v2",
        "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
        "result": "HtGj4yUbtcVW03rOR/ghNO7REbTp6HsBPKlTWyZ+tt2k7GJJTdTp2jccH+7xOv4XaXuFVBEXUI4uqgoGT3k5CA=="
      },
      {
        "custom": {
          "moment": "2025-04-02T05:10:31.635Z",
          "status": "pending"
        },
        "digest": "90e6c95ccedfa7dc56389616e096d51fa604a535237c4b21c329a68067614788",
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "result": "aVdagZEOtp8T2U4Nghuj4e8mXAI6rBSVQvuHoxUM6tkezlgZ5v2ATLcDhlxTgHfjZ79j7ovA0Dqvwfqwjr1GBA=="
      },
      {
        "custom": {
          "luid": "$int.-084781dXNN8wWR8D",
          "moment": "2025-04-02T05:10:31.639Z",
          "status": "pending"
        },
        "digest": "daa7350b23e07616d2ac9f0d3520982c3abd85b70d0ccfc91602a6c02a4b81ef",
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "result": "BcJEL0qY7bt4dtGHLb4ydOylqeLILoLIxOt2XZSFK0wb6Mc3FiEtlPv+IGMEviOZ7PFF0LckEsbJUE8C3M0lCg=="
      },
      {
        "custom": {
          "moment": "2025-04-02T05:10:31.667Z",
          "status": "prepared"
        },
        "digest": "43fa135547822b10f22bc5fba7b33d98e64acafa858b6db93bd312bb156a0a7f",
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "result": "Q0HoduFBEEvq6qjd4Xb8HFTts34cz2+0J3sfdTvjWrT7TGs1ICQQrKnKyib4/P0uu+XD2zIQDTbhVGUIg234Ag=="
      },
      {
        "custom": {
          "detail": "Not enough balance",
          "moment": "2025-04-02T05:10:31.713Z",
          "reason": "core.insufficient-balance",
          "status": "failed"
        },
        "digest": "4cff73d6824dfe2dd5249d9c51ad274337b96767db53def2f2b71b45f601a9a1",
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "result": "wpbYLhFX10msv4c9bEtIkC6zjDWfsFdg6fdYbg6Ib+okpX8IibEqPTAb4eXldSVfXAk/g5PqHvq3kV3UfmZHBg=="
      },
      {
        "custom": {
          "moment": "2025-04-02T05:10:31.734Z",
          "status": "aborted"
        },
        "digest": "036082da10138ad51ffc5d89fae70109c12096fa64fe95e31af5e067f5ab7464",
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "result": "NGDXb3XX5kFyzTHJbMPM57WfhzXH+QIxwq0/UwMgttrg6QcM0hPqlN7VRchMvcfQMjCADDizFrPw9cbPaFzYDQ=="
      },
      {
        "custom": {
          "moment": "2025-04-02T05:10:31.775Z",
          "status": "rejected"
        },
        "digest": "4b85e1298d5744b0501b8dd2fdbce71d405b7df1c690209bd2219f397402e598",
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "result": "xg/0MmhQVLNWNYCcZmwE9ElA9TijyvyiZqTdnM9QU1s8VBJ0uYGVZ4xOY5J0WkDpszQ13b4Rt24R8cqTCmi8Bw=="
      },
      {
        "custom": {
          "moment": "2025-04-02T05:10:30.823Z",
          "status": "prepared",
          "operation": "preparation"
        },
        "digest": "919a256a6db06f140ec8b12639c7a4a690669a2b980fef317a9acbfa7fcd938b",
        "method": "ed25519-v2",
        "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
        "result": "uouJICl72n2Ta71CPDlDczIOa2CLfC3YNxhKCLRyF0IW9qsb0HnucIgdkgDWiyG2s/rb+eOHwNa/HpJbHcCCAQ=="
      }
    ],
    "routed": true,
    "status": "rejected",
    "thread": "-08478DZPWqia20ds",
    "moment": "2025-04-02T05:10:31.635Z",
    "owners": [
      "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
    ]
  }
}

{
  "hash": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
  "data": {
    "reason": "auth.unauthorized",
    "detail": "Invalid token."
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "JdK8m5SqXGCiZ1TdXQbCe9ECqwL3Kg1UZxj4r9gT+cA=",
        "digest": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
        "result": "X2m5A9Yxh4FRPgj6wgJKN0dYrfgXSq3hx8UX1jnmJ7fVHtQCnAp8MepXDZQhNkMsJd7a9HPk96hmvYXTFcHzAw=="
      }
    ]
  }
}

{
  "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
  "data": {
    "reason": "auth.forbidden",
    "detail": "Request is not authorized"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
        "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
        "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ=="
      }
    ]
  }
}

{
  "hash": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
  "data": {
    "reason": "record.not-found",
    "detail": "Signer not found"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "7ZMqyx5Lk3PQwNrJvGIs9eT6ahcUKXZ8SbRj4WyF2dQ=",
        "digest": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
        "result": "VFp8RxnT2h+JK9W5/nJfLZdV1uLKXHBL5RwpnbZ4qDz3J1Ks4eOj7y9QVMhmwlIa5AQlNbdT3GJcvH8xo3WhBA=="
      }
    ]
  }
}

{
  "hash": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
  "data": {
    "reason": "record.schema-invalid",
    "detail": "Schema validator error: data.handle must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\"",
    "custom": {
      "errors": [
        {
          "instancePath": "/handle",
          "schemaPath": "#/properties/handle/pattern",
          "keyword": "pattern",
          "params": {
            "pattern": "^[a-zA-Z0-9_\\\\-+.]+$"
          },
          "message": "must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\""
        }
      ]
    }
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "vL8jKxm5PqTnJfEaRs2uOdY7gzX4CS9WbHlN3cAiBV0=",
        "digest": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
        "result": "uYxJLd2QGkEfT8rP7mCn1lHVzBvIaSK4jFqpO5ZwW9oADnMbg6yeiUsvN3tcXj0RwYxkrq5aLm9f4y2Ko8WwDw=="
      }
    ]
  }
}

{
  "hash": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
  "data": {
    "reason": "api.unexpected-error",
    "detail": "An unexpected error occurred"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "KxiLpB3v8VEdmYsT2RwNq5o1Cz9gHJfU4aAySt7D0X8=",
        "digest": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
        "result": "LzRmNh7x5TQYoqjw30BKDaZnbGcFUsX8v4tpEsr9P6iW1dyJkVC2uALfY8HdpM3eX9w0On12cqYxEtveKoFZDQ=="
      }
    ]
  }
}