Get Yield KYC Status
yields_get_kyc_statusGet the normalized KYC status of a wallet address for a yield. Use this before actions_enter on yields that gate deposits behind KYC (e.g. RWAs like Securitize/Superstate). Yields without a KYC requirement return "not_required". When the status is "not_started" or "pending", the response may include an authorizeUrl pointing to the issuer's KYC portal.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"yieldId": "<yieldId>",
"address": "<address>"
},
"name": "yields_get_kyc_status"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| address | Yes | Wallet address to check KYC status for. | |
| yieldId | Yes | Yield ID from yields_get_all e.g. "ethereum-ustb-securitize-rwa". |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kycStatus | Yes | ||
| authorizeUrl | No |