Traders
Search your customer directory without importing it. Selecting a suggestion retrieves its exact profile and activity for the interview.
https://risk.example-firm.com/rubi/v1 with no trailing slash. GET /traders is then requested as https://risk.example-firm.com/rubi/v1/traders.Shared rules for authentication, pagination, errors and the live check are on the Own tech overview.
Every call, including GET /health, sends Authorization: Bearer <api key> and Accept: application/json. The key is the secret you paste in the dashboard. Rubi never sends a body: every endpoint is GET.
GET/traders
Returns { data, next_cursor }
Provider-side search. Rubi sends at least two characters and limit=8. Suggestions remain ephemeral until the user selects one.
| Query | Required | Rules |
|---|---|---|
search | yes | At least 2 characters. Match name, email or customer ID, case-insensitively where applicable. CI is searchable only if exposed and indexed by your API. |
cursor | no | The next_cursor from the previous page. Ignore it when absent. |
limit | no | 1 to 500. Rubi requests 8 suggestions by default. Return at most the requested limit. |
Each object in data:
| Field | Type | Description |
|---|---|---|
id | string | Required, stable, unique. Numbers are accepted and stored as strings. Also used for GET /traders/{id}. |
updated_at | timestamp | Required. RFC 3339 UTC. Identifies the profile update time. |
email | string | null | Used to match an interview created with the same email. |
first_name, last_name | string | null | Preferred name fields. |
full_name | string | null | Accepted instead of first and last name. Rubi splits on the first space. |
country | string | null | ISO 3166-1 alpha-2, for example GB. |
phone | string | null | E.164 when you have it. |
registered_at | timestamp | null | When the trader opened an account with you. created_at is accepted as an alias. |
kyc_status | enum | null | One of not_started, pending, verified, failed. |
tags | string[] | Free labels. Omit or send an empty array when you have none. |
ci, customer_id, customer_nr | string | null | Optional searchable identifiers. Return them at top level or in metadata when your API indexes them. |
metadata | object | null | Stored on the selected trader. Do not put secrets here. |
{
"data": [
{
"id": "cus_18422",
"email": "jane@example.com",
"first_name": "Jane",
"last_name": "Doe",
"country": "GB",
"phone": "+447700900123",
"registered_at": "2026-03-02T09:12:44Z",
"kyc_status": "verified",
"tags": ["vip"],
"metadata": { "plan": "funded" },
"updated_at": "2026-09-20T08:00:00Z"
}
],
"next_cursor": "eyJpZCI6ImN1c18xODQyMiJ9"
}curl "https://risk.example-firm.com/rubi/v1/traders?search=Jane&limit=8" \
-H "Authorization: Bearer $PROVIDER_KEY" \
-H "Accept: application/json"GET/traders/{id}
Returns Trader
One trader, the same object as a list item, without the data envelope. Answer 404 with the error body when the id is unknown. Rubi uses this endpoint when a user selects a suggestion. It is required, and the returned id must exactly match the requested id.
{ "error": { "code": "not_found", "message": "Unknown trader cus_18422" } }Enforce search on the provider#
Each whitespace-separated term must match the returned name, email, ID or exposed identifier, ignoring case. Do not ignore search or require Rubi to download your directory to filter it locally. If search is unsupported, return an error. For connection validation only, authenticated GET /traders?limit=1 may omit search and must return at most one unsaved diagnostic profile. An empty data array is a valid search result. A request without a bearer token must return 401 or 403.