command.credential.verify
Verify a trading account credential.
Method
command.credential.verify
Description
Verifies API credentials by testing connectivity to the exchange and checking permissions. Returns a list of trading accounts accessible with the credential.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
credentialId | string | Yes | Credential ID to verify |
Result
Verification Result
| Field | Type | Description |
|---|---|---|
credentialId | string | Credential identifier |
status | string | Updated status (VERIFIED or FAILED) |
accounts | array | List of accessible trading accounts |
permissions | array | Detected API permissions |
Account Object
| Field | Type | Description |
|---|---|---|
externalAccountId | string | Exchange account ID |
accountType | string | Account type (SPOT, MARGIN, FUTURES) |
Usage
result = await client.rpc("command.credential.verify", {
"credentialId": "660e8400-e29b-41d4-a716-446655440001"
})
Example Response
{
"credentialId": "660e8400-e29b-41d4-a716-446655440001",
"status": "VERIFIED",
"accounts": [
{
"externalAccountId": "123456789",
"accountType": "SPOT"
},
{
"externalAccountId": "123456789",
"accountType": "MARGIN"
}
],
"permissions": ["SPOT_TRADE", "MARGIN_TRADE", "READ"]
}
Notes
- Verification tests actual connectivity to the exchange
- Detected permissions depend on API key configuration
- After verification, use
command.trading_account.connectto connect