Skip to main content
GET
Get investor information
Retrieves an investor profile, KYC/compliance state, and investments for one token. The response is not a whitelist lookup; use Get Whitelist Status for the on-chain whitelist.

Query Parameters

  • tokenSymbol (required): Token symbol
  • email (required): Investor email

Example

Response

complianceStatus is one of NOT_REQUIRED, NOT_STARTED, PENDING, APPROVED, REJECTED, or ON_HOLD and is derived from needKyc, kycStatus, and kycResult.

Authorizations

x-api-key
string
header
required

Query Parameters

tokenSymbol
string
required

The symbol of the token.

email
string
required

The email address of the investor.

Response

200 - application/json

Successful response

email
string<email>

User's email address.

Example:

"investor@example.com"

firstName
string

User's first name.

Example:

"John"

lastName
string

User's last name (derived from firstSurname).

Example:

"Doe"

kycUrl
string<url>

URL related to the user's KYC status/process.

Example:

"https://kyc.example.com/user/123"

profilePicture
string<url>

URL or identifier for the user's profile picture.

Example:

"https://images.example.com/profiles/john_doe.jpg"

walletAddress
string

User's associated wallet address.

Example:

"0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B"

type
string

Type classification of the user.

Example:

"INVESTOR_INDIVIDUAL"

needKyc
boolean

Whether this user must complete KYC.

kycStatus
string | null

Raw KYC workflow status.

kycResult
string | null

Raw KYC decision result.

complianceStatus
enum<string>

Normalized compliance state derived from the KYC requirement, status, and result.

Available options:
NOT_REQUIRED,
NOT_STARTED,
PENDING,
APPROVED,
REJECTED,
ON_HOLD
investments
object[]

An array containing the user's investment details.