@cheqd/studio 3.0.0-develop.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (654) hide show
  1. package/LICENSE +190 -0
  2. package/README.md +246 -0
  3. package/dist/app.d.ts +4 -0
  4. package/dist/app.d.ts.map +1 -0
  5. package/dist/app.js +180 -0
  6. package/dist/app.js.map +1 -0
  7. package/dist/controllers/admin/api-key.d.ts +153 -0
  8. package/dist/controllers/admin/api-key.d.ts.map +1 -0
  9. package/dist/controllers/admin/api-key.js +389 -0
  10. package/dist/controllers/admin/api-key.js.map +1 -0
  11. package/dist/controllers/admin/organisation.d.ts +72 -0
  12. package/dist/controllers/admin/organisation.d.ts.map +1 -0
  13. package/dist/controllers/admin/organisation.js +139 -0
  14. package/dist/controllers/admin/organisation.js.map +1 -0
  15. package/dist/controllers/admin/prices.d.ts +37 -0
  16. package/dist/controllers/admin/prices.d.ts.map +1 -0
  17. package/dist/controllers/admin/prices.js +75 -0
  18. package/dist/controllers/admin/prices.js.map +1 -0
  19. package/dist/controllers/admin/product.d.ts +90 -0
  20. package/dist/controllers/admin/product.d.ts.map +1 -0
  21. package/dist/controllers/admin/product.js +187 -0
  22. package/dist/controllers/admin/product.js.map +1 -0
  23. package/dist/controllers/admin/subscriptions.d.ts +183 -0
  24. package/dist/controllers/admin/subscriptions.d.ts.map +1 -0
  25. package/dist/controllers/admin/subscriptions.js +512 -0
  26. package/dist/controllers/admin/subscriptions.js.map +1 -0
  27. package/dist/controllers/admin/webhook.d.ts +5 -0
  28. package/dist/controllers/admin/webhook.d.ts.map +1 -0
  29. package/dist/controllers/admin/webhook.js +90 -0
  30. package/dist/controllers/admin/webhook.js.map +1 -0
  31. package/dist/controllers/api/account.d.ts +84 -0
  32. package/dist/controllers/api/account.d.ts.map +1 -0
  33. package/dist/controllers/api/account.js +442 -0
  34. package/dist/controllers/api/account.js.map +1 -0
  35. package/dist/controllers/api/credential-status.d.ts +257 -0
  36. package/dist/controllers/api/credential-status.d.ts.map +1 -0
  37. package/dist/controllers/api/credential-status.js +1080 -0
  38. package/dist/controllers/api/credential-status.js.map +1 -0
  39. package/dist/controllers/api/credential.d.ts +207 -0
  40. package/dist/controllers/api/credential.d.ts.map +1 -0
  41. package/dist/controllers/api/credential.js +527 -0
  42. package/dist/controllers/api/credential.js.map +1 -0
  43. package/dist/controllers/api/did.d.ts +259 -0
  44. package/dist/controllers/api/did.d.ts.map +1 -0
  45. package/dist/controllers/api/did.js +673 -0
  46. package/dist/controllers/api/did.js.map +1 -0
  47. package/dist/controllers/api/key.d.ts +136 -0
  48. package/dist/controllers/api/key.d.ts.map +1 -0
  49. package/dist/controllers/api/key.js +268 -0
  50. package/dist/controllers/api/key.js.map +1 -0
  51. package/dist/controllers/api/presentation.d.ts +87 -0
  52. package/dist/controllers/api/presentation.d.ts.map +1 -0
  53. package/dist/controllers/api/presentation.js +264 -0
  54. package/dist/controllers/api/presentation.js.map +1 -0
  55. package/dist/controllers/api/resource.d.ts +118 -0
  56. package/dist/controllers/api/resource.d.ts.map +1 -0
  57. package/dist/controllers/api/resource.js +312 -0
  58. package/dist/controllers/api/resource.js.map +1 -0
  59. package/dist/controllers/validator/controller.d.ts +7 -0
  60. package/dist/controllers/validator/controller.d.ts.map +1 -0
  61. package/dist/controllers/validator/controller.js +31 -0
  62. package/dist/controllers/validator/controller.js.map +1 -0
  63. package/dist/controllers/validator/credential-status.d.ts +6 -0
  64. package/dist/controllers/validator/credential-status.d.ts.map +1 -0
  65. package/dist/controllers/validator/credential-status.js +36 -0
  66. package/dist/controllers/validator/credential-status.js.map +1 -0
  67. package/dist/controllers/validator/credential.d.ts +9 -0
  68. package/dist/controllers/validator/credential.d.ts.map +1 -0
  69. package/dist/controllers/validator/credential.js +103 -0
  70. package/dist/controllers/validator/credential.js.map +1 -0
  71. package/dist/controllers/validator/decorator.d.ts +2 -0
  72. package/dist/controllers/validator/decorator.d.ts.map +1 -0
  73. package/dist/controllers/validator/decorator.js +25 -0
  74. package/dist/controllers/validator/decorator.js.map +1 -0
  75. package/dist/controllers/validator/did-also-known-as.d.ts +8 -0
  76. package/dist/controllers/validator/did-also-known-as.d.ts.map +1 -0
  77. package/dist/controllers/validator/did-also-known-as.js +31 -0
  78. package/dist/controllers/validator/did-also-known-as.js.map +1 -0
  79. package/dist/controllers/validator/did-array.d.ts +7 -0
  80. package/dist/controllers/validator/did-array.d.ts.map +1 -0
  81. package/dist/controllers/validator/did-array.js +27 -0
  82. package/dist/controllers/validator/did-array.js.map +1 -0
  83. package/dist/controllers/validator/did-document-section-id.d.ts +7 -0
  84. package/dist/controllers/validator/did-document-section-id.d.ts.map +1 -0
  85. package/dist/controllers/validator/did-document-section-id.js +43 -0
  86. package/dist/controllers/validator/did-document-section-id.js.map +1 -0
  87. package/dist/controllers/validator/did-document.d.ts +11 -0
  88. package/dist/controllers/validator/did-document.d.ts.map +1 -0
  89. package/dist/controllers/validator/did-document.js +96 -0
  90. package/dist/controllers/validator/did-document.js.map +1 -0
  91. package/dist/controllers/validator/did-uri.d.ts +5 -0
  92. package/dist/controllers/validator/did-uri.d.ts.map +1 -0
  93. package/dist/controllers/validator/did-uri.js +14 -0
  94. package/dist/controllers/validator/did-uri.js.map +1 -0
  95. package/dist/controllers/validator/did.d.ts +35 -0
  96. package/dist/controllers/validator/did.d.ts.map +1 -0
  97. package/dist/controllers/validator/did.js +233 -0
  98. package/dist/controllers/validator/did.js.map +1 -0
  99. package/dist/controllers/validator/helpers.d.ts +7 -0
  100. package/dist/controllers/validator/helpers.d.ts.map +1 -0
  101. package/dist/controllers/validator/helpers.js +6 -0
  102. package/dist/controllers/validator/helpers.js.map +1 -0
  103. package/dist/controllers/validator/identifier.d.ts +20 -0
  104. package/dist/controllers/validator/identifier.d.ts.map +1 -0
  105. package/dist/controllers/validator/identifier.js +100 -0
  106. package/dist/controllers/validator/identifier.js.map +1 -0
  107. package/dist/controllers/validator/index.d.ts +42 -0
  108. package/dist/controllers/validator/index.d.ts.map +1 -0
  109. package/dist/controllers/validator/index.js +90 -0
  110. package/dist/controllers/validator/index.js.map +1 -0
  111. package/dist/controllers/validator/jsonld-proof.d.ts +5 -0
  112. package/dist/controllers/validator/jsonld-proof.d.ts.map +1 -0
  113. package/dist/controllers/validator/jsonld-proof.js +50 -0
  114. package/dist/controllers/validator/jsonld-proof.js.map +1 -0
  115. package/dist/controllers/validator/jwt-proof.d.ts +5 -0
  116. package/dist/controllers/validator/jwt-proof.d.ts.map +1 -0
  117. package/dist/controllers/validator/jwt-proof.js +45 -0
  118. package/dist/controllers/validator/jwt-proof.js.map +1 -0
  119. package/dist/controllers/validator/presentation.d.ts +9 -0
  120. package/dist/controllers/validator/presentation.d.ts.map +1 -0
  121. package/dist/controllers/validator/presentation.js +96 -0
  122. package/dist/controllers/validator/presentation.js.map +1 -0
  123. package/dist/controllers/validator/resource-also-known-as.d.ts +7 -0
  124. package/dist/controllers/validator/resource-also-known-as.d.ts.map +1 -0
  125. package/dist/controllers/validator/resource-also-known-as.js +47 -0
  126. package/dist/controllers/validator/resource-also-known-as.js.map +1 -0
  127. package/dist/controllers/validator/service-create-request.d.ts +10 -0
  128. package/dist/controllers/validator/service-create-request.d.ts.map +1 -0
  129. package/dist/controllers/validator/service-create-request.js +63 -0
  130. package/dist/controllers/validator/service-create-request.js.map +1 -0
  131. package/dist/controllers/validator/service.d.ts +11 -0
  132. package/dist/controllers/validator/service.d.ts.map +1 -0
  133. package/dist/controllers/validator/service.js +76 -0
  134. package/dist/controllers/validator/service.js.map +1 -0
  135. package/dist/controllers/validator/utils.d.ts +3 -0
  136. package/dist/controllers/validator/utils.d.ts.map +1 -0
  137. package/dist/controllers/validator/utils.js +21 -0
  138. package/dist/controllers/validator/utils.js.map +1 -0
  139. package/dist/controllers/validator/validator.d.ts +20 -0
  140. package/dist/controllers/validator/validator.d.ts.map +1 -0
  141. package/dist/controllers/validator/validator.js +2 -0
  142. package/dist/controllers/validator/validator.js.map +1 -0
  143. package/dist/controllers/validator/verification-method.d.ts +30 -0
  144. package/dist/controllers/validator/verification-method.d.ts.map +1 -0
  145. package/dist/controllers/validator/verification-method.js +211 -0
  146. package/dist/controllers/validator/verification-method.js.map +1 -0
  147. package/dist/database/connection/connection.d.ts +9 -0
  148. package/dist/database/connection/connection.d.ts.map +1 -0
  149. package/dist/database/connection/connection.js +27 -0
  150. package/dist/database/connection/connection.js.map +1 -0
  151. package/dist/database/entities/api.key.entity.d.ts +18 -0
  152. package/dist/database/entities/api.key.entity.d.ts.map +1 -0
  153. package/dist/database/entities/api.key.entity.js +102 -0
  154. package/dist/database/entities/api.key.entity.js.map +1 -0
  155. package/dist/database/entities/coin.entity.d.ts +11 -0
  156. package/dist/database/entities/coin.entity.d.ts.map +1 -0
  157. package/dist/database/entities/coin.entity.js +66 -0
  158. package/dist/database/entities/coin.entity.js.map +1 -0
  159. package/dist/database/entities/customer.entity.d.ts +14 -0
  160. package/dist/database/entities/customer.entity.d.ts.map +1 -0
  161. package/dist/database/entities/customer.entity.js +87 -0
  162. package/dist/database/entities/customer.entity.js.map +1 -0
  163. package/dist/database/entities/identifier.entity.d.ts +7 -0
  164. package/dist/database/entities/identifier.entity.d.ts.map +1 -0
  165. package/dist/database/entities/identifier.entity.js +26 -0
  166. package/dist/database/entities/identifier.entity.js.map +1 -0
  167. package/dist/database/entities/key.entity.d.ts +13 -0
  168. package/dist/database/entities/key.entity.d.ts.map +1 -0
  169. package/dist/database/entities/key.entity.js +63 -0
  170. package/dist/database/entities/key.entity.js.map +1 -0
  171. package/dist/database/entities/operation.entity.d.ts +17 -0
  172. package/dist/database/entities/operation.entity.d.ts.map +1 -0
  173. package/dist/database/entities/operation.entity.js +98 -0
  174. package/dist/database/entities/operation.entity.js.map +1 -0
  175. package/dist/database/entities/payment.account.entity.d.ts +16 -0
  176. package/dist/database/entities/payment.account.entity.d.ts.map +1 -0
  177. package/dist/database/entities/payment.account.entity.js +86 -0
  178. package/dist/database/entities/payment.account.entity.js.map +1 -0
  179. package/dist/database/entities/payment.entity.d.ts +20 -0
  180. package/dist/database/entities/payment.entity.d.ts.map +1 -0
  181. package/dist/database/entities/payment.entity.js +103 -0
  182. package/dist/database/entities/payment.entity.js.map +1 -0
  183. package/dist/database/entities/resource.entity.d.ts +21 -0
  184. package/dist/database/entities/resource.entity.d.ts.map +1 -0
  185. package/dist/database/entities/resource.entity.js +117 -0
  186. package/dist/database/entities/resource.entity.js.map +1 -0
  187. package/dist/database/entities/role.entity.d.ts +7 -0
  188. package/dist/database/entities/role.entity.d.ts.map +1 -0
  189. package/dist/database/entities/role.entity.js +60 -0
  190. package/dist/database/entities/role.entity.js.map +1 -0
  191. package/dist/database/entities/subscription.entity.d.ts +16 -0
  192. package/dist/database/entities/subscription.entity.d.ts.map +1 -0
  193. package/dist/database/entities/subscription.entity.js +102 -0
  194. package/dist/database/entities/subscription.entity.js.map +1 -0
  195. package/dist/database/entities/user.entity.d.ts +13 -0
  196. package/dist/database/entities/user.entity.d.ts.map +1 -0
  197. package/dist/database/entities/user.entity.js +67 -0
  198. package/dist/database/entities/user.entity.js.map +1 -0
  199. package/dist/database/migrations/AlterAPIKeyTable.d.ts +6 -0
  200. package/dist/database/migrations/AlterAPIKeyTable.d.ts.map +1 -0
  201. package/dist/database/migrations/AlterAPIKeyTable.js +51 -0
  202. package/dist/database/migrations/AlterAPIKeyTable.js.map +1 -0
  203. package/dist/database/migrations/AlterCustomerTable.d.ts +6 -0
  204. package/dist/database/migrations/AlterCustomerTable.d.ts.map +1 -0
  205. package/dist/database/migrations/AlterCustomerTable.js +15 -0
  206. package/dist/database/migrations/AlterCustomerTable.js.map +1 -0
  207. package/dist/database/migrations/AlterCustomerTableAddEmail.d.ts +6 -0
  208. package/dist/database/migrations/AlterCustomerTableAddEmail.d.ts.map +1 -0
  209. package/dist/database/migrations/AlterCustomerTableAddEmail.js +20 -0
  210. package/dist/database/migrations/AlterCustomerTableAddEmail.js.map +1 -0
  211. package/dist/database/migrations/AlterOperationTable.d.ts +6 -0
  212. package/dist/database/migrations/AlterOperationTable.d.ts.map +1 -0
  213. package/dist/database/migrations/AlterOperationTable.js +38 -0
  214. package/dist/database/migrations/AlterOperationTable.js.map +1 -0
  215. package/dist/database/migrations/AlterOperationTableAddCustomer.d.ts +6 -0
  216. package/dist/database/migrations/AlterOperationTableAddCustomer.d.ts.map +1 -0
  217. package/dist/database/migrations/AlterOperationTableAddCustomer.js +22 -0
  218. package/dist/database/migrations/AlterOperationTableAddCustomer.js.map +1 -0
  219. package/dist/database/migrations/AlterOperationTableNewCategory.d.ts +6 -0
  220. package/dist/database/migrations/AlterOperationTableNewCategory.d.ts.map +1 -0
  221. package/dist/database/migrations/AlterOperationTableNewCategory.js +17 -0
  222. package/dist/database/migrations/AlterOperationTableNewCategory.js.map +1 -0
  223. package/dist/database/migrations/AlterPaymentTable.d.ts +6 -0
  224. package/dist/database/migrations/AlterPaymentTable.d.ts.map +1 -0
  225. package/dist/database/migrations/AlterPaymentTable.js +61 -0
  226. package/dist/database/migrations/AlterPaymentTable.js.map +1 -0
  227. package/dist/database/migrations/AlterTableClaim.d.ts +6 -0
  228. package/dist/database/migrations/AlterTableClaim.d.ts.map +1 -0
  229. package/dist/database/migrations/AlterTableClaim.js +21 -0
  230. package/dist/database/migrations/AlterTableClaim.js.map +1 -0
  231. package/dist/database/migrations/AlterTableIdentifier.d.ts +6 -0
  232. package/dist/database/migrations/AlterTableIdentifier.d.ts.map +1 -0
  233. package/dist/database/migrations/AlterTableIdentifier.js +21 -0
  234. package/dist/database/migrations/AlterTableIdentifier.js.map +1 -0
  235. package/dist/database/migrations/AlterTableKey.d.ts +6 -0
  236. package/dist/database/migrations/AlterTableKey.d.ts.map +1 -0
  237. package/dist/database/migrations/AlterTableKey.js +36 -0
  238. package/dist/database/migrations/AlterTableKey.js.map +1 -0
  239. package/dist/database/migrations/CreateApiKeyMigration.d.ts +6 -0
  240. package/dist/database/migrations/CreateApiKeyMigration.d.ts.map +1 -0
  241. package/dist/database/migrations/CreateApiKeyMigration.js +40 -0
  242. package/dist/database/migrations/CreateApiKeyMigration.js.map +1 -0
  243. package/dist/database/migrations/CreateCoinTable.d.ts +6 -0
  244. package/dist/database/migrations/CreateCoinTable.d.ts.map +1 -0
  245. package/dist/database/migrations/CreateCoinTable.js +20 -0
  246. package/dist/database/migrations/CreateCoinTable.js.map +1 -0
  247. package/dist/database/migrations/CreateCustomerTable.d.ts +6 -0
  248. package/dist/database/migrations/CreateCustomerTable.d.ts.map +1 -0
  249. package/dist/database/migrations/CreateCustomerTable.js +24 -0
  250. package/dist/database/migrations/CreateCustomerTable.js.map +1 -0
  251. package/dist/database/migrations/CreateCustomersTable.d.ts +6 -0
  252. package/dist/database/migrations/CreateCustomersTable.d.ts.map +1 -0
  253. package/dist/database/migrations/CreateCustomersTable.js +21 -0
  254. package/dist/database/migrations/CreateCustomersTable.js.map +1 -0
  255. package/dist/database/migrations/CreateOperationTable.d.ts +6 -0
  256. package/dist/database/migrations/CreateOperationTable.d.ts.map +1 -0
  257. package/dist/database/migrations/CreateOperationTable.js +28 -0
  258. package/dist/database/migrations/CreateOperationTable.js.map +1 -0
  259. package/dist/database/migrations/CreatePaymentAccountTable.d.ts +6 -0
  260. package/dist/database/migrations/CreatePaymentAccountTable.d.ts.map +1 -0
  261. package/dist/database/migrations/CreatePaymentAccountTable.js +35 -0
  262. package/dist/database/migrations/CreatePaymentAccountTable.js.map +1 -0
  263. package/dist/database/migrations/CreatePaymentTable.d.ts +6 -0
  264. package/dist/database/migrations/CreatePaymentTable.d.ts.map +1 -0
  265. package/dist/database/migrations/CreatePaymentTable.js +55 -0
  266. package/dist/database/migrations/CreatePaymentTable.js.map +1 -0
  267. package/dist/database/migrations/CreateResourceTable.d.ts +6 -0
  268. package/dist/database/migrations/CreateResourceTable.d.ts.map +1 -0
  269. package/dist/database/migrations/CreateResourceTable.js +46 -0
  270. package/dist/database/migrations/CreateResourceTable.js.map +1 -0
  271. package/dist/database/migrations/CreateRoleTable.d.ts +6 -0
  272. package/dist/database/migrations/CreateRoleTable.d.ts.map +1 -0
  273. package/dist/database/migrations/CreateRoleTable.js +25 -0
  274. package/dist/database/migrations/CreateRoleTable.js.map +1 -0
  275. package/dist/database/migrations/CreateSubscriptionTable.d.ts +6 -0
  276. package/dist/database/migrations/CreateSubscriptionTable.d.ts.map +1 -0
  277. package/dist/database/migrations/CreateSubscriptionTable.js +30 -0
  278. package/dist/database/migrations/CreateSubscriptionTable.js.map +1 -0
  279. package/dist/database/migrations/CreateUserTable.d.ts +6 -0
  280. package/dist/database/migrations/CreateUserTable.d.ts.map +1 -0
  281. package/dist/database/migrations/CreateUserTable.js +32 -0
  282. package/dist/database/migrations/CreateUserTable.js.map +1 -0
  283. package/dist/database/migrations/MigrateData.d.ts +7 -0
  284. package/dist/database/migrations/MigrateData.d.ts.map +1 -0
  285. package/dist/database/migrations/MigrateData.js +138 -0
  286. package/dist/database/migrations/MigrateData.js.map +1 -0
  287. package/dist/database/ormconfig.d.ts +2 -0
  288. package/dist/database/ormconfig.d.ts.map +1 -0
  289. package/dist/database/ormconfig.js +3 -0
  290. package/dist/database/ormconfig.js.map +1 -0
  291. package/dist/database/types/enum.d.ts +21 -0
  292. package/dist/database/types/enum.d.ts.map +1 -0
  293. package/dist/database/types/enum.js +35 -0
  294. package/dist/database/types/enum.js.map +1 -0
  295. package/dist/database/types/types.d.ts +11 -0
  296. package/dist/database/types/types.d.ts.map +1 -0
  297. package/dist/database/types/types.js +127 -0
  298. package/dist/database/types/types.js.map +1 -0
  299. package/dist/helpers/faucet.d.ts +5 -0
  300. package/dist/helpers/faucet.d.ts.map +1 -0
  301. package/dist/helpers/faucet.js +24 -0
  302. package/dist/helpers/faucet.js.map +1 -0
  303. package/dist/helpers/fee-analyzer.d.ts +8 -0
  304. package/dist/helpers/fee-analyzer.d.ts.map +1 -0
  305. package/dist/helpers/fee-analyzer.js +73 -0
  306. package/dist/helpers/fee-analyzer.js.map +1 -0
  307. package/dist/helpers/helpers.d.ts +28 -0
  308. package/dist/helpers/helpers.d.ts.map +1 -0
  309. package/dist/helpers/helpers.js +167 -0
  310. package/dist/helpers/helpers.js.map +1 -0
  311. package/dist/index.d.ts +2 -0
  312. package/dist/index.d.ts.map +1 -0
  313. package/dist/index.js +28 -0
  314. package/dist/index.js.map +1 -0
  315. package/dist/middleware/auth/auth-gaurd.d.ts +51 -0
  316. package/dist/middleware/auth/auth-gaurd.d.ts.map +1 -0
  317. package/dist/middleware/auth/auth-gaurd.js +117 -0
  318. package/dist/middleware/auth/auth-gaurd.js.map +1 -0
  319. package/dist/middleware/auth/logto-helper.d.ts +44 -0
  320. package/dist/middleware/auth/logto-helper.d.ts.map +1 -0
  321. package/dist/middleware/auth/logto-helper.js +438 -0
  322. package/dist/middleware/auth/logto-helper.js.map +1 -0
  323. package/dist/middleware/auth/oauth/abstract.d.ts +22 -0
  324. package/dist/middleware/auth/oauth/abstract.d.ts.map +1 -0
  325. package/dist/middleware/auth/oauth/abstract.js +24 -0
  326. package/dist/middleware/auth/oauth/abstract.js.map +1 -0
  327. package/dist/middleware/auth/oauth/logto-provider.d.ts +15 -0
  328. package/dist/middleware/auth/oauth/logto-provider.d.ts.map +1 -0
  329. package/dist/middleware/auth/oauth/logto-provider.js +42 -0
  330. package/dist/middleware/auth/oauth/logto-provider.js.map +1 -0
  331. package/dist/middleware/auth/routes/admin/admin-auth.d.ts +8 -0
  332. package/dist/middleware/auth/routes/admin/admin-auth.d.ts.map +1 -0
  333. package/dist/middleware/auth/routes/admin/admin-auth.js +44 -0
  334. package/dist/middleware/auth/routes/admin/admin-auth.js.map +1 -0
  335. package/dist/middleware/auth/routes/api/account-auth.d.ts +5 -0
  336. package/dist/middleware/auth/routes/api/account-auth.d.ts.map +1 -0
  337. package/dist/middleware/auth/routes/api/account-auth.js +9 -0
  338. package/dist/middleware/auth/routes/api/account-auth.js.map +1 -0
  339. package/dist/middleware/auth/routes/api/auth-user-info.d.ts +5 -0
  340. package/dist/middleware/auth/routes/api/auth-user-info.d.ts.map +1 -0
  341. package/dist/middleware/auth/routes/api/auth-user-info.js +8 -0
  342. package/dist/middleware/auth/routes/api/auth-user-info.js.map +1 -0
  343. package/dist/middleware/auth/routes/api/credential-auth.d.ts +5 -0
  344. package/dist/middleware/auth/routes/api/credential-auth.d.ts.map +1 -0
  345. package/dist/middleware/auth/routes/api/credential-auth.js +17 -0
  346. package/dist/middleware/auth/routes/api/credential-auth.js.map +1 -0
  347. package/dist/middleware/auth/routes/api/credential-status-auth.d.ts +5 -0
  348. package/dist/middleware/auth/routes/api/credential-status-auth.d.ts.map +1 -0
  349. package/dist/middleware/auth/routes/api/credential-status-auth.js +20 -0
  350. package/dist/middleware/auth/routes/api/credential-status-auth.js.map +1 -0
  351. package/dist/middleware/auth/routes/api/did-auth.d.ts +5 -0
  352. package/dist/middleware/auth/routes/api/did-auth.d.ts.map +1 -0
  353. package/dist/middleware/auth/routes/api/did-auth.js +19 -0
  354. package/dist/middleware/auth/routes/api/did-auth.js.map +1 -0
  355. package/dist/middleware/auth/routes/api/key-auth.d.ts +5 -0
  356. package/dist/middleware/auth/routes/api/key-auth.d.ts.map +1 -0
  357. package/dist/middleware/auth/routes/api/key-auth.js +11 -0
  358. package/dist/middleware/auth/routes/api/key-auth.js.map +1 -0
  359. package/dist/middleware/auth/routes/api/presentation-auth.d.ts +5 -0
  360. package/dist/middleware/auth/routes/api/presentation-auth.d.ts.map +1 -0
  361. package/dist/middleware/auth/routes/api/presentation-auth.js +10 -0
  362. package/dist/middleware/auth/routes/api/presentation-auth.js.map +1 -0
  363. package/dist/middleware/auth/routes/api/resource-auth.d.ts +5 -0
  364. package/dist/middleware/auth/routes/api/resource-auth.d.ts.map +1 -0
  365. package/dist/middleware/auth/routes/api/resource-auth.js +11 -0
  366. package/dist/middleware/auth/routes/api/resource-auth.js.map +1 -0
  367. package/dist/middleware/auth/routes/auth-rule-provider.d.ts +33 -0
  368. package/dist/middleware/auth/routes/auth-rule-provider.d.ts.map +1 -0
  369. package/dist/middleware/auth/routes/auth-rule-provider.js +39 -0
  370. package/dist/middleware/auth/routes/auth-rule-provider.js.map +1 -0
  371. package/dist/middleware/auth/routes/auth-rule-repository.d.ts +21 -0
  372. package/dist/middleware/auth/routes/auth-rule-repository.d.ts.map +1 -0
  373. package/dist/middleware/auth/routes/auth-rule-repository.js +28 -0
  374. package/dist/middleware/auth/routes/auth-rule-repository.js.map +1 -0
  375. package/dist/middleware/auth/user-info-fetcher/api-token.d.ts +17 -0
  376. package/dist/middleware/auth/user-info-fetcher/api-token.d.ts.map +1 -0
  377. package/dist/middleware/auth/user-info-fetcher/api-token.js +60 -0
  378. package/dist/middleware/auth/user-info-fetcher/api-token.js.map +1 -0
  379. package/dist/middleware/auth/user-info-fetcher/base.d.ts +14 -0
  380. package/dist/middleware/auth/user-info-fetcher/base.d.ts.map +1 -0
  381. package/dist/middleware/auth/user-info-fetcher/base.js +38 -0
  382. package/dist/middleware/auth/user-info-fetcher/base.js.map +1 -0
  383. package/dist/middleware/auth/user-info-fetcher/idtoken.d.ts +18 -0
  384. package/dist/middleware/auth/user-info-fetcher/idtoken.d.ts.map +1 -0
  385. package/dist/middleware/auth/user-info-fetcher/idtoken.js +56 -0
  386. package/dist/middleware/auth/user-info-fetcher/idtoken.js.map +1 -0
  387. package/dist/middleware/auth/user-info-fetcher/m2m-creds-token.d.ts +18 -0
  388. package/dist/middleware/auth/user-info-fetcher/m2m-creds-token.d.ts.map +1 -0
  389. package/dist/middleware/auth/user-info-fetcher/m2m-creds-token.js +52 -0
  390. package/dist/middleware/auth/user-info-fetcher/m2m-creds-token.js.map +1 -0
  391. package/dist/middleware/auth/user-info-fetcher/portal-token.d.ts +20 -0
  392. package/dist/middleware/auth/user-info-fetcher/portal-token.d.ts.map +1 -0
  393. package/dist/middleware/auth/user-info-fetcher/portal-token.js +79 -0
  394. package/dist/middleware/auth/user-info-fetcher/portal-token.js.map +1 -0
  395. package/dist/middleware/auth/user-info-fetcher/swagger-ui.d.ts +16 -0
  396. package/dist/middleware/auth/user-info-fetcher/swagger-ui.d.ts.map +1 -0
  397. package/dist/middleware/auth/user-info-fetcher/swagger-ui.js +48 -0
  398. package/dist/middleware/auth/user-info-fetcher/swagger-ui.js.map +1 -0
  399. package/dist/middleware/authentication.d.ts +15 -0
  400. package/dist/middleware/authentication.d.ts.map +1 -0
  401. package/dist/middleware/authentication.js +110 -0
  402. package/dist/middleware/authentication.js.map +1 -0
  403. package/dist/middleware/event-tracker.d.ts +5 -0
  404. package/dist/middleware/event-tracker.d.ts.map +1 -0
  405. package/dist/middleware/event-tracker.js +34 -0
  406. package/dist/middleware/event-tracker.js.map +1 -0
  407. package/dist/middleware/hook.d.ts +9 -0
  408. package/dist/middleware/hook.d.ts.map +1 -0
  409. package/dist/middleware/hook.js +24 -0
  410. package/dist/middleware/hook.js.map +1 -0
  411. package/dist/middleware/middleware.d.ts +6 -0
  412. package/dist/middleware/middleware.d.ts.map +1 -0
  413. package/dist/middleware/middleware.js +36 -0
  414. package/dist/middleware/middleware.js.map +1 -0
  415. package/dist/services/admin/api-key.d.ts +30 -0
  416. package/dist/services/admin/api-key.d.ts.map +1 -0
  417. package/dist/services/admin/api-key.js +135 -0
  418. package/dist/services/admin/api-key.js.map +1 -0
  419. package/dist/services/admin/stripe.d.ts +18 -0
  420. package/dist/services/admin/stripe.d.ts.map +1 -0
  421. package/dist/services/admin/stripe.js +125 -0
  422. package/dist/services/admin/stripe.js.map +1 -0
  423. package/dist/services/admin/subscription.d.ts +16 -0
  424. package/dist/services/admin/subscription.d.ts.map +1 -0
  425. package/dist/services/admin/subscription.js +75 -0
  426. package/dist/services/admin/subscription.js.map +1 -0
  427. package/dist/services/api/coin.d.ts +13 -0
  428. package/dist/services/api/coin.d.ts.map +1 -0
  429. package/dist/services/api/coin.js +49 -0
  430. package/dist/services/api/coin.js.map +1 -0
  431. package/dist/services/api/credentials.d.ts +8 -0
  432. package/dist/services/api/credentials.d.ts.map +1 -0
  433. package/dist/services/api/credentials.js +38 -0
  434. package/dist/services/api/credentials.js.map +1 -0
  435. package/dist/services/api/customer.d.ts +19 -0
  436. package/dist/services/api/customer.d.ts.map +1 -0
  437. package/dist/services/api/customer.js +88 -0
  438. package/dist/services/api/customer.js.map +1 -0
  439. package/dist/services/api/identifier.d.ts +12 -0
  440. package/dist/services/api/identifier.d.ts.map +1 -0
  441. package/dist/services/api/identifier.js +38 -0
  442. package/dist/services/api/identifier.js.map +1 -0
  443. package/dist/services/api/key.d.ts +14 -0
  444. package/dist/services/api/key.d.ts.map +1 -0
  445. package/dist/services/api/key.js +49 -0
  446. package/dist/services/api/key.js.map +1 -0
  447. package/dist/services/api/operation.d.ts +14 -0
  448. package/dist/services/api/operation.d.ts.map +1 -0
  449. package/dist/services/api/operation.js +61 -0
  450. package/dist/services/api/operation.js.map +1 -0
  451. package/dist/services/api/payment-account.d.ts +14 -0
  452. package/dist/services/api/payment-account.d.ts.map +1 -0
  453. package/dist/services/api/payment-account.js +68 -0
  454. package/dist/services/api/payment-account.js.map +1 -0
  455. package/dist/services/api/payment.d.ts +17 -0
  456. package/dist/services/api/payment.d.ts.map +1 -0
  457. package/dist/services/api/payment.js +68 -0
  458. package/dist/services/api/payment.js.map +1 -0
  459. package/dist/services/api/resource.d.ts +17 -0
  460. package/dist/services/api/resource.d.ts.map +1 -0
  461. package/dist/services/api/resource.js +65 -0
  462. package/dist/services/api/resource.js.map +1 -0
  463. package/dist/services/api/role.d.ts +14 -0
  464. package/dist/services/api/role.d.ts.map +1 -0
  465. package/dist/services/api/role.js +53 -0
  466. package/dist/services/api/role.js.map +1 -0
  467. package/dist/services/api/store.d.ts +8 -0
  468. package/dist/services/api/store.d.ts.map +1 -0
  469. package/dist/services/api/store.js +18 -0
  470. package/dist/services/api/store.js.map +1 -0
  471. package/dist/services/api/user.d.ts +15 -0
  472. package/dist/services/api/user.d.ts.map +1 -0
  473. package/dist/services/api/user.js +54 -0
  474. package/dist/services/api/user.js.map +1 -0
  475. package/dist/services/connectors/verida.d.ts +40 -0
  476. package/dist/services/connectors/verida.d.ts.map +1 -0
  477. package/dist/services/connectors/verida.js +110 -0
  478. package/dist/services/connectors/verida.js.map +1 -0
  479. package/dist/services/helpers.d.ts +10 -0
  480. package/dist/services/helpers.d.ts.map +1 -0
  481. package/dist/services/helpers.js +44 -0
  482. package/dist/services/helpers.js.map +1 -0
  483. package/dist/services/identity/abstract.d.ts +51 -0
  484. package/dist/services/identity/abstract.d.ts.map +1 -0
  485. package/dist/services/identity/abstract.js +101 -0
  486. package/dist/services/identity/abstract.js.map +1 -0
  487. package/dist/services/identity/agent.d.ts +43 -0
  488. package/dist/services/identity/agent.d.ts.map +1 -0
  489. package/dist/services/identity/agent.js +625 -0
  490. package/dist/services/identity/agent.js.map +1 -0
  491. package/dist/services/identity/default.d.ts +19 -0
  492. package/dist/services/identity/default.d.ts.map +1 -0
  493. package/dist/services/identity/default.js +26 -0
  494. package/dist/services/identity/default.js.map +1 -0
  495. package/dist/services/identity/index.d.ts +59 -0
  496. package/dist/services/identity/index.d.ts.map +1 -0
  497. package/dist/services/identity/index.js +31 -0
  498. package/dist/services/identity/index.js.map +1 -0
  499. package/dist/services/identity/local.d.ts +33 -0
  500. package/dist/services/identity/local.d.ts.map +1 -0
  501. package/dist/services/identity/local.js +156 -0
  502. package/dist/services/identity/local.js.map +1 -0
  503. package/dist/services/identity/postgres.d.ts +59 -0
  504. package/dist/services/identity/postgres.d.ts.map +1 -0
  505. package/dist/services/identity/postgres.js +388 -0
  506. package/dist/services/identity/postgres.js.map +1 -0
  507. package/dist/services/identity/unauthorized.d.ts +6 -0
  508. package/dist/services/identity/unauthorized.d.ts.map +1 -0
  509. package/dist/services/identity/unauthorized.js +49 -0
  510. package/dist/services/identity/unauthorized.js.map +1 -0
  511. package/dist/services/track/admin/account-submitter.d.ts +11 -0
  512. package/dist/services/track/admin/account-submitter.d.ts.map +1 -0
  513. package/dist/services/track/admin/account-submitter.js +54 -0
  514. package/dist/services/track/admin/account-submitter.js.map +1 -0
  515. package/dist/services/track/admin/subscription-submitter.d.ts +13 -0
  516. package/dist/services/track/admin/subscription-submitter.d.ts.map +1 -0
  517. package/dist/services/track/admin/subscription-submitter.js +106 -0
  518. package/dist/services/track/admin/subscription-submitter.js.map +1 -0
  519. package/dist/services/track/api/credential-status-subscriber.d.ts +10 -0
  520. package/dist/services/track/api/credential-status-subscriber.d.ts.map +1 -0
  521. package/dist/services/track/api/credential-status-subscriber.js +35 -0
  522. package/dist/services/track/api/credential-status-subscriber.js.map +1 -0
  523. package/dist/services/track/api/credential-subscriber.d.ts +10 -0
  524. package/dist/services/track/api/credential-subscriber.d.ts.map +1 -0
  525. package/dist/services/track/api/credential-subscriber.js +35 -0
  526. package/dist/services/track/api/credential-subscriber.js.map +1 -0
  527. package/dist/services/track/api/did-subscriber.d.ts +10 -0
  528. package/dist/services/track/api/did-subscriber.d.ts.map +1 -0
  529. package/dist/services/track/api/did-subscriber.js +33 -0
  530. package/dist/services/track/api/did-subscriber.js.map +1 -0
  531. package/dist/services/track/api/key-subscriber.d.ts +10 -0
  532. package/dist/services/track/api/key-subscriber.d.ts.map +1 -0
  533. package/dist/services/track/api/key-subscriber.js +35 -0
  534. package/dist/services/track/api/key-subscriber.js.map +1 -0
  535. package/dist/services/track/api/presentation-subscriber.d.ts +10 -0
  536. package/dist/services/track/api/presentation-subscriber.d.ts.map +1 -0
  537. package/dist/services/track/api/presentation-subscriber.js +35 -0
  538. package/dist/services/track/api/presentation-subscriber.js.map +1 -0
  539. package/dist/services/track/api/resource-subscriber.d.ts +11 -0
  540. package/dist/services/track/api/resource-subscriber.d.ts.map +1 -0
  541. package/dist/services/track/api/resource-subscriber.js +107 -0
  542. package/dist/services/track/api/resource-subscriber.js.map +1 -0
  543. package/dist/services/track/base.d.ts +10 -0
  544. package/dist/services/track/base.d.ts.map +1 -0
  545. package/dist/services/track/base.js +26 -0
  546. package/dist/services/track/base.js.map +1 -0
  547. package/dist/services/track/helpers.d.ts +23 -0
  548. package/dist/services/track/helpers.d.ts.map +1 -0
  549. package/dist/services/track/helpers.js +35 -0
  550. package/dist/services/track/helpers.js.map +1 -0
  551. package/dist/services/track/notifiers.d.ts +12 -0
  552. package/dist/services/track/notifiers.d.ts.map +1 -0
  553. package/dist/services/track/notifiers.js +39 -0
  554. package/dist/services/track/notifiers.js.map +1 -0
  555. package/dist/services/track/observer.d.ts +14 -0
  556. package/dist/services/track/observer.d.ts.map +1 -0
  557. package/dist/services/track/observer.js +43 -0
  558. package/dist/services/track/observer.js.map +1 -0
  559. package/dist/services/track/operation-subscriber.d.ts +14 -0
  560. package/dist/services/track/operation-subscriber.d.ts.map +1 -0
  561. package/dist/services/track/operation-subscriber.js +112 -0
  562. package/dist/services/track/operation-subscriber.js.map +1 -0
  563. package/dist/services/track/submitter.d.ts +22 -0
  564. package/dist/services/track/submitter.d.ts.map +1 -0
  565. package/dist/services/track/submitter.js +2 -0
  566. package/dist/services/track/submitter.js.map +1 -0
  567. package/dist/services/track/tracker.d.ts +24 -0
  568. package/dist/services/track/tracker.d.ts.map +1 -0
  569. package/dist/services/track/tracker.js +79 -0
  570. package/dist/services/track/tracker.js.map +1 -0
  571. package/dist/services/track/types.d.ts +16 -0
  572. package/dist/services/track/types.d.ts.map +1 -0
  573. package/dist/services/track/types.js +2 -0
  574. package/dist/services/track/types.js.map +1 -0
  575. package/dist/services/w3c-credential.d.ts +32 -0
  576. package/dist/services/w3c-credential.d.ts.map +1 -0
  577. package/dist/services/w3c-credential.js +120 -0
  578. package/dist/services/w3c-credential.js.map +1 -0
  579. package/dist/services/w3c-presentation.d.ts +30 -0
  580. package/dist/services/w3c-presentation.d.ts.map +1 -0
  581. package/dist/services/w3c-presentation.js +95 -0
  582. package/dist/services/w3c-presentation.js.map +1 -0
  583. package/dist/static/custom-button.d.ts +2 -0
  584. package/dist/static/custom-button.d.ts.map +1 -0
  585. package/dist/static/custom-button.js +35 -0
  586. package/dist/static/custom-button.js.map +1 -0
  587. package/dist/static/swagger-admin.json +1191 -0
  588. package/dist/static/swagger-api.json +3564 -0
  589. package/dist/types/admin.d.ts +122 -0
  590. package/dist/types/admin.d.ts.map +1 -0
  591. package/dist/types/admin.js +2 -0
  592. package/dist/types/admin.js.map +1 -0
  593. package/dist/types/authentication.d.ts +30 -0
  594. package/dist/types/authentication.d.ts.map +1 -0
  595. package/dist/types/authentication.js +131 -0
  596. package/dist/types/authentication.js.map +1 -0
  597. package/dist/types/constants.d.ts +98 -0
  598. package/dist/types/constants.d.ts.map +1 -0
  599. package/dist/types/constants.js +138 -0
  600. package/dist/types/constants.js.map +1 -0
  601. package/dist/types/credential-status.d.ts +168 -0
  602. package/dist/types/credential-status.d.ts.map +1 -0
  603. package/dist/types/credential-status.js +12 -0
  604. package/dist/types/credential-status.js.map +1 -0
  605. package/dist/types/credential.d.ts +55 -0
  606. package/dist/types/credential.d.ts.map +1 -0
  607. package/dist/types/credential.js +2 -0
  608. package/dist/types/credential.js.map +1 -0
  609. package/dist/types/customer.d.ts +18 -0
  610. package/dist/types/customer.d.ts.map +1 -0
  611. package/dist/types/customer.js +2 -0
  612. package/dist/types/customer.js.map +1 -0
  613. package/dist/types/did.d.ts +56 -0
  614. package/dist/types/did.d.ts.map +1 -0
  615. package/dist/types/did.js +2 -0
  616. package/dist/types/did.js.map +1 -0
  617. package/dist/types/key.d.ts +23 -0
  618. package/dist/types/key.d.ts.map +1 -0
  619. package/dist/types/key.js +2 -0
  620. package/dist/types/key.js.map +1 -0
  621. package/dist/types/presentation.d.ts +19 -0
  622. package/dist/types/presentation.d.ts.map +1 -0
  623. package/dist/types/presentation.js +2 -0
  624. package/dist/types/presentation.js.map +1 -0
  625. package/dist/types/resource.d.ts +26 -0
  626. package/dist/types/resource.d.ts.map +1 -0
  627. package/dist/types/resource.js +2 -0
  628. package/dist/types/resource.js.map +1 -0
  629. package/dist/types/shared.d.ts +51 -0
  630. package/dist/types/shared.d.ts.map +1 -0
  631. package/dist/types/shared.js +24 -0
  632. package/dist/types/shared.js.map +1 -0
  633. package/dist/types/swagger-admin-types.d.ts +352 -0
  634. package/dist/types/swagger-admin-types.d.ts.map +1 -0
  635. package/dist/types/swagger-admin-types.js +353 -0
  636. package/dist/types/swagger-admin-types.js.map +1 -0
  637. package/dist/types/swagger-api-types.d.ts +1312 -0
  638. package/dist/types/swagger-api-types.d.ts.map +1 -0
  639. package/dist/types/swagger-api-types.js +1313 -0
  640. package/dist/types/swagger-api-types.js.map +1 -0
  641. package/dist/types/track.d.ts +72 -0
  642. package/dist/types/track.d.ts.map +1 -0
  643. package/dist/types/track.js +37 -0
  644. package/dist/types/track.js.map +1 -0
  645. package/dist/types/validation.d.ts +23 -0
  646. package/dist/types/validation.d.ts.map +1 -0
  647. package/dist/types/validation.js +2 -0
  648. package/dist/types/validation.js.map +1 -0
  649. package/dist/types/verida.d.ts +23 -0
  650. package/dist/types/verida.d.ts.map +1 -0
  651. package/dist/types/verida.js +2 -0
  652. package/dist/types/verida.js.map +1 -0
  653. package/example.env +43 -0
  654. package/package.json +156 -0
@@ -0,0 +1,3564 @@
1
+ {
2
+ "openapi": "3.0.0",
3
+ "info": {
4
+ "title": "cheqd Studio API for cheqd network",
5
+ "version": "2.0.0",
6
+ "description": "API service to create and manage DIDs, Verifiable Credentials, and DID-Linked Resources",
7
+ "contact": {
8
+ "name": "Cheqd Foundation Limited",
9
+ "url": "https://github.com/cheqd/studio",
10
+ "email": "support-github@cheqd.io"
11
+ },
12
+ "license": {
13
+ "name": "Apache 2.0",
14
+ "url": "https://github.com/cheqd/studio/blob/main/LICENSE"
15
+ }
16
+ },
17
+ "tags": [
18
+ {
19
+ "name": "Account"
20
+ },
21
+ {
22
+ "name": "Key"
23
+ },
24
+ {
25
+ "name": "DID"
26
+ },
27
+ {
28
+ "name": "Resource"
29
+ },
30
+ {
31
+ "name": "Credential"
32
+ },
33
+ {
34
+ "name": "Presentation"
35
+ },
36
+ {
37
+ "name": "Credential Status"
38
+ }
39
+ ],
40
+ "externalDocs": {
41
+ "description": "cheqd Studio API Documentation",
42
+ "url": "https://docs.cheqd.io/identity"
43
+ },
44
+ "paths": {
45
+ "/account": {
46
+ "get": {
47
+ "tags": [
48
+ "Account"
49
+ ],
50
+ "summary": "Fetch custodian-mode client details.",
51
+ "description": "This endpoint returns the custodian-mode client details for authenticated users.",
52
+ "responses": {
53
+ "200": {
54
+ "description": "The request was successful.",
55
+ "content": {
56
+ "application/json": {
57
+ "schema": {
58
+ "$ref": "#/components/schemas/Customer"
59
+ }
60
+ }
61
+ }
62
+ },
63
+ "400": {
64
+ "$ref": "#/components/schemas/InvalidRequest"
65
+ },
66
+ "401": {
67
+ "$ref": "#/components/schemas/UnauthorizedError"
68
+ },
69
+ "500": {
70
+ "$ref": "#/components/schemas/InternalError"
71
+ }
72
+ }
73
+ }
74
+ },
75
+ "/account/idtoken": {
76
+ "get": {
77
+ "tags": [
78
+ "Account"
79
+ ],
80
+ "summary": "Fetch IdToken.",
81
+ "description": "This endpoint returns IdToken as JWT with list of user roles inside",
82
+ "deprecated": true,
83
+ "responses": {
84
+ "200": {
85
+ "description": "The request was successful.",
86
+ "content": {
87
+ "application/json": {
88
+ "idToken": {
89
+ "type": "string"
90
+ }
91
+ }
92
+ }
93
+ },
94
+ "400": {
95
+ "$ref": "#/components/schemas/InvalidRequest"
96
+ },
97
+ "401": {
98
+ "$ref": "#/components/schemas/UnauthorizedError"
99
+ },
100
+ "500": {
101
+ "$ref": "#/components/schemas/InternalError"
102
+ }
103
+ }
104
+ }
105
+ },
106
+ "/account/create": {
107
+ "post": {
108
+ "tags": [
109
+ "Account"
110
+ ],
111
+ "summary": "Create an client for an authenticated user.",
112
+ "description": "This endpoint creates a client in the custodian-mode for an authenticated user",
113
+ "requestBody": {
114
+ "content": {
115
+ "application/x-www-form-urlencoded": {
116
+ "schema": {
117
+ "$ref": "#/components/schemas/AccountCreateRequest"
118
+ }
119
+ },
120
+ "application/json": {
121
+ "schema": {
122
+ "$ref": "#/components/schemas/AccountCreateRequest"
123
+ }
124
+ }
125
+ }
126
+ },
127
+ "responses": {
128
+ "200": {
129
+ "description": "The request was successful.",
130
+ "content": {
131
+ "application/json": {
132
+ "idToken": {
133
+ "type": "string"
134
+ }
135
+ }
136
+ }
137
+ },
138
+ "400": {
139
+ "$ref": "#/components/schemas/InvalidRequest"
140
+ },
141
+ "401": {
142
+ "$ref": "#/components/schemas/UnauthorizedError"
143
+ },
144
+ "500": {
145
+ "$ref": "#/components/schemas/InternalError"
146
+ }
147
+ }
148
+ }
149
+ },
150
+ "/credential-status/create/unencrypted": {
151
+ "post": {
152
+ "tags": [
153
+ "Credential Status"
154
+ ],
155
+ "summary": "Create an unencrypted StatusList2021 credential status list.",
156
+ "description": "This endpoint creates an unencrypted StatusList2021 credential status list. The StatusList is published as a DID-Linked Resource on ledger. As input, it can can take input parameters needed to create the status list via a form, or a pre-assembled status list in JSON format. Status lists can be created as either encrypted or unencrypted; and with purpose as either revocation or suspension.",
157
+ "parameters": [
158
+ {
159
+ "in": "query",
160
+ "name": "statusPurpose",
161
+ "description": "The purpose of the status list. Can be either revocation or suspension. Once this is set, it cannot be changed. A new status list must be created to change the purpose.",
162
+ "required": true,
163
+ "schema": {
164
+ "type": "string",
165
+ "enum": [
166
+ "revocation",
167
+ "suspension"
168
+ ]
169
+ }
170
+ }
171
+ ],
172
+ "requestBody": {
173
+ "content": {
174
+ "application/x-www-form-urlencoded": {
175
+ "schema": {
176
+ "$ref": "#/components/schemas/CredentialStatusCreateUnencryptedRequest"
177
+ }
178
+ },
179
+ "application/json": {
180
+ "schema": {
181
+ "$ref": "#/components/schemas/CredentialStatusCreateUnencryptedRequest"
182
+ }
183
+ }
184
+ }
185
+ },
186
+ "responses": {
187
+ "200": {
188
+ "description": "The request was successful.",
189
+ "content": {
190
+ "application/json": {
191
+ "schema": {
192
+ "$ref": "#/components/schemas/CredentialStatusCreateUnencryptedResult"
193
+ }
194
+ }
195
+ }
196
+ },
197
+ "400": {
198
+ "$ref": "#/components/schemas/InvalidRequest"
199
+ },
200
+ "401": {
201
+ "$ref": "#/components/schemas/UnauthorizedError"
202
+ },
203
+ "500": {
204
+ "$ref": "#/components/schemas/InternalError"
205
+ }
206
+ }
207
+ }
208
+ },
209
+ "/credential-status/create/encrypted": {
210
+ "post": {
211
+ "tags": [
212
+ "Credential Status"
213
+ ],
214
+ "summary": "Create an encrypted StatusList2021 credential status list.",
215
+ "description": "This endpoint creates an encrypted StatusList2021 credential status list. The StatusList is published as a DID-Linked Resource on ledger. As input, it can can take input parameters needed to create the status list via a form, or a pre-assembled status list in JSON format. Status lists can be created as either encrypted or unencrypted; and with purpose as either revocation or suspension.",
216
+ "parameters": [
217
+ {
218
+ "in": "query",
219
+ "name": "statusPurpose",
220
+ "description": "The purpose of the status list. Can be either revocation or suspension. Once this is set, it cannot be changed. A new status list must be created to change the purpose.",
221
+ "required": true,
222
+ "schema": {
223
+ "type": "string",
224
+ "enum": [
225
+ "revocation",
226
+ "suspension"
227
+ ]
228
+ }
229
+ }
230
+ ],
231
+ "requestBody": {
232
+ "content": {
233
+ "application/x-www-form-urlencoded": {
234
+ "schema": {
235
+ "$ref": "#/components/schemas/CredentialStatusCreateEncryptedFormRequest"
236
+ }
237
+ },
238
+ "application/json": {
239
+ "schema": {
240
+ "$ref": "#/components/schemas/CredentialStatusCreateEncryptedJsonRequest"
241
+ }
242
+ }
243
+ }
244
+ },
245
+ "responses": {
246
+ "200": {
247
+ "description": "The request was successful.",
248
+ "content": {
249
+ "application/json": {
250
+ "schema": {
251
+ "$ref": "#/components/schemas/CredentialStatusCreateEncryptedResult"
252
+ }
253
+ }
254
+ }
255
+ },
256
+ "400": {
257
+ "$ref": "#/components/schemas/InvalidRequest"
258
+ },
259
+ "401": {
260
+ "$ref": "#/components/schemas/UnauthorizedError"
261
+ },
262
+ "500": {
263
+ "$ref": "#/components/schemas/InternalError"
264
+ }
265
+ }
266
+ }
267
+ },
268
+ "/credential-status/update/unencrypted": {
269
+ "post": {
270
+ "tags": [
271
+ "Credential Status"
272
+ ],
273
+ "summary": "Update an existing unencrypted StatusList2021 credential status list.",
274
+ "parameters": [
275
+ {
276
+ "in": "query",
277
+ "name": "statusAction",
278
+ "description": "The update action to be performed on the unencrypted status list, can be revoke, suspend or reinstate",
279
+ "required": true,
280
+ "schema": {
281
+ "type": "string",
282
+ "enum": [
283
+ "revoke",
284
+ "suspend",
285
+ "reinstate"
286
+ ]
287
+ }
288
+ }
289
+ ],
290
+ "requestBody": {
291
+ "content": {
292
+ "application/x-www-form-urlencoded": {
293
+ "schema": {
294
+ "$ref": "#/components/schemas/CredentialStatusUpdateUnencryptedRequest"
295
+ }
296
+ },
297
+ "application/json": {
298
+ "schema": {
299
+ "$ref": "#/components/schemas/CredentialStatusUpdateUnencryptedRequest"
300
+ }
301
+ }
302
+ }
303
+ },
304
+ "responses": {
305
+ "200": {
306
+ "description": "The request was successful.",
307
+ "content": {
308
+ "application/json": {
309
+ "schema": {
310
+ "$ref": "#/components/schemas/CredentialStatusUpdateUnencryptedResult"
311
+ }
312
+ }
313
+ }
314
+ },
315
+ "400": {
316
+ "$ref": "#/components/schemas/InvalidRequest"
317
+ },
318
+ "401": {
319
+ "$ref": "#/components/schemas/UnauthorizedError"
320
+ },
321
+ "500": {
322
+ "$ref": "#/components/schemas/InternalError"
323
+ }
324
+ }
325
+ }
326
+ },
327
+ "/credential-status/update/encrypted": {
328
+ "post": {
329
+ "tags": [
330
+ "Credential Status"
331
+ ],
332
+ "summary": "Update an existing encrypted StatusList2021 credential status list.",
333
+ "parameters": [
334
+ {
335
+ "in": "query",
336
+ "name": "statusAction",
337
+ "description": "The update action to be performed on the encrypted status list, can be revoke, suspend or reinstate",
338
+ "required": true,
339
+ "schema": {
340
+ "type": "string",
341
+ "enum": [
342
+ "revoke",
343
+ "suspend",
344
+ "reinstate"
345
+ ]
346
+ }
347
+ }
348
+ ],
349
+ "requestBody": {
350
+ "content": {
351
+ "application/x-www-form-urlencoded": {
352
+ "schema": {
353
+ "$ref": "#/components/schemas/CredentialStatusUpdateEncryptedFormRequest"
354
+ }
355
+ },
356
+ "application/json": {
357
+ "schema": {
358
+ "$ref": "#/components/schemas/CredentialStatusUpdateEncryptedJsonRequest"
359
+ }
360
+ }
361
+ }
362
+ },
363
+ "responses": {
364
+ "200": {
365
+ "description": "The request was successful.",
366
+ "content": {
367
+ "application/json": {
368
+ "schema": {
369
+ "$ref": "#/components/schemas/CredentialStatusUpdateEncryptedResult"
370
+ }
371
+ }
372
+ }
373
+ },
374
+ "400": {
375
+ "$ref": "#/components/schemas/InvalidRequest"
376
+ },
377
+ "401": {
378
+ "$ref": "#/components/schemas/UnauthorizedError"
379
+ },
380
+ "500": {
381
+ "$ref": "#/components/schemas/InternalError"
382
+ }
383
+ }
384
+ }
385
+ },
386
+ "/credential-status/check": {
387
+ "post": {
388
+ "tags": [
389
+ "Credential Status"
390
+ ],
391
+ "summary": "Check a StatusList2021 index for a given Verifiable Credential.",
392
+ "description": "This endpoint checks a StatusList2021 index for a given Verifiable Credential and reports whether it is revoked or suspended. It offers a standalone method for checking an index without passing the entire Verifiable Credential or Verifiable Presentation.",
393
+ "parameters": [
394
+ {
395
+ "in": "query",
396
+ "name": "statusPurpose",
397
+ "description": "The purpose of the status list. Can be either revocation or suspension.",
398
+ "required": true,
399
+ "schema": {
400
+ "type": "string",
401
+ "enum": [
402
+ "revocation",
403
+ "suspension"
404
+ ]
405
+ }
406
+ }
407
+ ],
408
+ "requestBody": {
409
+ "content": {
410
+ "application/x-www-form-urlencoded": {
411
+ "schema": {
412
+ "$ref": "#/components/schemas/CredentialStatusCheckRequest"
413
+ }
414
+ },
415
+ "application/json": {
416
+ "schema": {
417
+ "$ref": "#/components/schemas/CredentialStatusCheckRequest"
418
+ }
419
+ }
420
+ }
421
+ },
422
+ "responses": {
423
+ "200": {
424
+ "description": "The request was successful.",
425
+ "content": {
426
+ "application/json": {
427
+ "schema": {
428
+ "$ref": "#/components/schemas/CredentialStatusCheckResult"
429
+ }
430
+ }
431
+ }
432
+ },
433
+ "400": {
434
+ "$ref": "#/components/schemas/InvalidRequest"
435
+ },
436
+ "401": {
437
+ "$ref": "#/components/schemas/UnauthorizedError"
438
+ },
439
+ "500": {
440
+ "$ref": "#/components/schemas/InternalError"
441
+ }
442
+ }
443
+ }
444
+ },
445
+ "/credential-status/search": {
446
+ "get": {
447
+ "tags": [
448
+ "Credential Status"
449
+ ],
450
+ "summary": "Fetch StatusList2021 DID-Linked Resource based on search criteria.",
451
+ "parameters": [
452
+ {
453
+ "in": "query",
454
+ "name": "did",
455
+ "description": "The DID of the issuer of the status list.",
456
+ "required": true,
457
+ "schema": {
458
+ "type": "string"
459
+ }
460
+ },
461
+ {
462
+ "in": "query",
463
+ "name": "statusPurpose",
464
+ "description": "The purpose of the status list. Can be either revocation or suspension.",
465
+ "schema": {
466
+ "type": "string",
467
+ "enum": [
468
+ "revocation",
469
+ "suspension"
470
+ ]
471
+ }
472
+ },
473
+ {
474
+ "in": "query",
475
+ "name": "statusListName",
476
+ "description": "The name of the StatusList2021 DID-Linked Resource.",
477
+ "schema": {
478
+ "type": "string"
479
+ }
480
+ }
481
+ ],
482
+ "responses": {
483
+ "200": {
484
+ "description": "The request was successful.",
485
+ "content": {
486
+ "application/json": {
487
+ "schema": {
488
+ "$ref": "#/components/schemas/CredentialStatusListSearchResult"
489
+ }
490
+ }
491
+ }
492
+ },
493
+ "400": {
494
+ "$ref": "#/components/schemas/InvalidRequest"
495
+ },
496
+ "401": {
497
+ "$ref": "#/components/schemas/UnauthorizedError"
498
+ },
499
+ "500": {
500
+ "$ref": "#/components/schemas/InternalError"
501
+ }
502
+ }
503
+ }
504
+ },
505
+ "/credential/issue": {
506
+ "post": {
507
+ "tags": [
508
+ "Credential"
509
+ ],
510
+ "summary": "Issue a Verifiable Credential",
511
+ "description": "This endpoint issues a Verifiable Credential. As input it takes the list of issuerDid, subjectDid, attributes, and other parameters of the credential to be issued.",
512
+ "requestBody": {
513
+ "content": {
514
+ "application/x-www-form-urlencoded": {
515
+ "schema": {
516
+ "$ref": "#/components/schemas/CredentialRequest"
517
+ }
518
+ },
519
+ "application/json": {
520
+ "schema": {
521
+ "$ref": "#/components/schemas/CredentialRequest"
522
+ }
523
+ }
524
+ }
525
+ },
526
+ "responses": {
527
+ "200": {
528
+ "description": "The request was successful.",
529
+ "content": {
530
+ "application/json": {
531
+ "schema": {
532
+ "$ref": "#/components/schemas/Credential"
533
+ }
534
+ }
535
+ }
536
+ },
537
+ "400": {
538
+ "$ref": "#/components/schemas/InvalidRequest"
539
+ },
540
+ "401": {
541
+ "$ref": "#/components/schemas/UnauthorizedError"
542
+ },
543
+ "500": {
544
+ "$ref": "#/components/schemas/InternalError"
545
+ }
546
+ }
547
+ }
548
+ },
549
+ "/credential/verify": {
550
+ "post": {
551
+ "tags": [
552
+ "Credential"
553
+ ],
554
+ "summary": "Verify a Verifiable Credential.",
555
+ "description": "This endpoint verifies a Verifiable Credential passed to it. As input, it can take the VC-JWT as a string or the entire credential itself.",
556
+ "operationId": "verify",
557
+ "parameters": [
558
+ {
559
+ "in": "query",
560
+ "name": "verifyStatus",
561
+ "description": "If set to `true` the verification will also check the status of the credential. Requires the VC to have a `credentialStatus` property.",
562
+ "schema": {
563
+ "type": "boolean",
564
+ "default": false
565
+ }
566
+ },
567
+ {
568
+ "in": "query",
569
+ "name": "fetchRemoteContexts",
570
+ "description": "When dealing with JSON-LD you also MUST provide the proper contexts. Set this to `true` ONLY if you want the `@context` URLs to be fetched in case they are a custom context.",
571
+ "schema": {
572
+ "type": "boolean",
573
+ "default": false
574
+ }
575
+ },
576
+ {
577
+ "in": "query",
578
+ "name": "allowDeactivatedDid",
579
+ "description": "If set to `true` allow to verify credential which based on deactivated DID.",
580
+ "schema": {
581
+ "type": "boolean",
582
+ "default": false
583
+ }
584
+ }
585
+ ],
586
+ "requestBody": {
587
+ "content": {
588
+ "application/x-www-form-urlencoded": {
589
+ "schema": {
590
+ "$ref": "#/components/schemas/CredentialVerifyRequest"
591
+ }
592
+ },
593
+ "application/json": {
594
+ "schema": {
595
+ "$ref": "#/components/schemas/CredentialVerifyRequest"
596
+ }
597
+ }
598
+ }
599
+ },
600
+ "responses": {
601
+ "200": {
602
+ "description": "The request was successful.",
603
+ "content": {
604
+ "application/json": {
605
+ "schema": {
606
+ "$ref": "#/components/schemas/VerifyCredentialResult"
607
+ }
608
+ }
609
+ }
610
+ },
611
+ "400": {
612
+ "$ref": "#/components/schemas/InvalidRequest"
613
+ },
614
+ "401": {
615
+ "$ref": "#/components/schemas/UnauthorizedError"
616
+ },
617
+ "500": {
618
+ "$ref": "#/components/schemas/InternalError"
619
+ }
620
+ }
621
+ }
622
+ },
623
+ "/credential/revoke": {
624
+ "post": {
625
+ "tags": [
626
+ "Credential"
627
+ ],
628
+ "summary": "Revoke a Verifiable Credential.",
629
+ "description": "This endpoint revokes a given Verifiable Credential. As input, it can take the VC-JWT as a string or the entire credential itself. The StatusList2021 resource should already be setup in the VC and `credentialStatus` property present in the VC.",
630
+ "operationId": "revoke",
631
+ "parameters": [
632
+ {
633
+ "in": "query",
634
+ "name": "publish",
635
+ "description": "Set whether the StatusList2021 resource should be published to the ledger or not. If set to `false`, the StatusList2021 publisher should manually publish the resource.",
636
+ "required": true,
637
+ "schema": {
638
+ "type": "boolean",
639
+ "default": true
640
+ }
641
+ }
642
+ ],
643
+ "requestBody": {
644
+ "content": {
645
+ "application/x-www-form-urlencoded": {
646
+ "schema": {
647
+ "$ref": "#/components/schemas/CredentialRevokeRequest"
648
+ }
649
+ },
650
+ "application/json": {
651
+ "schema": {
652
+ "$ref": "#/components/schemas/CredentialRevokeRequest"
653
+ }
654
+ }
655
+ }
656
+ },
657
+ "responses": {
658
+ "200": {
659
+ "description": "The request was successful.",
660
+ "content": {
661
+ "application/json": {
662
+ "schema": {
663
+ "$ref": "#/components/schemas/RevocationResult"
664
+ }
665
+ }
666
+ }
667
+ },
668
+ "400": {
669
+ "$ref": "#/components/schemas/InvalidRequest"
670
+ },
671
+ "401": {
672
+ "$ref": "#/components/schemas/UnauthorizedError"
673
+ },
674
+ "500": {
675
+ "$ref": "#/components/schemas/InternalError"
676
+ }
677
+ }
678
+ }
679
+ },
680
+ "/credential/suspend": {
681
+ "post": {
682
+ "tags": [
683
+ "Credential"
684
+ ],
685
+ "summary": "Suspend a Verifiable Credential.",
686
+ "description": "This endpoint suspends a given Verifiable Credential. As input, it can take the VC-JWT as a string or the entire credential itself.",
687
+ "operationId": "suspend",
688
+ "parameters": [
689
+ {
690
+ "in": "query",
691
+ "name": "publish",
692
+ "description": "Set whether the StatusList2021 resource should be published to the ledger or not. If set to `false`, the StatusList2021 publisher should manually publish the resource.",
693
+ "schema": {
694
+ "type": "boolean"
695
+ }
696
+ }
697
+ ],
698
+ "requestBody": {
699
+ "content": {
700
+ "application/x-www-form-urlencoded": {
701
+ "schema": {
702
+ "$ref": "#/components/schemas/CredentialRevokeRequest"
703
+ }
704
+ },
705
+ "application/json": {
706
+ "schema": {
707
+ "$ref": "#/components/schemas/CredentialRevokeRequest"
708
+ }
709
+ }
710
+ }
711
+ },
712
+ "responses": {
713
+ "200": {
714
+ "description": "The request was successful.",
715
+ "content": {
716
+ "application/json": {
717
+ "schema": {
718
+ "$ref": "#/components/schemas/SuspensionResult"
719
+ }
720
+ }
721
+ }
722
+ },
723
+ "400": {
724
+ "$ref": "#/components/schemas/InvalidRequest"
725
+ },
726
+ "401": {
727
+ "$ref": "#/components/schemas/UnauthorizedError"
728
+ },
729
+ "500": {
730
+ "$ref": "#/components/schemas/InternalError"
731
+ }
732
+ }
733
+ }
734
+ },
735
+ "/credential/reinstate": {
736
+ "post": {
737
+ "tags": [
738
+ "Credential"
739
+ ],
740
+ "summary": "Reinstate a suspended Verifiable Credential.",
741
+ "description": "Set whether the StatusList2021 resource should be published to the ledger or not. If set to `false`, the StatusList2021 publisher should manually publish the resource.",
742
+ "operationId": "reinstate",
743
+ "parameters": [
744
+ {
745
+ "in": "query",
746
+ "name": "publish",
747
+ "description": "Set whether the StatusList2021 resource should be published to the ledger or not. If set to `false`, the StatusList2021 publisher should manually publish the resource.",
748
+ "schema": {
749
+ "type": "boolean"
750
+ }
751
+ }
752
+ ],
753
+ "requestBody": {
754
+ "content": {
755
+ "application/x-www-form-urlencoded": {
756
+ "schema": {
757
+ "$ref": "#/components/schemas/CredentialRevokeRequest"
758
+ }
759
+ },
760
+ "application/json": {
761
+ "schema": {
762
+ "$ref": "#/components/schemas/CredentialRevokeRequest"
763
+ }
764
+ }
765
+ }
766
+ },
767
+ "responses": {
768
+ "200": {
769
+ "description": "The request was successful.",
770
+ "content": {
771
+ "application/json": {
772
+ "schema": {
773
+ "$ref": "#/components/schemas/UnsuspensionResult"
774
+ }
775
+ }
776
+ }
777
+ },
778
+ "400": {
779
+ "$ref": "#/components/schemas/InvalidRequest"
780
+ },
781
+ "401": {
782
+ "$ref": "#/components/schemas/UnauthorizedError"
783
+ },
784
+ "500": {
785
+ "$ref": "#/components/schemas/InternalError"
786
+ }
787
+ }
788
+ }
789
+ },
790
+ "/did/create": {
791
+ "post": {
792
+ "tags": [
793
+ "DID"
794
+ ],
795
+ "summary": "Create a DID Document.",
796
+ "description": "This endpoint creates a DID and associated DID Document. As input, it can take the DID Document parameters via a form, or the fully-assembled DID Document itself.",
797
+ "requestBody": {
798
+ "content": {
799
+ "application/x-www-form-urlencoded": {
800
+ "schema": {
801
+ "$ref": "#/components/schemas/DidCreateRequestFormBased"
802
+ }
803
+ },
804
+ "application/json": {
805
+ "schema": {
806
+ "$ref": "#/components/schemas/DidCreateRequestJson"
807
+ }
808
+ }
809
+ }
810
+ },
811
+ "responses": {
812
+ "200": {
813
+ "description": "The request was successful.",
814
+ "content": {
815
+ "application/json": {
816
+ "schema": {
817
+ "$ref": "#/components/schemas/DidResult"
818
+ }
819
+ }
820
+ }
821
+ },
822
+ "400": {
823
+ "description": "A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.",
824
+ "content": {
825
+ "application/json": {
826
+ "schema": {
827
+ "$ref": "#/components/schemas/InvalidRequest"
828
+ },
829
+ "example": {
830
+ "error": "InvalidRequest"
831
+ }
832
+ }
833
+ }
834
+ },
835
+ "401": {
836
+ "$ref": "#/components/schemas/UnauthorizedError"
837
+ },
838
+ "500": {
839
+ "description": "An internal error has occurred. Additional state information plus metadata may be available in the response body.",
840
+ "content": {
841
+ "application/json": {
842
+ "schema": {
843
+ "$ref": "#/components/schemas/InvalidRequest"
844
+ },
845
+ "example": {
846
+ "error": "Internal Error"
847
+ }
848
+ }
849
+ }
850
+ }
851
+ }
852
+ }
853
+ },
854
+ "/did/update": {
855
+ "post": {
856
+ "tags": [
857
+ "DID"
858
+ ],
859
+ "summary": "Update a DID Document.",
860
+ "description": "This endpoint updates a DID Document. As an input, it can take JUST the sections/parameters that need to be updated in the DID Document (in this scenario, it fetches the current DID Document and applies the updated section). Alternatively, it take the fully-assembled DID Document with updated sections as well as unchanged sections.",
861
+ "requestBody": {
862
+ "content": {
863
+ "application/x-www-form-urlencoded": {
864
+ "schema": {
865
+ "$ref": "#/components/schemas/DidUpdateRequest"
866
+ }
867
+ },
868
+ "application/json": {
869
+ "schema": {
870
+ "$ref": "#/components/schemas/DidUpdateRequest"
871
+ }
872
+ }
873
+ }
874
+ },
875
+ "responses": {
876
+ "200": {
877
+ "description": "The request was successful.",
878
+ "content": {
879
+ "application/json": {
880
+ "schema": {
881
+ "$ref": "#/components/schemas/DidUpdateResponse"
882
+ }
883
+ }
884
+ }
885
+ },
886
+ "400": {
887
+ "$ref": "#/components/schemas/InvalidRequest"
888
+ },
889
+ "401": {
890
+ "$ref": "#/components/schemas/UnauthorizedError"
891
+ },
892
+ "500": {
893
+ "$ref": "#/components/schemas/InternalError"
894
+ }
895
+ }
896
+ }
897
+ },
898
+ "/did/import": {
899
+ "post": {
900
+ "tags": [
901
+ "DID"
902
+ ],
903
+ "summary": "Import a DID Document.",
904
+ "description": "This endpoint imports a decentralized identifier associated with the user's account for custodian-mode clients.",
905
+ "requestBody": {
906
+ "content": {
907
+ "application/x-www-form-urlencoded": {
908
+ "schema": {
909
+ "$ref": "#/components/schemas/DidImportRequest"
910
+ }
911
+ },
912
+ "application/json": {
913
+ "schema": {
914
+ "$ref": "#/components/schemas/DidImportRequest"
915
+ }
916
+ }
917
+ }
918
+ },
919
+ "responses": {
920
+ "200": {
921
+ "description": "The request was successful.",
922
+ "content": {
923
+ "application/json": {
924
+ "schema": {
925
+ "$ref": "#/components/schemas/DidResult"
926
+ }
927
+ }
928
+ }
929
+ },
930
+ "400": {
931
+ "description": "A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.",
932
+ "content": {
933
+ "application/json": {
934
+ "schema": {
935
+ "$ref": "#/components/schemas/InvalidRequest"
936
+ },
937
+ "example": {
938
+ "error": "InvalidRequest"
939
+ }
940
+ }
941
+ }
942
+ },
943
+ "401": {
944
+ "$ref": "#/components/schemas/UnauthorizedError"
945
+ },
946
+ "500": {
947
+ "description": "An internal error has occurred. Additional state information plus metadata may be available in the response body.",
948
+ "content": {
949
+ "application/json": {
950
+ "schema": {
951
+ "$ref": "#/components/schemas/InvalidRequest"
952
+ },
953
+ "example": {
954
+ "error": "Internal Error"
955
+ }
956
+ }
957
+ }
958
+ }
959
+ }
960
+ }
961
+ },
962
+ "/did/deactivate/{did}": {
963
+ "post": {
964
+ "tags": [
965
+ "DID"
966
+ ],
967
+ "summary": "Deactivate a DID Document.",
968
+ "description": "This endpoint deactivates a DID Document by taking the DID identifier as input. Must be called and signed by the DID owner.",
969
+ "parameters": [
970
+ {
971
+ "in": "path",
972
+ "name": "did",
973
+ "description": "DID identifier to deactivate.",
974
+ "schema": {
975
+ "type": "string"
976
+ },
977
+ "required": true
978
+ }
979
+ ],
980
+ "requestBody": {
981
+ "content": {
982
+ "application/x-www-form-urlencoded": {
983
+ "schema": {
984
+ "$ref": "#/components/schemas/DidDeactivateRequest"
985
+ }
986
+ },
987
+ "application/json": {
988
+ "schema": {
989
+ "$ref": "#/components/schemas/DidDeactivateRequest"
990
+ }
991
+ }
992
+ }
993
+ },
994
+ "responses": {
995
+ "200": {
996
+ "description": "The request was successful.",
997
+ "content": {
998
+ "application/json": {
999
+ "schema": {
1000
+ "$ref": "#/components/schemas/DeactivatedDidResolution"
1001
+ }
1002
+ }
1003
+ }
1004
+ },
1005
+ "400": {
1006
+ "$ref": "#/components/schemas/InvalidRequest"
1007
+ },
1008
+ "401": {
1009
+ "$ref": "#/components/schemas/UnauthorizedError"
1010
+ },
1011
+ "500": {
1012
+ "$ref": "#/components/schemas/InternalError"
1013
+ }
1014
+ }
1015
+ }
1016
+ },
1017
+ "/did/list": {
1018
+ "get": {
1019
+ "tags": [
1020
+ "DID"
1021
+ ],
1022
+ "summary": "Fetch DIDs associated with an account.",
1023
+ "description": "This endpoint returns the list of DIDs controlled by the account.",
1024
+ "responses": {
1025
+ "200": {
1026
+ "description": "The request was successful.",
1027
+ "content": {
1028
+ "application/json": {
1029
+ "schema": {
1030
+ "type": "array",
1031
+ "items": {
1032
+ "type": "string"
1033
+ }
1034
+ }
1035
+ }
1036
+ }
1037
+ },
1038
+ "400": {
1039
+ "$ref": "#/components/schemas/InvalidRequest"
1040
+ },
1041
+ "401": {
1042
+ "$ref": "#/components/schemas/UnauthorizedError"
1043
+ },
1044
+ "500": {
1045
+ "$ref": "#/components/schemas/InternalError"
1046
+ }
1047
+ }
1048
+ }
1049
+ },
1050
+ "/did/search/{did}": {
1051
+ "get": {
1052
+ "tags": [
1053
+ "DID"
1054
+ ],
1055
+ "summary": "Resolve a DID Document.",
1056
+ "description": "Resolve a DID Document by DID identifier. Also supports DID Resolution Queries as defined in the <a href=\"https://w3c-ccg.github.io/did-resolution/\">W3C DID Resolution specification</a>.",
1057
+ "parameters": [
1058
+ {
1059
+ "in": "path",
1060
+ "name": "did",
1061
+ "description": "DID identifier to resolve.",
1062
+ "schema": {
1063
+ "type": "string"
1064
+ },
1065
+ "required": true,
1066
+ "example": "did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0"
1067
+ },
1068
+ {
1069
+ "in": "query",
1070
+ "name": "metadata",
1071
+ "description": "Return only metadata of DID Document instead of actual DID Document.",
1072
+ "schema": {
1073
+ "type": "boolean"
1074
+ }
1075
+ },
1076
+ {
1077
+ "in": "query",
1078
+ "name": "versionId",
1079
+ "description": "Unique UUID version identifier of DID Document. Allows for fetching a specific version of the DID Document. See <a href=\"https://docs.cheqd.io/identity/architecture/adr-list/adr-001-cheqd-did-method#did-document-metadata\">cheqd DID Method Specification</a> for more details.",
1080
+ "schema": {
1081
+ "type": "string",
1082
+ "format": "uuid"
1083
+ },
1084
+ "example": "3ccde6ba-6ba5-56f2-9f4f-8825561a9860"
1085
+ },
1086
+ {
1087
+ "in": "query",
1088
+ "name": "versionTime",
1089
+ "description": "Returns the closest version of the DID Document *at* or *before* specified time. See <a href=\"https://docs.cheqd.io/identity/architecture/adr-list/adr-005-did-resolution-and-did-url-dereferencing\">DID Resolution handling for `did:cheqd`</a> for more details.",
1090
+ "schema": {
1091
+ "type": "string",
1092
+ "format": "date-time"
1093
+ },
1094
+ "example": "1970-01-01T00:00:00Z"
1095
+ },
1096
+ {
1097
+ "in": "query",
1098
+ "name": "transformKeys",
1099
+ "description": "This directive transforms the Verification Method key format from the version in the DID Document to the specified format chosen below.",
1100
+ "schema": {
1101
+ "type": "string",
1102
+ "enum": [
1103
+ "Ed25519VerificationKey2018",
1104
+ "Ed25519VerificationKey2020",
1105
+ "JsonWebKey2020"
1106
+ ]
1107
+ }
1108
+ },
1109
+ {
1110
+ "in": "query",
1111
+ "name": "service",
1112
+ "description": "Query DID Document for a specific Service Endpoint by Service ID (e.g., `service-1` in `did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1`). This will typically redirect to the Service Endpoint based on <a href=\"https://w3c-ccg.github.io/did-resolution/#dereferencing\">DID Resolution specification</a> algorithm.",
1113
+ "schema": {
1114
+ "type": "string"
1115
+ },
1116
+ "example": "service-1"
1117
+ },
1118
+ {
1119
+ "in": "query",
1120
+ "name": "relativeRef",
1121
+ "description": "Relative reference is a query fragment appended to the Service Endpoint URL. **Must** be used along with the `service` query property above. See <a href=\"https://w3c-ccg.github.io/did-resolution/#dereferencing\">DID Resolution specification</a> algorithm for more details.",
1122
+ "schema": {
1123
+ "type": "string"
1124
+ },
1125
+ "example": "/path/to/file"
1126
+ }
1127
+ ],
1128
+ "responses": {
1129
+ "200": {
1130
+ "description": "The request was successful.",
1131
+ "content": {
1132
+ "application/json": {
1133
+ "schema": {
1134
+ "$ref": "#/components/schemas/DidResolution"
1135
+ }
1136
+ }
1137
+ }
1138
+ },
1139
+ "400": {
1140
+ "$ref": "#/components/schemas/InvalidRequest"
1141
+ },
1142
+ "401": {
1143
+ "$ref": "#/components/schemas/UnauthorizedError"
1144
+ },
1145
+ "500": {
1146
+ "$ref": "#/components/schemas/InternalError"
1147
+ }
1148
+ }
1149
+ }
1150
+ },
1151
+ "/key/create": {
1152
+ "post": {
1153
+ "tags": [
1154
+ "Key"
1155
+ ],
1156
+ "summary": "Create an identity key pair.",
1157
+ "description": "This endpoint creates an identity key pair associated with the user's account for custodian-mode clients.",
1158
+ "parameters": [
1159
+ {
1160
+ "name": "type",
1161
+ "description": "Key type of the identity key pair to create.",
1162
+ "in": "query",
1163
+ "schema": {
1164
+ "type": "string",
1165
+ "enum": [
1166
+ "Ed25519",
1167
+ "Secp256k1"
1168
+ ]
1169
+ }
1170
+ }
1171
+ ],
1172
+ "responses": {
1173
+ "200": {
1174
+ "description": "The request was successful.",
1175
+ "content": {
1176
+ "application/json": {
1177
+ "schema": {
1178
+ "$ref": "#/components/schemas/KeyResult"
1179
+ }
1180
+ }
1181
+ }
1182
+ },
1183
+ "400": {
1184
+ "description": "A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.",
1185
+ "content": {
1186
+ "application/json": {
1187
+ "schema": {
1188
+ "$ref": "#/components/schemas/InvalidRequest"
1189
+ },
1190
+ "example": {
1191
+ "error": "InvalidRequest"
1192
+ }
1193
+ }
1194
+ }
1195
+ },
1196
+ "401": {
1197
+ "$ref": "#/components/schemas/UnauthorizedError"
1198
+ },
1199
+ "500": {
1200
+ "description": "An internal error has occurred. Additional state information plus metadata may be available in the response body.",
1201
+ "content": {
1202
+ "application/json": {
1203
+ "schema": {
1204
+ "$ref": "#/components/schemas/InvalidRequest"
1205
+ },
1206
+ "example": {
1207
+ "error": "Internal Error"
1208
+ }
1209
+ }
1210
+ }
1211
+ }
1212
+ }
1213
+ }
1214
+ },
1215
+ "/key/import": {
1216
+ "post": {
1217
+ "tags": [
1218
+ "Key"
1219
+ ],
1220
+ "summary": "Import an identity key pair.",
1221
+ "description": "This endpoint imports an identity key pair associated with the user's account for custodian-mode clients.",
1222
+ "requestBody": {
1223
+ "content": {
1224
+ "application/x-www-form-urlencoded": {
1225
+ "schema": {
1226
+ "$ref": "#/components/schemas/KeyImportRequest"
1227
+ }
1228
+ },
1229
+ "application/json": {
1230
+ "schema": {
1231
+ "$ref": "#/components/schemas/KeyImportRequest"
1232
+ }
1233
+ }
1234
+ }
1235
+ },
1236
+ "responses": {
1237
+ "200": {
1238
+ "description": "The request was successful.",
1239
+ "content": {
1240
+ "application/json": {
1241
+ "schema": {
1242
+ "$ref": "#/components/schemas/KeyResult"
1243
+ }
1244
+ }
1245
+ }
1246
+ },
1247
+ "400": {
1248
+ "description": "A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.",
1249
+ "content": {
1250
+ "application/json": {
1251
+ "schema": {
1252
+ "$ref": "#/components/schemas/InvalidRequest"
1253
+ },
1254
+ "example": {
1255
+ "error": "InvalidRequest"
1256
+ }
1257
+ }
1258
+ }
1259
+ },
1260
+ "401": {
1261
+ "$ref": "#/components/schemas/UnauthorizedError"
1262
+ },
1263
+ "500": {
1264
+ "description": "An internal error has occurred. Additional state information plus metadata may be available in the response body.",
1265
+ "content": {
1266
+ "application/json": {
1267
+ "schema": {
1268
+ "$ref": "#/components/schemas/InvalidRequest"
1269
+ },
1270
+ "example": {
1271
+ "error": "Internal Error"
1272
+ }
1273
+ }
1274
+ }
1275
+ }
1276
+ }
1277
+ }
1278
+ },
1279
+ "/key/read/{kid}": {
1280
+ "get": {
1281
+ "tags": [
1282
+ "Key"
1283
+ ],
1284
+ "summary": "Fetch an identity key pair.",
1285
+ "description": "This endpoint fetches an identity key pair's details for a given key ID. Only the user account associated with the custodian-mode client can fetch the key pair.",
1286
+ "parameters": [
1287
+ {
1288
+ "name": "kid",
1289
+ "description": "Key ID of the identity key pair to fetch.",
1290
+ "in": "path",
1291
+ "schema": {
1292
+ "type": "string"
1293
+ },
1294
+ "required": true
1295
+ }
1296
+ ],
1297
+ "responses": {
1298
+ "200": {
1299
+ "description": "The request was successful.",
1300
+ "content": {
1301
+ "application/json": {
1302
+ "schema": {
1303
+ "$ref": "#/components/schemas/KeyResult"
1304
+ }
1305
+ }
1306
+ }
1307
+ },
1308
+ "400": {
1309
+ "description": "A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.",
1310
+ "content": {
1311
+ "application/json": {
1312
+ "schema": {
1313
+ "$ref": "#/components/schemas/InvalidRequest"
1314
+ },
1315
+ "example": {
1316
+ "error": "InvalidRequest"
1317
+ }
1318
+ }
1319
+ }
1320
+ },
1321
+ "401": {
1322
+ "$ref": "#/components/schemas/UnauthorizedError"
1323
+ },
1324
+ "500": {
1325
+ "description": "An internal error has occurred. Additional state information plus metadata may be available in the response body.",
1326
+ "content": {
1327
+ "application/json": {
1328
+ "schema": {
1329
+ "$ref": "#/components/schemas/InvalidRequest"
1330
+ },
1331
+ "example": {
1332
+ "error": "Internal Error"
1333
+ }
1334
+ }
1335
+ }
1336
+ }
1337
+ }
1338
+ }
1339
+ },
1340
+ "/presentation/create": {
1341
+ "post": {
1342
+ "tags": [
1343
+ "Presentation"
1344
+ ],
1345
+ "summary": "!!! WARN. Such endpoint is made mostly for testing purposes and it is not supposed to be used in production !!! Create a Verifiable Presentation from credential(s).",
1346
+ "description": "This endpoint creates a Verifiable Presentation from credential(s). As input, it can take the credential(s) as a string or the entire credential(s) itself. \n !!! WARN. Such endpoint is made only for testing purposes !!!",
1347
+ "requestBody": {
1348
+ "content": {
1349
+ "application/x-www-form-urlencoded": {
1350
+ "schema": {
1351
+ "$ref": "#/components/schemas/PresentationCreateRequest"
1352
+ }
1353
+ },
1354
+ "application/json": {
1355
+ "schema": {
1356
+ "$ref": "#/components/schemas/PresentationCreateRequest"
1357
+ }
1358
+ }
1359
+ }
1360
+ },
1361
+ "responses": {
1362
+ "200": {
1363
+ "description": "The request was successful.",
1364
+ "content": {
1365
+ "application/json": {
1366
+ "schema": {
1367
+ "$ref": "#/components/schemas/PresentationCreateResult"
1368
+ }
1369
+ }
1370
+ }
1371
+ },
1372
+ "400": {
1373
+ "$ref": "#/components/schemas/InvalidRequest"
1374
+ },
1375
+ "401": {
1376
+ "$ref": "#/components/schemas/UnauthorizedError"
1377
+ },
1378
+ "500": {
1379
+ "$ref": "#/components/schemas/InternalError"
1380
+ }
1381
+ }
1382
+ }
1383
+ },
1384
+ "/presentation/verify": {
1385
+ "post": {
1386
+ "tags": [
1387
+ "Presentation"
1388
+ ],
1389
+ "summary": "Verify a Verifiable Presentation generated from credential(s).",
1390
+ "description": "This endpoint verifies the Verifiable Presentation generated from credential(s). As input, it can take the Verifiable Presentation JWT as a string or the entire Verifiable Presentation itself.",
1391
+ "parameters": [
1392
+ {
1393
+ "in": "query",
1394
+ "name": "verifyStatus",
1395
+ "description": "If set to `true` the verification will also check the status of the presentation. Requires the VP to have a `credentialStatus` property.",
1396
+ "schema": {
1397
+ "type": "boolean",
1398
+ "default": false
1399
+ }
1400
+ },
1401
+ {
1402
+ "in": "query",
1403
+ "name": "fetchRemoteContexts",
1404
+ "description": "When dealing with JSON-LD you also MUST provide the proper contexts. * Set this to `true` ONLY if you want the `@context` URLs to be fetched in case they are a custom context.",
1405
+ "schema": {
1406
+ "type": "boolean",
1407
+ "default": false
1408
+ }
1409
+ },
1410
+ {
1411
+ "in": "query",
1412
+ "name": "allowDeactivatedDid",
1413
+ "description": "If set to `true` allow to verify credential which based on deactivated DID.",
1414
+ "schema": {
1415
+ "type": "boolean",
1416
+ "default": false
1417
+ }
1418
+ }
1419
+ ],
1420
+ "requestBody": {
1421
+ "content": {
1422
+ "application/x-www-form-urlencoded": {
1423
+ "schema": {
1424
+ "$ref": "#/components/schemas/PresentationVerifyRequest"
1425
+ }
1426
+ },
1427
+ "application/json": {
1428
+ "schema": {
1429
+ "$ref": "#/components/schemas/PresentationVerifyRequest"
1430
+ }
1431
+ }
1432
+ }
1433
+ },
1434
+ "responses": {
1435
+ "200": {
1436
+ "description": "The request was successful.",
1437
+ "content": {
1438
+ "application/json": {
1439
+ "schema": {
1440
+ "$ref": "#/components/schemas/VerifyPresentationResult"
1441
+ }
1442
+ }
1443
+ }
1444
+ },
1445
+ "400": {
1446
+ "$ref": "#/components/schemas/InvalidRequest"
1447
+ },
1448
+ "401": {
1449
+ "$ref": "#/components/schemas/UnauthorizedError"
1450
+ },
1451
+ "500": {
1452
+ "$ref": "#/components/schemas/InternalError"
1453
+ }
1454
+ }
1455
+ }
1456
+ },
1457
+ "/resource/create/{did}": {
1458
+ "post": {
1459
+ "tags": [
1460
+ "Resource"
1461
+ ],
1462
+ "summary": "Create a DID-Linked Resource.",
1463
+ "description": "This endpoint creates a DID-Linked Resource. As input, it can take the DID identifier and the resource parameters via a form, or the fully-assembled resource itself.",
1464
+ "parameters": [
1465
+ {
1466
+ "in": "path",
1467
+ "name": "did",
1468
+ "description": "DID identifier to link the resource to.",
1469
+ "schema": {
1470
+ "type": "string"
1471
+ },
1472
+ "required": true
1473
+ }
1474
+ ],
1475
+ "requestBody": {
1476
+ "content": {
1477
+ "application/x-www-form-urlencoded": {
1478
+ "schema": {
1479
+ "$ref": "#/components/schemas/CreateResourceRequest"
1480
+ }
1481
+ },
1482
+ "application/json": {
1483
+ "schema": {
1484
+ "$ref": "#/components/schemas/CreateResourceRequest"
1485
+ }
1486
+ }
1487
+ }
1488
+ },
1489
+ "responses": {
1490
+ "200": {
1491
+ "description": "The request was successful.",
1492
+ "content": {
1493
+ "application/json": {
1494
+ "schema": {
1495
+ "$ref": "#/components/schemas/ResourceMetadata"
1496
+ }
1497
+ }
1498
+ }
1499
+ },
1500
+ "400": {
1501
+ "$ref": "#/components/schemas/InvalidRequest"
1502
+ },
1503
+ "401": {
1504
+ "$ref": "#/components/schemas/UnauthorizedError"
1505
+ },
1506
+ "500": {
1507
+ "$ref": "#/components/schemas/InternalError"
1508
+ }
1509
+ }
1510
+ }
1511
+ },
1512
+ "/resource/search/{did}": {
1513
+ "get": {
1514
+ "tags": [
1515
+ "Resource"
1516
+ ],
1517
+ "summary": "Get a DID-Linked Resource.",
1518
+ "description": "This endpoint returns the DID-Linked Resource for a given DID identifier and resource identifier.",
1519
+ "parameters": [
1520
+ {
1521
+ "in": "path",
1522
+ "name": "did",
1523
+ "description": "DID identifier",
1524
+ "schema": {
1525
+ "type": "string"
1526
+ },
1527
+ "required": true,
1528
+ "example": "did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0"
1529
+ },
1530
+ {
1531
+ "in": "query",
1532
+ "name": "resourceId",
1533
+ "description": "Fetch a DID-Linked Resource by Resource ID unique identifier. Since this is a unique identifier, other Resource query parameters are not required. See <a href=\"https://docs.cheqd.io/identity/credential-service/did-linked-resources/understanding-dlrs/technical-composition\">DID-Linked Resources</a> for more details.",
1534
+ "schema": {
1535
+ "type": "string",
1536
+ "format": "uuid"
1537
+ },
1538
+ "example": "3ccde6ba-6ba5-56f2-9f4f-8825561a9860"
1539
+ },
1540
+ {
1541
+ "in": "query",
1542
+ "name": "resourceName",
1543
+ "description": "Filter a DID-Linked Resource query by Resource Name. See <a href=\"https://docs.cheqd.io/identity/credential-service/did-linked-resources/understanding-dlrs/technical-composition\">DID-Linked Resources</a> for more details.",
1544
+ "schema": {
1545
+ "type": "string"
1546
+ },
1547
+ "example": "cheqd-issuer-logo"
1548
+ },
1549
+ {
1550
+ "in": "query",
1551
+ "name": "resourceType",
1552
+ "description": "Filter a DID-Linked Resource query by Resource Type. See <a href=\"https://docs.cheqd.io/identity/credential-service/did-linked-resources/understanding-dlrs/technical-composition\">DID-Linked Resources</a> for more details.",
1553
+ "schema": {
1554
+ "type": "string"
1555
+ },
1556
+ "example": "CredentialArtwork"
1557
+ },
1558
+ {
1559
+ "in": "query",
1560
+ "name": "resourceVersion",
1561
+ "description": "Filter a DID-Linked Resource query by Resource Version, which is an optional free-text field used by issuers (e.g., \"v1\", \"Final Version\", \"1st January 1970\" etc). See <a href=\"https://docs.cheqd.io/identity/credential-service/did-linked-resources/understanding-dlrs/technical-composition\">DID-Linked Resources</a> for more details.",
1562
+ "schema": {
1563
+ "type": "string"
1564
+ },
1565
+ "example": "v1"
1566
+ },
1567
+ {
1568
+ "in": "query",
1569
+ "name": "resourceVersionTime",
1570
+ "description": "Filter a DID-Linked Resource query which returns the closest version of the Resource *at* or *before* specified time. See <a href=\"https://docs.cheqd.io/identity/credential-service/did-linked-resources/understanding-dlrs/technical-composition\">DID-Linked Resources</a> for more details.",
1571
+ "schema": {
1572
+ "type": "string",
1573
+ "format": "date-time"
1574
+ },
1575
+ "example": "1970-01-01T00:00:00Z"
1576
+ },
1577
+ {
1578
+ "in": "query",
1579
+ "name": "checksum",
1580
+ "description": "Request integrity check against a given DID-Linked Resource by providing a SHA-256 checksum hash. See <a href=\"https://docs.cheqd.io/identity/credential-service/did-linked-resources/understanding-dlrs/technical-composition\">DID-Linked Resources</a> for more details.",
1581
+ "schema": {
1582
+ "type": "string"
1583
+ },
1584
+ "example": "dc64474d062ed750a66bad58cb609928de55ed0d81defd231a4a4bf97358e9ed"
1585
+ },
1586
+ {
1587
+ "in": "query",
1588
+ "name": "resourceMetadata",
1589
+ "description": "Return only metadata of DID-Linked Resource instead of actual DID-Linked Resource. Mutually exclusive with some of the other parameters.",
1590
+ "schema": {
1591
+ "type": "boolean"
1592
+ }
1593
+ }
1594
+ ],
1595
+ "responses": {
1596
+ "200": {
1597
+ "description": "The request was successful.",
1598
+ "content": {
1599
+ "any": {
1600
+ "schema": {
1601
+ "type": "object"
1602
+ }
1603
+ }
1604
+ }
1605
+ },
1606
+ "400": {
1607
+ "$ref": "#/components/schemas/InvalidRequest"
1608
+ },
1609
+ "401": {
1610
+ "$ref": "#/components/schemas/UnauthorizedError"
1611
+ },
1612
+ "500": {
1613
+ "$ref": "#/components/schemas/InternalError"
1614
+ }
1615
+ }
1616
+ }
1617
+ }
1618
+ },
1619
+ "components": {
1620
+ "schemas": {
1621
+ "AlsoKnownAs": {
1622
+ "type": "object",
1623
+ "properties": {
1624
+ "alsoKnownAs": {
1625
+ "type": "array",
1626
+ "description": "Optional field to assign a set of alternative URIs where the DID-Linked Resource can be fetched from.",
1627
+ "items": {
1628
+ "type": "object",
1629
+ "properties": {
1630
+ "uri": {
1631
+ "type": "string",
1632
+ "format": "uri",
1633
+ "description": "URI where the DID-Linked Resource can be fetched from. Can be any type of URI (e.g., DID, HTTPS, IPFS, etc.)"
1634
+ },
1635
+ "description": {
1636
+ "type": "string",
1637
+ "description": "Optional description of the URI."
1638
+ }
1639
+ }
1640
+ }
1641
+ }
1642
+ }
1643
+ },
1644
+ "CredentialRequest": {
1645
+ "description": "Input fields for the creating a Verifiable Credential.",
1646
+ "type": "object",
1647
+ "additionalProperties": false,
1648
+ "properties": {
1649
+ "issuerDid": {
1650
+ "description": "DID of the Verifiable Credential issuer. This needs to be a `did:cheqd` DID.",
1651
+ "type": "string",
1652
+ "example": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0"
1653
+ },
1654
+ "subjectDid": {
1655
+ "description": "DID of the Verifiable Credential holder/subject. This needs to be a `did:key` DID.",
1656
+ "type": "string",
1657
+ "example": "did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK"
1658
+ },
1659
+ "attributes": {
1660
+ "description": "JSON object containing the attributes to be included in the credential.",
1661
+ "type": "object",
1662
+ "example": {
1663
+ "name": "Bob",
1664
+ "gender": "male"
1665
+ }
1666
+ },
1667
+ "@context": {
1668
+ "description": "Optional properties to be included in the `@context` property of the credential.",
1669
+ "type": "array",
1670
+ "items": {
1671
+ "type": "string"
1672
+ },
1673
+ "example": [
1674
+ "https://schema.org/schema.jsonld",
1675
+ "https://veramo.io/contexts/profile/v1"
1676
+ ]
1677
+ },
1678
+ "type": {
1679
+ "description": "Optional properties to be included in the `type` property of the credential.",
1680
+ "type": "array",
1681
+ "items": {
1682
+ "type": "string"
1683
+ },
1684
+ "example": [
1685
+ "Person"
1686
+ ]
1687
+ },
1688
+ "expirationDate": {
1689
+ "description": "Optional expiration date according to the <a href=https://www.w3.org/TR/vc-data-model/#expiration> VC Data Model specification</a>.",
1690
+ "type": "string",
1691
+ "format": "date-time",
1692
+ "example": "2023-06-08T13:49:28.000Z"
1693
+ },
1694
+ "format": {
1695
+ "description": "Format of the Verifiable Credential. Defaults to VC-JWT.",
1696
+ "type": "string",
1697
+ "enum": [
1698
+ "jwt",
1699
+ "jsonld"
1700
+ ],
1701
+ "example": "jwt"
1702
+ },
1703
+ "credentialStatus": {
1704
+ "description": "Optional `credentialStatus` properties for VC revocation or suspension. Takes `statusListName` and `statusListPurpose` as inputs.",
1705
+ "type": "object",
1706
+ "required": [
1707
+ "statusPurpose",
1708
+ "statusListName"
1709
+ ],
1710
+ "properties": {
1711
+ "statusPurpose": {
1712
+ "type": "string",
1713
+ "enum": [
1714
+ "revocation",
1715
+ "suspension"
1716
+ ]
1717
+ },
1718
+ "statusListName": {
1719
+ "type": "string"
1720
+ },
1721
+ "statusListIndex": {
1722
+ "type": "number"
1723
+ },
1724
+ "statusListVersion": {
1725
+ "type": "string",
1726
+ "format": "date-time"
1727
+ },
1728
+ "statusListRangeStart": {
1729
+ "type": "number"
1730
+ },
1731
+ "statusListRangeEnd": {
1732
+ "type": "number"
1733
+ },
1734
+ "indexNotIn": {
1735
+ "type": "number"
1736
+ }
1737
+ },
1738
+ "example": {
1739
+ "statusPurpose": "revocation",
1740
+ "statusListName": "employee-credentials"
1741
+ }
1742
+ }
1743
+ },
1744
+ "required": [
1745
+ "issuerDid",
1746
+ "subjectDid",
1747
+ "attributes"
1748
+ ],
1749
+ "example": {
1750
+ "issuerDid": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0",
1751
+ "subjectDid": "did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK",
1752
+ "attributes": {
1753
+ "gender": "male",
1754
+ "name": "Bob"
1755
+ },
1756
+ "@context": [
1757
+ "https://schema.org"
1758
+ ],
1759
+ "type": [
1760
+ "Person"
1761
+ ],
1762
+ "format": "jwt",
1763
+ "credentialStatus": {
1764
+ "statusPurpose": "revocation",
1765
+ "statusListName": "employee-credentials",
1766
+ "statusListIndex": 10
1767
+ }
1768
+ }
1769
+ },
1770
+ "Credential": {
1771
+ "description": "Input fields for revoking/suspending a Verifiable Credential.",
1772
+ "type": "object",
1773
+ "additionalProperties": false,
1774
+ "properties": {
1775
+ "@context": {
1776
+ "type": "array",
1777
+ "items": {
1778
+ "type": "string"
1779
+ },
1780
+ "example": [
1781
+ "https://www.w3.org/2018/credentials/v1",
1782
+ "https://schema.org",
1783
+ "https://veramo.io/contexts/profile/v1"
1784
+ ]
1785
+ },
1786
+ "type": {
1787
+ "type": "array",
1788
+ "items": {
1789
+ "type": "string"
1790
+ },
1791
+ "example": [
1792
+ "VerifiableCredential",
1793
+ "Person"
1794
+ ]
1795
+ },
1796
+ "expirationDate": {
1797
+ "type": "string",
1798
+ "format": "date-time",
1799
+ "example": "2023-06-08T13:49:28.000Z"
1800
+ },
1801
+ "issuer": {
1802
+ "type": "object",
1803
+ "properties": {
1804
+ "id": {
1805
+ "type": "string",
1806
+ "format": "DID",
1807
+ "example": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0"
1808
+ }
1809
+ }
1810
+ },
1811
+ "credentialSubject": {
1812
+ "type": "object",
1813
+ "properties": {
1814
+ "id": {
1815
+ "type": "string",
1816
+ "format": "DID",
1817
+ "example": "did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK"
1818
+ }
1819
+ }
1820
+ },
1821
+ "credentialStatus": {
1822
+ "type": "object",
1823
+ "properties": {
1824
+ "id": {
1825
+ "type": "string",
1826
+ "example": "https://resolver.cheqd.net/1.0/identifiers/did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e?resourceName=cheqd-suspension-1&resourceType=StatusList2021Suspension#20"
1827
+ },
1828
+ "statusListIndex": {
1829
+ "type": "number",
1830
+ "example": 20
1831
+ },
1832
+ "statusPurpose": {
1833
+ "type": "string",
1834
+ "enum": [
1835
+ "revocation",
1836
+ "suspension"
1837
+ ],
1838
+ "example": "suspension"
1839
+ },
1840
+ "type": {
1841
+ "type": "string",
1842
+ "enum": [
1843
+ "StatusList2021Entry"
1844
+ ]
1845
+ }
1846
+ }
1847
+ },
1848
+ "issuanceDate": {
1849
+ "type": "string",
1850
+ "format": "date-time",
1851
+ "example": "2023-06-08T13:49:28.000Z"
1852
+ },
1853
+ "proof": {
1854
+ "type": "object",
1855
+ "properties": {
1856
+ "type": {
1857
+ "type": "string"
1858
+ },
1859
+ "jwt": {
1860
+ "type": "string"
1861
+ }
1862
+ },
1863
+ "example": {
1864
+ "type": "JwtProof2020",
1865
+ "jwt": "eyJhbGciOiJFZERTQSIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJkaWQ6Y2hlcWQ6dGVzdG5ldDo3YmY4MWEyMC02MzNjLTRjYzctYmM0YS01YTQ1ODAxMDA1ZTAiLCJuYmYiOjE2ODYyMzIxNjgsInN1YiI6ImRpZDprZXk6ejZNa2hhWGdCWkR2b3REa0w1MjU3ZmFpenRpR2lDMlF0S0xHcGJubkVHdGEyZG9LIiwidmMiOnsiQGNvbnRleHQiOlsiaHR0cHM6Ly93d3cudzMub3JnLzIwMTgvY3JlZGVudGlhbHMvdjEiLCJodHRwczovL3NjaGVtYS5vcmciLCJodHRwczovL3ZlcmFtby5pby9jb250ZXh0cy9wcm9maWxlL3YxIl0sImNyZWRlbnRpYWxTdWJqZWN0Ijp7ImdlbmRlciI6Im1hbGUiLCJuYW1lIjoiQm9iIn0sInR5cGUiOlsiVmVyaWZpYWJsZUNyZWRlbnRpYWwiLCJQZXJzb24iXX19.wMfdR6RtyAZA4eoWya5Aw97wwER2Cm5Guk780Xw8H9fA3sfudIJeLRLboqixpTchqSbYeA7KbuCTAnLgXTD_Cg"
1866
+ }
1867
+ }
1868
+ },
1869
+ "example": {
1870
+ "@context": [
1871
+ "https://www.w3.org/2018/credentials/v1",
1872
+ "https://schema.org",
1873
+ "https://veramo.io/contexts/profile/v1"
1874
+ ],
1875
+ "credentialSubject": {
1876
+ "gender": "male",
1877
+ "id": "did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK",
1878
+ "name": "Bob"
1879
+ },
1880
+ "credentialStatus": {
1881
+ "id": "https://resolver.cheqd.net/1.0/identifiers/did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e?resourceName=cheqd-suspension-1&resourceType=StatusList2021Suspension#20",
1882
+ "statusIndex": 20,
1883
+ "statusPurpose": "suspension",
1884
+ "type": "StatusList2021Entry"
1885
+ },
1886
+ "issuanceDate": "2023-06-08T13:49:28.000Z",
1887
+ "issuer": {
1888
+ "id": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0"
1889
+ },
1890
+ "proof": {
1891
+ "jwt": "eyJhbGciOiJFZERTQSIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJkaWQ6Y2hlcWQ6dGVzdG5ldDo3YmY4MWEyMC02MzNjLTRjYzctYmM0YS01YTQ1ODAxMDA1ZTAiLCJuYmYiOjE2ODYyMzIxNjgsInN1YiI6ImRpZDprZXk6ejZNa2hhWGdCWkR2b3REa0w1MjU3ZmFpenRpR2lDMlF0S0xHcGJubkVHdGEyZG9LIiwidmMiOnsiQGNvbnRleHQiOlsiaHR0cHM6Ly93d3cudzMub3JnLzIwMTgvY3JlZGVudGlhbHMvdjEiLCJodHRwczovL3NjaGVtYS5vcmciLCJodHRwczovL3ZlcmFtby5pby9jb250ZXh0cy9wcm9maWxlL3YxIl0sImNyZWRlbnRpYWxTdWJqZWN0Ijp7ImdlbmRlciI6Im1hbGUiLCJuYW1lIjoiQm9iIn0sInR5cGUiOlsiVmVyaWZpYWJsZUNyZWRlbnRpYWwiLCJQZXJzb24iXX19.wMfdR6RtyAZA4eoWya5Aw97wwER2Cm5Guk780Xw8H9fA3sfudIJeLRLboqixpTchqSbYeA7KbuCTAnLgXTD_Cg",
1892
+ "type": "JwtProof2020"
1893
+ },
1894
+ "type": [
1895
+ "VerifiableCredential",
1896
+ "Person"
1897
+ ]
1898
+ }
1899
+ },
1900
+ "CredentialRevokeRequest": {
1901
+ "type": "object",
1902
+ "properties": {
1903
+ "credential": {
1904
+ "description": "Verifiable Credential to be revoked as a VC-JWT string or a JSON object.",
1905
+ "oneOf": [
1906
+ {
1907
+ "type": "object"
1908
+ },
1909
+ {
1910
+ "type": "string"
1911
+ }
1912
+ ]
1913
+ },
1914
+ "symmetricKey": {
1915
+ "description": "The symmetric key used to encrypt the StatusList2021 DID-Linked Resource. Required if the StatusList2021 DID-Linked Resource is encrypted.",
1916
+ "type": "string"
1917
+ }
1918
+ }
1919
+ },
1920
+ "RevocationResult": {
1921
+ "properties": {
1922
+ "revoked": {
1923
+ "type": "boolean",
1924
+ "example": true
1925
+ }
1926
+ }
1927
+ },
1928
+ "SuspensionResult": {
1929
+ "properties": {
1930
+ "suspended": {
1931
+ "type": "boolean",
1932
+ "example": true
1933
+ }
1934
+ }
1935
+ },
1936
+ "UnsuspensionResult": {
1937
+ "properties": {
1938
+ "unsuspended": {
1939
+ "type": "boolean",
1940
+ "example": true
1941
+ }
1942
+ }
1943
+ },
1944
+ "CredentialVerifyRequest": {
1945
+ "type": "object",
1946
+ "properties": {
1947
+ "credential": {
1948
+ "description": "Verifiable Credential to be verified as a VC-JWT string or a JSON object.",
1949
+ "type": "object"
1950
+ },
1951
+ "policies": {
1952
+ "description": "Custom verification policies to execute when verifying credential.",
1953
+ "type": "object",
1954
+ "properties": {
1955
+ "issuanceDate": {
1956
+ "description": "Policy to skip the `issuanceDate` (`nbf`) timestamp check when set to `false`.",
1957
+ "type": "boolean",
1958
+ "default": true
1959
+ },
1960
+ "expirationDate": {
1961
+ "description": "Policy to skip the `expirationDate` (`exp`) timestamp check when set to `false`.",
1962
+ "type": "boolean",
1963
+ "default": true
1964
+ },
1965
+ "audience": {
1966
+ "description": "Policy to skip the audience check when set to `false`.",
1967
+ "type": "boolean",
1968
+ "default": false
1969
+ }
1970
+ }
1971
+ }
1972
+ }
1973
+ },
1974
+ "VerifyPresentationResult": {
1975
+ "type": "object",
1976
+ "properties": {
1977
+ "verified": {
1978
+ "type": "boolean"
1979
+ },
1980
+ "issuer": {
1981
+ "type": "string"
1982
+ },
1983
+ "signer": {
1984
+ "type": "object"
1985
+ },
1986
+ "jwt": {
1987
+ "type": "string"
1988
+ },
1989
+ "verifiableCredential": {
1990
+ "type": "object"
1991
+ }
1992
+ }
1993
+ },
1994
+ "VerifyCredentialResult": {
1995
+ "type": "object",
1996
+ "properties": {
1997
+ "verified": {
1998
+ "type": "boolean"
1999
+ },
2000
+ "issuer": {
2001
+ "type": "string"
2002
+ },
2003
+ "signer": {
2004
+ "type": "object"
2005
+ },
2006
+ "jwt": {
2007
+ "type": "string"
2008
+ },
2009
+ "verifiableCredential": {
2010
+ "type": "object"
2011
+ }
2012
+ },
2013
+ "example": {
2014
+ "verified": true,
2015
+ "polices": {},
2016
+ "issuer": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0",
2017
+ "signer": {
2018
+ "controller": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0",
2019
+ "id": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#key-1",
2020
+ "publicKeyBase58": "BTJiso1S4iSiReP6wGksSneGfiKHxz9SYcm2KknpqBJt",
2021
+ "type": "Ed25519VerificationKey2018"
2022
+ }
2023
+ }
2024
+ },
2025
+ "PresentationCreateRequest": {
2026
+ "type": "object",
2027
+ "required": [
2028
+ "credentials"
2029
+ ],
2030
+ "properties": {
2031
+ "credentials": {
2032
+ "description": "Verifiable Credentials to be used for VP-JWT creation as a VP-JWT strings or a JSON objectsf.",
2033
+ "type": "array",
2034
+ "items": {
2035
+ "type": "object"
2036
+ }
2037
+ },
2038
+ "holderDid": {
2039
+ "description": "DID of holder",
2040
+ "type": "string"
2041
+ },
2042
+ "verifierDid": {
2043
+ "description": "DID of verifier",
2044
+ "type": "string"
2045
+ }
2046
+ }
2047
+ },
2048
+ "PresentationVerifyRequest": {
2049
+ "type": "object",
2050
+ "required": [
2051
+ "presentation"
2052
+ ],
2053
+ "properties": {
2054
+ "presentation": {
2055
+ "description": "Verifiable Presentation to be verified as a VP-JWT string or a JSON object.",
2056
+ "type": "object"
2057
+ },
2058
+ "verifierDid": {
2059
+ "description": "Provide an optional verifier DID (also known as 'domain' parameter), if the verifier DID in the presentation is not managed in the wallet.",
2060
+ "type": "string"
2061
+ },
2062
+ "makeFeePayment": {
2063
+ "description": "Automatically make fee payment (if required) based on payment conditions to unlock encrypted StatusList2021 DID-Linked Resource.",
2064
+ "type": "boolean",
2065
+ "default": false
2066
+ },
2067
+ "policies": {
2068
+ "description": "Custom verification policies to execute when verifying presentation.",
2069
+ "type": "object",
2070
+ "properties": {
2071
+ "issuanceDate": {
2072
+ "description": "Policy to skip the `issuanceDate` (`nbf`) timestamp check when set to `false`.",
2073
+ "type": "boolean",
2074
+ "default": true
2075
+ },
2076
+ "expirationDate": {
2077
+ "description": "Policy to skip the `expirationDate` (`exp`) timestamp check when set to `false`.",
2078
+ "type": "boolean",
2079
+ "default": true
2080
+ },
2081
+ "audience": {
2082
+ "description": "Policy to skip the audience check when set to `false`.",
2083
+ "type": "boolean",
2084
+ "default": false
2085
+ }
2086
+ }
2087
+ }
2088
+ }
2089
+ },
2090
+ "CredentialStatusCreateBody": {
2091
+ "allOf": [
2092
+ {
2093
+ "type": "object",
2094
+ "required": [
2095
+ "did",
2096
+ "statusListName"
2097
+ ],
2098
+ "properties": {
2099
+ "did": {
2100
+ "description": "DID of the StatusList2021 publisher.",
2101
+ "type": "string",
2102
+ "format": "uri"
2103
+ },
2104
+ "statusListName": {
2105
+ "description": "The name of the StatusList2021 DID-Linked Resource to be created.",
2106
+ "type": "string"
2107
+ },
2108
+ "length": {
2109
+ "description": "The length of the status list to be created. The default and minimum length is 140000 which is 16kb.",
2110
+ "type": "integer",
2111
+ "minimum": 0,
2112
+ "exclusiveMinimum": true,
2113
+ "default": 140000
2114
+ },
2115
+ "encoding": {
2116
+ "description": "The encoding format of the StatusList2021 DiD-Linked Resource to be created.",
2117
+ "type": "string",
2118
+ "default": "base64url",
2119
+ "enum": [
2120
+ "base64url",
2121
+ "base64",
2122
+ "hex"
2123
+ ]
2124
+ },
2125
+ "statusListVersion": {
2126
+ "description": "Optional field to assign a human-readable version in the StatusList2021 DID-Linked Resource.",
2127
+ "type": "string"
2128
+ }
2129
+ }
2130
+ },
2131
+ {
2132
+ "$ref": "#/components/schemas/AlsoKnownAs"
2133
+ }
2134
+ ]
2135
+ },
2136
+ "CredentialStatusCreateUnencryptedRequest": {
2137
+ "allOf": [
2138
+ {
2139
+ "$ref": "#/components/schemas/CredentialStatusCreateBody"
2140
+ }
2141
+ ],
2142
+ "example": {
2143
+ "did": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e",
2144
+ "statusListName": "cheqd-employee-credentials",
2145
+ "length": 140000,
2146
+ "encoding": "base64url"
2147
+ }
2148
+ },
2149
+ "CredentialStatusUnencryptedResult": {
2150
+ "type": "object",
2151
+ "properties": {
2152
+ "resource": {
2153
+ "type": "object",
2154
+ "properties": {
2155
+ "StatusList2021": {
2156
+ "type": "object",
2157
+ "properties": {
2158
+ "encodedList": {
2159
+ "type": "string",
2160
+ "example": "H4sIAAAAAAAAA-3BAQ0AAADCoPdPbQ8HFAAAAAAAAAAAAAAAAAAAAADwaDhDr_xcRAAA"
2161
+ },
2162
+ "type": {
2163
+ "type": "string",
2164
+ "example": "StatusList2021Revocation"
2165
+ },
2166
+ "validFrom": {
2167
+ "type": "string",
2168
+ "format": "date-time",
2169
+ "example": "2023-06-26T11:45:19.349Z"
2170
+ }
2171
+ }
2172
+ },
2173
+ "metadata": {
2174
+ "type": "object",
2175
+ "properties": {
2176
+ "type": {
2177
+ "type": "string",
2178
+ "example": "StatusList2021Revocation"
2179
+ },
2180
+ "encoding": {
2181
+ "type": "string",
2182
+ "example": "base64url"
2183
+ },
2184
+ "encrypted": {
2185
+ "type": "boolean",
2186
+ "example": false
2187
+ }
2188
+ }
2189
+ }
2190
+ }
2191
+ },
2192
+ "resourceMetadata": {
2193
+ "type": "object",
2194
+ "example": {
2195
+ "resourceURI": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e/resources/5945233a-a4b5-422b-b893-eaed5cedd2dc",
2196
+ "resourceCollectionId": "7c2b990c-3d05-4ebf-91af-f4f4d0091d2e",
2197
+ "resourceId": "5945233a-a4b5-422b-b893-eaed5cedd2dc",
2198
+ "resourceName": "cheqd-employee-credentials",
2199
+ "resourceType": "StatusList2021Revocation",
2200
+ "mediaType": "application/json",
2201
+ "resourceVersion": "1.0.0",
2202
+ "created": "2023-06-26T11:45:20Z",
2203
+ "checksum": "909e22e371a41afbb96c330a97752cf7c8856088f1f937f87decbef06cbe9ca2",
2204
+ "previousVersionId": null,
2205
+ "nextVersionId": null
2206
+ }
2207
+ }
2208
+ }
2209
+ },
2210
+ "CredentialStatusCreateUnencryptedResult": {
2211
+ "allOf": [
2212
+ {
2213
+ "type": "object",
2214
+ "properties": {
2215
+ "created": {
2216
+ "type": "boolean",
2217
+ "example": true
2218
+ }
2219
+ }
2220
+ },
2221
+ {
2222
+ "$ref": "#/components/schemas/CredentialStatusUnencryptedResult"
2223
+ }
2224
+ ]
2225
+ },
2226
+ "CredentialStatusEncryptedPaymentConditionsBody": {
2227
+ "type": "object",
2228
+ "properties": {
2229
+ "feePaymentAddress": {
2230
+ "description": "The cheqd/Cosmos payment address where payments to unlock the encrypted StatusList2021 DID-Linked Resource need to be sent.",
2231
+ "type": "string",
2232
+ "example": "cheqd1qs0nhyk868c246defezhz5eymlt0dmajna2csg"
2233
+ },
2234
+ "feePaymentAmount": {
2235
+ "description": "Amount in CHEQ tokens to unlock the encrypted StatusList2021 DID-Linked Resource.",
2236
+ "type": "number",
2237
+ "minimum": 0,
2238
+ "exclusiveMinimum": true,
2239
+ "default": 20
2240
+ },
2241
+ "feePaymentWindow": {
2242
+ "description": "Time window (in minutes) within which the payment to unlock the encrypted StatusList2021 DID-Linked Resource is considered valid.",
2243
+ "type": "number",
2244
+ "minimum": 0,
2245
+ "exclusiveMinimum": true,
2246
+ "default": 10
2247
+ }
2248
+ }
2249
+ },
2250
+ "CredentialStatusEncryptedPaymentConditionsJson": {
2251
+ "type": "object",
2252
+ "properties": {
2253
+ "paymentConditions": {
2254
+ "allOf": [
2255
+ {
2256
+ "$ref": "#/components/schemas/CredentialStatusEncryptedPaymentConditionsBody"
2257
+ }
2258
+ ]
2259
+ }
2260
+ }
2261
+ },
2262
+ "CredentialStatusCreateEncryptedFormRequest": {
2263
+ "allOf": [
2264
+ {
2265
+ "$ref": "#/components/schemas/CredentialStatusCreateBody"
2266
+ },
2267
+ {
2268
+ "$ref": "#/components/schemas/CredentialStatusEncryptedPaymentConditionsBody"
2269
+ },
2270
+ {
2271
+ "type": "object",
2272
+ "required": [
2273
+ "feePaymentAddress",
2274
+ "feePaymentAmount",
2275
+ "feePaymentWindow"
2276
+ ]
2277
+ }
2278
+ ]
2279
+ },
2280
+ "CredentialStatusCreateEncryptedJsonRequest": {
2281
+ "allOf": [
2282
+ {
2283
+ "$ref": "#/components/schemas/CredentialStatusCreateBody"
2284
+ },
2285
+ {
2286
+ "$ref": "#/components/schemas/CredentialStatusEncryptedPaymentConditionsJson"
2287
+ },
2288
+ {
2289
+ "type": "object",
2290
+ "required": [
2291
+ "paymentConditions"
2292
+ ]
2293
+ }
2294
+ ],
2295
+ "example": {
2296
+ "did": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e",
2297
+ "statusListName": "cheqd-employee-credentials-encrypted",
2298
+ "paymentConditions": [
2299
+ {
2300
+ "feePaymentAddress": "cheqd1qs0nhyk868c246defezhz5eymlt0dmajna2csg",
2301
+ "feePaymentAmount": 20,
2302
+ "feePaymentWindow": 10
2303
+ }
2304
+ ]
2305
+ }
2306
+ },
2307
+ "CredentialStatusEncryptedResult": {
2308
+ "type": "object",
2309
+ "properties": {
2310
+ "resource": {
2311
+ "type": "object",
2312
+ "properties": {
2313
+ "StatusList2021": {
2314
+ "type": "object",
2315
+ "properties": {
2316
+ "encodedList": {
2317
+ "type": "string",
2318
+ "example": "496fdfbeb745b4db03fcdb40566f9c4c4a1c0f184b31255e641b6e7bdfb9b6946c12be87ca3763be0393c00b67ac1e8737c106b32f46ef59c765754415b5e8cc7c65fccaa3374620430ea476301a5e0dd63340e7a27a68bc627518471f22e4a2"
2319
+ },
2320
+ "type": {
2321
+ "type": "string",
2322
+ "example": "StatusList2021Revocation"
2323
+ },
2324
+ "validFrom": {
2325
+ "type": "string",
2326
+ "format": "date-time",
2327
+ "example": "2023-06-26T11:45:19.349Z"
2328
+ }
2329
+ }
2330
+ },
2331
+ "metadata": {
2332
+ "type": "object",
2333
+ "properties": {
2334
+ "type": {
2335
+ "type": "string",
2336
+ "example": "StatusList2021Revocation"
2337
+ },
2338
+ "encoding": {
2339
+ "type": "string",
2340
+ "example": "base64url"
2341
+ },
2342
+ "encrypted": {
2343
+ "type": "boolean",
2344
+ "example": true
2345
+ },
2346
+ "encryptedSymmetricKey": {
2347
+ "type": "string",
2348
+ "example": "b11182dc524b8181f9a6aef4c4ad0a1c14e40033b9112dffd8d1bcf6cc3b85abc07ded2205ee94068a99f4202502cb0855f322583fa6ce1534d3a05bf36891766ea2c5f90a982b3040680762977d404d758a2370224a239c8279aa7d21e980931c42055b17ca4c7dbffa4782480a8b6279cf989b2f166d5fdb4b2c1b5a63927200000000000000203018dcaba26df45a415bb599218b27ca853a70289d7a3ed3ed0e3730452e8f8d9af91b6e71312565d2c069341f6660ab"
2349
+ },
2350
+ "paymentConditions": {
2351
+ "type": "array",
2352
+ "items": {
2353
+ "type": "object",
2354
+ "properties": {
2355
+ "feePaymentAddress": {
2356
+ "type": "string",
2357
+ "example": "cheqd1qs0nhyk868c246defezhz5eymlt0dmajna2csg"
2358
+ },
2359
+ "feePaymentAmount": {
2360
+ "type": "string",
2361
+ "example": "20000000000ncheq"
2362
+ },
2363
+ "intervalInSeconds": {
2364
+ "type": "number",
2365
+ "example": 600
2366
+ },
2367
+ "type": {
2368
+ "type": "string",
2369
+ "example": "timelockPayment"
2370
+ }
2371
+ }
2372
+ }
2373
+ }
2374
+ }
2375
+ },
2376
+ "resourceMetadata": {
2377
+ "type": "object",
2378
+ "example": {
2379
+ "resourceURI": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e/resources/5945233a-a4b5-422b-b893-eaed5cedd2dc",
2380
+ "resourceCollectionId": "7c2b990c-3d05-4ebf-91af-f4f4d0091d2e",
2381
+ "resourceId": "5945233a-a4b5-422b-b893-eaed5cedd2dc",
2382
+ "resourceName": "cheqd-revocation-encrypted-1",
2383
+ "resourceType": "StatusList2021Revocation",
2384
+ "mediaType": "application/json",
2385
+ "resourceVersion": "2023-06-26T11:45:19.349Z",
2386
+ "created": "2023-06-26T11:45:20Z",
2387
+ "checksum": "909e22e371a41afbb96c330a97752cf7c8856088f1f937f87decbef06cbe9ca2",
2388
+ "previousVersionId": null,
2389
+ "nextVersionId": null
2390
+ }
2391
+ },
2392
+ "symmetricKey": {
2393
+ "type": "string",
2394
+ "example": "dfe204ee95ae74ea5d74b94c3d8ff782273905b07fbc9f8c3d961c3b43849f18"
2395
+ }
2396
+ }
2397
+ }
2398
+ }
2399
+ },
2400
+ "CredentialStatusCreateEncryptedResult": {
2401
+ "allOf": [
2402
+ {
2403
+ "type": "object",
2404
+ "properties": {
2405
+ "created": {
2406
+ "type": "boolean",
2407
+ "example": true
2408
+ }
2409
+ }
2410
+ },
2411
+ {
2412
+ "$ref": "#/components/schemas/CredentialStatusEncryptedResult"
2413
+ }
2414
+ ]
2415
+ },
2416
+ "CredentialStatusUpdateBody": {
2417
+ "type": "object",
2418
+ "required": [
2419
+ "did",
2420
+ "statusListName",
2421
+ "indices"
2422
+ ],
2423
+ "properties": {
2424
+ "did": {
2425
+ "description": "DID of the StatusList2021 publisher.",
2426
+ "type": "string",
2427
+ "format": "uri"
2428
+ },
2429
+ "statusListName": {
2430
+ "description": "The name of the StatusList2021 DID-Linked Resource to be updated.",
2431
+ "type": "string"
2432
+ },
2433
+ "indices": {
2434
+ "description": "List of credential status indices to be updated. The indices must be in the range of the status list.",
2435
+ "type": "array",
2436
+ "items": {
2437
+ "type": "integer",
2438
+ "minimum": 0,
2439
+ "exclusiveMinimum": false
2440
+ }
2441
+ },
2442
+ "statusListVersion": {
2443
+ "description": "Optional field to assign a human-readable version in the StatusList2021 DID-Linked Resource.",
2444
+ "type": "string"
2445
+ }
2446
+ }
2447
+ },
2448
+ "CredentialStatusUpdateUnencryptedRequest": {
2449
+ "allOf": [
2450
+ {
2451
+ "$ref": "#/components/schemas/CredentialStatusUpdateBody"
2452
+ }
2453
+ ],
2454
+ "example": {
2455
+ "did": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e",
2456
+ "statusListName": "cheqd-employee-credentials",
2457
+ "indices": [
2458
+ 10,
2459
+ 3199,
2460
+ 12109,
2461
+ 130999
2462
+ ]
2463
+ }
2464
+ },
2465
+ "CredentialStatusUpdateUnencryptedResult": {
2466
+ "allOf": [
2467
+ {
2468
+ "type": "object",
2469
+ "properties": {
2470
+ "updated": {
2471
+ "type": "boolean",
2472
+ "example": true
2473
+ }
2474
+ }
2475
+ },
2476
+ {
2477
+ "oneOf": [
2478
+ {
2479
+ "$ref": "#/components/schemas/RevocationResult"
2480
+ },
2481
+ {
2482
+ "$ref": "#/components/schemas/SuspensionResult"
2483
+ },
2484
+ {
2485
+ "$ref": "#/components/schemas/UnsuspensionResult"
2486
+ }
2487
+ ]
2488
+ },
2489
+ {
2490
+ "$ref": "#/components/schemas/CredentialStatusUnencryptedResult"
2491
+ }
2492
+ ]
2493
+ },
2494
+ "CredentialStatusUpdateEncryptedFormRequest": {
2495
+ "allOf": [
2496
+ {
2497
+ "$ref": "#/components/schemas/CredentialStatusUpdateBody"
2498
+ },
2499
+ {
2500
+ "type": "object",
2501
+ "required": [
2502
+ "symmetricKey"
2503
+ ],
2504
+ "properties": {
2505
+ "symmetricKey": {
2506
+ "description": "The symmetric key used to encrypt the StatusList2021 DID-Linked Resource.",
2507
+ "type": "string"
2508
+ }
2509
+ }
2510
+ },
2511
+ {
2512
+ "$ref": "#/components/schemas/CredentialStatusEncryptedPaymentConditionsBody"
2513
+ }
2514
+ ]
2515
+ },
2516
+ "CredentialStatusUpdateEncryptedJsonRequest": {
2517
+ "allOf": [
2518
+ {
2519
+ "$ref": "#/components/schemas/CredentialStatusUpdateBody"
2520
+ },
2521
+ {
2522
+ "type": "object",
2523
+ "required": [
2524
+ "symmetricKey"
2525
+ ],
2526
+ "properties": {
2527
+ "symmetricKey": {
2528
+ "description": "The symmetric key used to encrypt the StatusList2021 DID-Linked Resource.",
2529
+ "type": "string"
2530
+ }
2531
+ }
2532
+ },
2533
+ {
2534
+ "$ref": "#/components/schemas/CredentialStatusEncryptedPaymentConditionsJson"
2535
+ }
2536
+ ],
2537
+ "example": {
2538
+ "did": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e",
2539
+ "statusListName": "cheqd-employee-credentials-encrypted",
2540
+ "indices": [
2541
+ 10,
2542
+ 3199,
2543
+ 12109,
2544
+ 130999
2545
+ ],
2546
+ "symmetricKey": "dfe204ee95ae74ea5d74b94c3d8ff782273905b07fbc9f8c3d961c3b43849f18"
2547
+ }
2548
+ },
2549
+ "CredentialStatusUpdateEncryptedResult": {
2550
+ "allOf": [
2551
+ {
2552
+ "type": "object",
2553
+ "properties": {
2554
+ "updated": {
2555
+ "type": "boolean",
2556
+ "example": true
2557
+ }
2558
+ }
2559
+ },
2560
+ {
2561
+ "oneOf": [
2562
+ {
2563
+ "$ref": "#/components/schemas/RevocationResult"
2564
+ },
2565
+ {
2566
+ "$ref": "#/components/schemas/SuspensionResult"
2567
+ },
2568
+ {
2569
+ "$ref": "#/components/schemas/UnsuspensionResult"
2570
+ }
2571
+ ]
2572
+ },
2573
+ {
2574
+ "$ref": "#/components/schemas/CredentialStatusEncryptedResult"
2575
+ }
2576
+ ]
2577
+ },
2578
+ "CredentialStatusCheckRequest": {
2579
+ "type": "object",
2580
+ "required": [
2581
+ "did",
2582
+ "statusListName",
2583
+ "index"
2584
+ ],
2585
+ "properties": {
2586
+ "did": {
2587
+ "description": "DID of the StatusList2021 publisher.",
2588
+ "type": "string",
2589
+ "format": "uri"
2590
+ },
2591
+ "statusListName": {
2592
+ "description": "The name of the StatusList2021 DID-Linked Resource to be checked.",
2593
+ "type": "string"
2594
+ },
2595
+ "index": {
2596
+ "description": "Credential status index to be checked for revocation or suspension.",
2597
+ "type": "integer",
2598
+ "minimum": 0,
2599
+ "exclusiveMinimum": false
2600
+ },
2601
+ "makeFeePayment": {
2602
+ "description": "Automatically make fee payment (if required) based on payment conditions to unlock encrypted StatusList2021 DID-Linked Resource.",
2603
+ "type": "boolean",
2604
+ "default": true
2605
+ }
2606
+ }
2607
+ },
2608
+ "CredentialStatusCheckResult": {
2609
+ "oneOf": [
2610
+ {
2611
+ "$ref": "#/components/schemas/CredentialStatusCheckRevocationResult"
2612
+ },
2613
+ {
2614
+ "$ref": "#/components/schemas/CredentialStatusCheckSuspensionResult"
2615
+ }
2616
+ ]
2617
+ },
2618
+ "CredentialStatusCheckRevocationResult": {
2619
+ "type": "object",
2620
+ "properties": {
2621
+ "checked": {
2622
+ "type": "boolean",
2623
+ "example": true
2624
+ },
2625
+ "revoked": {
2626
+ "type": "boolean",
2627
+ "example": false
2628
+ }
2629
+ }
2630
+ },
2631
+ "CredentialStatusCheckSuspensionResult": {
2632
+ "type": "object",
2633
+ "properties": {
2634
+ "checked": {
2635
+ "type": "boolean",
2636
+ "example": true
2637
+ },
2638
+ "suspended": {
2639
+ "type": "boolean",
2640
+ "example": false
2641
+ }
2642
+ }
2643
+ },
2644
+ "CredentialStatusListSearchResult": {
2645
+ "allOf": [
2646
+ {
2647
+ "type": "object",
2648
+ "properties": {
2649
+ "found": {
2650
+ "type": "boolean",
2651
+ "example": true
2652
+ }
2653
+ }
2654
+ },
2655
+ {
2656
+ "oneOf": [
2657
+ {
2658
+ "$ref": "#/components/schemas/CredentialStatusUnencryptedResult"
2659
+ },
2660
+ {
2661
+ "$ref": "#/components/schemas/CredentialStatusEncryptedResult"
2662
+ }
2663
+ ]
2664
+ }
2665
+ ]
2666
+ },
2667
+ "KeyImportRequest": {
2668
+ "type": "object",
2669
+ "properties": {
2670
+ "alias": {
2671
+ "type": "string"
2672
+ },
2673
+ "type": {
2674
+ "type": "string",
2675
+ "enum": [
2676
+ "Ed25519",
2677
+ "Secp256k1"
2678
+ ]
2679
+ },
2680
+ "privateKeyHex": {
2681
+ "type": "string"
2682
+ }
2683
+ }
2684
+ },
2685
+ "KeyResult": {
2686
+ "type": "object",
2687
+ "properties": {
2688
+ "kid": {
2689
+ "type": "string"
2690
+ },
2691
+ "type": {
2692
+ "type": "string",
2693
+ "enum": [
2694
+ "Ed25519",
2695
+ "Secp256k1"
2696
+ ]
2697
+ },
2698
+ "publicKeyHex": {
2699
+ "type": "string"
2700
+ }
2701
+ }
2702
+ },
2703
+ "DidDocument": {
2704
+ "description": "This input field contains either a complete DID document, or an incremental change (diff) to a DID document. See <a href=\"https://identity.foundation/did-registration/#diddocument\">Universal DID Registrar specification</a>.",
2705
+ "type": "object",
2706
+ "properties": {
2707
+ "@context": {
2708
+ "type": "array",
2709
+ "items": {
2710
+ "type": "string"
2711
+ }
2712
+ },
2713
+ "id": {
2714
+ "type": "string"
2715
+ },
2716
+ "controllers": {
2717
+ "type": "array",
2718
+ "items": {
2719
+ "type": "string"
2720
+ }
2721
+ },
2722
+ "verificationMethod": {
2723
+ "type": "array",
2724
+ "items": {
2725
+ "$ref": "#/components/schemas/VerificationMethod"
2726
+ }
2727
+ },
2728
+ "service": {
2729
+ "type": "array",
2730
+ "items": {
2731
+ "$ref": "#/components/schemas/Service"
2732
+ }
2733
+ },
2734
+ "authentication": {
2735
+ "type": "array",
2736
+ "items": {
2737
+ "type": "string"
2738
+ }
2739
+ },
2740
+ "assertionMethod": {
2741
+ "type": "array",
2742
+ "items": {
2743
+ "type": "string"
2744
+ }
2745
+ },
2746
+ "capabilityInvocation": {
2747
+ "type": "array",
2748
+ "items": {
2749
+ "type": "string"
2750
+ }
2751
+ },
2752
+ "capabilityDelegation": {
2753
+ "type": "array",
2754
+ "items": {
2755
+ "type": "string"
2756
+ }
2757
+ },
2758
+ "keyAgreement": {
2759
+ "type": "array",
2760
+ "items": {
2761
+ "type": "string"
2762
+ }
2763
+ }
2764
+ },
2765
+ "example": {
2766
+ "@context": [
2767
+ "https://www.w3.org/ns/did/v1"
2768
+ ],
2769
+ "id": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0",
2770
+ "controller": [
2771
+ "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0"
2772
+ ],
2773
+ "verificationMethod": [
2774
+ {
2775
+ "id": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#key-1",
2776
+ "type": "Ed25519VerificationKey2018",
2777
+ "controller": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0",
2778
+ "publicKeyBase58": "z6MkkVbyHJLLjdjU5B62DaJ4mkdMdUkttf9UqySSkA9bVTeZ"
2779
+ }
2780
+ ],
2781
+ "authentication": [
2782
+ "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#key-1"
2783
+ ],
2784
+ "service": [
2785
+ {
2786
+ "id": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1",
2787
+ "type": "LinkedDomains",
2788
+ "serviceEndpoint": [
2789
+ "https://example.com"
2790
+ ]
2791
+ }
2792
+ ]
2793
+ }
2794
+ },
2795
+ "DidDocumentWithoutVerificationMethod": {
2796
+ "type": "object",
2797
+ "properties": {
2798
+ "@context": {
2799
+ "type": "array",
2800
+ "items": {
2801
+ "type": "string"
2802
+ }
2803
+ },
2804
+ "id": {
2805
+ "type": "string"
2806
+ },
2807
+ "controllers": {
2808
+ "type": "array",
2809
+ "items": {
2810
+ "type": "string"
2811
+ }
2812
+ },
2813
+ "service": {
2814
+ "type": "array",
2815
+ "items": {
2816
+ "$ref": "#/components/schemas/Service"
2817
+ }
2818
+ },
2819
+ "authentication": {
2820
+ "type": "array",
2821
+ "items": {
2822
+ "type": "string"
2823
+ }
2824
+ },
2825
+ "assertionMethod": {
2826
+ "type": "array",
2827
+ "items": {
2828
+ "type": "string"
2829
+ }
2830
+ },
2831
+ "capabilityInvocation": {
2832
+ "type": "array",
2833
+ "items": {
2834
+ "type": "string"
2835
+ }
2836
+ },
2837
+ "capabilityDelegation": {
2838
+ "type": "array",
2839
+ "items": {
2840
+ "type": "string"
2841
+ }
2842
+ },
2843
+ "keyAgreement": {
2844
+ "type": "array",
2845
+ "items": {
2846
+ "type": "string"
2847
+ }
2848
+ }
2849
+ },
2850
+ "example": {
2851
+ "@context": [
2852
+ "https://www.w3.org/ns/did/v1"
2853
+ ],
2854
+ "id": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0",
2855
+ "controller": [
2856
+ "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0"
2857
+ ],
2858
+ "authentication": [
2859
+ "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#key-1"
2860
+ ],
2861
+ "service": [
2862
+ {
2863
+ "id": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1",
2864
+ "type": "LinkedDomains",
2865
+ "serviceEndpoint": [
2866
+ "https://example.com"
2867
+ ]
2868
+ }
2869
+ ]
2870
+ }
2871
+ },
2872
+ "DidCreateRequestFormBased": {
2873
+ "type": "object",
2874
+ "properties": {
2875
+ "network": {
2876
+ "description": "Network to create the DID on (testnet or mainnet)",
2877
+ "type": "string",
2878
+ "enum": [
2879
+ "testnet",
2880
+ "mainnet"
2881
+ ]
2882
+ },
2883
+ "identifierFormatType": {
2884
+ "description": "Algorithm to use for generating the method-specific ID. The two styles supported are UUIDs and Indy-style Base58. See <a href=\"https://docs.cheqd.io/identity/architecture/adr-list/adr-001-cheqd-did-method#cheqd-did-method-did-cheqd\">cheqd DID method documentation</a> for more details.",
2885
+ "type": "string",
2886
+ "enum": [
2887
+ "uuid",
2888
+ "base58btc"
2889
+ ]
2890
+ },
2891
+ "verificationMethodType": {
2892
+ "description": "Type of verification method to use for the DID. See <a href=\"https://www.w3.org/TR/did-core/#verification-methods\">DID Core specification</a> for more details. Only the types listed below are supported.",
2893
+ "type": "string",
2894
+ "enum": [
2895
+ "Ed25519VerificationKey2018",
2896
+ "JsonWebKey2020",
2897
+ "Ed25519VerificationKey2020"
2898
+ ]
2899
+ },
2900
+ "service": {
2901
+ "description": "It's a list of special objects which are designed to build the actual service. It's almost the same as in <a href=\"https://www.w3.org/TR/did-core/#services\">DID Core specification</a>, but instead of `id` it utilises `idFragment` field for making the right `id` for each service. !!! WARN. Cause swagger-ui does not handle x-ww-form based arrays correctly, please frame all your services in brackets while using swagger UI. !!!",
2902
+ "type": "array",
2903
+ "items": {
2904
+ "type": "object",
2905
+ "properties": {
2906
+ "idFragment": {
2907
+ "type": "string"
2908
+ },
2909
+ "type": {
2910
+ "type": "string"
2911
+ },
2912
+ "serviceEndpoint": {
2913
+ "type": "array",
2914
+ "items": {
2915
+ "type": "string"
2916
+ }
2917
+ }
2918
+ }
2919
+ },
2920
+ "example": [
2921
+ {
2922
+ "idFragment": "service-1",
2923
+ "type": "LinkedDomains",
2924
+ "serviceEndpoint": [
2925
+ "https://example.com"
2926
+ ]
2927
+ }
2928
+ ]
2929
+ },
2930
+ "key": {
2931
+ "description": "The unique identifier in hexadecimal public key format used in the verification method to create the DID.",
2932
+ "type": "string"
2933
+ },
2934
+ "@context": {
2935
+ "type": "array",
2936
+ "items": {
2937
+ "type": "string"
2938
+ },
2939
+ "example": [
2940
+ "https://www.w3.org/ns/did/v1"
2941
+ ]
2942
+ }
2943
+ }
2944
+ },
2945
+ "DidCreateRequestJson": {
2946
+ "type": "object",
2947
+ "properties": {
2948
+ "network": {
2949
+ "description": "Network to create the DID on (testnet or mainnet)",
2950
+ "type": "string",
2951
+ "enum": [
2952
+ "testnet",
2953
+ "mainnet"
2954
+ ]
2955
+ },
2956
+ "identifierFormatType": {
2957
+ "description": "Algorithm to use for generating the method-specific ID. The two styles supported are UUIDs and Indy-style Base58. See <a href=\"https://docs.cheqd.io/identity/architecture/adr-list/adr-001-cheqd-did-method#cheqd-did-method-did-cheqd\">cheqd DID method documentation</a> for more details.",
2958
+ "type": "string",
2959
+ "enum": [
2960
+ "uuid",
2961
+ "base58btc"
2962
+ ]
2963
+ },
2964
+ "assertionMethod": {
2965
+ "description": "Usually a reference to a Verification Method. An Assertion Method is required to issue JSON-LD credentials. See <a href=\"https://w3c.github.io/did-core/#assertion\">DID Core specification</a> for more details.",
2966
+ "type": "boolean",
2967
+ "default": true
2968
+ },
2969
+ "options": {
2970
+ "type": "object",
2971
+ "properties": {
2972
+ "key": {
2973
+ "type": "string",
2974
+ "example": "8255ddadd75695e01f3d98fcec8ccc7861a030b317d4326b0e48a4d579ddc43a"
2975
+ },
2976
+ "verificationMethodType": {
2977
+ "description": "Type of verification method to use for the DID. See <a href=\"https://www.w3.org/TR/did-core/#verification-methods\">DID Core specification</a> for more details. Only the types listed below are supported.",
2978
+ "type": "string",
2979
+ "enum": [
2980
+ "Ed25519VerificationKey2018",
2981
+ "JsonWebKey2020",
2982
+ "Ed25519VerificationKey2020"
2983
+ ]
2984
+ }
2985
+ }
2986
+ },
2987
+ "didDocument": {
2988
+ "$ref": "#/components/schemas/DidDocumentWithoutVerificationMethod"
2989
+ }
2990
+ }
2991
+ },
2992
+ "DidImportRequest": {
2993
+ "type": "object",
2994
+ "properties": {
2995
+ "did": {
2996
+ "type": "string",
2997
+ "description": "DID to be imported",
2998
+ "format": "uri",
2999
+ "required": true
3000
+ },
3001
+ "keys": {
3002
+ "type": "array",
3003
+ "description": "List of keys required to import the DID",
3004
+ "required": true,
3005
+ "items": {
3006
+ "$ref": "#/components/schemas/KeyImportRequest"
3007
+ }
3008
+ }
3009
+ }
3010
+ },
3011
+ "PresentationCreateResult": {
3012
+ "type": "object",
3013
+ "properties": {
3014
+ "vp": {
3015
+ "type": "object",
3016
+ "description": "Verifiable Presentation which could be provided to the verifier."
3017
+ },
3018
+ "nbf": {
3019
+ "type": "integer",
3020
+ "description": "Unix timestamp of the earliest time that the Verifiable Presentation is valid."
3021
+ },
3022
+ "iss": {
3023
+ "type": "string",
3024
+ "description": "DID of the issuer of the Verifiable Presentation. (Here it's supposed to be a holder DID)"
3025
+ },
3026
+ "aud": {
3027
+ "type": "array",
3028
+ "items": {
3029
+ "type": "string"
3030
+ },
3031
+ "description": "DID of the verifier of the Verifiable Presentation."
3032
+ }
3033
+ },
3034
+ "example": {
3035
+ "vp": {
3036
+ "@context": [
3037
+ "https://www.w3.org/2018/credentials/v1"
3038
+ ],
3039
+ "type": [
3040
+ "VerifiablePresentation"
3041
+ ],
3042
+ "verifiableCredential": [
3043
+ "eyJhbGciOiJFZERTQSIsInR5cCI6IkpXVCJ9.eyJ2YyI6eyJAY29udGV4dCI6WyJodHRwczovL3d3dy53My5vcmcvMjAxOC9jcmVkZW50aWFscy92MSIsImh0dHBzOi8vc2NoZW1hLm9yZy9zY2hlbWEuanNvbmxkIiwiaHR0cHM6Ly92ZXJhbW8uaW8vY29udGV4dHMvcHJvZmlsZS92MSIsImh0dHBzOi8vdzNpZC5vcmcvdmMtc3RhdHVzLWxpc3QtMjAyMS92MSJdLCJ0eXBlIjpbIlZlcmlmaWFibGVDcmVkZW50aWFsIiwiUGVyc29uIl0sImNyZWRlbnRpYWxTdWJqZWN0Ijp7Im5hbWUiOiJCb2IiLCJnZW5kZXIiOiJtYWxlIn0sImNyZWRlbnRpYWxTdGF0dXMiOnsiaWQiOiJodHRwczovL3Jlc29sdmVyLmNoZXFkLm5ldC8xLjAvaWRlbnRpZmllcnMvZGlkOmNoZXFkOnRlc3RuZXQ6OTBkNWMxNDEtNzI0Zi00N2FkLTlhZTctYTdjMzNhOWU1NjQzP3Jlc291cmNlTmFtZT1zdXNwZW5zaW9uRW4mcmVzb3VyY2VUeXBlPVN0YXR1c0xpc3QyMDIxU3VzcGVuc2lvbiMxMzMzOCIsInR5cGUiOiJTdGF0dXNMaXN0MjAyMUVudHJ5Iiwic3RhdHVzUHVycG9zZSI6InN1c3BlbnNpb24iLCJzdGF0dXNMaXN0SW5kZXgiOiIxMzMzOCJ9fSwic3ViIjoiZGlkOmtleTp6Nk1raGFYZ0JaRHZvdERrTDUyNTdmYWl6dGlHaUMyUXRLTEdwYm5uRUd0YTJkb0siLCJuYmYiOjE3MDA0NzM0MTYsImlzcyI6ImRpZDpjaGVxZDp0ZXN0bmV0OjkwZDVjMTQxLTcyNGYtNDdhZC05YWU3LWE3YzMzYTllNTY0MyJ9.-14Ril1pZEy2HEEo48gTJr2yOtGxBhUGTFmzVdjAtyhFRsW5zZg9onHt6V9JQ8BaiYBlTkP9GzTnJ-O6hdiyCw"
3044
+ ]
3045
+ },
3046
+ "nbf": 1700744275,
3047
+ "iss": "did:cheqd:testnet:4b846d0f-2f6c-4ab6-9fe2-5b8db301c83c",
3048
+ "aud": [
3049
+ "did:cheqd:testnet:8c71e9b6-c5a3-4250-8c58-fa591533cd22"
3050
+ ]
3051
+ }
3052
+ },
3053
+ "DidResult": {
3054
+ "type": "object",
3055
+ "properties": {
3056
+ "did": {
3057
+ "type": "string"
3058
+ },
3059
+ "controllerKeyId": {
3060
+ "type": "string"
3061
+ },
3062
+ "keys": {
3063
+ "type": "array",
3064
+ "items": {
3065
+ "type": "object"
3066
+ }
3067
+ },
3068
+ "services": {
3069
+ "type": "array",
3070
+ "items": {
3071
+ "$ref": "#/components/schemas/Service"
3072
+ }
3073
+ }
3074
+ }
3075
+ },
3076
+ "DidUpdateResponse": {
3077
+ "type": "object",
3078
+ "properties": {
3079
+ "did": {
3080
+ "type": "string"
3081
+ },
3082
+ "controllerKeyId": {
3083
+ "type": "string",
3084
+ "description": "The default key id of which is the key associated with the first verificationMethod"
3085
+ },
3086
+ "keys": {
3087
+ "type": "array",
3088
+ "description": "The list of keys associated with the list of verificationMethod's of DIDDocument",
3089
+ "items": {
3090
+ "type": "object"
3091
+ }
3092
+ },
3093
+ "services": {
3094
+ "type": "array",
3095
+ "items": {
3096
+ "$ref": "#/components/schemas/Service"
3097
+ }
3098
+ },
3099
+ "controllerKeyRefs": {
3100
+ "type": "array",
3101
+ "description": "The list of keyRefs which were used for signing the transaction",
3102
+ "items": {
3103
+ "type": "string"
3104
+ }
3105
+ },
3106
+ "controllerKeys": {
3107
+ "type": "array",
3108
+ "description": "The list of all possible keys, inlcuding all controller's keys",
3109
+ "items": {
3110
+ "type": "string"
3111
+ }
3112
+ }
3113
+ }
3114
+ },
3115
+ "VerificationMethod": {
3116
+ "type": "object",
3117
+ "properties": {
3118
+ "id": {
3119
+ "type": "string"
3120
+ },
3121
+ "type": {
3122
+ "type": "string"
3123
+ },
3124
+ "controller": {
3125
+ "type": "string"
3126
+ },
3127
+ "publicKeyMultibase": {
3128
+ "type": "string"
3129
+ },
3130
+ "publicKeyJwk": {
3131
+ "type": "array",
3132
+ "items": {
3133
+ "type": "string"
3134
+ }
3135
+ }
3136
+ },
3137
+ "example": {
3138
+ "controller": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0",
3139
+ "id": "did:cheqd:testnet :7bf81a20-633c-4cc7-bc4a-5a45801005e0#key-1",
3140
+ "publicKeyBase58": "BTJiso1S4iSiReP6wGksSneGfiKHxz9SYcm2KknpqBJt",
3141
+ "type": "Ed25519VerificationKey2018"
3142
+ }
3143
+ },
3144
+ "Service": {
3145
+ "description": "Communicating or interacting with the DID subject or associated entities via one or more service endpoints. See <a href=\"https://www.w3.org/TR/did-core/#services\">DID Core specification</a> for more details.",
3146
+ "type": "object",
3147
+ "properties": {
3148
+ "id": {
3149
+ "description": "DID appended with Service fragment ID (e.g., `#service-1` in `did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1`)",
3150
+ "type": "string",
3151
+ "example": "did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1"
3152
+ },
3153
+ "type": {
3154
+ "description": "Service type as defined in <a href=\"https://www.w3.org/TR/did-spec-registries/#service-types\">DID Specification Registries</a>.",
3155
+ "type": "string",
3156
+ "example": "LinkedDomains"
3157
+ },
3158
+ "serviceEndpoint": {
3159
+ "description": "Service endpoint as defined in <a href=\"https://www.w3.org/TR/did-core/#services\">DID Core Specification</a>.",
3160
+ "type": "array",
3161
+ "items": {
3162
+ "type": "string",
3163
+ "example": "https://example.com"
3164
+ }
3165
+ }
3166
+ }
3167
+ },
3168
+ "DidUpdateRequest": {
3169
+ "type": "object",
3170
+ "properties": {
3171
+ "did": {
3172
+ "description": "DID identifier to be updated.",
3173
+ "type": "string",
3174
+ "example": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0"
3175
+ },
3176
+ "service": {
3177
+ "type": "array",
3178
+ "description": "Service section of the DID Document.",
3179
+ "items": {
3180
+ "$ref": "#/components/schemas/Service"
3181
+ }
3182
+ },
3183
+ "verificationMethod": {
3184
+ "type": "array",
3185
+ "description": "Verification Method section of the DID Document.",
3186
+ "items": {
3187
+ "$ref": "#/components/schemas/VerificationMethod"
3188
+ }
3189
+ },
3190
+ "authentication": {
3191
+ "description": "Authentication section of the DID Document.",
3192
+ "type": "array",
3193
+ "items": {
3194
+ "type": "string"
3195
+ }
3196
+ },
3197
+ "publicKeyHexs": {
3198
+ "description": "List of key references (publicKeys) which will be used for signing the message. The should be in hexadecimal format and placed in the wallet of current user.",
3199
+ "type": "array",
3200
+ "items": {
3201
+ "type": "string"
3202
+ }
3203
+ },
3204
+ "didDocument": {
3205
+ "$ref": "#/components/schemas/DidDocument"
3206
+ }
3207
+ }
3208
+ },
3209
+ "DidDeactivateRequest": {
3210
+ "type": "object",
3211
+ "properties": {
3212
+ "publicKeyHexs": {
3213
+ "description": "List of key references (publicKeys) which will be used for signing the message. The should be in hexadecimal format and placed in the wallet of current user.",
3214
+ "type": "array",
3215
+ "items": {
3216
+ "type": "string"
3217
+ }
3218
+ }
3219
+ }
3220
+ },
3221
+ "CreateResourceRequest": {
3222
+ "description": "Input fields for DID-Linked Resource creation.",
3223
+ "type": "object",
3224
+ "additionalProperties": false,
3225
+ "required": [
3226
+ "name",
3227
+ "type",
3228
+ "data",
3229
+ "encoding"
3230
+ ],
3231
+ "properties": {
3232
+ "data": {
3233
+ "description": "Encoded string containing the data to be stored in the DID-Linked Resource.",
3234
+ "type": "string"
3235
+ },
3236
+ "encoding": {
3237
+ "description": "Encoding format used to encode the data.",
3238
+ "type": "string",
3239
+ "enum": [
3240
+ "base64url",
3241
+ "base64",
3242
+ "hex"
3243
+ ]
3244
+ },
3245
+ "name": {
3246
+ "description": "Name of DID-Linked Resource.",
3247
+ "type": "string"
3248
+ },
3249
+ "type": {
3250
+ "description": "Type of DID-Linked Resource. This is NOT the same as the media type, which is calculated automatically ledger-side.",
3251
+ "type": "string"
3252
+ },
3253
+ "alsoKnownAs": {
3254
+ "description": "Optional field to assign a set of alternative URIs where the DID-Linked Resource can be fetched from.",
3255
+ "type": "array",
3256
+ "items": {
3257
+ "type": "object",
3258
+ "properties": {
3259
+ "uri": {
3260
+ "type": "string"
3261
+ },
3262
+ "description": {
3263
+ "type": "string"
3264
+ }
3265
+ }
3266
+ }
3267
+ },
3268
+ "version": {
3269
+ "description": "Optional field to assign a human-readable version in the DID-Linked Resource.",
3270
+ "type": "string"
3271
+ },
3272
+ "publicKeyHexs": {
3273
+ "description": "List of key references (publicKeys) which will be used for signing the message. The should be in hexadecimal format and placed in the wallet of current user.",
3274
+ "type": "array",
3275
+ "items": {
3276
+ "type": "string"
3277
+ }
3278
+ }
3279
+ },
3280
+ "example": {
3281
+ "data": "SGVsbG8gV29ybGQ=",
3282
+ "encoding": "base64url",
3283
+ "name": "ResourceName",
3284
+ "type": "TextDocument"
3285
+ }
3286
+ },
3287
+ "ResourceList": {
3288
+ "type": "object",
3289
+ "properties": {
3290
+ "@context": {
3291
+ "type": "string",
3292
+ "example": "https://w3id.org/did-resolution/v1"
3293
+ },
3294
+ "contentMetadata": {
3295
+ "type": "object"
3296
+ },
3297
+ "contentStream": {
3298
+ "type": "object"
3299
+ },
3300
+ "dereferencingMetadata": {
3301
+ "$ref": "#/components/schemas/DereferencingMetadata"
3302
+ }
3303
+ }
3304
+ },
3305
+ "DereferencingMetadata": {
3306
+ "type": "object",
3307
+ "properties": {
3308
+ "contentType": {
3309
+ "type": "string",
3310
+ "example": "application/did+ld+json"
3311
+ },
3312
+ "did": {
3313
+ "$ref": "#/components/schemas/DidProperties"
3314
+ },
3315
+ "retrieved": {
3316
+ "type": "string",
3317
+ "example": "2021-09-01T12:00:00Z"
3318
+ }
3319
+ }
3320
+ },
3321
+ "DidResolution": {
3322
+ "type": "object",
3323
+ "properties": {
3324
+ "@context": {
3325
+ "type": "string",
3326
+ "example": "https://w3id.org/did-resolution/v1"
3327
+ },
3328
+ "didDidResolutionMetadata": {
3329
+ "$ref": "#/components/schemas/DidResolutionMetadata"
3330
+ },
3331
+ "didDocument": {
3332
+ "$ref": "#/components/schemas/DidDocument"
3333
+ },
3334
+ "didDocumentMetadata": {
3335
+ "$ref": "#/components/schemas/DidDocumentMetadata"
3336
+ }
3337
+ }
3338
+ },
3339
+ "DeactivatedDidResolution": {
3340
+ "type": "object",
3341
+ "properties": {
3342
+ "@context": {
3343
+ "type": "string",
3344
+ "example": "https://w3id.org/did-resolution/v1"
3345
+ },
3346
+ "didDidResolutionMetadata": {
3347
+ "$ref": "#/components/schemas/DidResolutionMetadata"
3348
+ },
3349
+ "didDocument": {
3350
+ "$ref": "#/components/schemas/DidDocument"
3351
+ },
3352
+ "didDocumentMetadata": {
3353
+ "$ref": "#/components/schemas/DeactivatedDidDocumentMetadata"
3354
+ }
3355
+ }
3356
+ },
3357
+ "DidDocumentMetadata": {
3358
+ "type": "object",
3359
+ "properties": {
3360
+ "created": {
3361
+ "type": "string",
3362
+ "example": "2021-09-01T12:00:00Z"
3363
+ },
3364
+ "deactivated": {
3365
+ "type": "boolean",
3366
+ "example": false
3367
+ },
3368
+ "updated": {
3369
+ "type": "string",
3370
+ "example": "2021-09-10T12:00:00Z"
3371
+ },
3372
+ "versionId": {
3373
+ "type": "string",
3374
+ "example": "3ccde6ba-6ba5-56f2-9f4f-8825561a9860"
3375
+ },
3376
+ "linkedResourceMetadata": {
3377
+ "type": "array",
3378
+ "items": {
3379
+ "$ref": "#/components/schemas/ResourceMetadata"
3380
+ }
3381
+ }
3382
+ }
3383
+ },
3384
+ "DeactivatedDidDocumentMetadata": {
3385
+ "type": "object",
3386
+ "properties": {
3387
+ "created": {
3388
+ "type": "string",
3389
+ "example": "2021-09-01T12:00:00Z"
3390
+ },
3391
+ "deactivated": {
3392
+ "type": "boolean",
3393
+ "example": true
3394
+ },
3395
+ "updated": {
3396
+ "type": "string",
3397
+ "example": "2021-09-10T12:00:00Z"
3398
+ },
3399
+ "versionId": {
3400
+ "type": "string",
3401
+ "example": "3ccde6ba-6ba5-56f2-9f4f-8825561a9860"
3402
+ },
3403
+ "linkedResourceMetadata": {
3404
+ "type": "array",
3405
+ "items": {
3406
+ "$ref": "#/components/schemas/ResourceMetadata"
3407
+ }
3408
+ }
3409
+ }
3410
+ },
3411
+ "ResourceMetadata": {
3412
+ "type": "object",
3413
+ "properties": {
3414
+ "resourceURI": {
3415
+ "type": "string",
3416
+ "example": "did:cheqd:testnet:55dbc8bf-fba3-4117-855c-1e0dc1d3bb47/resources/398cee0a-efac-4643-9f4c-74c48c72a14b"
3417
+ },
3418
+ "resourceCollectionId": {
3419
+ "type": "string",
3420
+ "example": "55dbc8bf-fba3-4117-855c-1e0dc1d3bb47"
3421
+ },
3422
+ "resourceId": {
3423
+ "type": "string",
3424
+ "example": "398cee0a-efac-4643-9f4c-74c48c72a14b"
3425
+ },
3426
+ "resourceName": {
3427
+ "type": "string",
3428
+ "example": "cheqd-issuer-logo"
3429
+ },
3430
+ "resourceType": {
3431
+ "type": "string",
3432
+ "example": "CredentialArtwork"
3433
+ },
3434
+ "mediaType": {
3435
+ "type": "string",
3436
+ "example": "image/png"
3437
+ },
3438
+ "resourceVersion": {
3439
+ "type": "string",
3440
+ "example": "1.0"
3441
+ },
3442
+ "checksum": {
3443
+ "type": "string",
3444
+ "example": "a95380f460e63ad939541a57aecbfd795fcd37c6d78ee86c885340e33a91b559"
3445
+ },
3446
+ "created": {
3447
+ "type": "string",
3448
+ "example": "2021-09-01T12:00:00Z"
3449
+ },
3450
+ "nextVersionId": {
3451
+ "type": "string",
3452
+ "example": "d4829ac7-4566-478c-a408-b44767eddadc"
3453
+ },
3454
+ "previousVersionId": {
3455
+ "type": "string",
3456
+ "example": "ad7a8442-3531-46eb-a024-53953ec6e4ff"
3457
+ }
3458
+ }
3459
+ },
3460
+ "DidResolutionMetadata": {
3461
+ "type": "object",
3462
+ "properties": {
3463
+ "contentType": {
3464
+ "allOf": [
3465
+ {
3466
+ "$ref": "#/components/schemas/ContentType"
3467
+ }
3468
+ ],
3469
+ "example": "application/did+ld+json"
3470
+ },
3471
+ "retrieved": {
3472
+ "type": "string",
3473
+ "example": "2021-09-01T12:00:00Z"
3474
+ },
3475
+ "did": {
3476
+ "$ref": "#/components/schemas/DidProperties"
3477
+ }
3478
+ }
3479
+ },
3480
+ "ContentType": {
3481
+ "type": "string",
3482
+ "enum": [
3483
+ "application/did+json",
3484
+ "application/did+ld+json",
3485
+ "application/ld+json",
3486
+ "application/json"
3487
+ ]
3488
+ },
3489
+ "DidProperties": {
3490
+ "type": "object",
3491
+ "properties": {
3492
+ "didString": {
3493
+ "type": "string",
3494
+ "example": "did:cheqd:testnet:55dbc8bf-fba3-4117-855c-1e0dc1d3bb47"
3495
+ },
3496
+ "method": {
3497
+ "type": "string",
3498
+ "example": "cheqd"
3499
+ },
3500
+ "methodSpecificId": {
3501
+ "type": "string",
3502
+ "example": "55dbc8bf-fba3-4117-855c-1e0dc1d3bb47"
3503
+ }
3504
+ }
3505
+ },
3506
+ "Customer": {
3507
+ "type": "object",
3508
+ "properties": {
3509
+ "customerId": {
3510
+ "type": "string",
3511
+ "example": "6w5drpiiwhhs"
3512
+ },
3513
+ "address": {
3514
+ "type": "string",
3515
+ "example": "cheqd1wgsvqwlkmdp60f4dek26ak0sjw6au3ytd3pz7f"
3516
+ }
3517
+ }
3518
+ },
3519
+ "AccountCreateRequest": {
3520
+ "type": "object",
3521
+ "properties": {
3522
+ "user": {
3523
+ "type": "object",
3524
+ "properties": {
3525
+ "primaryEmail": {
3526
+ "type": "string"
3527
+ }
3528
+ }
3529
+ }
3530
+ }
3531
+ },
3532
+ "InvalidRequest": {
3533
+ "description": "A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.",
3534
+ "type": "object",
3535
+ "properties": {
3536
+ "error": {
3537
+ "type": "string",
3538
+ "example": "InvalidRequest"
3539
+ }
3540
+ }
3541
+ },
3542
+ "InternalError": {
3543
+ "description": "An internal error has occurred. Additional state information plus metadata may be available in the response body.",
3544
+ "type": "object",
3545
+ "properties": {
3546
+ "error": {
3547
+ "type": "string",
3548
+ "example": "Internal Error"
3549
+ }
3550
+ }
3551
+ },
3552
+ "UnauthorizedError": {
3553
+ "description": "Access token is missing or invalid",
3554
+ "type": "object",
3555
+ "properties": {
3556
+ "error": {
3557
+ "type": "string",
3558
+ "example": "Unauthorized Error"
3559
+ }
3560
+ }
3561
+ }
3562
+ }
3563
+ }
3564
+ }