--- title: Get consumer validation audit logs filtered by event type slug: api-documentation/get-consumer-validation-audit-logs-filtered-by-event-type docTags: createdAt: 2026-08-27T16:53:43.446Z --- { "id": "3Z_D3xFe2AfxbXyX-GFCp", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.upstartcommerce.com/compliance-orchestrator/consumer-validation/audit", "servers": [ { "url": "https://api.upstartcommerce.com/compliance-orchestrator/consumer-validation/audit" } ], "name": "Get consumer validation audit logs filtered by event type", "description": "

Retrieve consumer validation audit logs across all consumers for a specific tenant, filtered by a required event type (identity_verified or identity_failed).

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "required", "name": "x-upstart-tenant", "type": "string", "description": "Tenant identifier associated with the site." }, { "kind": "required", "name": "x-upstart-site", "type": "string", "description": "The site identifier." } ], "queryParameters": [ { "kind": "required", "name": "eventType", "type": "object", "description": "

Filter by event type (identity_verified or identity_failed).

", "customType": "ConsumerValidationEventType", "schema": [], "modelRef": "#/components/schemas/ConsumerValidationEventType" }, { "kind": "optional", "name": "yearMonth", "type": "string", "example": "2026-04", "description": "

Time bucket in YYYY-MM format. Defaults to current month if omitted.

" }, { "kind": "optional", "name": "limit", "type": "integer", "description": "

Maximum number of results per page. Defaults to 50, max 200.

", "default": 50, "format": "int32", "minimum": 1, "maximum": 200 }, { "kind": "optional", "name": "pagingState", "type": "string", "description": "Opaque token from a previous response to fetch the next page." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "ApiKeyAccess", "name": "X-Upstart-Api-Key", "kind": "optional", "type": "apiKey", "description": "Api key based authorization.", "in": "header" }, { "id": "SessionIdAccess", "name": "X-Upstart-Session-Id", "kind": "optional", "type": "apiKey", "description": "

Session based authorization. This authentication is required for clients to interact with any of the management APIs. Similar to 'LoggedIn', it indicates that the user has actually logged into the system, but in this case with a management role.

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Consumer Validation Audit logs retrieved", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Paginated response for consumer validation audit logs.", "customType": "PaginatedConsumerValidationAuditResponse", "schema": [ { "name": "items", "kind": "required", "type": "array", "description": "Response model for consumer validation audit logs.", "modelRef": "#/components/schemas/ConsumerValidationAuditResponse", "customType": "ConsumerValidationAuditResponse[]", "schema": [ { "name": "tenant", "kind": "required", "type": "string", "description": "tenant" }, { "name": "consumerId", "kind": "required", "type": "string", "description": "consumer id", "format": "uuid" }, { "name": "eventId", "kind": "required", "type": "string", "description": "Unique identifier for the event", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid" }, { "name": "eventType", "kind": "required", "type": "string", "description": "

The outcome of a consumer identity-verification attempt.

", "modelRef": "#/components/schemas/ConsumerValidationEventType", "customType": "ConsumerValidationEventType", "schema": [] }, { "name": "detail", "kind": "required", "type": "string", "description": "Reason for the validation event", "example": "User requested data retrieval" }, { "name": "createdAt", "kind": "required", "type": "string", "description": "Timestamp when the event was created", "format": "date-time" } ] }, { "name": "pagingState", "kind": "optional", "type": "string", "description": "Opaque token for fetching the next page. Absent if no more pages." } ], "modelRef": "#/components/schemas/PaginatedConsumerValidationAuditResponse", "isExpanded": true } ] }, { "statusCode": "400", "description": "The request contained information that the server was unable to process. Appropriate errors are provided in the response body.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "Error response for validation errors", "customType": "ValidationErrorResponse[]", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" }, { "name": "metadata", "kind": "optional", "type": "map", "description": "", "example": "", "customType": "map", "schema": [] } ], "modelRef": "#/components/schemas/ValidationErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "The provided credentials were not valid for this endpoint.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Error payload returned when a request is not authenticated or not permitted. Same shape as ErrorResponse.", "customType": "UnauthorizedErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/UnauthorizedErrorResponse", "isExpanded": true } ] }, { "statusCode": "403", "description": "User's roles are insufficient for this endpoint.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

Error payload identifying the failure by name and code, with optional detail and reason.

", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "404", "description": "The requested resource was not found in the NoChannel system.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

Error payload identifying the failure by name and code, with optional detail and reason.

", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "405", "description": "This is to indicate that the server has received a request with an HTTP method that is not supported for the requested resource.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

Error payload identifying the failure by name and code, with optional detail and reason.

", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "415", "description": "This is to indicate that the server cannot process the request because the media type of the request entity is not supported or not recognized by the server.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

Error payload identifying the failure by name and code, with optional detail and reason.

", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "422", "description": "

This is to indicate that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

Error payload identifying the failure by name and code, with optional detail and reason.

", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "500", "description": "There was an internal server error.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

Error payload identifying the failure by name and code, with optional detail and reason.

", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "Za1Fi4UvqujYlXh77Oc7M", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://api.upstartcommerce.com/compliance-orchestrator/consumer-validation/audit?eventType=object&limit=50' \\\n --header 'accept: application/json' \\\n --header 'x-upstart-tenant: string' \\\n --header 'x-upstart-site: string'" }, { "id": "ckiHcMgUrDiZ4nLGlE10q", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\nmyHeaders.append(\"x-upstart-site\", \"string\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/compliance-orchestrator/consumer-validation/audit?eventType=object&limit=50\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "Mnw1DSFymo2yZ2NfW9HRj", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/compliance-orchestrator/consumer-validation/audit?eventType=object&limit=50\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\nrequest[\"x-upstart-site\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "DVe3oTgCW1ciCtWGszBpx", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/compliance-orchestrator/consumer-validation/audit?eventType=object&limit=50\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string',\n 'x-upstart-site': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "Za1Fi4UvqujYlXh77Oc7M" }, "results": { "languages": [ { "id": "OPU2FVN_8Fxf_iYoZCF1-", "language": "200", "code": "// Consumer Validation Audit logs retrieved\n{\n \"items\": [\n {\n \"tenant\": \"\",\n \"consumerId\": \"\",\n \"eventId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"eventType\": \"\",\n \"detail\": \"User requested data retrieval\",\n \"createdAt\": \"\"\n }\n ],\n \"pagingState\": \"\"\n}" }, { "id": "Zwlzdyk8wG1izQcPPyXFr", "language": "400", "code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n[\n {\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\",\n \"metadata\": \"\"\n }\n]" }, { "id": "r5cHERvdleuNExI0swMez", "language": "401", "code": "// The provided credentials were not valid for this endpoint.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "NDAVcLguzhcYcWYGZvn2t", "language": "403", "code": "// User's roles are insufficient for this endpoint.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "FSDOqElpa6dywgVeQE1gP", "language": "404", "code": "// The requested resource was not found in the NoChannel system.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "8x_NuPuq1HcjBrIVJ-XOa", "language": "405", "code": "// This is to indicate that the server has received a request with an HTTP method that is not supported for the requested resource.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "OalfVAkSKQs3aKu8bNg4m", "language": "415", "code": "// This is to indicate that the server cannot process the request because the media type of the request entity is not supported or not recognized by the server.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "1gkxGp2FfYsGm1zk7WOnu", "language": "422", "code": "// This is to indicate that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "pAnP5Gdx1tC_2TZpKKGoi", "language": "500", "code": "// There was an internal server error.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "OPU2FVN_8Fxf_iYoZCF1-" } }, "children": [ { "text": "" } ] }