🇬🇧
Yativo Documentation
Spanish
English
English
  • Yativo
  • Introduction to Yativo
    • Financial Infrastructure
    • About Us
  • Dashboard
  • Business Plans
  • Getting Started with Yativo API
  • Yativo API Glossary
  • API reference
    • Misc.
      • Countries
      • States
      • City
  • Security and Authentication
    • Security
    • Authentication
    • Idempotency in API Requests
  • Environment
    • Environments
  • Notifications
    • Webhook
  • Compliance
    • Verification
      • KYC
      • KYB
      • KYC/KYB Update
      • KYC Status
      • Global Business Search
    • Supported Jurisdiction
    • Supported Countries, Currencies and Payment Method
  • User Management
    • Customer
      • Get Customers
      • Retrieve customer
      • Add Customer
  • Payments
    • Currencies
    • Crypto Wallets
      • Generate Wallet Address
      • Fetch Wallet Address
      • Crypto Deposit History
      • Single crypto deposit history
    • Payout
      • Payout
      • Get Payouts
      • Get Payout
      • Beneficiaries
        • Get Beneficiaries
        • Add Beneficiary Payment Details
        • Update Beneficiary
        • Archive Beneficiary
        • Add Beneficiary
    • Payin
    • Virtual Cards
      • Supported Currency, Country
      • Create card
      • Fetch card
      • Top up card
      • Get Transactions
      • Freeze and Unfreeze Card
    • Virtual Accounts
      • Create VIrtual Accounts
        • USD Virtual Account
        • Mexico Virtual Account
        • Brazil PIX QR
      • Virtual Account Management
      • Transaction History
  • Foreign Exchange
    • Exchange Rate
      • Request Quote
  • Transactions
    • Transaction Summary
    • Get Single Transaction
  • Crypto System
    • Yativo Crypto Platform API
Powered by GitBook
On this page
  1. Crypto System

Customers

Overview

Customers are the end users of your platform. Managing their data allows you to map wallet addresses and transactions to individual users.

Use Case

  • User Onboarding: Register customers when they sign up on your platform.

  • Account Linking: Link customers to sub-accounts for wallet operations.

Endpoints

Create Customer

  • URL: POST /api/v1/customers

  • Description: Adds a new customer to your platform.

  • Implementation Context:

    • Use during onboarding to automatically create a user profile in Yativo.

  • Request Example:

  • {
        "name": "Jane Doe",
        "email": "janedoe@example.com",
        "phone": "+123456789"
    }
  • Response Example:

  • {
        "status": "success",
        "customer_id": "cus789",
        "message": "Customer created successfully."
    }

Fetch All Customers

  • URL: GET /api/v1/customers

  • Description: Retrieve all customers associated with your account.

  • Response Example:

  • [
        {
            "customer_id": "cus123",
            "name": "John Doe",
            "email": "johndoe@example.com"
        }
    ]

Last updated 5 months ago