Developer docs · API v1

# Bring the traders. We'll bring them back.

Connect trader sign-ups, trading activity and your client portal. We calculate the rewards and run the program with you.

1. 09:41:02 `POST` `/v1/users` `200` `USER_CREATED`
2. 09:41:03 `POST` `/v1/users/update` `200` `USER_UPDATED`
3. 09:41:07 activity batch accepted `batch_id` `2026-09-26-009`
4. 09:41:08 coins, XP and tiers calculated
5. 09:41:30 store purchase by trader `3247779`
6. 09:41:30 purchase webhook sent to your URL
7. 09:42:10 `PUT` `/v1/redemption-transactions/status` `200` `REDEMPTION_TRANSACTION_STATUS_UPDATED`

## Each kind of data takes its own route.

[How it works](https://docs.returning.ai/how-it-works.md)

Your platform

### Traders

[API](https://docs.returning.ai/api-reference/users/create-user.md) or [registration webhook](https://docs.returning.ai/broker-integrations/workflow-webhooks.md)

### Trading activity

[a queue](https://docs.returning.ai/broker-integrations/sqs.md) or [file uploads](https://docs.returning.ai/how-it-works.md#file-ingest)

### Read-only access

[we read your trading platform or warehouse](https://docs.returning.ai/broker-integrations/metatrader.md)

Returning.AI

coins · tiers · rewards

Back to you

### Widgets in your client portal

[Widget SDK for web](https://docs.returning.ai/widget-sdk.md), [mobile SDKs](https://docs.returning.ai/mobile-widget-sdk.md)

Your server requests a short-lived embed token.

### Data back to your systems

[webhooks](https://dev.returning.ai/events/outgoing-webhooks), integrations or [the API](https://docs.returning.ai/api-reference/users/get-user-data.md)

For example: sign-ups by webhook, trades we read from your trading platform, balances back through the API.

Your systems identify traders, send activity and place the widgets. We calculate coins, tiers and rewards, and send the results back.

## From kickoff to live

1. Together

   **Kickoff:** we map your data with your team.
2. Us

   **Setup:** we set up your community and API keys.
3. You

   **Build:** your team connects data and places the widgets.
4. Together

   **Launch checklist:** we test it together.
5. Together

   **Live.**

[Integration guide](https://docs.returning.ai/broker-integrations.md) [Launch checklist](https://docs.returning.ai/broker-integrations/launch-checklist.md)

## What a call looks like

`cURL request`

```bash
curl --request POST \
  --url https://api.returning.ai/v1/users \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
    "firstname": "Sample",
    "lastname": "Trader",
    "username": "sample_trader",
    "displayname": "Sample Trader",
    "email": "trader@example.com",
    "accessLevel": 1,
    "joinServer": true,
    "sendEmail": false,
    "emailPassword": false,
    "externalId": "<brokerCustomerId>"
  }'
```

`200 response body`

```json
{
  "status": "success",
  "code": "USER_CREATED",
  "message": "User created successfully",
  "data": {
    "userId": "3247779",
    "username": "sample_trader",
    "email": "trader@example.com",
    "communityMemberId": "66f000000000000000000001",
    "identifierKey": "customerid",
    "externalId": "<brokerCustomerId>",
    "created": true
  }
}
```

[Create User reference](https://docs.returning.ai/api-reference/users/create-user.md)

## Browse the docs

- [Users and data Traders, custom fields, field history and bulk updates. 25 endpoints](https://docs.returning.ai/api-reference/users/get-user-data.md)
- [Gamification Leaderboards, streaks and mini games, referrals and match predictions. 28 endpoints](https://docs.returning.ai/api-reference/gamification-leaderboards/list-leaderboards.md)
- [Store and rewards Products, categories, redemptions and purchase history. 24 endpoints](https://docs.returning.ai/api-reference/rewards-and-redemptions/list-redemption-orders-by-community.md)
- [Community Members, channels, messaging, appearance and analytics. 19 endpoints](https://docs.returning.ai/api-reference/community-appearance/update-community-theme-colors.md)
- [Widgets The Widget SDK for your web portal and the mobile SDKs for your apps. 18 pages](https://docs.returning.ai/widget-sdk.md)
- [Broker integrations Enrolling traders, workflow webhooks, the SQS feed, trading rewards and MetaTrader. 9 pages](https://docs.returning.ai/broker-integrations/users.md)

## The fine print

- ISO 27001 certified
- 99.97% uptime
- API-key auth
- [Per-community rate limits](https://docs.returning.ai/how-it-works.md#rate-limits)
- Dedicated customer success manager