Preview Client Enrollment
agency_enrollment_previewChecks every client in the batch for missing facts, owner approval and payer conflicts, and returns what enrolling would install, with the fingerprint and approval IDs needed to enroll. Requires an agency owner, admin or operator. It records the preview on the session but installs nothing.
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": {
"partnerId": "<partnerId>",
"sessionId": "<sessionId>"
},
"name": "agency_enrollment_preview"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| partnerId | Yes | The agency (partner) workspace ID. | |
| sessionId | Yes | The enrollment session to preview. | |
| idempotencyKey | No | Stable key for this request; reuse it when retrying the same request. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Present when success is false | |
| receipt | No | ||
| success | Yes | Whether the tool completed successfully |