get_consumer
Retrieve a consumer record using their consumer ID. Access consumer data for open banking operations.
Instructions
Get a consumer record by consumer id.
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": {
"consumer_id": "<consumer_id>"
},
"name": "get_consumer"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| consumer_id | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | True when the upstream HTTP status was < 400. | |
| data | No | Finicity's native response body. | |
| error | No | Error summary when ok is False. | |
| status_code | Yes | Upstream Finicity HTTP status code. |