ONonetrust
Applications

Get Application Scan

Use this API to retrieve the details of a single scan for a specific application. The response includes the scan's ID, status, date, and summary data for detected SDKs and permissions.

get/api/cmp/v1/applications/{id}/scans/{scanId}

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/cmp/v1/applications/{id}/scans/{scanId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: COOKIE_READ

Path parameters

idstring uuid required

Unique identifier of the application.

scanIdstring uuid required

Unique identifier the scan.

Response

OK

scanIdstring uuid

Unique identifier for this scan

status'PENDING' | 'PROGRESS' | 'COMPLETED' | 'FAILED' | 'INTERRUPTED' | 'UNSCANNED'

Status of this scan

sdkCountinteger

Total number of SDKs found

sdkCategoriesobject

SDK counts grouped by category

permissionCountinteger

Total number of permissions found

permissionCountHighRiskinteger

Number of high-risk permissions

permissionCategoriesobject

Permission counts grouped by category

scanDatestring date-time

Date and time of the scan

versionstring

Detected version of the given application

engineVersionstring

OneTrust mobile scan engine version used for this scan

Example response

{
  "scanId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
  "status": "COMPLETED",
  "sdkCategories": {
    "Strictly Necessary": 10,
    "Performance": 5,
    "Functionality": 3,
    "Targeting": 2,
    "Unknown": 1
  },
  "permissionCategories": {
    "Device Hardware": 4,
    "Accounts": 1,
    "Media": 1,
    "System Notifications": 3,
    "Security": 1
  },
  "scanDate": "2022-01-01T00:00:00.000Z",
  "version": "1.0.0",
  "engineVersion": "2.0.0"
}

Changes

No recorded changes to this operation across all 1 revision of this API.