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 an investor

POST /v1/investors Creates a new investor record. The investor’s KYC status, accreditation status, and country are used by the decision engine when evaluating compliance against a policy.
All requests to this endpoint require a valid API key in the Authorization header.

Request body

name
string
required
The investor’s full legal name.
type
string
required
The investor type. Must be "individual" or "entity".
country
string
required
The investor’s country of residence or incorporation as a 2-letter ISO 3166-1 alpha-2 code (e.g. "US", "GB").
kyc_status
string
required
The result of the investor’s KYC check. Must be "verified", "pending", or "failed".
accredited_status
boolean
required
Whether the investor is accredited. Set to true if accreditation has been confirmed.
review_status
string
The manual review state of the investor record. Must be "approved", "pending", or "rejected". Defaults to "pending".

Response fields

id
string
Unique investor ID. Format: inv_...
name
string
The investor’s full name.
type
string
"individual" or "entity".
country
string
2-letter ISO country code.
kyc_status
string
"verified", "pending", or "failed".
accredited_status
boolean
Whether the investor is accredited.
review_status
string
"approved", "pending", or "rejected".
created_at
string
ISO 8601 timestamp of when the investor was created.

Example

curl -X POST https://clearlayer-api-production.up.railway.app/v1/investors \
  -H "Authorization: Bearer cl_test_key_1234567890" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Alice Johnson",
    "type": "individual",
    "country": "US",
    "kyc_status": "verified",
    "accredited_status": true
  }'

201 — Created

{
  "id": "inv_a1b2c3d4e5f6",
  "name": "Alice Johnson",
  "type": "individual",
  "country": "US",
  "kyc_status": "verified",
  "accredited_status": true,
  "review_status": "pending",
  "created_at": "2024-01-15T10:30:00.000Z"
}