Where to Start

Just got access to Sandbox, Production or the API and want to test IRON fast?

Before diving into our API, we recommend familiarizing yourself with the customer and transaction flow via our Dashboard App. You will manage to go from zero to first transaction in 10 minutes. This will help you better understand how our Autoramp logic works

Step-by-Step Guide via the Dashboard

1. Create a New Customer in the DASHBOARD (left menu tree)

   i. Navigate to the “Customers” section in the dashboard and create a new customer.

   ii. You’ll get an onboarding link to share with the customer for KYC/KYB verification.

   iii. Share the onboarding link and you can

2. Create an Autoramp in the APP (left menu tree)

   i. Once your customer finished his onboarding. Select the Customer Profile From the top-right selector in the APP, choose your customer to manage their profile.

   ii. Whitelist a Wallet: Add and verify the customer’s destination wallet address in My Addresses > Linked wallet

   iii. Whitelist a Bank Account (optional): For fiat off-ramping use cases in My Addresses > Linked Bank Account

   iv. Create an Autoramp Market: Define transaction parameters including source/destination assets and destination wallet. E.g: EUR -> USDC

3. Initiate a Transaction

   i. Ask your customer to send EUR to their vIBAN.

   ii. Monitor the transaction via the “Transactions” section in the APP

   iii. The customer will receive USDC in their external wallet once the transaction settles.\

Reproducing the Flow via the API

Once you’re comfortable with the dashboard experience, you can automate the same flow using our API.

1. API Credentials - here

2. Onboard a customer - here

   i. Create a new customer: https:/.iron.xyz/reference/createcustomer

   ii. Request their signature on the terms https:/.iron.xyz/reference/createcustomersigning

   iii. Verify their identity using https:/.iron.xyz/reference/createcustomeridentification

   a. Direct Iron KYB link method

   b. SumSub token sharing

3. Whitelist a destination address - here

   i. Wallet

   ii. Bank Account for this customer

4. Create an Autoramp for this customer - here

5. Monitor Transactions for this Autoramp - here

Now what?

Onboarding

• Onboard a customer via sumsub token sharing - here

Autoramp type

• Autoramp quote - here
• Other Currencies PayinAutoramp Quote Exact In
• Other Currencies Payout