👋Welcome to Vault API

Vault API provides a comprehensive suite of tools for managing financial operations, including user management, wallet operations, card services, and payment integrations. Whether you need currency exchange, card management, or payment system integration, Vault API offers all the essential features for efficient financial management.

🚀 Get Started with Vault API

1. Register: Start by registering to gain access to all API features. Complete the required information to create an account and activate access.

2. Obtain access_token: Retrieve your unique API key for secure access. After registration, you'll receive an access_token needed for API authentication.

3. Explore our documentation: Dive into the detailed documentation to understand API integration. It includes information on endpoints, parameters, and example requests.

🌟 Key Features of Vault API

🔐 User Management

Manage user accounts and their associated data with ease.

• Create and Update Users
  • Create a new user - Register a new user in the system.
  • Retrieve user information - Access detailed information about a user.
  • Update user information with PII - Modify user details, including personally identifiable information.
  • List all user groups - View all user groups within the system.
  • Get user limits - Check the limits imposed on a user account.

🏠 Physical Address

Handle user addresses and manage residential address details.

• Manage Addresses
  • List all addresses - Retrieve all stored addresses for users.
  • Create a new address - Add a new address to the user's profile.
  • Delete an address - Remove an existing address.
  • Update an address - Modify details of an existing address.
  • Set an address as primary residential - Designate an address as the primary residential address.

🔑 Two Factor Authentication

Enhance security through two-factor authentication methods.

• Manage Two-Factor Authentication
  • Create a two-factor authenticator - Set up a new two-factor authentication method.
  • List two-factor authentications - View all two-factor authentication setups.
  • Create a challenge for two-factor authenticator - Initiate a challenge for verification purposes.

🔒 Authentication

Handle authentication processes and secure access.

• Authentication Procedures
  • Send a one-time password - Dispatch a one-time password for secure login.
  • OAuth2.0 endpoint - Access the OAuth2.0 authentication endpoint for token generation.

🖥️ Sessions

Monitor and manage user sessions.

• Manage Sessions
  • Get all active sessions - Retrieve a list of all currently active sessions.
  • Logout from sessions - End all active sessions for a user.
  • Delete a session - Remove a specific session from the system.

🔑 Password

Facilitate password reset operations.

• Reset Password
  • Reset password, phase 1 - Initiate the first phase of the password reset process.
  • Reset password, phase 2 - Complete the second phase of the password reset process.

📜 User Terms and Conditions

Manage and retrieve terms of service agreements.

• User Terms and Conditions
  • Retrieve latest terms and conditions - Fetch the most recent terms of service.
  • Sign terms and conditions - Agree to and sign the terms of service.

📈 Verification

Handle user verification processes and document management.

• Verification Procedures
  • Retrieve verification status - Check the current verification status of a user.
  • Create verification - Initiate a new verification process.
  • Retrieve verification by UUID - Access verification details using a UUID.
  • Upload document for verification by UUID - Upload supporting documents for verification.
  • Delete document by UUID - Remove a document from verification.
  • Retrieve document by UUID - Access a specific document using a UUID.
  • Update verification status to Pending - Change the verification status to 'Pending'.

💸 Discounts

Manage and apply discount offers.

• Discount Management
  • List discounts - View available discount offers.
  • Redeem discount - Apply a discount to a purchase.
  • Revoke discount - Cancel or revoke an applied discount.

📧 Email

Handle user email addresses and verification.

• Email Management
  • List all emails - Retrieve a list of all associated email addresses.
  • Create email - Add a new email address to the user profile.
  • Update primary email - Set a new primary email address.
  • Delete email - Remove an email address from the user profile.
  • Create confirmation code for email - Generate a confirmation code for email verification.
  • Confirm email with code - Verify an email address using a confirmation code.
  • Set email primary - Designate an email as the primary address.

📞 Phone

Manage user phone numbers and verification.

• Phone Management
  • Create user phone - Add a phone number to the user profile.
  • Update user phone - Modify an existing phone number.
  • Confirm phone - Verify a phone number.
  • Request phone code - Request a code for phone verification.

🏢 Business

Manage business and company-related information.

• Business Information Management
  • Retrieve company info - Access details about a company.
  • Update company info - Modify company information.
  • Create individual for company info - Add an individual representative to the company.
  • Delete individual info - Remove an individual representative's details.
  • Update individual info - Update details for an individual representative.
  • Retrieve company info individuals - Get a list of individual representatives for a company.

🧾 Subscription Operations

Manage subscription plans and details.

• Subscription Management
  • Get subscription details - Retrieve information about a specific subscription.
  • Create new subscription - Initiate a new subscription plan.
  • Get available subscription details - View details of available subscription plans.
  • Subscription webhook handler - Manage subscription-related webhook events.
  • Cancel subscription - Terminate an existing subscription.
  • Update subscription details - Modify subscription plan details.

💬 Partnership and Collaboration

Our team is ready to explore various collaboration options and offer you favorable conditions for a mutually beneficial partnership.

If you are interested in partnership opportunities, we are always open for discussions and collaboration. Feel free to reach out to us at 💙 [email protected].