Docs
  • What We Do
  • Supported Countries, Payment Methods, and Cryptocurrencies
  • Getting Started
  • Integration Guides
    • API
      • Required Headers
      • Create a User
      • Assign a Deposit Address
      • KYC
      • Link and Verify a Bank Account
        • Re-link Bank Account
        • Update Bank Account
        • Delete Bank Account
      • Transaction Limits
      • Buy Crypto (ACH)
      • Transaction Monitoring
      • Transaction History
    • React Native
      • Installation
      • Session Token and Wallet Signing
      • Preset Order Details
      • Example
      • Reference
      • Release History
      • User experience
        • Sign up
        • Sign in
        • Buy crypto
        • Settings & activity
    • React JS (Beta)
      • Installation
      • Session Token and Wallet Signing
      • Preset Orders
      • Callbacks
      • Theming
      • Example
      • Reference
      • Release History
  • API Reference
    • Endpoints
      • Auth
        • Crypto Wallet
        • Email OTP
        • SMS OTP
      • Activity
      • Bank
      • Client
      • Config
      • Crypto
      • Users
      • Wallets
      • Webhook Registrations
    • Custom Headers
    • Error Codes
    • Types Glossary
    • Postman
    • Open API Specification
    • Webhooks
  • Design Reference
    • UI/UX Starter kit
    • UI Requirements
  • Guides
    • Sandbox Testing
    • User Authentication
    • Link a new Signing Wallet to an Existing User
    • Plaid Bank Linking
      • Plaid OAuth Support
    • Client Dashboard (Alpha)
  • User Support Reference
    • User Account Flags
      • KYC Review
      • Transaction Processing
      • NSFs and Returned Payments
      • Fraud
    • Transactional Emails
Powered by GitBook
On this page
  • Important info
  • Base URLs
  • API
  • Resources

Was this helpful?

  1. Integration Guides

API

Reminder, to get started:

  • Obtain a clientID & secret

  • Install the appropriate Plaid SDK

  • Provide us with a redirect URI or Android Package Name to be used alongside Plaid

  • Provide us with anonymized device biometrics in the header of each API call

Please refer to the integrating with Ratio section here for more details

Important info

Our JWTs expire after 5 minutes, and user sessions expire after 10 minutes of inactivity.

When a JWT nears expiry, we will refresh it in the background and provide you a new JWT in the following response header: ratio-authentication-refresh.

If you encounter this header, you should begin using the new JWT.

Base URLs

Production: https://api.ratio.me/

Sandbox: Coming soon

API

We strongly recommend that you follow our API implementation guide in the order it is presented below.

  • Create new user <--Start here

  • Assign user deposit address

  • KYC user

  • Link a bank account

  • Sign in

  • Buy crypto

  • Transaction activity

Resources

  • Authentication methods

  • Custom headers

  • Webhooks

    • Webhook registrations

  • Types Glossary

  • Postman

  • Specification

  • UX/UI starter kit

PreviousGetting StartedNextRequired Headers

Last updated 1 year ago

Was this helpful?