get_virtual_credential_request
Retrieves a mobile credential and its assignment state for a person and card format, returning CARDFORMAT, PERSONID, and STATUS to verify access.
Instructions
Retrieves a mobile (virtual) credential and its assignment state for a person and card format (wraps NBAPI GetVirtualCredentialRequest). Returns CARDFORMAT, PERSONID and STATUS. A card format the controller does not know answers FAIL with "CARDFORMAT NOT FOUND"; use get_card_formats for valid names.
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": {
"PERSONID": "<PERSONID>",
"CARDFORMAT": "<CARDFORMAT>"
},
"name": "get_virtual_credential_request"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| PERSONID | Yes | Required. The PERSONID the credential is assigned to. | |
| CARDFORMAT | Yes | Required. Name of the card format used to decode the credential (see get_card_formats). |