Skip to main content
POST
/
api
/
kyc
/
prepare
curl --request POST \
  --url https://api.starkfi.io/api/kyc/prepare \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api_key>' \
  --data '{"email":"user@example.com"}'

{
  "statusCode": 201,
  "success": true,
  "status": "user_prepared",
  "message": "User prepared for KYC, please verify your email"
}

Documentation Index

Fetch the complete documentation index at: https://docs.starkfi.io/llms.txt

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

​
x-api-key
string
required
Your StarkFi API key when required by your environment.
​
email
string
required
End user email. Use the same value (lowercase recommended) for OTP and session calls.
curl --request POST \
  --url https://api.starkfi.io/api/kyc/prepare \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api_key>' \
  --data '{"email":"user@example.com"}'

{
  "statusCode": 201,
  "success": true,
  "status": "user_prepared",
  "message": "User prepared for KYC, please verify your email"
}

​
Response

​
data.email_verified
boolean
Present on 200 user_already_prepared — whether email OTP was completed.
​
data.kyc_approved
boolean
Present on 200 — whether KYC is approved.
​
data.kyc_status
string
Present on 200 — stored KYC status for that email.