This section contains brief descriptions of the changes included in a product update.

v.3.1.0 - 2025.04.22

• Body and response parameters and elements descriptions for Start subscription endpoint have been updated.

v.3.0.9 - 2025.04.21

• Response parameters and elements descriptions for Get available subscriptions endpoint have been updated.

v.3.0.8 - 2025.04.18

• Response parameters and elements descriptions for Get current subscription endpoint have been updated.

v.3.0.7 - 2025.04.15

• The Subscription Flow section has been updated with detailed descriptions of parameters and endpoints.

v.3.0.6 - 2025.04.14

• Query and response body parameters of the Get address endpoint were updated.
• Get addresses list endpoint was deprecated. Use Get address instead.

v.3.0.5 - 2025.04.11

• The new endpoint Get latest terms and conditions has been added to Registration section. Step 2 of Registration process has been updated respectively.

v.3.0.4 - 2025.04.08

• OAuth2.0 endpoint was deprecated. Use the new one instead.
• Retrieve user info endpoint was deprecated. Use Retrieve user information endpoint instead.

v.3.0.3 - 2025.04.07

• Registration Process was updated with the new "Verify Referral Code" optional step. Now it includes details about how to verify referral code in case the user has got one.
• The body parameters and responses for the Signup new user and Signup confirm endpoints were updated.
• The new Referral Code Validation endpoint was added.

v.3.0.2 - 2025.03.31

• Change password process was updated with new password and email confirmation code requirements.

v.3.0.1 - 2025.03.21

• The Get Account Balance endpoint was deprecated. Use Get total Balance instead.
• The password reset flow has been updated with Password reset, phase 3 step. Phases 1, 2 and Password reset process of the Customer Guide were updated.

This section contains brief descriptions of the changes included in a product update.

v.2.0.16 - 2024.12.17

• Updated: The article on the Registration Process has been updated. Now includes details about the integration of the Terms and Conditions and Sign Terms and Conditions endpoints, which are required for users in the production environment and optional in the sandbox environment.

v.2.0.15 - 2024.12.06

• Updated: The parameters for the Card-holder Service section have been updated. Please note the changes carefully.
• Unchanged: The card ordering flow remains the same.

v.2.0.14 - 2024.11.29

• Updated: The response fields for the Get Subscriptions endpoint have been updated.
• Updated: The body parameters for the Start Subscription endpoint have been updated.
• Updated: The body parameters for the Webhook endpoint have been updated.
• Updated: The response fields for the Cancel Subscription endpoint have been updated.
• Updated: The response fields for the Get Subscription by ID endpoint have been updated.
• New Endpoint: A new endpoint has been added: Update User Verification Data for verification processes.
• Added: Detailed description has been added for the Reset Password Confirmation endpoint.
• Added: Detailed description has been added for the Update Primary Email endpoint.

v.2.0.13 - 2024.11.25

• Article updated: The article for Subscription Operations has been updated and subscription plans have been added.
• New article added: A detailed guide on on-ramp functionality and SDK integration for CHECKOUT payments is now available.

v.2.0.12 - 2024.11.21

• Endpoint removed: The POST /card-holder/invoice/webhook endpoint has been removed as it is a service endpoint.
• Guide updated: The Card Order & Payment Flow guide has been updated.
• Field description added: The description for the secondary_cardname field has been added to the Create Card Request documentation.

v.2.0.11 - 2024.11.19

• Articles added: The articles for the Google Pay Card Setup Guide and the Apple Pay Card Setup Guide have been added.

v.2.0.10 - 2024.11.15

• Video instructions will be added to guides alongside descriptions, making the documentation more interactive and user-friendly. 🎉

v.2.0.9 - 2024.11.14

• Added a new article: Ordering a Visa Card, providing a comprehensive guide for the card ordering process, including step-by-step instructions and API details.

v.2.0.8 - 2024.11.13

• The Acquiring section has been updated with detailed descriptions of parameters and endpoints.

v.2.0.7 - 2024.11.11

• Added the Operations section to the documentation, providing detailed descriptions of available operations.
• Added a new article on Account Funding and Transfers, explaining the processes for account funding and transfers between different account types.

v.2.0.6 - 2024.11.05

• Added the PayIn operations section in Transactions Operations.
• Added a new section for IBAN.
• Added detailed description for IBAN Top-Up process, explaining the usage of exchange and transfer methods for topping up IBAN accounts, along with the role of the BANK_ACCOUNT_VIRTUAL account type in this process.
• Endpoint: Create Account
  • Added detailed description for the accountType parameter, specifying possible values (CHECKING, CARD_PREPAID, BANK_ACCOUNT_VIRTUAL) and their use cases.

v.2.0.5 - 2024.10.29

Update in the Wallet Section:

• The endpoint GET /wallet/v2/address has been removed.
• Required parameters have been highlighted for a clearer understanding of request requirements.

v.2.0.4 - 2024.10.28

• Added the FAQ article.
• Updated the Introduction article.

v.2.0.3 - 2024.10.18

• Registration Flow Update. The registration flow has been modified.

v.2.0.2 - 2024.10.10

• Registration Flow Update. The registration flow has been modified. Now, the initial request must be made without the emailConfirmCode parameter, which triggers the system to send a confirmation code to the user's email. In the second request, the emailConfirmCode parameter must always be set to 12345 to complete the email verification and finalize the account creation process, regardless of the actual code sent to the user.

v.2.0.1 - 2024.10.09

• The Send one time password endpoint is deprecated. Use Multi-Factor Authentication (MFA) instead of the legacy OTP.
• The endpoint POST OAuth2.0 Token Service has been updated with the following parameters:
  • refresh_token (string): The refresh token issued during the initial authentication, used to request a new access token.
  • client_id (string, required, defaults to haequi3Aah8lie2r): The client identifier, same as in the query parameters.
  • client_secret (string): The secret key corresponding to the client, same as in the query parameters.
  • username (string): The username of the user for whom the access token is requested.
  • password (string): The password for the user’s account.
  • twoFactorId (string): The identifier for two-factor authentication, typically issued during the challenge.
  • twoFactorCode (string): The code provided by the user for two-factor authentication.
  • twoFactorChallenge (object): An object that may contain additional data related to two-factor authentication challenges.

This section contains brief descriptions of the changes included in a product update.

v.1.0.48 - 2024.12.28

• KYC Process Updates: Important changes have been made to the KYC process and related documentation.
  • Simplified KYC Requirement Notices: All endpoints now state that completing the KYC process is mandatory.
  • Endpoint Change for SumSub KYC: The endpoint for starting the KYC process via SumSub has been updated from /v4/kyc/start to /v5/kyc/start.
    • URL: https://api.vault.ist/reference/start-sumsub-kyc-flow
  • Switch to SumSub for KYC: All mentions of the KYC process now reflect the transition to SumSub.
  • As of December 23, we are using SumSub for the KYC process.

What You Need to Do

• If you are using the KYC endpoint in your integrations, ensure you update it to the new endpoint (/v5/kyc/start).
• Review the updated documentation for additional details.

v.1.0.47 - 2024.12.06

• A new status SUPPORT has been added to the status endpoint. This status indicates that the client has been permanently blocked from submitting documents due to a final rejection (e.g., suspicion of fraud) or exceeding the allowed number of verifications (5 verifications in production). The client can no longer submit new documents once this status is assigned.

v.1.0.46 - 2024.11.14

• A new article has been added: Sumsub Integration Guide.
• A new endpoint has been introduced: Start Sumsub KYC Flow.
• The article on KYC Procedure has been updated.

v.1.0.45 - 2024.11.13

• A Restriction for KYC_1 Users has been added to the Update Customer Profile endpoint: users with KYC_1 cannot update the fields firstName and lastName.
• The citizenshipCountry parameter has been removed from the Update Customer Profile endpoint.

v.1.0.45 - 2024.11.06

Shipping Address Field and Phone Number Validation Updates

1. Field Length Restrictions:

   • First Name: The maximum length for the first name field has been set to 20 characters.
   • Last Name: The maximum length for the last name field has been set to 20 characters.
   • Postal Code (Index): The maximum length for the postal code has been set to 10 characters.
   • City: The maximum length for the city field has been set to 20 characters.
   • Address 1: The maximum length for Address 1 has been set to 50 characters.

2. Phone Number Validation:

   • The phone number in the shipping address must now match the format of the destination country. This includes the correct country code and follows the local phone number format.

These updates enhance address field validation and help ensure smoother processing of shipping details.

v.1.0.44 - 2024.10.31

• The country list for the Visa Card Program has been updated.

v.1.0.43 - 2024.10.02

• The endpoint POST Retrieve List of All Referral Codes has been added.

v.1.0.42 - 2024.09.10

Updated:

• GET /v2/card/prices
• GET /v2/card/list
• POST /v2/card/card-requests
• POST /v3/card/additional-personal-info
• POST /v2/card/card-requests/{id}/payment-offer/{currency}

Added:

• PUT /v2/card/card-requests/{cardRequestId}/cardholder-name
• GET /v2/card/card-requests/country/plastic-delivery
• PUT /v3/card/card-requests/{cardRequestId}/address
• Article: Plastic Card Preorder

v.1.0.41 - 2024.09.02

• Added regular expressions for validating KYC 0 survey data.

v.1.0.40 - 2024.08.20

• Field Descriptions Added to the 200 Response of the Get Card Operations History.

v.1.0.39 - 2024.08.14

• A list of documents required to complete KYC 1 has been added.
• The endpoint Update Address for Card Request has been updated.

v.1.0.38 - 2024.07.31

• The endpoint Get SMS Code to Show Card Details and the code field in Get Card Details are now optional.

v.1.0.37 - 2024.07.24

• The IBAN Order article has been updated.
• The endpoint POST Set/Reset PIN Code has been added.
• The endpoint POST Add Additional Personal Info for IBAN has been added.
• The endpoint GET Get Constants for Additional Personal Info for IBAN has been added.
• The endpoint Get Additional Personal Info for IBAN has been added.

v.1.0.36 - 2024.07.16

• The IBAN Operations article has been added.

v.1.0.35 - 2024.07.15

• The section Card Payload Management has been updated.
• The endpoint Update Address for Card Request has been updated.

v.1.0.34 - 2024.07.12

• The endpoint Get Card Operations History has been updated.

v.1.0.33 - 2024.07.10

• The FAQ article has been updated.
• The IBAN Order article has been added.

v.1.0.32 - 2024.07.03

• The FAQ article has been updated.
• The section IBAN has been updated.

v.1.0.31 - 01.07.2024

• The endpoint Get Card Operations History has been updated.

v.1.0.30 - 21.06.2024

• The FAQ article has been updated.

v.1.0.29 - 20.06.2024

• The endpoint Get Card Operations History has been updated.
• The article Adding and confirming an email address has been added.

v.1.0.28 - 19.06.2024

• The article Transactional MFA has been added.

v.1.0.27 - 18.06.2024

• The endpoint Send Coins to Another Wallet has been updated.

v.1.0.26 - 04.06.2024

• The endpoint Update Customer Profile has been updated.
• The endpoint Resend Code has been updated.

v.1.0.25 - 03.06.2024

• The endpoint History Transactions has been updated.

v.1.0.24 - 29.05.2024

• The endpoint GET Get Current Customer Profile has been updated.
• Added instructions for completing KYC 2.
• Added instructionsfor completing KYC 3.
• The FAQ article has been updated.
• The Execute offer payment article has been updated.
• New cryptocurrency asset added: USDT_TRON.

v.1.0.23 - 28.05.2024

• Fields were detailed in all responses.
• The instruction on how to obtain the PublicKey .

v.1.0.22 - 22.05.2024

• The list of allowed countries for PayIn has been added.

v.1.0.21 - 21.05.2024

• The FAQ article has been updated.
• The article Ordering a VISA Card has been added.

v.1.0.20 - 20.05.2024

• The FAQ article has been updated.
• An instruction how to obtain the PublicKey has been added.

v.1.0.19 - 17.05.2024

• A new section IBAN has been added.
• The FAQ article has been updated.

v.1.0.18 - 16.05.2024

• The KYC Procedure article has been updated.
• The information at KYC Status has been updated and new statuses have been added.
• The following endpoints have been updated:
  • KYC 1 Start
  • KYC 1 Finish
  • KYC 2
  • KYC 3
  • Pay Card Order Offer
  • Get Card Price for VISA Card Program
  • Create Card Order Offer
  • Additional Personal Info
  • Resend Password
  • Confirm Password Reset
  • Set New Password

v.1.0.17 - 16.04.2024

• A new section VISA Card Program has been added.

v.1.0.16 - 16.04.2024

• The article Parameter placeholders in endpoints has been added.

v.1.0.15 - 15.04.2024

• The article Registration Process has been updated.
• FAQ section was added.

v.1.0.14 - 05.04.2024

Articles added:

• Instruction: Add Card
• Instruction: Add billing address
• Instruction: Create an offer
• Instruction: Execute offer payment
• Instruction: Update existing offer
• Instruction: Add Card PayOut
• Instruction: Create Payout Offer
• Instruction: Execute PayOut Offer
• Instruction: Create Offer Exchange
• Instruction: Execute offer exchange

v.1.0.13 - 03.04.2024

• The article Registration Process has been updated.

v.1.0.12 - 02.04.2024

• The new section History has been added.

v.1.0.11 - 25.03.2024

• The endpoint PATCH Update customer profile has been added.
• The endpoint GET Get Current Customer Profile has been updated.

v.1.0.10 - 22.03.2024

• Refined the Create Wallets endpoint. Updated descriptions in the documentation.

v.1.0.9 - 21.03.2024

• The entire collection of endpoints has been added.

v.1.0.8 - 20.03.2024

• Basic authorization has been removed.
• Updated article Operations and Constraints.

v.1.0.7 - 18.03.2024

Articles added:

• Getting Started with API Vault
• Instruction: Registration of a new user
• Instruction: Confirm phone number
• Instruction: Resend Code
• Instruction: Add Email
• Instruction: SignIn
• Instruction: SignOut
• Instruction: Change password
• Instruction: Resend Password
• Instruction: Confirm password reset
• Instruction: Set new password
• Instruction: Validate send coins request
• Instruction: Get fee
• Instruction: Send coins

v.1.0.6 - 05.03.2024

• The KYC Procedure article has been updated.

v.1.0.5 - 01.03.2024

• Added a new endpoint Get RSA Key.

v.1.0.4 - 13.02.2024

• Features have been added for KYC Card Program 1.
• Refined the Create account endpoint. Updated descriptions in the documentation.
• Refined the Add email endpoint. Updated descriptions in the documentation.
• A new section Account password operations has been added.
• Added a new endpoint Confirm email.
• The process of passing KYC 1 and KYC 2 has been added.

v.1.0.3 - 06.02.2024

• Added a new endpoint Update an offer.
• Added a new endpoint Get available currencies for crypto exchanges.

v.1.0.2 - 01.02.2024

• Added the capability to utilize requests through the Sandbox.

v.1.0.1 - 31.01.2024

• Refined the SignIn endpoint. Updated descriptions in the documentation.
• Added description of Fingerprint.

v.1.0.0 - 29.01.2024

Release of the documentation.