--- updatedAt: 2026-07-21T09:14:57.000Z agentTools: projectIndex: https://guides.tell.money/llms.txt --- # List consents for the authenticated client Returns a paginated list of all consents associated with the authenticated client (i.e. the caller's own consents). Equivalent to `GET /clients/{own_client_uuid}/consents`. # OpenAPI definition ```json { "openapi": "3.0.3", "info": { "title": "Tell Intelligence", "version": "1.0.0", "description": "Intelligence endpoints for ASPSP clients. All endpoints require\n`client_secret_basic` authentication (HTTP Basic with `clientId:clientSecret`\nbase64-encoded). Successful responses include an `x-tell-id` header carrying\nthe correlation ID, and a `traceId` field in the response body.\n" }, "servers": [ { "url": "https://aspsp.{domain}/intel", "variables": { "domain": { "default": "tell.systems", "description": "System domain (e.g. tell.systems)" } } } ], "security": [ { "basicAuth": [] } ], "components": { "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic", "description": "`client_secret_basic` — credentials are `clientId:clientSecret`\nbase64-encoded in the Authorization header.\n" } }, "parameters": { "from": { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$" }, "description": "Start date filter — YYYY-MM-DD.", "example": "2024-01-01" }, "to": { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$" }, "description": "End date filter — YYYY-MM-DD.", "example": "2024-12-31" }, "tpp": { "name": "tpp", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Filter by TPP UUID." }, "consentType": { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "aisp", "pisp", "cbpii" ] }, "description": "Filter by consent type." }, "consentStatus": { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "APPROVED", "DECLINED", "PENDING", "REVOKED", "EXPIRED", "CONSUMED", "REJECTED" ] }, "description": "Filter by consent status." }, "page": { "name": "page", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[1-9][0-9]*$" }, "description": "Page number (positive integer, passed as string).", "example": "1" }, "rpp": { "name": "rpp", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[1-9][0-9]*$" }, "description": "Results per page (positive integer, passed as string).", "example": "25" } }, "schemas": { "ConsentGateway": { "type": "object", "properties": { "gateway_id": { "type": "string" }, "gateway_name": { "type": "string" } } }, "ConsentTpp": { "type": "object", "properties": { "tpp_id": { "type": "string" }, "tpp_name": { "type": "string" }, "tpp_app_id": { "type": "string" }, "tpp_app_name": { "type": "string" } } }, "ConsentListItem": { "type": "object", "required": [ "consent_id", "type", "status", "created" ], "properties": { "consent_id": { "type": "string" }, "type": { "type": "string", "enum": [ "AISP", "PISP", "CBPII", "UNKNOWN" ] }, "status": { "type": "string", "enum": [ "APPROVED", "DECLINED", "PENDING", "REVOKED", "EXPIRED", "CONSUMED", "REJECTED", "UNKNOWN" ] }, "created": { "type": "string", "format": "date-time" }, "granted": { "type": "string", "format": "date-time", "nullable": true }, "expiry": { "type": "string", "format": "date-time", "nullable": true }, "revoked": { "type": "string", "format": "date-time", "nullable": true }, "user_id": { "type": "string", "nullable": true }, "account_ids": { "type": "array", "items": { "type": "string" } }, "gateway": { "$ref": "#/components/schemas/ConsentGateway" }, "tpp": { "$ref": "#/components/schemas/ConsentTpp" } } }, "ConsentsSummaryBlock": { "type": "object", "properties": { "total_requested": { "type": "integer", "minimum": 0 }, "total_approved": { "type": "integer", "minimum": 0 }, "total_revoked": { "type": "integer", "minimum": 0 }, "total_declined": { "type": "integer", "minimum": 0 }, "total_expired": { "type": "integer", "minimum": 0 } } }, "ConsentsMeta": { "type": "object", "required": [ "page", "page_size", "total_records", "total_pages", "has_next", "has_prev" ], "properties": { "page": { "description": "Current page number." }, "page_size": { "description": "Number of results per page." }, "total_records": { "type": "integer", "minimum": 0 }, "total_pages": { "type": "integer", "minimum": 0 }, "has_next": { "type": "boolean" }, "has_prev": { "type": "boolean" } } }, "ConsentsResponse": { "type": "object", "required": [ "summary", "consents", "meta" ], "properties": { "summary": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ConsentsSummaryBlock" }, "description": "Keyed by consent type or grouping identifier." }, "consents": { "type": "array", "items": { "$ref": "#/components/schemas/ConsentListItem" } }, "meta": { "$ref": "#/components/schemas/ConsentsMeta" }, "traceId": { "type": "string", "format": "uuid" } } }, "ValidationDetail": { "type": "object", "required": [ "field", "code", "message" ], "properties": { "field": { "type": "string", "description": "Dot-notation path to the invalid field, e.g. \"qs.from\"." }, "code": { "type": "string", "enum": [ "INVALID_FORMAT", "INVALID_PATTERN", "FIELD_REQUIRED", "INVALID_TYPE", "OUT_OF_RANGE", "INVALID_LENGTH", "INVALID_ENUM_VALUE", "UNEXPECTED_FIELD", "INVALID_VALUE", "VALIDATION_ERROR" ] }, "message": { "type": "string" } } }, "ErrorResponse": { "type": "object", "required": [ "status", "code", "message", "traceId", "docsUrl" ], "properties": { "status": { "type": "integer", "description": "HTTP status code." }, "code": { "type": "string", "description": "Machine-readable error code." }, "message": { "type": "string", "description": "Human-readable error message." }, "traceId": { "type": "string", "format": "uuid", "description": "Correlation ID for tracing in CloudWatch / X-Ray." }, "docsUrl": { "type": "string", "format": "uri", "description": "Link to error documentation." }, "details": { "type": "array", "description": "Populated for INVALID_REQUEST_DATA only.", "items": { "$ref": "#/components/schemas/ValidationDetail" } } } } }, "responses": { "Unauthorized": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missingHeader": { "summary": "Missing Authorization header", "value": { "status": 401, "code": "MISSING_AUTHORIZATION_HEADER", "message": "The request is missing the required Authorization header. Please provide valid credentials and try again.", "traceId": "b77155e8-17f7-4188-99ca-a2baedce7a23", "docsUrl": "https://docs.tell.money/errors#MISSING_AUTHORIZATION_HEADER" } }, "invalidCredentials": { "summary": "Invalid credentials", "value": { "status": 401, "code": "INVALID_AUTHORIZATION_CREDENTIALS", "message": "The request contains invalid authorization credentials. Please provide valid credentials and try again.", "traceId": "b77155e8-17f7-4188-99ca-a2baedce7a23", "docsUrl": "https://docs.tell.money/errors#INVALID_AUTHORIZATION_CREDENTIALS" } } } } } }, "BadRequest": { "description": "Request data failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "status": 400, "code": "INVALID_REQUEST_DATA", "message": "Request data failed validation", "traceId": "b77155e8-17f7-4188-99ca-a2baedce7a23", "docsUrl": "https://docs.tell.money/errors#INVALID_REQUEST_DATA", "details": [ { "field": "qs.from", "code": "INVALID_PATTERN", "message": "from must be a valid date in YYYY-MM-DD format" } ] } } } }, "InternalError": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "status": 500, "code": "UNHANDLED_SYSTEM_ERROR", "message": "The server encountered an unexpected error. Please contact support or try again later.", "traceId": "b77155e8-17f7-4188-99ca-a2baedce7a23", "docsUrl": "https://docs.tell.money/errors#UNHANDLED_SYSTEM_ERROR" } } } } } }, "paths": { "/consents": { "get": { "operationId": "GetConsents", "summary": "List consents for the authenticated client", "description": "Returns a paginated list of all consents associated with the authenticated\nclient (i.e. the caller's own consents). Equivalent to\n`GET /clients/{own_client_uuid}/consents`.\n", "tags": [ "Self" ], "parameters": [ { "$ref": "#/components/parameters/from" }, { "$ref": "#/components/parameters/to" }, { "$ref": "#/components/parameters/tpp" }, { "$ref": "#/components/parameters/consentType" }, { "$ref": "#/components/parameters/consentStatus" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/rpp" } ], "responses": { "200": { "description": "Consents list.", "headers": { "x-tell-id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsentsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "500": { "$ref": "#/components/responses/InternalError" } } } } }, "tags": [ { "name": "Self", "description": "Endpoints scoped to the authenticated client's own data." } ] } ```