Overview
The Connect API enables third-party marketplaces to access LootRush user data through an OAuth-style consent flow. Users explicitly grant permission for your application to access their profile, email, wallet, and KYC information.Prerequisites
Before implementing the Connect API, you must register your integration with LootRush:- Contact LootRush at [email protected] to request integration access
- Provide your redirect URI(s) - The URL(s) where users will be redirected after granting consent
- Specify required scopes - The data access permissions your integration needs
- Integration ID - Your unique integration identifier
- API Key - For authenticating API requests
Integration Flow
Step 1: Redirect User to Consent Page
Redirect the user to the LootRush Connect page:Step 2: User Grants Consent
The user reviews the requested permissions and clicks “Allow” to grant access. Only business admins can grant consent on behalf of their organization.Step 3: Receive Consent ID
After consent, the user is redirected to your preconfigured redirect URI with the consent ID:Step 4: Fetch User Data
Use the consent ID to retrieve the user’s data via the API.Authentication
All API requests must include your API key in thex-api-key header:
Scopes
The following scopes can be configured for your integration:Scopes are configured by LootRush during integration registration. Contact [email protected] to modify your integration’s allowed scopes.
Get User Data
Retrieves the user data for a given consent.Path Parameters
Example Request
Response
string
The consent identifier
string
Your integration identifier
string
ISO 8601 timestamp of when consent was granted
array
List of granted scopes
object
User data object containing the following fields based on granted scopes:
object
object
object
object
KYC information (requires
kyc scope):
string
Verified email from KYC
string
Account type: “individual” or “business”
string
Legal first name
string
Legal last name
string
Business legal name (null for individuals)
string
ID document type (e.g., “PASSPORT”)
string
ID document number
string
Tax identification number
Example Response
Error Responses
Example Error Response
Consent Revocation
Users can revoke consent at any time from their LootRush account settings. When a consent is revoked:- API requests with that consent ID will return
410 Gone - Your application should handle this gracefully and prompt the user to reconnect
Best Practices
- Store the consent ID securely: Associate the consent ID with the user in your system for future API calls.
-
Handle revocation: Check for
410responses and provide a way for users to reconnect. - Request only necessary scopes: When registering your integration, only request the scopes you actually need to build trust with users.
- Cache responsibly: User data can change. Consider refreshing data periodically rather than caching indefinitely.
Support
For API support, please contact:- Email: [email protected]
- Dashboard: LootRush Dashboard