Skip to main content
GET
/
api
/
kyc
/
status
curl --request GET \
  --url 'https://api.starkfi.io/api/kyc/status?email=user@example.com' \
  --header 'x-api-key: <api_key>'

{
  "statusCode": 200,
  "success": true,
  "status": "kyc_status_retrieved",
  "message": "KYC status retrieved",
  "data": {
    "status": "pending",
    "approved": false,
    "session_id": "string",
    "session_status": "string",
    "session_url": "https://...",
    "ip_info": [],
    "is_blocklisted": false
  }
}

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
Email associated with the KYC session. Must match the address used in prepare and session creation.
curl --request GET \
  --url 'https://api.starkfi.io/api/kyc/status?email=user@example.com' \
  --header 'x-api-key: <api_key>'

{
  "statusCode": 200,
  "success": true,
  "status": "kyc_status_retrieved",
  "message": "KYC status retrieved",
  "data": {
    "status": "pending",
    "approved": false,
    "session_id": "string",
    "session_status": "string",
    "session_url": "https://...",
    "ip_info": [],
    "is_blocklisted": false
  }
}

​
Response

​
data.status
string
required
Stored KYC status for the user.
​
data.approved
boolean
required
Whether the user is approved.
​
data.session_id
string
Current Didit session id when available.
​
data.session_status
string
Session status from the provider.
​
data.session_url
string
Hosted verification URL when available.
​
data.ip_info
array
Deduplicated IP / device summaries (country, VPN/Tor, data center flags, etc.).
​
data.is_blocklisted
boolean
true when document or liveness checks include a blocklisted match.