---
url: /apidocs/verus.md
---
## Verus API

| Endpoint | Method | Description |
|-----|-----|-----|
| [/verus/checkChallenge](#check-verus-challenge) | webRequest | Check Verus challenge |
| [/verus/signDisclaimer](#sign-disclaimer-with-verus) | webRequest | Sign disclaimer with Verus |
| [/verus/signDisclaimer/checkChallenge](#check-verus-challenge-for-sign-disclaimer) | webRequest | Check Verus challenge for sign disclaimer |
| [/verus/purchaseContent](#purchase-content-with-verus) | webRequest | Purchase content with Verus |
| [/verus/purchaseContent/checkChallenge](#check-verus-challenge-for-purchase-content) | webRequest | Check Verus challenge for purchase content |
| [/verus/verusIdLoginResponse](#proxy-response-from-verus-to-crypto-server-) | webRequest | Proxy response from Verus to crypto server. |
| [/verus/verusIdLoginResponseTestnet](#proxy-response-from-verus-to-crypto-server-testnet-) | webRequest | Proxy response from Verus to crypto server (Testnet). |
| [/verus/getChallengeDeeplink](#get-verus-deeplink-by-challenge-id-) | webRequest | Get Verus deeplink by challenge id. |
| [/verus/signMessageByUserResponse](#proxy-response-from-verus-to-crypto-server-) | webRequest | Proxy response from Verus to crypto server. |
| [/verus/claimsSendResponse](#proxy-response-from-verus-to-crypto-server-) | webRequest | Proxy response from Verus to crypto server. |
| [/verus/claimsSendResponseTestnet](#proxy-response-from-verus-to-crypto-server-testnet-) | webRequest | Proxy response from Verus to crypto server (Testnet). |
| [/verus/createAndSignEndorsementResponse](#proxy-response-from-verus-to-crypto-server-) | webRequest | Proxy response from Verus to crypto server. |
| [/verus/createAndSignEndorsementResponseTestnet](#proxy-response-from-verus-to-crypto-server-testnet-) | webRequest | Proxy response from Verus to crypto server (Testnet). |
| [/verus/getClaimsData](#api-returns-claims-data-that-should-be-saved-by-verus-wallet-using-one-time-token-) | webRequest | Api returns claims data that should be saved by Verus wallet (using one time token). |
| [/verus/getClaimsData/{challengeId}](#api-returns-claims-data-that-should-be-saved-by-verus-wallet-using-challengeid-) | webRequest | Api returns claims data that should be saved by Verus wallet (using challengeId). |
| [/verus/getAttestationResponse](#proxy-response-from-verus-to-crypto-server-) | webRequest | Proxy response from Verus to crypto server. |
| [/verus/getAttestationProofsResponse](#proxy-response-from-verus-to-crypto-server-) | webRequest | Proxy response from Verus to crypto server. |
| [/verus/timelockResponse](#proxy-response-from-verus-to-crypto-server-) | webRequest | Proxy response from Verus to crypto server. |
| [/verus/revokeResponse](#proxy-response-from-verus-to-crypto-server-) | webRequest | Proxy response from Verus to crypto server. |
| [/verus/recoverResponse](#proxy-response-from-verus-to-crypto-server-) | webRequest | Proxy response from Verus to crypto server. |
| [/agreement/{agreementType}?...queryParameters](#show-agreement-page-) | webRequest | Show agreement page. |
| [verus:getScopedRootKey](#get-scoped-root-key-from-verus-wallet) | websocket | Get scoped root key from Verus wallet |
| [verus:createAlbum](#create-album-using-verus) | websocket | Create album using Verus |
| [verus:listAlbumForSale](#list-album-for-sale-using-verus) | websocket | List album for sale using Verus |
| [verus:giftAlbum](#gift-album-using-verus) | websocket | Gift album using Verus |
| [verus:getCreatedPlaylist](#get-created-playlist-using-verus) | websocket | Get Created playlist using Verus |
| [verus:getNewPlaylist](#get-new-playlist-using-verus) | websocket | Get New playlist using Verus |
| [verus:getMyPlaylist](#get-my-playlist-using-verus) | websocket | Get My playlist using Verus |
| [verus:signDisclaimer](#sign-disclaimer-using-verus) | websocket | Sign disclaimer using Verus |
| [verus:purchaseContent](#purchase-content-using-verus) | websocket | Purchase content using Verus |
| [verus:sendMoneyToUser](#verus-send-money-to-user) | websocket | Verus send money to user |
| [verus:sendMoneyToIdentity](#verus-send-money-to-identity) | websocket | Verus send money to identity |
| [verus:exchangeCrypto](#verus-exchange-crypto) | websocket | Verus exchange crypto |
| [verus:getUserBalance](#verus-get-user-balance) | websocket | Verus get user balance |
| [verus:getExchangeRate](#verus-get-exchange-rate) | websocket | Verus get exchange rate |
| [verus:getExchangeRates](#verus-get-exchange-rates) | websocket | Verus get exchange rates |
| [verus:getVerusCoinPrice](#get-verus-coin-price) | websocket | Get verus coin price |
| [verus:getTransactionStatusHistory](#verus-get-transaction-status-history) | websocket | Verus get transaction status history |
| [verus:listTransactionStatusHistory](#verus-list-transaction-status-history) | websocket | Verus list transaction status history |
| ~~[verus:createVerifiableMessage](#verus-create-verifiable-statement-message)~~ | websocket | Verus create verifiable statement message |
| [verus:createStatementClaim](#verus-create-statement-claim) | websocket | Verus create statement claim |
| ~~[verus:createVerifiableSocialAccount](#verus-create-verifiable-social-account)~~ | websocket | Verus create verifiable social account |
| [verus:createSocialAccountClaim](#verus-create-social-account-claim) | websocket | Verus create social account claim |
| ~~[verus:createVerifiableSkillMessage](#verus-create-verifiable-skill-message)~~ | websocket | Verus create verifiable skill message |
| [verus:createSkillClaim](#verus-create-skill-claim) | websocket | Verus create skill claim |
| ~~[verus:createVerifiableWorkExperienceMessage](#verus-create-verifiable-work-experience-message)~~ | websocket | Verus create verifiable work experience message |
| [verus:createWorkExperienceClaim](#verus-create-work-experience-claim) | websocket | Verus create work experience claim |
| ~~[verus:createVerifiableEducationMessage](#verus-create-verifiable-education-message)~~ | websocket | Verus create verifiable education message |
| [verus:createEducationClaim](#verus-create-education-claim) | websocket | Verus create education claim |
| ~~[verus:createVerifiableAchievementMessage](#verus-create-verifiable-achievement-message)~~ | websocket | Verus create verifiable achievement message |
| [verus:createAchievementClaim](#verus-create-achievement-claim) | websocket | Verus create achievement claim |
| ~~[verus:deleteVerifiableMessage](#verus-delete-verifiable-message)~~ | websocket | Verus delete verifiable message |
| [verus:deleteTargetAttestationClaim](#verus-delete-target-attestation-claim) | websocket | Verus delete target attestation claim |
| [verus:deleteAttestationClaim](#verus-delete-attestation-claim) | websocket | Verus delete attestation claim |
| ~~[verus:updateVerifiableWorkExperienceMessage](#verus-update-verifiable-work-experience-message)~~ | websocket | Verus update verifiable work experience message |
| [verus:updateWorkExperienceClaim](#verus-update-work-experience-claim) | websocket | Verus update work experience claim |
| ~~[verus:updateVerifiableEducationMessage](#verus-update-verifiable-education-message)~~ | websocket | Verus update verifiable education message |
| [verus:updateEducationClaim](#verus-update-education-claim) | websocket | Verus update education claim |
| ~~[verus:updateVerifiableAchievementMessage](#verus-update-verifiable-achievement-message)~~ | websocket | Verus update verifiable achievement message |
| [verus:updateAchievementClaim](#verus-update-achievement-claim) | websocket | Verus update achievement claim |
| ~~[verus:listVerifiableMessages](#verus-list-verifiable-statement-messages)~~ | websocket | Verus list verifiable statement messages |
| [verus:listAttestationClaims](#verus-list-attestation-claims) | websocket | Verus list attestation claims |
| [verus:listStatementClaims](#verus-list-statement-claims) | websocket | Verus list statement claims |
| ~~[verus:listVerifiableSkillMessages](#verus-list-verifiable-skill-messages)~~ | websocket | Verus list verifiable skill messages |
| [verus:listSkillClaims](#verus-list-skill-claims) | websocket | Verus list skill claims |
| ~~[verus:listVerifiableWorkExperienceMessages](#verus-list-verifiable-work-experience-messages)~~ | websocket | Verus list verifiable work experience messages |
| [verus:listWorkExperienceClaims](#verus-list-work-experience-claims) | websocket | Verus list work experience claims |
| ~~[verus:listVerifiableEducationMessages](#verus-list-verifiable-education-messages)~~ | websocket | Verus list verifiable education messages |
| [verus:listEducationClaims](#verus-list-education-claims) | websocket | Verus list education claims |
| ~~[verus:listVerifiableAchievementMessages](#verus-list-verifiable-achievement-messages)~~ | websocket | Verus list verifiable achievement messages |
| [verus:listAchievementClaims](#verus-list-achievement-claims) | websocket | Verus list achievement claims |
| [verus:searchSkillTags](#verus-search-skill-tags) | websocket | Verus search skill tags |
| ~~[verus:listVerifiableMessageSignatures](#verus-list-verifiable-message-signatures)~~ | websocket | Verus list verifiable message signatures |
| [verus:listAttestationClaimSignatures](#verus-list-attestation-claim-signatures) | websocket | Verus list attestation claim signatures |
| [verus:listUserEndorsements](#verus-list-user-endorsements) | websocket | Verus list user endorsements |
| [verus:listUserEndorsementsWithClaims](#verus-list-user-endorsements-with-claims) | websocket | Verus list user endorsements with claims |
| ~~[verus:getDeeplinkToVerifyMessage](#verus-get-deeplink-to-verify-message)~~ | websocket | Verus get deeplink to verify message |
| [verus:getDeeplinkToVerifyAttestationClaim](#verus-get-deeplink-to-verify-attestation-claim) | websocket | Verus get deeplink to verify attestation claim |
| ~~[verus:listVerifiableSocialAccounts](#verus-list-verifiable-social-accounts)~~ | websocket | Verus list verifiable social accounts |
| [verus:listSocialAccountsClaims](#verus-list-social-accounts-claims) | websocket | Verus list social accounts claims |
| [verus:provideProofToVerifySocialAccount](#verus-provide-proof-to-verify-social-account) | websocket | Verus provide proof to verify social account |
| [verus:getDeeplinkToSaveClaims](#verus-get-deeplink-to-save-claims) | websocket | Verus get deeplink to save claims |
| [verus:getDeeplinkToSignCredential](#verus-get-deeplink-to-sign-credential) | websocket | Verus get deeplink to sign credential |
| [verus:getDeeplinkToSignCredentials](#verus-get-deeplink-to-sign-credentials) | websocket | Verus get deeplink to sign credentials |
| [verus:getDeeplinkToCreateEndorsement](#verus-get-deeplink-to-create-endorsement) | websocket | Verus get deeplink to create endorsement |
| [verus:saveEndorsementsToBlockchain](#verus-save-endorsements-to-blockchain) | websocket | Verus save endorsements to blockchain |
| ~~[verus:getEndorsementHash](#verus-get-endorsement-hash)~~ | websocket | Verus get endorsement hash |
| [verus:getEndorsementVerifyLink](#verus-get-endorsement-verify-link) | websocket | Verus get endorsement verify link |
| [verus:createCredentialTemplate](#verus-create-credential-template) | websocket | Verus create credential template |
| [verus:deleteCredentialTemplate](#verus-delete-credential-template) | websocket | Verus delete credential template |
| [verus:listCredentialTemplates](#verus-list-credential-templates) | websocket | Verus list credential templates |
| [verus:grantCredential](#verus-grant-credential) | websocket | Verus grant credential |
| [verus:listCredentials](#verus-list-credentials) | websocket | Verus list credentials |
| [verus:revokeCredential](#verus-revoke-credential) | websocket | Verus revoke credential |
| [verus:synchronizeClaimsAndEndorsements](#verus-synchronize-claims-and-endorsements) | websocket | Verus synchronize claims and endorsements |
| [verus:getDeeplinkForAttestationProofsFromWallet](#verus-get-deeplink-for-attestation-proofs-from-wallet) | websocket | Verus get deeplink for attestation proofs from wallet |
| [verus:getDeeplinkForAttestationValuesFromWallet](#verus-get-deeplink-for-attestation-values-from-wallet) | websocket | Verus get deeplink for attestation values from wallet |
| ~~[verus:getDeeplinkForAttestation](#verus-get-deeplink-for-attestation)~~ | websocket | Verus get deeplink for attestation |
| ~~[verus:getDeeplinkForAttestationProofs](#verus-get-deeplink-for-attestation-proofs)~~ | websocket | Verus get deeplink for attestation proofs |
| [verus:getUserAttestation](#verus-get-user-attestation) | websocket | Verus get user attestation |
| [verus:createAttestationBlock](#verus-create-attestation-block) | websocket | Verus create attestation block |
| [verus:deleteAttestationBlock](#verus-delete-attestation-block) | websocket | Verus delete attestation block |
| [verus:updateAttestationBlock](#verus-update-attestation-block) | websocket | Verus update attestation block |
| [verus:publishAttestationBlock](#verus-publish-attestation-block) | websocket | Verus publish attestation block |
| [verus:listAttestationBlocks](#verus-list-attestation-blocks) | websocket | Verus list attestation blocks |
| ~~[verus:getAttestationBlocksForUser](#verus-get-attestation-blocks-for-user)~~ | websocket | Verus get attestation blocks for user |
| [verus:listAttestationBlocksForUser](#verus-list-attestation-blocks-for-user) | websocket | Verus list attestation blocks for user |
| [verus:setAnswersForAttestationBlock](#verus-set-answers-for-attestation-block) | websocket | Verus set answers for attestation block |
| [verus:setAnswersForBlock](#verus-set-answers-for-block) | websocket | Verus set answers for block |
| [verus:getBlockVDXFKeysBySuffix](#verus-get-block-vdxf-keys-by-suffix) | websocket | Verus get block vDXF keys by suffix |
| [verus:createCurrencyIdentity](#verus-create-currency-identity) | websocket | Verus create currency identity |
| [verus:checkCurrencyIdentityName](#verus-check-currency-identity-name) | websocket | Verus check currency identity name |
| [verus:changeCurrencyOwner](#verus-change-currency-owner) | websocket | Verus change currency owner |
| [verus:mintNFTOnCurrency](#verus-mint-nft-on-currency) | websocket | Verus mint nFT on currency |
| [verus:listIdentitiesFromWalletOnCurrency](#verus-list-identities-from-wallet-on-currency) | websocket | Verus list identities from wallet on currency |
| [verus:getAllIdentitiesInWalletOnCurrency](#verus-get-all-identities-in-wallet-on-currency) | websocket | Verus get all identities in wallet on currency |
| [verus:getProvisionDeeplink](#verus-get-provision-deeplink) | websocket | Verus get provision deeplink |
| [verus:getIdentityProvisionStatus](#verus-get-identity-provision-status) | websocket | Verus get identity provision status |
| [verus:checkValuLightIdentityName](#verus-check-valu-light-identity-name) | websocket | Verus check valu light identity name |
| [verus:provisionValuLightIdentity](#verus-provision-valu-light-identity) | websocket | Verus provision valu light identity |
| [verus:getValuLightIdentityProvisionStatus](#verus-get-valu-light-identity-provision-status) | websocket | Verus get valu light identity provision status |
| [verus:createIdentityMarketplaceSellOffer](#verus-create-identity-marketplace-sell-offer) | websocket | Verus create identity marketplace sell offer |
| [verus:deleteIdentityMarketplaceSellOffer](#verus-delete-identity-marketplace-sell-offer) | websocket | Verus delete identity marketplace sell offer |
| [verus:listIdentityMarketplaceSellOffersOfCurrentUser](#verus-list-identity-marketplace-sell-offers-of-current-user) | websocket | Verus list identity marketplace sell offers of current user |
| [verus:listIdentityMarketplaceSellOffersOfTargetUser](#verus-list-identity-marketplace-sell-offers-of-target-user) | websocket | Verus list identity marketplace sell offers of target user |
| [verus:createIdentityMarketplaceBuyOffer](#verus-create-identity-marketplace-buy-offer) | websocket | Verus create identity marketplace buy offer |
| [verus:deleteIdentityMarketplaceBuyOffer](#verus-delete-identity-marketplace-buy-offer) | websocket | Verus delete identity marketplace buy offer |
| [verus:listIdentityMarketplaceOutgoingBuyOffers](#verus-list-identity-marketplace-outgoing-buy-offers) | websocket | Verus list identity marketplace outgoing buy offers |
| [verus:listIdentityMarketplaceIncomingBuyOffers](#verus-list-identity-marketplace-incoming-buy-offers) | websocket | Verus list identity marketplace incoming buy offers |
| [verus:getDeeplinkToPayForIdentityMarketplaceBuyOffer](#verus-get-deeplink-to-pay-for-identity-marketplace-buy-offer) | websocket | Verus get deeplink to pay for identity marketplace buy offer |
| [verus:simulatePaymentForIdentityMarketplaceBuyOffer](#verus-simulate-payment-for-identity-marketplace-buy-offer) | websocket | Verus simulate payment for identity marketplace buy offer |
| [verus:acceptIdentityMarketplaceBuyOffer](#verus-accept-identity-marketplace-buy-offer) | websocket | Verus accept identity marketplace buy offer |
| [verus:listIdentityMarketplaceBuyOfferValues](#verus-list-identity-marketplace-buy-offer-values) | websocket | Verus list identity marketplace buy offer values |
| [verus:listAmbassadors](#verus-list-ambassadors) | websocket | Verus list ambassadors |
| [verus:listIdentities](#verus-list-identities) | websocket | Verus list identities |
| [verus:getIdentityStatus](#verus-get-identity-status) | websocket | Verus get identity status |
| [verus:listIdentityTransactions](#verus-list-identity-transactions) | websocket | Verus list identity transactions |
| [verus:listIdentityBalances](#verus-list-identity-balances) | websocket | Verus list identity balances |
| [verus:getBlockHeight](#verus-get-block-height) | websocket | Verus get block height |
| [verus:getTimelockDeeplink](#verus-get-timelock-deeplink) | websocket | Verus get timelock deeplink |
| [verus:getRevokeDeeplink](#verus-get-revoke-deeplink) | websocket | Verus get revoke deeplink |
| [verus:getRevokeIdentities](#verus-get-revoke-identities) | websocket | Verus get revoke identities |
| [verus:getRecoveryDeeplink](#verus-get-recovery-deeplink) | websocket | Verus get recovery deeplink |
| [verus:getRecoveryIdentities](#verus-get-recovery-identities) | websocket | Verus get recovery identities |
| [verus:createAgentId](#verus-create-agent-id) | websocket | Verus create agent id |
| [verus:getAgentsBalance](#verus-get-agents-balance) | websocket | Verus get agents balance |
| [verus:agentSendMoney](#verus-agent-send-money) | websocket | Verus agent send money |
| ~~[verus:verifiableStatementCreated](#on-attestation-statement-claim-created-event-deprecated)~~ | websocketEvent | On attestation statement claim created event: deprecated |
| [verus:statementClaimCreated](#on-attestation-statement-claim-created-event) | websocketEvent | On attestation statement claim created event |
| ~~[verus:verifiableSocialAccountCreated](#on-attestation-social-account-claim-created-event-deprecated)~~ | websocketEvent | On attestation social account claim created event: deprecated |
| [verus:socialAccountClaimCreated](#on-attestation-social-account-claim-created-event) | websocketEvent | On attestation social account claim created event |
| ~~[verus:verifiableSkillCreated](#on-attestation-skill-claim-created-event-deprecated)~~ | websocketEvent | On attestation skill claim created event: deprecated |
| [verus:skillClaimCreated](#on-attestation-skill-claim-created-event) | websocketEvent | On attestation skill claim created event |
| ~~[verus:verifiableWorkExperienceCreated](#on-attestation-work-experience-claim-created-event-deprecated)~~ | websocketEvent | On attestation work experience claim created event: deprecated |
| [verus:workExperienceClaimCreated](#on-attestation-work-experience-claim-created-event) | websocketEvent | On attestation work experience claim created event |
| ~~[verus:verifiableEducationCreated](#on-attestation-education-claim-created-event-deprecated)~~ | websocketEvent | On attestation education claim created event: deprecated |
| [verus:educationClaimCreated](#on-attestation-education-claim-created-event) | websocketEvent | On attestation education claim created event |
| [verus:achievementClaimCreated](#on-attestation-achievement-claim-created-event) | websocketEvent | On attestation achievement claim created event |
| [verus:attestationBlockClaimCreated](#on-attestation-block-claim-created-event) | websocketEvent | On attestation block claim created event |
| [verus:attestationBlockClaimsCreated](#on-attestation-block-claims-created-event) | websocketEvent | On attestation block claims created event |
| ~~[verus:verifiableStatementDeleted](#on-attestation-statement-claim-deleted-event-deprecated)~~ | websocketEvent | On attestation statement claim deleted event: deprecated |
| [verus:statementClaimDeleted](#on-attestation-statement-claim-deleted-event) | websocketEvent | On attestation statement claim deleted event |
| ~~[verus:verifiableSocialAccountDeleted](#on-attestation-social-account-claim-deleted-event-deprecated)~~ | websocketEvent | On attestation social account claim deleted event deprecated |
| [verus:socialAccountClaimDeleted](#on-attestation-social-account-claim-deleted-event) | websocketEvent | On attestation social account claim deleted event |
| ~~[verus:verifiableSkillDeleted](#on-attestation-skill-claim-deleted-event-deprecated)~~ | websocketEvent | On attestation skill claim deleted event: deprecated |
| [verus:skillClaimDeleted](#on-attestation-skill-claim-deleted-event) | websocketEvent | On attestation skill claim deleted event |
| ~~[verus:verifiableWorkExperienceDeleted](#on-attestation-work-experience-claim-deleted-event-deprecated)~~ | websocketEvent | On attestation work experience claim deleted event: deprecated |
| [verus:workExperienceClaimDeleted](#on-attestation-work-experience-claim-deleted-event) | websocketEvent | On attestation work experience claim deleted event |
| ~~[verus:verifiableEducationDeleted](#on-attestation-education-claim-deleted-event-deprecated)~~ | websocketEvent | On attestation education claim deleted event: deprecated |
| [verus:educationClaimDeleted](#on-attestation-education-claim-deleted-event) | websocketEvent | On attestation education claim deleted event |
| [verus:achievementClaimDeleted](#on-attestation-achievement-claim-deleted-event) | websocketEvent | On attestation achievement claim deleted event |
| [verus:attestationBlockClaimDeleted](#on-attestation-block-claim-deleted-event) | websocketEvent | On attestation block claim deleted event |
| ~~[verus:verifiableStatementUpdated](#on-attestation-statement-claim-updated-event-deprecated)~~ | websocketEvent | On attestation statement claim updated event: deprecated |
| [verus:statementClaimUpdated](#on-attestation-statement-claim-updated-event) | websocketEvent | On attestation statement claim updated event |
| ~~[verus:verifiableSocialAccountUpdated](#on-attestation-social-account-claim-updated-event-deprecated)~~ | websocketEvent | On attestation social account claim updated event: deprecated |
| [verus:socialAccountClaimUpdated](#on-attestation-social-account-claim-updated-event) | websocketEvent | On attestation social account claim updated event |
| ~~[verus:verifiableSkillUpdated](#on-attestation-skill-claim-updated-event-deprecated)~~ | websocketEvent | On attestation skill claim updated event: deprecated |
| [verus:skillClaimUpdated](#on-attestation-skill-claim-updated-event) | websocketEvent | On attestation skill claim updated event |
| ~~[verus:verifiableWorkExperienceUpdated](#on-attestation-work-experience-claim-updated-event-deprecated)~~ | websocketEvent | On attestation work experience claim updated event: deprecated |
| [verus:workExperienceClaimUpdated](#on-attestation-work-experience-claim-updated-event) | websocketEvent | On attestation work experience claim updated event |
| ~~[verus:verifiableEducationUpdated](#on-attestation-education-claim-updated-event-deprecated)~~ | websocketEvent | On attestation education claim updated event: deprecated |
| [verus:educationClaimUpdated](#on-attestation-education-claim-updated-event) | websocketEvent | On attestation education claim updated event |
| [verus:achievementClaimUpdated](#on-attestation-achievement-claim-updated-event) | websocketEvent | On attestation achievement claim updated event |
| [verus:blockClaimUpdated](#on-attestation-block-claim-updated-event) | websocketEvent | On attestation block claim updated event |
| ~~[verus:verifySocialAccountProofResultEvent](#on-verify-social-account-proof-result-event-deprecated)~~ | websocketEvent | On verify social account proof result event: deprecated |
| [verus:socialAccountProofResultEvent](#on-verify-social-account-proof-result-event) | websocketEvent | On verify social account proof result event |
| ~~[verus:signatureForVerifiableStatementCreated](#on-new-signature-for-attestation-statement-claim-event-deprecated)~~ | websocketEvent | On new signature for attestation statement claim event: deprecated |
| [verus:signatureForStatementClaimCreated](#on-new-signature-for-attestation-statement-claim-event) | websocketEvent | On new signature for attestation statement claim event |
| ~~[verus:signatureForVerifiableSkillCreated](#on-new-signature-for-attestation-skill-claim-event-deprecated)~~ | websocketEvent | On new signature for attestation skill claim event: deprecated |
| [verus:signatureForSkillClaimCreated](#on-new-signature-for-attestation-skill-claim-event) | websocketEvent | On new signature for attestation skill claim event |
| ~~[verus:signatureForVerifiableWorkExperienceCreated](#on-new-signature-for-attestation-work-experience-claim-event-deprecated)~~ | websocketEvent | On new signature for attestation work experience claim event: deprecated |
| [verus:signatureForWorkExperienceClaimCreated](#on-new-signature-for-attestation-work-experience-claim-event) | websocketEvent | On new signature for attestation work experience claim event |
| ~~[verus:signatureForVerifiableEducationCreated](#on-new-signature-for-attestation-education-claim-event-deprecated)~~ | websocketEvent | On new signature for attestation education claim event: deprecated |
| [verus:signatureForEducationClaimCreated](#on-new-signature-for-attestation-education-claim-event) | websocketEvent | On new signature for attestation education claim event |
| [verus:signatureForAchievementClaimCreated](#on-new-signature-for-attestation-achievement-claim-event) | websocketEvent | On new signature for attestation achievement claim event |
| [verus:signatureForBlockClaimCreated](#on-new-signature-for-attestation-block-claim-event) | websocketEvent | On new signature for attestation block claim event |
| [verus:identityMarketplaceBuyOfferCreatedEvent](#on-identity-marketplace-buy-offer-created-event) | websocketEvent | On identity marketplace buy offer created event |
| [verus:identityMarketplaceBuyOfferUpdatedEvent](#on-identity-marketplace-buy-offer-updated-event) | websocketEvent | On identity marketplace buy offer updated event |
| [verus:identityMarketplaceBuyOfferAutoAcceptEvent](#on-identity-marketplace-buy-offer-auto-accept-event) | websocketEvent | On identity marketplace buy offer auto accept event |
| [verus:signDisclaimerSuccess](#verus-sign-disclaimer-success-event) | websocketEvent | Verus sign disclaimer success event |
| [verus:signDisclaimerError](#verus-sign-disclaimer-error-event) | websocketEvent | Verus sign disclaimer error event |
| [verus:purchaseContentSuccess](#verus-purchase-content-success-event) | websocketEvent | Verus purchase content success event |
| [verus:purchaseContentError](#verus-purchase-content-error-event) | websocketEvent | Verus purchase content error event |
| [verus:albumCreated](#verus-album-created-event) | websocketEvent | Verus album created event |
| [verus:albumCreateError](#verus-album-create-error-event) | websocketEvent | Verus album create error event |
| [verus:albumPurchased](#verus-album-purchased-event) | websocketEvent | Verus album purchased event |
| [verus:albumPurchaseError](#verus-album-purchase-error-event) | websocketEvent | Verus album purchase error event |
| [verus:createRoomSubscription](#create-room-subscription-with-verus) | websocketEvent | Create room subscription with Verus |
| [verus:createRoomSubscriptionSuccess](#verus-create-room-subscription-success-event) | websocketEvent | Verus create room subscription success event |
| [verus:createRoomSubscriptionError](#verus-create-room-subscription-error-event) | websocketEvent | Verus create room subscription error event |
| [verus:transactionStatusUpdated](#verus-transaction-status-updated-event) | websocketEvent | Verus transaction status updated event |
| [verus:linkPersonaAccountResultEvent](#verus-link-persona-account-result-event) | websocketEvent | Verus link persona account result event |
| [verus:getScopedRootKeyResultEvent](#verus-get-scoped-root-key-result-event) | websocketEvent | Verus get scoped root key result event |
| ~~[verus:verifyMessageResultEvent](#on-verus-verify-message-result-event-deprecated)~~ | websocketEvent | On verus verify message result event: deprecated |
| [verus:verifyAttestationClaimResultEvent](#verus-verify-attestation-claim-result-event) | websocketEvent | Verus verify attestation claim result event |
| ~~[verus:verifySocialAccountResultEvent](#on-verus-verify-social-account-result-event-deprecated)~~ | websocketEvent | On verus verify social account result event: deprecated |
| [verus:verifySocialAccountClaimResultEvent](#verus-verify-social-account-result-event) | websocketEvent | Verus verify social account result event |
| [verus:saveClaimsResultEvent](#verus-save-claims-result-event) | websocketEvent | Verus save claims result event |
| [verus:createEndorsementResultEvent](#verus-create-endorsement-result-event) | websocketEvent | Verus create endorsement result event |
| [verus:saveEndorsementResultEvent](#verus-save-endorsement-result-event) | websocketEvent | Verus save endorsement result event |
| [verus:getAttestationResultEvent](#verus-get-attestation-result-event) | websocketEvent | Verus get attestation result event |
| [verus:getAttestationProofsResultEvent](#verus-get-attestation-proofs-result-event) | websocketEvent | Verus get attestation proofs result event |
| [verus:getAttestationValuesResultEvent](#verus-get-attestation-values-result-event) | websocketEvent | Verus get attestation values result event |
| [verus:transferIdentityEvent](#on-verus-transfer-identity-event) | websocketEvent | On verus transfer identity event |
| [verus:nftMintedEvent](#on-verus-nft-minted-event) | websocketEvent | On verus nft minted event |
| [verus:paymentReadyEvent](#on-verus-payment-ready-event) | websocketEvent | On verus payment ready event |
| [verus:currencyReadyEvent](#on-verus-currency-ready-event) | websocketEvent | On verus currency ready event |
| [verus:provisionStartedEvent](#on-provision-started-event) | websocketEvent | On provision started event |
| [verus:provisionEndedEvent](#on-provision-ended-event) | websocketEvent | On provision ended event |
| [verus:valuLightProvisionStartedEvent](#on-valu-light-provision-started-event) | websocketEvent | On valu light provision started event |
| [verus:valuLightProvisionEndedEvent](#on-valu-light-provision-ended-event) | websocketEvent | On valu light provision ended event |
| [verus:timelockResultEvent](#on-timelock-result-event) | websocketEvent | On timelock result event |
| [verus:revokeResultEvent](#on-revoke-result-event) | websocketEvent | On revoke result event |
| [verus:recoveryResultEvent](#on-recovery-result-event) | websocketEvent | On recovery result event |
| [verus:agentIdCreatedEvent](#on-verus-agent-id-created-event) | websocketEvent | On verus agent id created event |
| [verus:agentBalancesEvent](#on-verus-agent-balances-event) | websocketEvent | On verus agent balances event |

### Check Verus challenge

**HTTP Method:** POST

**Path:** /verus/checkChallenge

**Description:** Api returns error in case if Verus verification is not ready yet or failed. Api returns empty response if Verus verification succeeded.

**Request:**

**Response:**

### Sign disclaimer with Verus

**HTTP Method:** POST

**Path:** /verus/signDisclaimer

**Description:** Verus sign disclaimer for mobile platforms. Endpoint creates Verus challenge and returns `challengeId` and `deeplink`. Client opens Verus application with deeplink and authorizes with Verus account. After successful authorization, Verus application redirects client to `redirectUrl`. When client returned to Valuverse application it should call `/verus/signDisclaimer/checkChallenge` endpoint for checking Verus sign disclaimer result.

**Request:**

**Response:**

### Check Verus challenge for sign disclaimer

**HTTP Method:** POST

**Path:** /verus/signDisclaimer/checkChallenge

**Description:** Checks Verus sign disclaimer result after `/verus/signDisclaimer`.

**Request:**

**Response:**

### Purchase content with Verus

**HTTP Method:** POST

**Path:** /verus/purchaseContent

**Description:** Verus purchase content for mobile platforms. Endpoint creates Verus challenge and returns `challengeId` and `deeplink`. Client opens Verus application with deeplink and authorizes with Verus account. After successful authorization, Verus application redirects client to `redirectUrl`. When client returned to Valuverse application it should call `/verus/purchaseContent/checkChallenge` endpoint for checking Verus purchase content result.

**Request:**

**Response:**

### Check Verus challenge for purchase content

**HTTP Method:** POST

**Path:** /verus/purchaseContent/checkChallenge

**Description:** Checks Verus purchase content result after `/verus/purchaseContent`.

**Request:**

**Response:**

### Proxy response from Verus to crypto server.

**HTTP Method:** POST

**Path:** /verus/verusIdLoginResponse

**Request:**

**Response:**

### Proxy response from Verus to crypto server (Testnet).

**HTTP Method:** POST

**Path:** /verus/verusIdLoginResponseTestnet

**Request:**

**Response:**

### Get Verus deeplink by challenge id.

**HTTP Method:** POST

**Path:** /verus/getChallengeDeeplink

**Request:**

**Response:**

### Proxy response from Verus to crypto server.

**HTTP Method:** POST

**Path:** /verus/signMessageByUserResponse

**Request:**

**Response:**

### Proxy response from Verus to crypto server.

**HTTP Method:** POST

**Path:** /verus/claimsSendResponse

**Request:**

**Response:**

### Proxy response from Verus to crypto server (Testnet).

**HTTP Method:** POST

**Path:** /verus/claimsSendResponseTestnet

**Request:**

**Response:**

### Proxy response from Verus to crypto server.

**HTTP Method:** POST

**Path:** /verus/createAndSignEndorsementResponse

**Request:**

**Response:**

### Proxy response from Verus to crypto server (Testnet).

**HTTP Method:** POST

**Path:** /verus/createAndSignEndorsementResponseTestnet

**Request:**

**Response:**

### Api returns claims data that should be saved by Verus wallet (using one time token).

**HTTP Method:** GET

**Path:** /verus/getClaimsData

**Parameters:**

token: string

**Request:**

**Response:**

### Api returns claims data that should be saved by Verus wallet (using challengeId).

**HTTP Method:** GET

**Path:** /verus/getClaimsData/{challengeId}

**Request:**

**Response:**

### Proxy response from Verus to crypto server.

**HTTP Method:** POST

**Path:** /verus/getAttestationResponse

**Request:**

**Response:**

### Proxy response from Verus to crypto server.

**HTTP Method:** POST

**Path:** /verus/getAttestationProofsResponse

**Request:**

**Response:**

### Proxy response from Verus to crypto server.

**HTTP Method:** POST

**Path:** /verus/timelockResponse

**Request:**

**Response:**

### Proxy response from Verus to crypto server.

**HTTP Method:** POST

**Path:** /verus/revokeResponse

**Request:**

**Response:**

### Proxy response from Verus to crypto server.

**HTTP Method:** POST

**Path:** /verus/recoverResponse

**Request:**

**Response:**

### Show agreement page.

**HTTP Method:** GET

**Path:** /agreement/{agreementType}?...queryParameters

**Description:** Path parameter `agreementType` could be one of: `verusPurchaseRoom`, `verusRentRoom`.

**Parameters:**

`verusIdentity`, `subscriptionOption`, `priceInUsd`, `priceInVerus`, `roomName`

**Request:**

**Response:**

### Get scoped root key from Verus wallet

**Method:** websocket

**Endpoint:** verus:getScopedRootKey

**Description:** Endpoint returns deeplink that should be used for Verus authorization. After Verus authorization is finished, server sends `verus:getScopedRootKeyResultEvent` event.

**Request:**

**Response:**

### Create album using Verus

**Method:** websocket

**Endpoint:** verus:createAlbum

**Request:**

**Response:**

### List album for sale using Verus

**Method:** websocket

**Endpoint:** verus:listAlbumForSale

**Request:**

**Response:**

### Gift album using Verus

**Method:** websocket

**Endpoint:** verus:giftAlbum

**Request:**

**Response:**

### Get Created playlist using Verus

**Method:** websocket

**Endpoint:** verus:getCreatedPlaylist

**Request:**

**Response:**

### Get New playlist using Verus

**Method:** websocket

**Endpoint:** verus:getNewPlaylist

**Request:**

**Response:**

### Get My playlist using Verus

**Method:** websocket

**Endpoint:** verus:getMyPlaylist

**Request:**

**Response:**

### Sign disclaimer using Verus

**Method:** websocket

**Endpoint:** verus:signDisclaimer

**Description:** Endpoint returns deeplink that should be used for Verus authorization. After Verus authorization is finished, server sends `verus:signDisclaimerSuccess` or `verus:signDisclaimerError` event.

**Request:**

**Response:**

### Purchase content using Verus

**Method:** websocket

**Endpoint:** verus:purchaseContent

**Description:** Endpoint returns deeplink that should be used for Verus authorization. After Verus authorization is finished, server sends `verus:purchaseContentSuccess` or `verus:purchaseContentError` event.

**Request:**

**Response:**

### Verus send money to user

**Method:** websocket

**Endpoint:** verus:sendMoneyToUser

**Description:** Endpoint returns deeplink that should be used for Verus money transfer.

**Request:**

**Response:**

### Verus send money to identity

**Method:** websocket

**Endpoint:** verus:sendMoneyToIdentity

**Description:** Endpoint returns deeplink that should be used for Verus money transfer.

**Request:**

**Response:**

### Verus exchange crypto

**Method:** websocket

**Endpoint:** verus:exchangeCrypto

**Description:** Endpoint returns deeplink that should be used for Verus exchange crypto.

**Request:**

**Response:**

### Verus get user balance

**Method:** websocket

**Endpoint:** verus:getUserBalance

**Description:** Endpoint returns Verus user balance.

**Request:**

**Response:**

### Verus get exchange rate

**Method:** websocket

**Endpoint:** verus:getExchangeRate

**Description:** Endpoint returns exchange rate + fees for Verus.

**Request:**

**Response:**

### Verus get exchange rates

**Method:** websocket

**Endpoint:** verus:getExchangeRates

**Description:** Endpoint returns exchange rates + fees for Verus.

**Request:**

**Response:**

### Get verus coin price

**Method:** websocket

**Endpoint:** verus:getVerusCoinPrice

**Request:**

**Response:**

### Verus get transaction status history

**Method:** websocket

**Endpoint:** verus:getTransactionStatusHistory

**Description:** Endpoint returns status history for a Verus transaction.

**Request:**

**Response:**

### Verus list transaction status history

**Method:** websocket

**Endpoint:** verus:listTransactionStatusHistory

**Description:** Endpoint returns status history for Verus transactions.

**Request:**

**Response:**

### Verus create verifiable statement message

**Method:** websocket

**Endpoint:** verus:createVerifiableMessage

**DEPRECATED**

**Request:**

**Response:**

### Verus create statement claim

**Method:** websocket

**Endpoint:** verus:createStatementClaim

**Description:** Endpoint creates statement claim that could be verified by other users using Verus identity.

**Request:**

**Response:**

### Verus create verifiable social account

**Method:** websocket

**Endpoint:** verus:createVerifiableSocialAccount

**DEPRECATED**

**Request:**

**Response:**

### Verus create social account claim

**Method:** websocket

**Endpoint:** verus:createSocialAccountClaim

**Description:** Endpoint creates claim that represents social account and could be verified by user using Verus identity.

**Request:**

**Response:**

### Verus create verifiable skill message

**Method:** websocket

**Endpoint:** verus:createVerifiableSkillMessage

**DEPRECATED**

**Request:**

**Response:**

### Verus create skill claim

**Method:** websocket

**Endpoint:** verus:createSkillClaim

**Description:** Endpoint creates claim that represent some skill and could be verified by other users using Verus identity.

**Request:**

**Response:**

### Verus create verifiable work experience message

**Method:** websocket

**Endpoint:** verus:createVerifiableWorkExperienceMessage

**DEPRECATED**

**Request:**

**Response:**

### Verus create work experience claim

**Method:** websocket

**Endpoint:** verus:createWorkExperienceClaim

**Description:** Endpoint creates claim that represent work experience and could be verified by other users using Verus identity.

**Request:**

**Response:**

### Verus create verifiable education message

**Method:** websocket

**Endpoint:** verus:createVerifiableEducationMessage

**DEPRECATED**

**Request:**

**Response:**

### Verus create education claim

**Method:** websocket

**Endpoint:** verus:createEducationClaim

**Description:** Endpoint creates claim that represent education and could be verified by other users using Verus identity.

**Request:**

**Response:**

### Verus create verifiable achievement message

**Method:** websocket

**Endpoint:** verus:createVerifiableAchievementMessage

**DEPRECATED**

**Request:**

**Response:**

### Verus create achievement claim

**Method:** websocket

**Endpoint:** verus:createAchievementClaim

**Description:** Endpoint creates claim that represent achievement and could be verified by other users using Verus identity.

**Request:**

**Response:**

### Verus delete verifiable message

**Method:** websocket

**Endpoint:** verus:deleteVerifiableMessage

**DEPRECATED**

**Request:**

**Response:**

### Verus delete target attestation claim

**Method:** websocket

**Endpoint:** verus:deleteTargetAttestationClaim

**Description:** deletes any claim for admins

**Request:**

**Response:**

### Verus delete attestation claim

**Method:** websocket

**Endpoint:** verus:deleteAttestationClaim

**Description:** Endpoint deletes Verus verifiable claim.

**Request:**

**Response:**

### Verus update verifiable work experience message

**Method:** websocket

**Endpoint:** verus:updateVerifiableWorkExperienceMessage

**DEPRECATED**

**Request:**

**Response:**

### Verus update work experience claim

**Method:** websocket

**Endpoint:** verus:updateWorkExperienceClaim

**Description:** Endpoint updates claim that represent work experience and could be verified by other users using Verus identity.

**Request:**

**Response:**

### Verus update verifiable education message

**Method:** websocket

**Endpoint:** verus:updateVerifiableEducationMessage

**DEPRECATED**

**Request:**

**Response:**

### Verus update education claim

**Method:** websocket

**Endpoint:** verus:updateEducationClaim

**Description:** Endpoint updates claim that represent education and could be verified by other users using Verus identity.

**Request:**

**Response:**

### Verus update verifiable achievement message

**Method:** websocket

**Endpoint:** verus:updateVerifiableAchievementMessage

**DEPRECATED**

**Request:**

**Response:**

### Verus update achievement claim

**Method:** websocket

**Endpoint:** verus:updateAchievementClaim

**Description:** Endpoint updates claim that represent achievement and could be verified by other users using Verus identity.

**Request:**

**Response:**

### Verus list verifiable statement messages

**Method:** websocket

**Endpoint:** verus:listVerifiableMessages

**DEPRECATED**

**Request:**

**Response:**

### Verus list attestation claims

**Method:** websocket

**Endpoint:** verus:listAttestationClaims

**Description:** Endpoint returns all statement claims for user.

**Request:**

**Response:**

### Verus list statement claims

**Method:** websocket

**Endpoint:** verus:listStatementClaims

**Description:** Endpoint returns all statement claims for user.

**Request:**

**Response:**

### Verus list verifiable skill messages

**Method:** websocket

**Endpoint:** verus:listVerifiableSkillMessages

**DEPRECATED**

**Request:**

**Response:**

### Verus list skill claims

**Method:** websocket

**Endpoint:** verus:listSkillClaims

**Description:** Endpoint returns all skill claims for user. Actual skillTag could be found by path.

**Request:**

**Response:**

### Verus list verifiable work experience messages

**Method:** websocket

**Endpoint:** verus:listVerifiableWorkExperienceMessages

**DEPRECATED**

**Request:**

**Response:**

### Verus list work experience claims

**Method:** websocket

**Endpoint:** verus:listWorkExperienceClaims

**Description:** Endpoint returns all work experience claims for user.

**Request:**

**Response:**

### Verus list verifiable education messages

**Method:** websocket

**Endpoint:** verus:listVerifiableEducationMessages

**DEPRECATED**

**Request:**

**Response:**

### Verus list education claims

**Method:** websocket

**Endpoint:** verus:listEducationClaims

**Description:** Endpoint returns all education claims for user.

**Request:**

**Response:**

### Verus list verifiable achievement messages

**Method:** websocket

**Endpoint:** verus:listVerifiableAchievementMessages

**DEPRECATED**

**Request:**

**Response:**

### Verus list achievement claims

**Method:** websocket

**Endpoint:** verus:listAchievementClaims

**Description:** Endpoint returns all achievement claims for user.

**Request:**

**Response:**

### Verus search skill tags

**Method:** websocket

**Endpoint:** verus:searchSkillTags

**Description:** Endpoint searches for tags that were previously used for verifiable skill messages generation.

**Request:**

**Response:**

### Verus list verifiable message signatures

**Method:** websocket

**Endpoint:** verus:listVerifiableMessageSignatures

**DEPRECATED**

**Request:**

**Response:**

### Verus list attestation claim signatures

**Method:** websocket

**Endpoint:** verus:listAttestationClaimSignatures

**Description:** Endpoint returns all Verus signatures for attestation claim.

**Request:**

**Response:**

### Verus list user endorsements

**Method:** websocket

**Endpoint:** verus:listUserEndorsements

**Description:** Endpoint returns all the endorsements of the calling user.

**Request:**

**Response:**

### Verus list user endorsements with claims

**Method:** websocket

**Endpoint:** verus:listUserEndorsementsWithClaims

**Description:** Endpoint returns all the endorsements with claims of the calling user.

**Request:**

**Response:**

### Verus get deeplink to verify message

**Method:** websocket

**Endpoint:** verus:getDeeplinkToVerifyMessage

**DEPRECATED**

**Request:**

**Response:**

### Verus get deeplink to verify attestation claim

**Method:** websocket

**Endpoint:** verus:getDeeplinkToVerifyAttestationClaim

**Description:** Endpoint returns deeplink to user in order to verify attestation claim using Verus.

**Request:**

**Response:**

### Verus list verifiable social accounts

**Method:** websocket

**Endpoint:** verus:listVerifiableSocialAccounts

**DEPRECATED**

**Request:**

**Response:**

### Verus list social accounts claims

**Method:** websocket

**Endpoint:** verus:listSocialAccountsClaims

**Description:** Endpoint returns all Verus verifiable social accounts for user.

**Request:**

**Response:**

### Verus provide proof to verify social account

**Method:** websocket

**Endpoint:** verus:provideProofToVerifySocialAccount

**Description:** Endpoint uses link to post in social network in order to verify that user actually controls provided account.

**Request:**

**Response:**

### Verus get deeplink to save claims

**Method:** websocket

**Endpoint:** verus:getDeeplinkToSaveClaims

**Description:** Endpoint returns deeplink to user in order to save attestation claims to Verus.

**Request:**

**Response:**

### Verus get deeplink to sign credential

**Method:** websocket

**Endpoint:** verus:getDeeplinkToSignCredential

**Description:** Endpoint returns deeplink to user in order to save attestation claims to Verus.

**Request:**

**Response:**

### Verus get deeplink to sign credentials

**Method:** websocket

**Endpoint:** verus:getDeeplinkToSignCredentials

**Description:** Endpoint returns a single deeplink for signing multiple credentials at once.

**Request:**

**Response:**

### Verus get deeplink to create endorsement

**Method:** websocket

**Endpoint:** verus:getDeeplinkToCreateEndorsement

**Description:** Endpoint returns deeplink to user in order to create and sign endorsement for attestation claim.

**Request:**

**Response:**

### Verus save endorsements to blockchain

**Method:** websocket

**Endpoint:** verus:saveEndorsementsToBlockchain

**Description:** Endpoint saves endorsements to Verus blockchain.

**Request:**

**Response:**

### Verus get endorsement hash

**Method:** websocket

**Endpoint:** verus:getEndorsementHash

**DEPRECATED**

**Request:**

**Response:**

### Verus get endorsement verify link

**Method:** websocket

**Endpoint:** verus:getEndorsementVerifyLink

**Request:**

**Response:**

### Verus create credential template

**Method:** websocket

**Endpoint:** verus:createCredentialTemplate

**Request:**

**Response:**

### Verus delete credential template

**Method:** websocket

**Endpoint:** verus:deleteCredentialTemplate

**Request:**

**Response:**

### Verus list credential templates

**Method:** websocket

**Endpoint:** verus:listCredentialTemplates

**Request:**

**Response:**

### Verus grant credential

**Method:** websocket

**Endpoint:** verus:grantCredential

**Request:**

**Response:**

### Verus list credentials

**Method:** websocket

**Endpoint:** verus:listCredentials

**Request:**

**Response:**

### Verus revoke credential

**Method:** websocket

**Endpoint:** verus:revokeCredential

**Request:**

**Response:**

### Verus synchronize claims and endorsements

**Method:** websocket

**Endpoint:** verus:synchronizeClaimsAndEndorsements

**Description:** Endpoint synchronizes claims and endorsements with Verus blockchain.

**Request:**

**Response:**

### Verus get deeplink for attestation proofs from wallet

**Method:** websocket

**Endpoint:** verus:getDeeplinkForAttestationProofsFromWallet

**Description:** Endpoint returns deeplink to user in order to retrieve attestation proofs using Verus.

**Request:**

**Response:**

### Verus get deeplink for attestation values from wallet

**Method:** websocket

**Endpoint:** verus:getDeeplinkForAttestationValuesFromWallet

**Description:** Endpoint returns deeplink to user in order to retrieve attestation values (by requested keys) using Verus. Result attestation values could be used in order to autofill attestation block form.

**Request:**

**Response:**

### Verus get deeplink for attestation

**Method:** websocket

**Endpoint:** verus:getDeeplinkForAttestation

**DEPRECATED**

**Description:** Endpoint returns deeplink to user in order to retrieve attestation using Verus.

**Request:**

**Response:**

### Verus get deeplink for attestation proofs

**Method:** websocket

**Endpoint:** verus:getDeeplinkForAttestationProofs

**DEPRECATED**

**Description:** Endpoint returns deeplink to user in order to retrieve attestation using Verus.

**Request:**

**Response:**

### Verus get user attestation

**Method:** websocket

**Endpoint:** verus:getUserAttestation

**Description:** Endpoint returns user attestation from database.

**Request:**

**Response:**

### Verus create attestation block

**Method:** websocket

**Endpoint:** verus:createAttestationBlock

**Request:**

**Response:**

### Verus delete attestation block

**Method:** websocket

**Endpoint:** verus:deleteAttestationBlock

**Request:**

**Response:**

### Verus update attestation block

**Method:** websocket

**Endpoint:** verus:updateAttestationBlock

**Request:**

**Response:**

### Verus publish attestation block

**Method:** websocket

**Endpoint:** verus:publishAttestationBlock

**Request:**

**Response:**

### Verus list attestation blocks

**Method:** websocket

**Endpoint:** verus:listAttestationBlocks

**Request:**

**Response:**

### Verus get attestation blocks for user

**Method:** websocket

**Endpoint:** verus:getAttestationBlocksForUser

**DEPRECATED**

**Request:**

**Response:**

### Verus list attestation blocks for user

**Method:** websocket

**Endpoint:** verus:listAttestationBlocksForUser

**Request:**

**Response:**

### Verus set answers for attestation block

**Method:** websocket

**Endpoint:** verus:setAnswersForAttestationBlock

**Description:** Deprecated, sets answers in old way: one claim (claimType: 'attestationBlock') per answer. Use setAnswersForBlock.

**Request:**

**Response:**

### Verus set answers for block

**Method:** websocket

**Endpoint:** verus:setAnswersForBlock

**Description:** creates a claim with answers (claimType: 'block') for the whole attestation block.

**Request:**

**Response:**

### Verus get block vDXF keys by suffix

**Method:** websocket

**Endpoint:** verus:getBlockVDXFKeysBySuffix

**Description:** Endpoint returns available VDXF keys from network attestation blocks by provided suffix.

**Request:**

**Response:**

### Verus create currency identity

**Method:** websocket

**Endpoint:** verus:createCurrencyIdentity

**Request:**

**Response:**

### Verus check currency identity name

**Method:** websocket

**Endpoint:** verus:checkCurrencyIdentityName

**Request:**

**Response:**

### Verus change currency owner

**Method:** websocket

**Endpoint:** verus:changeCurrencyOwner

**Request:**

**Response:**

### Verus mint nFT on currency

**Method:** websocket

**Endpoint:** verus:mintNFTOnCurrency

**Request:**

**Response:**

### Verus list identities from wallet on currency

**Method:** websocket

**Endpoint:** verus:listIdentitiesFromWalletOnCurrency

**Request:**

**Response:**

### Verus get all identities in wallet on currency

**Method:** websocket

**Endpoint:** verus:getAllIdentitiesInWalletOnCurrency

**Request:**

**Response:**

### Verus get provision deeplink

**Method:** websocket

**Endpoint:** verus:getProvisionDeeplink

**Description:** Endpoint returns deeplink that should be used for Verus provision process. After Verus provision is finished, server links new Verus account to user and sends `auth:verusLinkSuccess` or `auth:verusLinkError` event.

**Request:**

**Response:**

### Verus get identity provision status

**Method:** websocket

**Endpoint:** verus:getIdentityProvisionStatus

**Request:**

**Response:**

### Verus check valu light identity name

**Method:** websocket

**Endpoint:** verus:checkValuLightIdentityName

**Description:** Tells whether a name can be provisioned right now through ValuLight. Does not reserve it.

**Request:**

**Response:**

### Verus provision valu light identity

**Method:** websocket

**Endpoint:** verus:provisionValuLightIdentity

**Description:** Queues one identity for ValuLight's hot-wallet-funded provisioning; no action is required in the user's own wallet. Once registered, server links the identity to user and sends `verus:valuLightProvisionStartedEvent` / `verus:valuLightProvisionEndedEvent` events.

**Request:**

**Response:**

### Verus get valu light identity provision status

**Method:** websocket

**Endpoint:** verus:getValuLightIdentityProvisionStatus

**Description:** Returns the progress of the identity the current user last queued via `verus:provisionValuLightIdentity`.

**Request:**

**Response:**

### Verus create identity marketplace sell offer

**Method:** websocket

**Endpoint:** verus:createIdentityMarketplaceSellOffer

**Description:** Endpoint creates/updates an offer from user attestation data that could be sold on identity marketplace.

When creating/updating sell offer, user must increase encryption epoch (targetType: `identitySellOffer`, targetId: `userId:identityKey`).

**Request:**

**Response:**

### Verus delete identity marketplace sell offer

**Method:** websocket

**Endpoint:** verus:deleteIdentityMarketplaceSellOffer

**Request:**

**Response:**

### Verus list identity marketplace sell offers of current user

**Method:** websocket

**Endpoint:** verus:listIdentityMarketplaceSellOffersOfCurrentUser

**Description:** Endpoint returns list of identity marketplace sell offers created by current user.

**Request:**

**Response:**

### Verus list identity marketplace sell offers of target user

**Method:** websocket

**Endpoint:** verus:listIdentityMarketplaceSellOffersOfTargetUser

**Description:** Endpoint returns list of identity marketplace sell offers created by target user.

**Request:**

**Response:**

### Verus create identity marketplace buy offer

**Method:** websocket

**Endpoint:** verus:createIdentityMarketplaceBuyOffer

**Description:** Endpoint creates identity marketplace buy offer for target user's identity sell offer.

When creating buy offer, user must create new encryption epoch. (targetType: `identityBuyOffer`, targetId: `offerId`). Later, this epoch should be used to access purchased identity values.

**Request:**

**Response:**

### Verus delete identity marketplace buy offer

**Method:** websocket

**Endpoint:** verus:deleteIdentityMarketplaceBuyOffer

**Request:**

**Response:**

### Verus list identity marketplace outgoing buy offers

**Method:** websocket

**Endpoint:** verus:listIdentityMarketplaceOutgoingBuyOffers

**Description:** Endpoint returns list of identity marketplace buy offers created by current user.

**Request:**

**Response:**

### Verus list identity marketplace incoming buy offers

**Method:** websocket

**Endpoint:** verus:listIdentityMarketplaceIncomingBuyOffers

**Description:** Endpoint returns list of identity marketplace buy offers addressed to current user.

**Request:**

**Response:**

### Verus get deeplink to pay for identity marketplace buy offer

**Method:** websocket

**Endpoint:** verus:getDeeplinkToPayForIdentityMarketplaceBuyOffer

**Description:** Endpoint returns deeplink to user in order to pay for identity marketplace buy offer using Verus.

**Request:**

**Response:**

### Verus simulate payment for identity marketplace buy offer

**Method:** websocket

**Endpoint:** verus:simulatePaymentForIdentityMarketplaceBuyOffer

**Description:** Endpoint simulates payment for identity marketplace buy offer. DEVELOPERS ONLY.

**Request:**

**Response:**

### Verus accept identity marketplace buy offer

**Method:** websocket

**Endpoint:** verus:acceptIdentityMarketplaceBuyOffer

**Description:** Endpoint accepts identity marketplace buy offer after payment is completed.

When accepting the offer, user must set an additional owner for an encryption epoch for each sold identity value (ownerType: `identityBuyOffer`, ownerId: `offerId`).

**Request:**

**Response:**

### Verus list identity marketplace buy offer values

**Method:** websocket

**Endpoint:** verus:listIdentityMarketplaceBuyOfferValues

**Description:** Endpoint returns list of values for identity marketplace buy offer after payment is completed and offer is accepted.

**Request:**

**Response:**

### Verus list ambassadors

**Method:** websocket

**Endpoint:** verus:listAmbassadors

**Description:** Endpoint returns list of predefined ambassador ids.

**Request:**

**Response:**

### Verus list identities

**Method:** websocket

**Endpoint:** verus:listIdentities

**Request:**

**Response:**

### Verus get identity status

**Method:** websocket

**Endpoint:** verus:getIdentityStatus

**Request:**

**Response:**

### Verus list identity transactions

**Method:** websocket

**Endpoint:** verus:listIdentityTransactions

**Request:**

**Response:**

### Verus list identity balances

**Method:** websocket

**Endpoint:** verus:listIdentityBalances

**Request:**

**Response:**

### Verus get block height

**Method:** websocket

**Endpoint:** verus:getBlockHeight

**Request:**

**Response:**

### Verus get timelock deeplink

**Method:** websocket

**Endpoint:** verus:getTimelockDeeplink

**Description:** Endpoint returns deeplink that should be used for Verus timelock process. After Verus timelock process is finished, server sends `verus:timelockResultEvent`.

**Request:**

**Response:**

### Verus get revoke deeplink

**Method:** websocket

**Endpoint:** verus:getRevokeDeeplink

**Description:** Endpoint returns deeplink that should be used for Verus revocation process. After Verus timelock process is finished, server sends `verus:revokeResultEvent`.

**Request:**

**Response:**

### Verus get revoke identities

**Method:** websocket

**Endpoint:** verus:getRevokeIdentities

**Request:**

**Response:**

### Verus get recovery deeplink

**Method:** websocket

**Endpoint:** verus:getRecoveryDeeplink

**Description:** Endpoint returns deeplink that should be used for Verus recovery process. After Verus timelock process is finished, server sends `verus:recoveryResultEvent`.

**Request:**

**Response:**

### Verus get recovery identities

**Method:** websocket

**Endpoint:** verus:getRecoveryIdentities

**Request:**

**Response:**

### Verus create agent id

**Method:** websocket

**Endpoint:** verus:createAgentId

**Description:** Results are sent asynchronously through `verus:agentIdCreatedEvent` event.

**Request:**

**Response:**

### Verus get agents balance

**Method:** websocket

**Endpoint:** verus:getAgentsBalance

**Description:** Results are sent asynchronously through `verus:agentsBalanceResultEvent` event.

**Request:**

**Response:**

### Verus agent send money

**Method:** websocket

**Endpoint:** verus:agentSendMoney

**Request:**

**Response:**

### On attestation statement claim created event: deprecated

**Event:** verus:verifiableStatementCreated

**DEPRECATED**

**Data:**

### On attestation statement claim created event

**Event:** verus:statementClaimCreated

**Description:** Event is triggered when new statement claim is created for user.

**Data:**

### On attestation social account claim created event: deprecated

**Event:** verus:verifiableSocialAccountCreated

**DEPRECATED**

**Data:**

### On attestation social account claim created event

**Event:** verus:socialAccountClaimCreated

**Description:** Event is triggered when new social account claim is created for user.

**Data:**

### On attestation skill claim created event: deprecated

**Event:** verus:verifiableSkillCreated

**DEPRECATED**

**Data:**

### On attestation skill claim created event

**Event:** verus:skillClaimCreated

**Description:** Event is triggered when new skill claim is created for user.

**Data:**

### On attestation work experience claim created event: deprecated

**Event:** verus:verifiableWorkExperienceCreated

**DEPRECATED**

**Data:**

### On attestation work experience claim created event

**Event:** verus:workExperienceClaimCreated

**Description:** Event is triggered when new work experience claim is created for user.

**Data:**

### On attestation education claim created event: deprecated

**Event:** verus:verifiableEducationCreated

**DEPRECATED**

**Data:**

### On attestation education claim created event

**Event:** verus:educationClaimCreated

**Description:** Event is triggered when new education claim is created for user.

**Data:**

### On attestation achievement claim created event

**Event:** verus:achievementClaimCreated

**Description:** Event is triggered when new achievement claim is created for user.

**Data:**

### On attestation block claim created event

**Event:** verus:attestationBlockClaimCreated

**Description:** Event is triggered when new claims are created for a block-claim.

**Data:**

### On attestation block claims created event

**Event:** verus:attestationBlockClaimsCreated

**Description:** Event is triggered when new claims are created for attestation block.

**Data:**

### On attestation statement claim deleted event: deprecated

**Event:** verus:verifiableStatementDeleted

**DEPRECATED**

**Data:**

### On attestation statement claim deleted event

**Event:** verus:statementClaimDeleted

**Description:** Event is triggered when statement claim is deleted.

**Data:**

### On attestation social account claim deleted event deprecated

**Event:** verus:verifiableSocialAccountDeleted

**DEPRECATED**

**Data:**

### On attestation social account claim deleted event

**Event:** verus:socialAccountClaimDeleted

**Description:** Event is triggered when social account claim is deleted.

**Data:**

### On attestation skill claim deleted event: deprecated

**Event:** verus:verifiableSkillDeleted

**DEPRECATED**

**Data:**

### On attestation skill claim deleted event

**Event:** verus:skillClaimDeleted

**Description:** Event is triggered when skill claim is deleted.

**Data:**

### On attestation work experience claim deleted event: deprecated

**Event:** verus:verifiableWorkExperienceDeleted

**DEPRECATED**

**Data:**

### On attestation work experience claim deleted event

**Event:** verus:workExperienceClaimDeleted

**Description:** Event is triggered when work experience claim is deleted.

**Data:**

### On attestation education claim deleted event: deprecated

**Event:** verus:verifiableEducationDeleted

**DEPRECATED**

**Data:**

### On attestation education claim deleted event

**Event:** verus:educationClaimDeleted

**Description:** Event is triggered when education claim is deleted.

**Data:**

### On attestation achievement claim deleted event

**Event:** verus:achievementClaimDeleted

**Description:** Event is triggered when achievement claim is deleted.

**Data:**

### On attestation block claim deleted event

**Event:** verus:attestationBlockClaimDeleted

**Description:** Event is triggered when attestation block claim is deleted.

**Data:**

### On attestation statement claim updated event: deprecated

**Event:** verus:verifiableStatementUpdated

**DEPRECATED**

**Data:**

### On attestation statement claim updated event

**Event:** verus:statementClaimUpdated

**Description:** Event is triggered when statement claim is updated.

**Data:**

### On attestation social account claim updated event: deprecated

**Event:** verus:verifiableSocialAccountUpdated

**DEPRECATED**

**Data:**

### On attestation social account claim updated event

**Event:** verus:socialAccountClaimUpdated

**Description:** Event is triggered when social account claim is updated.

**Data:**

### On attestation skill claim updated event: deprecated

**Event:** verus:verifiableSkillUpdated

**DEPRECATED**

**Data:**

### On attestation skill claim updated event

**Event:** verus:skillClaimUpdated

**Description:** Event is triggered when skill claim is updated.

**Data:**

### On attestation work experience claim updated event: deprecated

**Event:** verus:verifiableWorkExperienceUpdated

**DEPRECATED**

**Data:**

### On attestation work experience claim updated event

**Event:** verus:workExperienceClaimUpdated

**Description:** Event is triggered when work experience claim is updated.

**Data:**

### On attestation education claim updated event: deprecated

**Event:** verus:verifiableEducationUpdated

**DEPRECATED**

**Data:**

### On attestation education claim updated event

**Event:** verus:educationClaimUpdated

**Description:** Event is triggered when education claim is updated.

**Data:**

### On attestation achievement claim updated event

**Event:** verus:achievementClaimUpdated

**Description:** Event is triggered when achievement claim is updated.

**Data:**

### On attestation block claim updated event

**Event:** verus:blockClaimUpdated

**Description:** Event is triggered when achievement claim is updated.

**Data:**

### On verify social account proof result event: deprecated

**Event:** verus:verifySocialAccountProofResultEvent

**DEPRECATED**

**Data:**

### On verify social account proof result event

**Event:** verus:socialAccountProofResultEvent

**Description:** Event is triggered when social account proof url verification completed (or failed).

**Data:**

### On new signature for attestation statement claim event: deprecated

**Event:** verus:signatureForVerifiableStatementCreated

**DEPRECATED**

**Data:**

### On new signature for attestation statement claim event

**Event:** verus:signatureForStatementClaimCreated

**Description:** Event is triggered when new signature is created for statement claim.

**Data:**

### On new signature for attestation skill claim event: deprecated

**Event:** verus:signatureForVerifiableSkillCreated

**DEPRECATED**

**Data:**

### On new signature for attestation skill claim event

**Event:** verus:signatureForSkillClaimCreated

**Description:** Event is triggered when new signature is created for skill claim.

**Data:**

### On new signature for attestation work experience claim event: deprecated

**Event:** verus:signatureForVerifiableWorkExperienceCreated

**DEPRECATED**

**Data:**

### On new signature for attestation work experience claim event

**Event:** verus:signatureForWorkExperienceClaimCreated

**Description:** Event is triggered when new signature is created for work experience claim.

**Data:**

### On new signature for attestation education claim event: deprecated

**Event:** verus:signatureForVerifiableEducationCreated

**DEPRECATED**

**Data:**

### On new signature for attestation education claim event

**Event:** verus:signatureForEducationClaimCreated

**Description:** Event is triggered when new signature is created for education claim.

**Data:**

### On new signature for attestation achievement claim event

**Event:** verus:signatureForAchievementClaimCreated

**Description:** Event is triggered when new signature is created for achievement claim.

**Data:**

### On new signature for attestation block claim event

**Event:** verus:signatureForBlockClaimCreated

**Description:** Event is triggered when new signature is created for achievement claim.

**Data:**

### On identity marketplace buy offer created event

**Event:** verus:identityMarketplaceBuyOfferCreatedEvent

**Data:**

### On identity marketplace buy offer updated event

**Event:** verus:identityMarketplaceBuyOfferUpdatedEvent

**Data:**

### On identity marketplace buy offer auto accept event

**Event:** verus:identityMarketplaceBuyOfferAutoAcceptEvent

**Description:** Triggered when payment is completed for buy offer with auto accept flag. When target user device receives an event, it should automatically accept an offer and disclose identity listings to a buyer.

**Data:**

### Verus sign disclaimer success event

**Event:** verus:signDisclaimerSuccess

**Description:** Event is emitted after Verus sign disclaimer have been completed and crypto server verifies challengeId.

**Data:**

### Verus sign disclaimer error event

**Event:** verus:signDisclaimerError

**Description:** Event is emitted in case if Verus sign disclaimer fails or challengeId verification fails.

**Data:**

### Verus purchase content success event

**Event:** verus:purchaseContentSuccess

**Description:** Event is emitted after Verus purchase content have been completed and crypto server verifies challengeId.

**Data:**

### Verus purchase content error event

**Event:** verus:purchaseContentError

**Description:** Event is emitted in case if Verus purchase content fails or challengeId verification fails.

**Data:**

### Verus album created event

**Event:** verus:albumCreated

**Description:** Event is emitted when album is created.

**Data:**

### Verus album create error event

**Event:** verus:albumCreateError

**Description:** Event is emitted when album create is failed.

**Data:**

### Verus album purchased event

**Event:** verus:albumPurchased

**Description:** Event is emitted when album is purchased.

**Data:**

### Verus album purchase error event

**Event:** verus:albumPurchaseError

**Description:** Event is emitted when album purchase is failed.

**Data:**

### Create room subscription with Verus

**Event:** verus:createRoomSubscription

**Description:** Event provides deeplink that should be used for Verus payment. After Verus payment is finished, server sends `verus:createRoomSubscriptionSuccess` or `verus:createRoomSubscriptionError` event.

**Data:**

### Verus create room subscription success event

**Event:** verus:createRoomSubscriptionSuccess

**Description:** Event is emitted after Verus payment have been completed and crypto server verifies challengeId.

**Data:**

### Verus create room subscription error event

**Event:** verus:createRoomSubscriptionError

**Description:** Event is emitted in case if Verus payment fails or challengeId verification fails.

**Data:**

### Verus transaction status updated event

**Event:** verus:transactionStatusUpdated

**Description:** Event is emitted when Verus transaction status updated.

**Data:**

### Verus link persona account result event

**Event:** verus:linkPersonaAccountResultEvent

**Description:** Event is emitted after Verus persona account linking have been completed (or failed).

**Data:**

### Verus get scoped root key result event

**Event:** verus:getScopedRootKeyResultEvent

**Description:** Event is emitted after Verus get scoped root key process have been completed (or failed).

**Data:**

### On verus verify message result event: deprecated

**Event:** verus:verifyMessageResultEvent

**DEPRECATED**

**Data:**

### Verus verify attestation claim result event

**Event:** verus:verifyAttestationClaimResultEvent

**Description:** Event is emitted after Verus attestation claim verification have been completed (or failed).

**Data:**

### On verus verify social account result event: deprecated

**Event:** verus:verifySocialAccountResultEvent

**DEPRECATED**

**Data:**

### Verus verify social account result event

**Event:** verus:verifySocialAccountClaimResultEvent

**Description:** Event is emitted after Verus social account message verification have been completed (or failed).

**Data:**

### Verus save claims result event

**Event:** verus:saveClaimsResultEvent

**Description:** Event is emitted after Verus save claims have been completed (or failed).

**Data:**

### Verus create endorsement result event

**Event:** verus:createEndorsementResultEvent

**Description:** Event is emitted after Verus create endorsement challenge have been completed (or failed).

**Data:**

### Verus save endorsement result event

**Event:** verus:saveEndorsementResultEvent

**Description:** Event is emitted after endorsement have been saved to blockchain (or failed).

**Data:**

### Verus get attestation result event

**Event:** verus:getAttestationResultEvent

**Description:** Event is emitted after Verus attestation retrieval have been completed (or failed).

**Data:**

### Verus get attestation proofs result event

**Event:** verus:getAttestationProofsResultEvent

**Description:** Event is emitted after Verus attestation proofs retrieval have been completed (or failed).

**Data:**

### Verus get attestation values result event

**Event:** verus:getAttestationValuesResultEvent

**Description:** Event is emitted after Verus attestation values (by requested keys) retrieval have been completed (or failed).

**Data:**

### On verus transfer identity event

**Event:** verus:transferIdentityEvent

**Data:**

### On verus nft minted event

**Event:** verus:nftMintedEvent

**Data:**

### On verus payment ready event

**Event:** verus:paymentReadyEvent

**Data:**

### On verus currency ready event

**Event:** verus:currencyReadyEvent

**Data:**

### On provision started event

**Event:** verus:provisionStartedEvent

**Data:**

### On provision ended event

**Event:** verus:provisionEndedEvent

**Data:**

### On valu light provision started event

**Event:** verus:valuLightProvisionStartedEvent

**Data:**

### On valu light provision ended event

**Event:** verus:valuLightProvisionEndedEvent

**Data:**

### On timelock result event

**Event:** verus:timelockResultEvent

**Data:**

### On revoke result event

**Event:** verus:revokeResultEvent

**Data:**

### On recovery result event

**Event:** verus:recoveryResultEvent

**Data:**

### On verus agent id created event

**Event:** verus:agentIdCreatedEvent

**Data:**

### On verus agent balances event

**Event:** verus:agentBalancesEvent

**Data:**
