Skip to main content

Documentation Index

Fetch the complete documentation index at: https://clearlayer.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Register a wallet

POST /v1/wallets Registers an Ethereum wallet address and links it to an existing investor. The wallet’s screening status and risk level are evaluated by the decision engine when checking compliance against a policy.
All requests to this endpoint require a valid API key in the Authorization header.

Request body

address
string
required
The Ethereum wallet address to register (e.g. "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045").
investor_id
string
required
The ID of the investor to link this wallet to. The investor must already exist. Returns 404 if not found.
screening_status
string
required
The wallet’s screening result. Must be "verified", "pending", or "blocked".
risk_level
string
required
The assessed risk level of the wallet. Must be "low", "medium", or "high".

Response fields

id
string
Unique wallet ID. Format: wal_...
address
string
The registered Ethereum wallet address.
investor_id
string
The ID of the linked investor.
screening_status
string
"verified", "pending", or "blocked".
risk_level
string
"low", "medium", or "high".
created_at
string
ISO 8601 timestamp of when the wallet was created.

Example

curl -X POST https://clearlayer-api-production.up.railway.app/v1/wallets \
  -H "Authorization: Bearer cl_test_key_1234567890" \
  -H "Content-Type: application/json" \
  -d '{
    "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "investor_id": "inv_a1b2c3d4e5f6",
    "screening_status": "verified",
    "risk_level": "low"
  }'

201 — Created

{
  "id": "wal_g7h8i9j0k1l2",
  "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "investor_id": "inv_a1b2c3d4e5f6",
  "screening_status": "verified",
  "risk_level": "low",
  "created_at": "2024-01-15T10:31:00.000Z"
}

404 — Investor not found

Returned when the investor_id does not match any existing investor.
{
  "error": "not_found",
  "message": "investor inv_notexist not found",
  "docs": "/investors"
}