Skip to main content
GET
/
get-investor-info
Get investors information
curl --request GET \
  --url https://api.sandbox.brickken.com/get-investor-info \
  --header 'x-api-key: <api-key>'
{
  "email": "investor@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "kycUrl": "https://kyc.example.com/user/123",
  "profilePicture": "https://images.example.com/profiles/john_doe.jpg",
  "walletAddress": "0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B",
  "type": "INVESTOR_INDIVIDUAL",
  "investments": [
    {
      "id": "b8341970-b99d-4c75-929c-854ab746723e",
      "date": "2024-06-13T08:20:00.656Z",
      "txHash": "0x123abc456def789...",
      "currency": "USDT",
      "amountInUSDT": "100.0",
      "status": "success",
      "tokenSymbol": "ABC",
      "offeringId": "a5232594-3f97-47d0-b362-491caac9388f",
      "offeringName": "Round A"
    }
  ]
}
Retrieves information about a specific investor.

​
Query Parameters

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

​
Example

curl --request GET \
  --url 'https://api.sandbox.brickken.com/get-investor-info?tokenSymbol=EXMPL&email=investor@example.com' \
  --header 'x-api-key: YOUR_API_KEY'

​
Response

{
  "email": "investor@example.com",
  "kycStatus": "approved",
  "whitelistStatus": true
}

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

Succesful 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"

​
investments
object[]

An array containing the user's investment details.