api-json (1).json

{"openapi":"3.0.0","paths":{"/api/v1/app/oauth":{"post":{"operationId":"AppOAuthController_generateAccessToken","parameters":[{"name":"X-Api-Secret-Key","required":true,"in":"header","description":"Provide Api Secret  key to get access token","schema":{"type":"string"}},{"name":"Origin","in":"header","description":"Origin as you set in application cors","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"AccessToken generated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateTokenResponse"}}}},"400":{"description":"Error occured at the time of generating access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateTokenError"}}}}},"tags":["App"]}},"/api/v1/did":{"get":{"operationId":"DidController_getDidList","parameters":[{"name":"Authorization","required":false,"in":"header","description":"Bearer <access_token>","schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"Page value","schema":{"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Fetch limited list of data","schema":{"default":10,"type":"number"}},{"name":"Origin","in":"header","description":"Origin as you set in application cors","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"DID List","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetDidList"}}}}},"404":{"description":"Error in finding resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DidNotFoundError"}}}}},"tags":["Did"],"security":[{"Authorization":[]}]},"patch":{"operationId":"DidController_updateDid","parameters":[{"name":"Authorization","required":false,"in":"header","description":"Bearer <access_token>","schema":{"type":"string"}},{"name":"Origin","in":"header","description":"Origin as you set in application cors","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDidDto"}}}},"responses":{"200":{"description":"DID Updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TxnHash"}}}},"400":{"description":"Invalid didDoc","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DidError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DidNotFoundError"}}}}},"tags":["Did"],"security":[{"Authorization":[]}]}},"/api/v1/did/resolve/{did}":{"get":{"operationId":"DidController_resolveDid","parameters":[{"name":"Authorization","required":false,"in":"header","description":"Bearer <access_token>","schema":{"type":"string"}},{"name":"did","required":true,"in":"path","schema":{"type":"string"}},{"name":"Origin","in":"header","description":"Origin as you set in application cors","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"DID Resolved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolvedDid"}}}}},"tags":["Did"],"security":[{"Authorization":[]}]}},"/api/v1/did/create":{"post":{"operationId":"DidController_create","parameters":[{"name":"Authorization","required":false,"in":"header","description":"Bearer <access_token>","schema":{"type":"string"}},{"name":"Origin","in":"header","description":"Origin as you set in application cors","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDidDto"}}}},"responses":{"201":{"description":"DID Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDidResponse"}}}},"400":{"description":"Error occured at the time of creating did","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DidError"}}}},"409":{"description":"Duplicate key error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DidConflictError"}}}}},"tags":["Did"],"security":[{"Authorization":[]}]}},"/api/v1/did/register":{"post":{"operationId":"DidController_register","parameters":[{"name":"Authorization","required":false,"in":"header","description":"Bearer <access_token>","schema":{"type":"string"}},{"name":"Origin","in":"header","description":"Origin as you set in application cors","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterDidDto"}}}},"responses":{"201":{"description":"DID Registred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterDidResponse"}}}},"400":{"description":"Error occured at the time of creating did","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DidError"}}}}},"tags":["Did"],"security":[{"Authorization":[]}]}},"/api/v1/schema":{"post":{"operationId":"SchemaController_create","parameters":[{"name":"Authorization","required":false,"in":"header","description":"Bearer <access_token>","schema":{"type":"string"}},{"name":"Origin","in":"header","description":"Origin as you set in application cors","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSchemaDto"}}}},"responses":{"201":{"description":"Schema Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/createSchemaResponse"}}}},"400":{"description":"Error occured at the time of creating schema","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaError"}}}},"404":{"description":"Error in finding resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaNotFoundError"}}}}},"tags":["Schema"],"security":[{"Authorization":[]}]},"get":{"operationId":"SchemaController_getSchemaList","parameters":[{"name":"Authorization","required":false,"in":"header","description":"Bearer <access_token>","schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"Page value","schema":{"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Fetch limited list of data","schema":{"default":10,"type":"number"}},{"name":"Origin","in":"header","description":"Origin as you set in application cors","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Schema List","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetSchemaList"}}}}},"404":{"description":"No schema has created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaNotFoundError"}}}}},"tags":["Schema"],"security":[{"Authorization":[]}]}},"/api/v1/schema/{schemaId}":{"get":{"operationId":"SchemaController_resolveSchema","parameters":[{"name":"Authorization","required":false,"in":"header","description":"Bearer <access_token>","schema":{"type":"string"}},{"name":"schemaId","required":true,"in":"path","schema":{"type":"string"}},{"name":"Origin","in":"header","description":"Origin as you set in application cors","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Resolved schema detail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolveSchema"}}}},"404":{"description":"sch:hid:testnet:...... not on chain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaNotFoundError"}}}}},"tags":["Schema"],"security":[{"Authorization":[]}]}},"/api/v1/credential":{"get":{"operationId":"CredentialController_findAll","parameters":[{"name":"Authorization","required":false,"in":"header","description":"Bearer <access_token>","schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"Page value","schema":{"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Fetch limited list of data","schema":{"default":10,"type":"number"}},{"name":"Origin","in":"header","description":"Origin as you set in application cors","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of credentials","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetCredentialList"}}}}},"404":{"description":"Error in finding resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialNotFoundError"}}}}},"tags":["Credential"],"security":[{"Authorization":[]}]}},"/api/v1/credential/{credentialId}":{"get":{"operationId":"CredentialController_resolveCredential","parameters":[{"name":"Authorization","required":false,"in":"header","description":"Bearer <access_token>","schema":{"type":"string"}},{"name":"credentialId","required":true,"in":"path","schema":{"type":"string"}},{"name":"retrieveCredential","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"Origin","in":"header","description":"Origin as you set in application cors","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Resolved credential detail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolveCredential"}}}},"404":{"description":"Credential with id vc:hid:testnet:...... not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialNotFoundError"}}}}},"tags":["Credential"],"security":[{"Authorization":[]}]}},"/api/v1/credential/issue":{"post":{"operationId":"CredentialController_create","parameters":[{"name":"Authorization","required":false,"in":"header","description":"Bearer <access_token>","schema":{"type":"string"}},{"name":"Origin","in":"header","description":"Origin as you set in application cors","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCredentialDto"}}}},"responses":{"201":{"description":"Credential Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCredentialResponse"}}}},"400":{"description":"Error occured at the time of creating credential","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialNotFoundError"}}}}},"tags":["Credential"],"security":[{"Authorization":[]}]}},"/api/v1/credential/verify":{"post":{"operationId":"CredentialController_verify","parameters":[{"name":"Authorization","required":false,"in":"header","description":"Bearer <access_token>","schema":{"type":"string"}},{"name":"Origin","in":"header","description":"Origin as you set in application cors","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyCredentialDto"}}}},"responses":{"200":{"description":"verification result of credential","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyCredentialResponse"}}}},"400":{"description":"Error occured at the time of verifying credential","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialError"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialNotFoundError"}}}}},"tags":["Credential"],"security":[{"Authorization":[]}]}},"/api/v1/credential/status/{credentialId}":{"patch":{"operationId":"CredentialController_update","parameters":[{"name":"Authorization","required":false,"in":"header","description":"Bearer <access_token>","schema":{"type":"string"}},{"name":"credentialId","required":true,"in":"path","schema":{"type":"string"}},{"name":"Origin","in":"header","description":"Origin as you set in application cors","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCredentialDto"}}}},"responses":{"200":{"description":"Credential Updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolveCredential"}}}},"400":{"description":"Error occured at the time of creating credential","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialError"}}}},"404":{"description":"did:hid:testnet:........#key-${idx} not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialNotFoundError"}}}}},"tags":["Credential"],"security":[{"Authorization":[]}]}},"/api/v1/presentation/template":{"post":{"operationId":"PresentationTempleteController_createPresentationTemplate","parameters":[{"name":"Authorization","required":false,"in":"header","description":"Bearer <access_token>","schema":{"type":"string"}},{"name":"Origin","in":"header","description":"Origin as you set in application cors","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePresentationTemplateDto"}}}},"responses":{"201":{"description":"presentaion template  Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePresentationTemplateDto"}}}},"400":{"description":"name must be unique for an app","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PTemplateError"}}}}},"tags":["Presentation Template"],"security":[{"Authorization":[]}]},"get":{"operationId":"PresentationTempleteController_fetchListOfPresentationTemplate","parameters":[{"name":"Authorization","required":false,"in":"header","description":"Bearer <access_token>","schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"Page value","schema":{"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Fetch limited list of data","schema":{"default":10,"type":"number"}},{"name":"Origin","in":"header","description":"Origin as you set in application cors","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of presentation template","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPresentationTemplateListList"}}}},"404":{"description":"No template has created for appId 42...18-....","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PTemplateNotFoundError"}}}}},"tags":["Presentation Template"],"security":[{"Authorization":[]}]}},"/api/v1/presentation/template/{templateId}":{"get":{"operationId":"PresentationTempleteController_fetchAPresentationTemplate","parameters":[{"name":"Authorization","required":false,"in":"header","description":"Bearer <access_token>","schema":{"type":"string"}},{"name":"templateId","required":true,"in":"path","schema":{"type":"string"}},{"name":"Origin","in":"header","description":"Origin as you set in application cors","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Presentation template detail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PresentationTemplate"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PTemplateNotFoundError"}}}}},"tags":["Presentation Template"],"security":[{"Authorization":[]}]},"patch":{"operationId":"PresentationTempleteController_updatePresentationTemplate","parameters":[{"name":"Authorization","required":false,"in":"header","description":"Bearer <access_token>","schema":{"type":"string"}},{"name":"templateId","required":true,"in":"path","schema":{"type":"string"}},{"name":"Origin","in":"header","description":"Origin as you set in application cors","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePresentationDto"}}}},"responses":{"200":{"description":"Template Updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PresentationTemplate"}}}},"400":{"description":"Error occured at the time of updating","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PTemplateError"}}}}},"tags":["Presentation Template"],"security":[{"Authorization":[]}]},"delete":{"operationId":"PresentationTempleteController_remove","parameters":[{"name":"Authorization","required":false,"in":"header","description":"Bearer <access_token>","schema":{"type":"string"}},{"name":"templateId","required":true,"in":"path","schema":{"type":"string"}},{"name":"Origin","in":"header","description":"Origin as you set in application cors","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Template Deleted Successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PresentationTemplate"}}}},"404":{"description":"No resource found for templateId 63d7c558743fea9d22aab...","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PTemplateNotFoundError"}}}}},"tags":["Presentation Template"],"security":[{"Authorization":[]}]}},"/api/v1/presentation":{"post":{"operationId":"PresentationController_create","parameters":[{"name":"Authorization","required":false,"in":"header","description":"Bearer <access_token>","schema":{"type":"string"}},{"name":"Origin","in":"header","description":"Origin as you set in application cors","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePresentationDto"}}}},"responses":{"200":{"description":"Response of presentation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PresentationResponse"}}}},"404":{"description":"did:hid:testnet:......#key-${id} not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PTemplateNotFoundError"}}}}},"tags":["Presentation"],"security":[{"Authorization":[]}]}},"/api/v1/presentation/request":{"post":{"operationId":"PresentationController_createPresentationRequest","parameters":[{"name":"Authorization","required":false,"in":"header","description":"Bearer <access_token>","schema":{"type":"string"}},{"name":"Origin","in":"header","description":"Origin as you set in application cors","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePresentationRequestDto"}}}},"responses":{"201":{"description":"Presentation request is created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePresentationResponse"}}}},"400":{"description":"templeteId :62874356...  not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PTemplateError"}}}}},"tags":["Presentation"],"security":[{"Authorization":[]}]}},"/api/v1/presentation/verify":{"post":{"operationId":"PresentationController_verify","parameters":[{"name":"Authorization","required":false,"in":"header","description":"Bearer <access_token>","schema":{"type":"string"}},{"name":"Origin","in":"header","description":"Origin as you set in application cors","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyPresentationDto"}}}},"responses":{"200":{"description":"presentation verification done successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyPresentationResponse"}}}}},"tags":["Presentation"],"security":[{"Authorization":[]}]}}},"info":{"title":"Entity Studio SSI API Playground","description":"Open API Documentation of the Entity Studio","version":"1.0","contact":{}},"tags":[],"servers":[],"components":{"securitySchemes":{"Authorization":{"scheme":"bearer","bearerFormat":"JWT","type":"http","name":"Authorization","in":"header"}},"schemas":{"GenerateTokenResponse":{"type":"object","properties":{"access_token":{"type":"string","description":"accessToken","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6IjRkNjhmMjNmLTcwZjQtNDFhZC1hMGViLTU3MjA4YTZlOTcxMSIsImFwcFNlY3JldCI6IjNjN2NiNTY1LTZmNWQtNGY2MC1hMjQ2LTZhOGFjYWVhMmY0MyIsImdyYW50VHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsImlhdCI6MTY3NDAyMDY3NCwiZXhwIjoxNjc0MDM1MDc0fQ.P-AbheTJMxQNGLTkGWOsnct4M0nKCd-7oUFGqMCpIDM"},"tokenType":{"type":"string","description":"Type of token","example":"Bearer"},"expiresIn":{"type":"number","description":"Token expiry time","example":14400}},"required":["access_token","tokenType","expiresIn"]},"AppError":{"type":"object","properties":{"statusCode":{"type":"number","description":"statusCode","example":400},"message":{"description":"message","example":["error message 1","error message 2"],"type":"array","items":{"type":"string"}},"error":{"type":"string","description":"error","example":"Bad Request"}},"required":["statusCode","message","error"]},"GenerateTokenError":{"type":"object","properties":{"statusCode":{"type":"number","description":"statusCode","example":401},"message":{"type":"string","description":"message","example":["access_denied"]},"error":{"type":"string","description":"Unauthorized","example":"Unauthorized"}},"required":["statusCode","message","error"]},"Did":{"type":"object","properties":{"did":{"type":"string","description":"Did of user","example":"did:hid:testnet:1234"},"transactionHash":{"type":"string","description":"Txn hash during registration","example":"EDAB2D76772B8401CF82FF7EE0B4CBAA4A330EC16064B27505AABD8A5BA8B05B"},"registrationStatus":{"type":"string"}},"required":["did","transactionHash","registrationStatus"]},"GetDidList":{"type":"object","properties":{"totalCount":{"type":"number","description":"totalCount","example":12},"data":{"description":"data","example":["did:hid:testnet:............"],"type":"array","items":{"$ref":"#/components/schemas/Did"}}},"required":["totalCount","data"]},"DidNotFoundError":{"type":"object","properties":{"statusCode":{"type":"number","description":"statusCode","example":404},"message":{"description":"message","example":["error message 1","error message 2"],"type":"array","items":{"type":"string"}},"error":{"type":"string","description":"error","example":"Not Found"}},"required":["statusCode","message","error"]},"verificationMethod":{"type":"object","properties":{"id":{"type":"string","description":"Verification Method id","example":"did:hid:testnet:z28ScfSszr2zi2Bd7qmNE4mfHX5j8nCwx4DBF6nAUHu4p#key-1"},"type":{"type":"string","description":"Verification Method type","example":"EcdsaSecp256k1RecoveryMethod2020"},"controller":{"type":"string","description":"Verification Method controller","example":"did:hid:method:.............."},"blockchainAccountId":{"type":"string","description":"blockchainAccountId","example":"eip155:1:0x19d73aeeBcc6FEf2d0342375090401301Fe9663F"}},"required":["id","type","controller"]},"Service":{"type":"object","properties":{"id":{"type":"string","description":"id","example":"did:hid:testnet:z23dCariJNNpMNca86EtVZVvrLpn61isd86fWVyWa8Jkm#linked-domain"},"type":{"type":"string","description":"type","example":"LinkedDomains"},"serviceEndpoint":{"type":"string","description":"serviceEndpoint","example":"https://stage.hypermine.in/studioserver/api/v1/org/did:hid:testnet:......................"}},"required":["id","type","serviceEndpoint"]},"DidDoc":{"type":"object","properties":{"@context":{"description":"Context","example":["https://www.w3.org/ns/did/v1"],"type":"array","items":{"type":"string"}},"id":{"type":"string","description":"id","example":"did:hid:method:......"},"controller":{"description":"Controller","example":["did:hid:method:......"],"type":"array","items":{"type":"string"}},"alsoKnownAs":{"description":"alsoKnownAs","example":["did:hid:method:......"],"type":"array","items":{"type":"string"}},"verificationMethod":{"description":"verificationMethod","type":"array","items":{"$ref":"#/components/schemas/verificationMethod"}},"authentication":{"description":"authentication","example":["did:hid:method:......"],"type":"array","items":{"type":"string"}},"assertionMethod":{"description":"assertionMethod","example":["did:hid:method:......"],"type":"array","items":{"type":"string"}},"keyAgreement":{"description":"keyAgreement","example":["did:hid:method:......"],"type":"array","items":{"type":"string"}},"capabilityInvocation":{"description":"capabilityInvocation","example":["did:hid:method:......"],"type":"array","items":{"type":"string"}},"capabilityDelegation":{"description":"capabilityDelegation","example":["did:hid:method:......"],"type":"array","items":{"type":"string"}},"service":{"description":"service","type":"array","items":{"$ref":"#/components/schemas/Service"}}},"required":["@context","id","controller","alsoKnownAs","verificationMethod","authentication","assertionMethod","keyAgreement","capabilityInvocation","capabilityDelegation"]},"DidDocumentMetaData":{"type":"object","properties":{"created":{"type":"string","example":"2023-01-23T13:45:17Z"},"updated":{"type":"string","example":"2023-01-23T13:45:17Z"},"deactivated":{"type":"boolean","example":"false"},"versionId":{"type":"string","example":"095A65E4D2F9CA2AACE0D17A28883A0E5DDC1BBE1C9BF9D............."}},"required":["created","updated","deactivated","versionId"]},"ResolvedDid":{"type":"object","properties":{"didDocument":{"description":"Resolved Did Document","allOf":[{"$ref":"#/components/schemas/DidDoc"}]},"didDocumentMetadata":{"description":"Resolved didDocumentMetadata","allOf":[{"$ref":"#/components/schemas/DidDocumentMetaData"}]}},"required":["didDocument","didDocumentMetadata"]},"Options":{"type":"object","properties":{"keyType":{"type":"string","description":"Verification Method Keytype Ed25519VerificationKey2020 or EcdsaSecp256k1RecoveryMethod2020","example":"keyType:EcdsaSecp256k1RecoveryMethod2020"},"chainId":{"type":"string","example":"0x1","description":"Chain Id"},"publicKey":{"type":"object","example":"z76tzt4XCb6FNqC3CPZvsxRfEDX5HHQc2VPux4DeZYndW","description":"Public Key extracted from keplr"},"walletAddress":{"type":"string","example":"0x01978e553Df0C54A63e2E063DFFe71c688d91C76","description":"Checksum address from web3 wallet"},"verificationRelationships":{"description":"verificationRelationships defines  verification methods to be used for which purposes","example":"authentication/ assertionMethod","type":"array","items":{"type":"array"}}}},"CreateDidDto":{"type":"object","properties":{"namespace":{"type":"string","description":"Namespace to be added in did.","example":"testnet"},"methodSpecificId":{"type":"string","description":"MethodSpecificId to be added in did","example":"0x19d73aeeBcc6FEf2d0342375090401301Fe9663F"},"options":{"description":" keyType used for verification","example":{"keyType":"Ed25519VerificationKey2020","chainId":"0x1","publicKey":"z76tzt4XCb6FNqC3CPZvsxRfEDX5HHQc2VPux4DeZYndW","walletAddress":"0x01978e553Df0C54A63e2E063DFFe71c688d91C76","verificationRelationships":["assertionMethod","authentication"]},"allOf":[{"$ref":"#/components/schemas/Options"}]}},"required":["namespace"]},"MetaData":{"type":"object","properties":{"didDocument":{"description":"Did document","allOf":[{"$ref":"#/components/schemas/DidDoc"}]}},"required":["didDocument"]},"CreateDidResponse":{"type":"object","properties":{"did":{"type":"string","description":"Did document id","example":"did:hid:namespace:......................."},"registrationStatus":{"type":"string","description":"Did document registration status","example":"COMPLETED/PROCESSING"},"metaData":{"description":"metaData contaning initial didDocument","allOf":[{"$ref":"#/components/schemas/MetaData"}]}},"required":["did","registrationStatus","metaData"]},"DidError":{"type":"object","properties":{"statusCode":{"type":"number","description":"statusCode","example":400},"message":{"description":"message","example":["error message 1","error message 2"],"type":"array","items":{"type":"string"}},"error":{"type":"string","description":"error","example":"Bad Request"}},"required":["statusCode","message","error"]},"DidConflictError":{"type":"object","properties":{"statusCode":{"type":"number","description":"statusCode","example":409},"message":{"description":"message","example":["Duplicate key Error"],"type":"array","items":{"type":"string"}},"error":{"type":"string","description":"error","example":"Not Found"}},"required":["statusCode","message","error"]},"RegisterDidDto":{"type":"object","properties":{"didDocument":{"description":"Did doc to be registered","allOf":[{"$ref":"#/components/schemas/DidDoc"}]},"verificationMethodId":{"type":"string","description":"Verification Method id for did registration","example":"did:hid:testnet:........#key-${idx}"},"clientSpec":{"type":"string","description":"IClientSpec  'eth-personalSign' or  'cosmos-ADR036'","example":"eth-personalSign"},"signature":{"type":"string","description":"Signature for clientSpec","example":"afafljagahgp9agjagknaglkj/kagka="}},"required":["didDocument","verificationMethodId"]},"RegisterDidResponse":{"type":"object","properties":{"did":{"type":"string","description":"Did document id","example":"did:hid:namespace:......................."},"registrationStatus":{"type":"string","description":"Did document registration status","example":"COMPLETED/PROCESSING"},"metaData":{"description":"metaData contaning initial didDocument","allOf":[{"$ref":"#/components/schemas/MetaData"}]},"transactionHash":{"type":"string","description":"Transaction Has","example":"XYAIFLKFLKHSLFHKLAOHFOAIHG.........."}},"required":["did","registrationStatus","metaData","transactionHash"]},"UpdateDidDto":{"type":"object","properties":{"didDocument":{"description":"Did doc to be updated","allOf":[{"$ref":"#/components/schemas/DidDoc"}]},"deactivate":{"type":"boolean","description":"Field to check if to deactivate did or to update it ","example":false},"verificationMethodId":{"type":"string","description":"Verification Method id for did updation","example":"did:hid:testnet:........#key-${idx}"},"clientSpec":{"type":"string","description":"IClientSpec  'eth-personalSign' or      'cosmos-ADR036'","example":"eth-personalSign"},"signature":{"type":"string","description":"Signature for clientSpec","example":"afafljagahgp9agjagknaglkj/kagka="}},"required":["didDocument","deactivate","verificationMethodId"]},"TxnHash":{"type":"object","properties":{"transactionHash":{"type":"string","description":"Transaction Has","example":"XYAIFLKFLKHSLFHKLAOHFOAIHG.........."}},"required":["transactionHash"]},"Fields":{"type":"object","properties":{"name":{"type":"string","description":"Name of the field","example":"name"},"format":{"type":"string","description":"format","example":""},"type":{"type":"string","description":"type of properties","example":"string"},"isRequired":{"type":"boolean","description":"State wheter field is required","example":false}},"required":["name","format","type","isRequired"]},"SchemaBody":{"type":"object","properties":{"name":{"type":"string","description":"Name of the schema","example":"Railway ticket schema"},"author":{"type":"string","description":"Issuer Did","example":"did:hid:namespace:................"},"description":{"type":"string","description":"description for the schema","example":"Railway ticket schema\""},"additionalProperties":{"type":"boolean","description":"additionalProperties","example":false},"fields":{"description":"Schema configuration","type":"array","items":{"$ref":"#/components/schemas/Fields"}}},"required":["name","author","description","additionalProperties","fields"]},"CreateSchemaDto":{"type":"object","properties":{"schema":{"description":"Schema body","allOf":[{"$ref":"#/components/schemas/SchemaBody"}]},"namespace":{"type":"string","description":"Namespace to be added in did.","example":"testnet"},"verificationMethodId":{"type":"string","description":"Verification Method id for did updation","example":"did:hid:testnet:........#key-${idx}"}},"required":["schema","namespace","verificationMethodId"]},"createSchemaResponse":{"type":"object","properties":{"schemaId":{"type":"string","description":"Schema id","example":"sch:hid:namespce:....................."},"transactionHash":{"type":"string","description":"transaction hash for schema","example":"KAGSLKAGDLKJGA.................."}},"required":["schemaId","transactionHash"]},"SchemaError":{"type":"object","properties":{"statusCode":{"type":"number","description":"statusCode","example":400},"message":{"description":"message","example":["error message 1","error message 2"],"type":"array","items":{"type":"string"}},"error":{"type":"string","description":"error","example":"Bad Request"}},"required":["statusCode","message","error"]},"SchemaNotFoundError":{"type":"object","properties":{"statusCode":{"type":"number","description":"statusCode","example":404},"message":{"description":"message","example":["error message 1","error message 2"],"type":"array","items":{"type":"string"}},"error":{"type":"string","description":"error","example":"Not Found"}},"required":["statusCode","message","error"]},"Schemas":{"type":"object","properties":{"schemaId":{"type":"string","description":"SchemaId","example":"sch:hid:namespace:....................."},"appId":{"type":"string","description":"Id  to which particular schema is issued","example":"aa4ded21-437e-4215-8792-601ce9ba3de5"},"authorDid":{"type":"string","description":"issuer Did","example":"did:hid:namespace:....................."},"transactionHash":{"type":"string","description":"transactionHash of the schema","example":"LFJWEKGSKDGFKSHGDUFK..................."}},"required":["schemaId","appId","authorDid","transactionHash"]},"GetSchemaList":{"type":"object","properties":{"totalCount":{"type":"number","description":"totalCount","example":12},"data":{"description":"data","example":["sch:hid:testnet:............"],"type":"array","items":{"$ref":"#/components/schemas/Schemas"}}},"required":["totalCount","data"]},"schemaDetail":{"type":"object","properties":{"schema":{"type":"string","description":"schema url ","example":"http://json-schema.org/draft-07/schema"},"description":{"type":"string","description":"Short description of schema","example":"schema for railway ticket"},"type":{"type":"string","description":"Data type","example":"object"},"properties":{"type":"string","description":"all the configure field in schema ","example":"schema for railway ticket"},"required":{"type":"string","description":"name of the schema ","example":"object"},"require":{"type":"string","description":"To defien field is required or not","example":[true]}},"required":["schema","description","type","properties","required","require"]},"Proof":{"type":"object","properties":{"type":{"type":"string","description":"Key type to generate  credential","example":"Ed25519VerificationKey2020"},"created":{"type":"string","description":"Time of schema creation ","example":"2023-01-24T14:35:53Z"},"verificationMethod":{"type":"string","description":"Verification Method id","example":"did:hid:testnet:.............."},"proofPurpose":{"type":"string","description":"Purpose of proof ","example":"assertion"},"proofValue":{"type":"string","description":"proof value ","example":"8jKQBTUnY2k5n2rNFwuI.....Jyyco6uYJtG7HM4ojnmwUCa....."}},"required":["type","created","verificationMethod","proofPurpose","proofValue"]},"ResolveSchema":{"type":"object","properties":{"type":{"type":"string","description":"type ","example":"https://w3c-ccg.github.io/vc-json-schemas/v1/schema/1.0/schema.json"},"modelVersion":{"type":"string","description":"version of model ","example":"1.0"},"id":{"type":"string","description":"schema id ","example":"sh:his:testnet:................."},"name":{"type":"string","description":"name of the schema ","example":"schema for railway ticket"},"author":{"type":"string","description":"issuer did ","example":"did:hid:testnet:.........."},"authored":{"type":"string","description":"Time of schema creation ","example":"2023-01-24T14:35:53Z"},"Schema":{"description":"Resolved schema Document","allOf":[{"$ref":"#/components/schemas/schemaDetail"}]},"proof":{"description":"proof of schema","allOf":[{"$ref":"#/components/schemas/Proof"}]}},"required":["type","modelVersion","id","name","author","authored","Schema","proof"]},"Credential":{"type":"object","properties":{}},"GetCredentialList":{"type":"object","properties":{"totalCount":{"type":"number","description":"totalCount","example":12},"data":{"description":"data","example":["vc:hid:testnet:............"],"type":"array","items":{"$ref":"#/components/schemas/Credential"}}},"required":["totalCount","data"]},"CredentialNotFoundError":{"type":"object","properties":{"statusCode":{"type":"number","description":"statusCode","example":404},"message":{"description":"message","example":["error message 1","error message 2"],"type":"array","items":{"type":"string"}},"error":{"type":"string","description":"error","example":"Not Found"}},"required":["statusCode","message","error"]},"CredentialSubject":{"type":"object","properties":{"id":{"type":"string","description":"id","example":"did:hid:testnet:..............."}},"required":["id"]},"CredentialSchema":{"type":"object","properties":{"id":{"type":"string","description":"id","example":"sch:hid:testnet:..............."},"type":{"type":"string","description":"type of schema","example":"JsonSchemaValidator2018"}},"required":["id","type"]},"CredentialStatus":{"type":"object","properties":{"id":{"type":"string","description":"id","example":"https://api.jagrat.hypersign.id/hypersign-protocol/hidnode/ssi/credential/vc:hid:testnet:..............."},"type":{"type":"string","description":"type of credential","example":"CredentialStatusList2017"}},"required":["id","type"]},"CredentialProof":{"type":"object","properties":{"type":{"type":"string","description":"type using which credential has signed","example":"Ed25519Signature2020"},"created":{"format":"date-time","type":"string","description":"Date on which credential has issued","example":"2023-01-25T17:01:02Z"},"verificationMethod":{"type":"string","description":"Verification id using which credential has signed","example":"did:hid:testnet:...............#key-${id}"},"proofPurpose":{"format":"date-time","type":"string","description":"","example":"assertionMethod"},"proofValue":{"type":"string","description":"","example":"z5LairjrBYkc5FtP.......................EXFHm37aDvcMtCvnYfmvQ"}},"required":["type","created","verificationMethod","proofPurpose","proofValue"]},"CredDoc":{"type":"object","properties":{"@context":{"description":"Context","example":["https://www.w3.org/2018/credentials/v1",{"hs":"https://api.jagrat.hypersign.id/hypersign-protocol/hidnode/ssi/schema/sch:hid:testnet:...........:1.0:"},{"name":"hs:name"},"https://w3id.org/security/suites/ed25519-2020/v1"],"type":"array","items":{"type":"string"}},"id":{"type":"string","description":"id","example":"vc:hid:testnet:......"},"type":{"description":"type","example":["VerifiableCredential","nameschema"],"type":"array","items":{"type":"array"}},"expirationDate":{"format":"date-time","type":"string","description":"Expiry date of credential","example":"2027-12-10T18:30:00Z"},"issuanceDate":{"format":"date-time","type":"string","description":"Credential issuance date","example":"2027-12-10T18:30:00Z"},"issuer":{"type":"string","description":"issuer did","example":"did:hid:testnet:.........."},"credentialSubject":{"description":"Field value based on schema","allOf":[{"$ref":"#/components/schemas/CredentialSubject"}]},"credentialSchema":{"description":"Schema detail based on which credential has issued","allOf":[{"$ref":"#/components/schemas/CredentialSchema"}]},"credentialStatus":{"description":"Information of credential status","allOf":[{"$ref":"#/components/schemas/CredentialStatus"}]},"proof":{"description":"Proof of credential","allOf":[{"$ref":"#/components/schemas/CredentialProof"}]}},"required":["@context","id","type","expirationDate","issuanceDate","issuer","credentialSubject","credentialSchema","credentialStatus","proof"]},"Claim":{"type":"object","properties":{"id":{"type":"string","description":"Credential id","example":"vc:hid:testnet:................"},"currentStatus":{"type":"string","description":"Status of credential","example":"vc:hid:testnet:................"},"statusReason":{"type":"string","description":"Reason of current status","example":"Credential is active"}},"required":["id","currentStatus","statusReason"]},"CredProof":{"type":"object","properties":{"type":{"type":"string","description":"type using which credential has signed","example":"Ed25519Signature2020"},"created":{"format":"date-time","type":"string","description":"Date on which credential has issued","example":"2023-01-25T17:01:02Z"},"verificationMethod":{"type":"string","description":"Verification id using which credential has signed","example":"did:hid:testnet:...............#key-${id}"},"proofPurpose":{"format":"date-time","type":"string","description":"","example":"assertionMethod"},"proofValue":{"type":"string","description":"","example":"z5LairjrBYkc5FtP.......................EXFHm37aDvcMtCvnYfmvQ"},"updated":{"format":"date-time","type":"string","description":"Date on which credential has issued","example":"2023-01-25T17:01:02Z"}},"required":["type","created","verificationMethod","proofPurpose","proofValue","updated"]},"ResolvedCredentialStatus":{"type":"object","properties":{"claim":{"description":" ","allOf":[{"$ref":"#/components/schemas/Claim"}]},"issuer":{"type":"string","description":"did of the one who issue the credential","example":"did:hid:testnet:.............."},"issuanceDate":{"format":"date-time","type":"string","description":"Date on which credential hasa issued","example":"2023-01-25T16:59:21Z"},"expirationDate":{"format":"date-time","type":"string","description":"Date on which credential will expire","example":"2023-01-25T16:59:21Z"},"credentialHash":{"type":"string","description":"Hash of credential","example":"ae93886f2a............3f6d1c6ae4..........393d43730"},"proof":{"description":"proof of credential","allOf":[{"$ref":"#/components/schemas/CredProof"}]}},"required":["claim","issuer","issuanceDate","expirationDate","credentialHash","proof"]},"ResolveCredential":{"type":"object","properties":{"credentialDocument":{"description":"credential document ","allOf":[{"$ref":"#/components/schemas/CredDoc"}]},"credentialStatus":{"description":"status of the credential","allOf":[{"$ref":"#/components/schemas/ResolvedCredentialStatus"}]},"persist":{"type":"boolean","description":"return credentialDocument if persist is set to true at the time of issuing credential","example":true},"retrieveCredential":{"type":"boolean","description":"If set true then return credential Document also","example":true}},"required":["credentialStatus","persist","retrieveCredential"]},"CreateCredentialDto":{"type":"object","properties":{"schemaId":{"type":"string","description":"schemaId for credential Schema"},"subjectDid":{"type":"string","description":"holder did of the credential"},"issuerDid":{"type":"string","description":"issuerDid of the credential"},"expirationDate":{"type":"string","description":"Date in ISOString format","example":"2027-12-10T18:30:00.000Z"},"fields":{"type":"object","description":"Credential Data fields","example":{"name":"Random name"}},"namespace":{"type":"string","description":"Namespace to be added in vcId.","example":"testnet"},"verificationMethodId":{"type":"string","description":"Verification Method id for did updation","example":"did:hid:testnet:........#key-${idx}"},"persist":{"type":"boolean","description":"Persist in edv","example":"true"}},"required":["subjectDid","issuerDid","expirationDate","fields","namespace","verificationMethodId","persist"]},"CredStatus":{"type":"object","properties":{"claim":{"description":" ","allOf":[{"$ref":"#/components/schemas/Claim"}]},"issuer":{"type":"string","description":"did of the one who issue the credential","example":"did:hid:testnet:.............."},"issuanceDate":{"format":"date-time","type":"string","description":"Date on which credential hasa issued","example":"2023-01-25T16:59:21Z"},"expirationDate":{"format":"date-time","type":"string","description":"Date on which credential will expire","example":"2023-01-25T16:59:21Z"},"credentialHash":{"type":"string","description":"Hash of credential","example":"ae93886f2a............3f6d1c6ae4..........393d43730"}},"required":["claim","issuer","issuanceDate","expirationDate","credentialHash"]},"CreateCredentialResponse":{"type":"object","properties":{"credentialDocument":{"description":"Credential doc","allOf":[{"$ref":"#/components/schemas/CredDoc"}]},"credentialStatus":{"description":"Status detail of credential","allOf":[{"$ref":"#/components/schemas/CredStatus"}]},"persist":{"type":"boolean","description":"Define whether to store cred or ust store its meta","example":true}},"required":["credentialDocument","credentialStatus","persist"]},"CredentialError":{"type":"object","properties":{"statusCode":{"type":"number","description":"statusCode","example":400},"message":{"description":"message","example":["error message 1","error message 2"],"type":"array","items":{"type":"string"}},"error":{"type":"string","description":"error","example":"Bad Request"}},"required":["statusCode","message","error"]},"VerifyCredentialDto":{"type":"object","properties":{"credentialDocument":{"description":"credential document","allOf":[{"$ref":"#/components/schemas/CredDoc"}]}},"required":["credentialDocument"]},"CredResultProof":{"type":"object","properties":{"type":{"type":"string","description":"type using which credential has signed","example":"Ed25519Signature2020"},"created":{"format":"date-time","type":"string","description":"Date on which credential has issued","example":"2023-01-25T17:01:02Z"},"verificationMethod":{"type":"string","description":"Verification id using which credential has signed","example":"did:hid:testnet:...............#key-${id}"},"proofPurpose":{"format":"date-time","type":"string","description":"","example":"assertionMethod"},"proofValue":{"type":"string","description":"","example":"z5LairjrBYkc5FtP.......................EXFHm37aDvcMtCvnYfmvQ"},"Context":{"description":"","example":["https://www.w3.org/2018/credentials/v1",{"hs":"https://api.jagrat.hypersign.id/hypersign-protocol/hidnode/ssi/schema/sch:hid:testnet:z3KX4ZqoizKTaED645aV4aE8dBbnSpmQYe3xfzVBJadPY:1.0:"},{"name":"hs:name"},"https://w3id.org/security/suites/ed25519-2020/v1"],"type":"array","items":{"type":"string"}}},"required":["type","created","verificationMethod","proofPurpose","proofValue","Context"]},"VerificationMethod":{"type":"object","properties":{"id":{"type":"string","description":"Verification Method id","example":"did:hid:testnet:................................#key-${id}"},"type":{"type":"string","description":"Verification Method type","example":"Ed25519VerificationKey2020"},"controller":{"type":"string","description":"Verification Method controller","example":"did:hid:method:.............."},"publicKeyMultibase":{"type":"string","description":"publicKeyMultibase","example":"z28ScfSszr.............j8nCwx4DBF6nAUHu4p"}},"required":["id","type","controller","publicKeyMultibase"]},"PurposeResult":{"type":"object","properties":{"valid":{"type":"boolean","description":"","example":true}},"required":["valid"]},"Result":{"type":"object","properties":{"proof":{"description":"proof of credential","allOf":[{"$ref":"#/components/schemas/CredResultProof"}]},"verified":{"type":"boolean","description":"proof verification result","example":true},"verificationMethod":{"description":"verification method","allOf":[{"$ref":"#/components/schemas/VerificationMethod"}]},"purposeResult":{"description":"purpose result","allOf":[{"$ref":"#/components/schemas/PurposeResult"}]}},"required":["proof","verified","verificationMethod","purposeResult"]},"StatusResult":{"type":"object","properties":{"verified":{"type":"boolean","description":"verification result","example":true}},"required":["verified"]},"VerifyCredentialResponse":{"type":"object","properties":{"verified":{"type":"boolean","description":"result of credential verification"},"results":{"description":"Verification detail of proof ","type":"array","items":{"$ref":"#/components/schemas/Result"}},"statusResult":{"description":"Verification result","allOf":[{"$ref":"#/components/schemas/StatusResult"}]}},"required":["verified","results","statusResult"]},"UpdateCredentialDto":{"type":"object","properties":{"namespace":{"type":"string","description":"Namespace to be added in vcId.","example":"testnet"},"status":{"type":"string","description":"Credential status","example":"LIVE / SUSPEND / REVOKE"},"statusReason":{"type":"string","description":"Credential status Reason","example":"Reason"},"issuerDid":{"type":"string","description":"issuerDid of the credential"},"verificationMethodId":{"type":"string","description":"Verification Method id for did updation","example":"did:hid:testnet:........#key-${idx}"}},"required":["namespace","status","statusReason","issuerDid","verificationMethodId"]},"Query":{"type":"object","properties":{"type":{"type":"string","description":"Query Type","example":"QueryByExample / DIDAuthentication"},"credentialQuery":{"description":"credentialQuery","example":[{"required":true,"reason":"We need you to prove your eligibility to work.","example":{"@context":["https://www.w3.org/2018/credentials/v1"],"type":"AlumniCredential","credentialSubject":{"name":"Random name","id":"did:hid:testnet:............................."},"credentialSchema":{"id":"sch:hid:testnet:...............","type":"JsonSchemaValidator2018"},"trustedIssuer":[{"required":true,"issuer":"did:hid:testnet:................"}]}}],"type":"array","items":{"type":"string"}}},"required":["type","credentialQuery"]},"CreatePresentationTemplateDto":{"type":"object","properties":{"domain":{"type":"string","description":"Domain name","example":"fyre.hypersign.id"},"name":{"type":"string","description":"name of the presentation template","example":"alumni_credential_request (sanke_case)"},"query":{"description":"query parameter for requesting presentation","type":"array","items":{"$ref":"#/components/schemas/Query"}}},"required":["domain","name","query"]},"PTemplateError":{"type":"object","properties":{"statusCode":{"type":"number","description":"statusCode","example":400},"message":{"description":"message","example":["error message 1","error message 2"],"type":"array","items":{"type":"string"}},"error":{"type":"string","description":"error","example":"Bad Request"}},"required":["statusCode","message","error"]},"PresentationTemplate":{"type":"object","properties":{"appId":{"type":"string","description":"Application Id","example":"43...18-..........."},"domain":{"type":"string","description":"Domain name","example":"fyre.hypersign.id"},"query":{"description":"Domain name","example":[{"type":"QueryByExample","credentialQuery":[{"required":true,"reason":"We need you to prove your eligibility to work.","example":{"@context":["https://www.w3.org/2018/credentials/v1"],"type":"AlumniCredential","credentialSubject":{"name":"Random name","id":"did:hid:testnet:............................."},"credentialSchema":{"id":"sch:hid:testnet:...............","type":"JsonSchemaValidator2018"},"trustedIssuer":[{"required":true,"issuer":"did:hid:testnet:................"}]}}]}],"allOf":[{"$ref":"#/components/schemas/Query"}]}},"required":["appId","domain","query"]},"GetPresentationTemplateListList":{"type":"object","properties":{"totalCount":{"type":"number","description":"totalCount","example":12},"data":{"description":"data","type":"array","items":{"$ref":"#/components/schemas/PresentationTemplate"}}},"required":["totalCount","data"]},"PTemplateNotFoundError":{"type":"object","properties":{"statusCode":{"type":"number","description":"statusCode","example":404},"message":{"description":"message","example":["error message 1","error message 2"],"type":"array","items":{"type":"string"}},"error":{"type":"string","description":"error","example":"Not Found"}},"required":["statusCode","message","error"]},"UpdatePresentationDto":{"type":"object","properties":{"domain":{"type":"string","description":"Domain name","example":"fyre.hypersign.id"},"name":{"type":"string","description":"name of the presentation template","example":"alumni_credential_request (sanke_case)"},"query":{"description":"query parameter for requesting presentation","type":"array","items":{"$ref":"#/components/schemas/Query"}}}},"CreatePresentationDto":{"type":"object","properties":{"credentialDocuments":{"description":"list of credentials","type":"array","items":{"$ref":"#/components/schemas/CredDoc"}},"holderDid":{"type":"string","description":"list of credentials","example":"did:hid:testnet:............"},"challenge":{"type":"string","description":"Challenge can be used to match the response to a request ","example":"skfdhldklgjh-gaghkdhgaskda-aisgkjheyi"},"domain":{"type":"string","description":"domain that will receive verifiable presentation","example":"example.com"}},"required":["credentialDocuments","holderDid","challenge","domain"]},"PresentationProof":{"type":"object","properties":{"type":{"type":"string","description":"type using which credential has signed","example":"Ed25519Signature2020"},"created":{"format":"date-time","type":"string","description":"Date on which credential has issued","example":"2023-01-25T17:01:02Z"},"verificationMethod":{"type":"string","description":"Verification id using which credential has signed","example":"did:hid:testnet:...............#key-${id}"},"proofPurpose":{"type":"string","description":"","example":"authentication"},"challenge":{"type":"string","description":"challenge used for generating presentation","example":"skfdhldklgjh-gaghkdhgaskda-aisgkjheyi"},"proofValue":{"type":"string","description":"Proof value","example":"z5LairjrBYkc5FtPWeDVuLdQUzpMTBULcp3Q5YDnrLh63UuBuY6BpdiQYhTEcKBFW76TEXFHm37aDvcMtCvnYfmvQ"}},"required":["type","created","verificationMethod","proofPurpose","challenge","proofValue"]},"Presentation":{"type":"object","properties":{"@context":{"description":"Context of the credential","example":["https://www.w3.org/2018/credentials/v1"],"type":"array","items":{"type":"string"}},"type":{"description":"Type of presentation geenrated","example":["VerifiablePresentation"],"type":"array","items":{"type":"string"}},"verifiableCredential":{"description":"Array of credentials that has passed to generate presentation","type":"array","items":{"$ref":"#/components/schemas/CredDoc"}},"id":{"type":"string","description":"Vp id","example":"vp:hid:testnet:.........................."},"holder":{"type":"string","description":"did of the holder of credential","example":"did:hid:testnet:.............."},"proof":{"description":"proof of presentation","allOf":[{"$ref":"#/components/schemas/PresentationProof"}]}},"required":["@context","type","verifiableCredential","id","holder","proof"]},"PresentationResponse":{"type":"object","properties":{"presentation":{"description":"Detail of presentaion that has created","allOf":[{"$ref":"#/components/schemas/Presentation"}]}},"required":["presentation"]},"CreatePresentationRequestDto":{"type":"object","properties":{"challenge":{"type":"string","description":"Challenge can be used to match the response to a request ","example":"skfdhldklgjh-gaghkdhgaskda-aisgkjheyi"},"did":{"type":"string","description":"did of the verifier","example":"did:hid:<namespace>:..............."},"templateId":{"type":"string","description":"templateId of the presentation templete to form presentation request","example":"6392854982......"},"expiresTime":{"type":"number","description":"expiresTime  for the presentation request (unix timestamp)","example":1231423},"callbackUrl":{"type":"string","description":"callbackUrl that will receive verifiable presentation","example":"https://example.com/verify/callback"}},"required":["challenge","did","templateId","expiresTime","callbackUrl"]},"CreatePresentationResponse":{"type":"object","properties":{"id":{"type":"string","description":"id of presentation request template","example":"f....8-84ae-4..2-a..3-efab....d4db"},"from":{"type":"string","description":"did of the holder","example":"did:hid:testnet:..............."},"created_time":{"type":"number","description":"Time of request creation","example":1675167388737},"expires_time":{"type":"number","description":"Time at which challenge become invalid","example":1675177277551},"reply_url":{"type":"string","description":"Url that will receive verifiable presentation","example":"https://example.com/verify/callback"},"reply_to":{"description":"list of dids to whome presentationis to be given","example":["did:hid:testnet:................."],"type":"array","items":{"type":"string"}},"body":{"description":"Presentatioin template detail","allOf":[{"$ref":"#/components/schemas/PresentationTemplate"}]}},"required":["id","from","created_time","expires_time","reply_url","reply_to","body"]},"VerifyPresentationDto":{"type":"object","properties":{"presentation":{"description":"list of credentials","allOf":[{"$ref":"#/components/schemas/Presentation"}]}},"required":["presentation"]},"CredentialResults":{"type":"object","properties":{"verified":{"type":"boolean","description":"verification result","example":true},"results":{"description":" result description","type":"array","items":{"$ref":"#/components/schemas/Result"}},"statusResult":{"description":" result of status","allOf":[{"$ref":"#/components/schemas/StatusResult"}]},"credentialId":{"type":"string","description":"credential id","example":"vc:hid:testnet:......"}},"required":["verified","results","statusResult","credentialId"]},"VerifyPresentationResponse":{"type":"object","properties":{"verified":{"type":"boolean","description":"resul of verification","example":true},"results":{"description":"detailed information of verification","type":"array","items":{"$ref":"#/components/schemas/Presentation"}},"credentialResults":{"description":"verification result of credential","type":"array","items":{"$ref":"#/components/schemas/CredentialResults"}}},"required":["verified","results","credentialResults"]}}}}