NAV Navbar
cURL

Introduction

Cymatic Security's API provides the digital infrastructure you will need to reliably secure your fintech application in savings, investing, wealth, insurance, and financial wellness. This includes the base functionality to create, authenticate, onboard clients and accounts, and store and process data which all other APIs in the Cymatic platform will utilize.

All of Cymatic Security APIs are built on REST principles, with resource oriented URLs and HTTP response codes. All API responses are returned in JSON format.

Production Base URL

  https://api.cymaticsecurity.com/

Authentication

API Authentication

After successful registration of your tenant and site, you will be provided a client_id and client_secret which will be used to identify your site when calling any CymaticSecurity API.

We require all API calls to be made over HTTPS connections.

OAuth2 Authorization

CymaticSecurity uses OAuth 2.0 to facilitate authorization on the API, an industry standard framework for authorization. The client credentials flow is used by your site to obtain permission to act on its own behalf. A call will be made to our OAuth server to exchange your client_id, client_secret, and grant_type=client_credentials for an access_token, which can then be used to make calls to CymaticSecurity on behalf of the site.

HTTP Request

POST https://<tenant>.api.cymaticsecurity.com/auth/token

REQUEST ARGUMENTS

Parameter Type Required Description
grant_type string required Must be set to client_credentials.
client_id string required Site's credential id for identification, which will be given to you when you register a site.
client_secret string required Site's credential secret, which will be given to you only once when you register a site. Please keep this in a safe place.

RESPONSE

Field Description
access_token Token that will be used for all subsequent API calls
expires_in When the token expires in seconds and will need to be called again. Default is 86400 or 24 hours.
scope The scope your user has been granted in the application

Example Request

curl -X POST https://<tenant>.api.cymaticsecurity.com/auth/token --data-urlencode "grant_type=client_credentials" \
  -H "Authorization: Basic Y2xpZW50X2lkOmNsaWVudF9zZWNyZXQ="

Example Response

  {
    "access_token": "6F63A27A-082D-49F3-9F6B-E143E0F823DA",
    "expires_in": 10800,
    "scope": "email profile"
  }

Token Refresh

An access_token will need to be refreshed to continue being authorized for the app. Access tokens are short lived: 24 hours. The Client Credentials grant type doesn’t return a refresh token. When your access_token expires, the site has to simply request a new token which will invalidate the previous token. The token can be deserialized to determine how much longer it is valid.

To authorize, use this code:

Command Endpoints

Login

Example Request

  curl -X POST https://<tenant>.api.cymaticsecurity.com/login \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \
  --data '{"c_uuid": "DCBF72CF-A5BC-463B-A648-C7FD909DF39C", "jwt": "BEB82D40-1433-482F-B469-5C2EF8605D60"}'

Example Response

{
  "session_id": "B26A4AFE-2B7A-413A-AABF-CB2402F4F951",
  "c_uuid": "DCBF72CF-A5BC-463B-A648-C7FD909DF39C",
  "sdk_uuid": "83c1462d-26c2-406e-9f2b-778e7fd63b21",
  "device_id": "5c772b5bd101b600130d04c9",
  "socket_id": "/client#AFxaNRHEpX5iVo8nAAJc",
  "jwt": "BEB82D40-1433-482F-B469-5C2EF8605D60",
  "started_at": "2019-02-28T20:31:35.873Z",
}

This endpoint creates a new session for an end user in Cymatic's environment.

HTTP Request

POST https://<tenant>.api.cymaticsecurity.com/login

REQUEST ARGUMENTS

Parameter Type Required Description
jwt string required JWT (string) that represents the enduser traking identity.
c_uuid string required UUID (string) An enduser's profile identificator provided to you at the moment you created this user's profile.

RESPONSE

Field Description
session_id See ids section.
c_uuid See ids section.
sdk_uuid See ids section.
device_id See ids section.
socket_id See ids section.
jwt This is the end user's tracking identity JWT (also known as IntJWT).
started_at Time the session started.

Logout

Example Request

  curl -X POST https://<tenant>.api.cymaticsecurity.com/logout \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \
  --data '{"session_id": "B26A4AFE-2B7A-413A-AABF-CB2402F4F951"}'

Example Response

Closed

This endpoint closes an end user's open session on Cymatic's environment.

HTTP REQUEST

POST https://<tenant>.api.cymaticsecurity.com/logout

REQUEST ARGUMENTS

Parameter Type Required Description
session_id string required Session identificator returned from a successful /login call to Cymatic.

Bio

Credentials

Passwords

Example Request

  curl https://api.cymaticsecurity.com/v1/credentials/sites/<sdk_uuid>/darkweb/passwords?seen_after=1550815200000 \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \

Example Response

{
  "counters": {
    "total": 0,
    "risky": 0,
    "safe": 0
  },
  "graph": [
    {
      "tick": "1550793600000",
      "date": "2019-02-22T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1550880000000",
      "date": "2019-02-23T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1550966400000",
      "date": "2019-02-24T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551052800000",
      "date": "2019-02-25T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551139200000",
      "date": "2019-02-26T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551225600000",
      "date": "2019-02-27T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551312000000",
      "date": "2019-02-28T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551398400000",
      "date": "2019-03-01T00:00:00Z",
      "risky": 0,
      "safe": 0
    }
  ]
}

Reports end users vulnerabilities due to detection of their passwords in the darkweb databases.

HTTP Request

GET https://api.cymaticsecurity.com/v1/credentials/sites/<sdk_uuid>/darkweb/passwords

REQUEST ARGUMENTS

Parameter Type Required Description
seen_after epoch timestamp required Start date to look for records. Current time marks the end of the search.
report string optional If set , it will stream a file with the search data. Valid values: csv
timezone string optional Timezone for search context. It defaults to UTC

RESPONSE

Field Description
counters Contains counts of total passwords detected and their risky/safe ratio.
graph Contains structured data to use in visualizations.

Passwords Summary

Example Request

  curl https://api.cymaticsecurity.com/v1/credentials/sites/<sdk_uuid>/darkweb/passwordsSummary?seen_after=1550815200000 \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \

Example Response

{
  "totalCount":0,
  "graph":[
    {"risky":0},
    {"safe":0}
  ]
}

Most condensed report about healthy and compromised passwords for end users detected by the platform.

HTTP Request

GET https://api.cymaticsecurity.com/v1/credentials/sites/<sdk_uuid>/darkweb/passwordsSummary

REQUEST ARGUMENTS

Parameter Type Required Description
seen_after epoch timestamp required Start date to look for records. Current time marks the end of the filtered date range.

RESPONSE

Field Description
totalCount The total of unique usernames detected in the filtered date range.
graph Contains the ratio of risky vs safe unique usernames detected in the filtered date range.

Passwords Threats

Example Request

  curl https://api.cymaticsecurity.com/v1/credentials/sites/<sdk_uuid>/darkweb/passwords/threats?calculated_at_after=1550815200000 \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \

Example Response

{
  "totalCount":0,
  "resources":[]
}

Reports end users vulnerabilities due to detection of their passwords in the darkweb databases.

HTTP Request

GET https://api.cymaticsecurity.com/v1/credentials/sites/<sdk_uuid>/darkweb/passwords/threats

REQUEST ARGUMENTS

Parameter Type Required Description
calculated_at_after epoch timestamp required Start date to look for records. Current time marks the end of the search.
report string optional If set , it will stream a file with the search data. Valid values: csv
timezone string optional Timezone for search context. It defaults to UTC

RESPONSE

Field Description
counters See ids section.
graph See ids section.

Example Request

  curl https://api.cymaticsecurity.com/v1/credentials/sites/<sdk_uuid>/darkweb/passwords/trend?seen_after=1550815200000 \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \

Example Response

{
  "counters": {
    "total": 0,
    "risky": 0,
    "safe": 0
  },
  "graph": [
    {
      "tick": "1550793600000",
      "date": "2019-02-22T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1550880000000",
      "date": "2019-02-23T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1550966400000",
      "date": "2019-02-24T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551052800000",
      "date": "2019-02-25T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551139200000",
      "date": "2019-02-26T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551225600000",
      "date": "2019-02-27T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551312000000",
      "date": "2019-02-28T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551398400000",
      "date": "2019-03-01T00:00:00Z",
      "risky": 0,
      "safe": 0
    }
  ]
}

Reports end users vulnerabilities due to detection of their usernames in the darkweb databases.

HTTP Request

GET https://api.cymaticsecurity.com/v1/credentials/sites/<sdk_uuid>/darkweb/passwords/trend

REQUEST ARGUMENTS

Parameter Type Required Description
seen_after epoch timestamp required Start date to look for records. Current time marks the end of the search.
report string optional If set , it will stream a file with the search data. Valid values: csv
timezone string optional Timezone for search context. It defaults to UTC

RESPONSE

Field Description
counters See ids section.
graph See ids section.

Usernames

Example Request

  curl -X GET https://api.cymaticsecurity.com/v1/sites/<sdk_uuid>/darkweb/usernames?seen_after=1550815200000 \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \

Example Response

{
  "counters": {
    "total": 0,
    "risky": 0,
    "safe": 0
  },
  "graph": [
    {
      "tick": "1550793600000",
      "date": "2019-02-22T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1550880000000",
      "date": "2019-02-23T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1550966400000",
      "date": "2019-02-24T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551052800000",
      "date": "2019-02-25T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551139200000",
      "date": "2019-02-26T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551225600000",
      "date": "2019-02-27T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551312000000",
      "date": "2019-02-28T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551398400000",
      "date": "2019-03-01T00:00:00Z",
      "risky": 0,
      "safe": 0
    }
  ]
}

Reports end users vulnerabilities due to detection of their usernames in the darkweb databases.

HTTP Request

GTE https://api.cymaticsecurity.com/v1/credentials/sites/<sdk_uuid>/darkweb/usernames

REQUEST ARGUMENTS

Parameter Type Required Description
seen_after epoch timestamp required Start date to look for records. Current time marks the end of the search.
report string optional If set , it will stream a file with the search data. Valid values: csv
timezone string optional Timezone for search context. It defaults to UTC

RESPONSE

Field Description
counters See ids section.
graph See ids section.

Usernames Summary

Example Request

  curl -X GET https://api.cymaticsecurity.com/v1/credentials/sites/<sdk_uuid>/darkweb/usernamesSummary?seen_after=1550815200000 \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \

Example Response

{
  "totalCount":0,
  "graph":[
    {"risky":0},
    {"safe":0}
  ]
}

Most condensed report about healthy and compromised usernames for end users detected by the platform.

HTTP Request

GET https://api.cymaticsecurity.com/v1/credentials/sites/<sdk_uuid>/darkweb/usernamesSummary

REQUEST ARGUMENTS

Parameter Type Required Description
seen_after epoch timestamp required Start date to look for records. Current time marks the end of the filtered date range.

RESPONSE

Field Description
totalCount The total of unique usernames detected in the filtered date range.
graph Contains the ratio of risky vs safe unique usernames detected in the filtered date range.

Usernames Threats

Example Request

  curl -X GET https://api.cymaticsecurity.com/v1/credentials/sites/<sdk_uuid>/darkweb/usernames/threats?calculated_at_after=1550815200000 \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \

Example Response

{
  "totalCount":0,
  "resources":[]
}

Reports end users vulnerabilities due to detection of their usernames in the darkweb databases.

HTTP Request

GET https://api.cymaticsecurity.com/v1/sites/<sdk_uuid>/darkweb/usernames

REQUEST ARGUMENTS

Parameter Type Required Description
seen_after epoch timestamp required Start date to look for records. Current time marks the end of the search.
report string optional If set , it will stream a file with the search data. Valid values: csv
timezone string optional Timezone for search context. It defaults to UTC

RESPONSE

Field Description
counters See ids section.
graph See ids section.

Example Request

  curl -X GET https://api.cymaticsecurity.com/v1/credentials/sites/<sdk_uuid>/darkweb/usernames?seen_after=1550815200000 \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \

Example Response

{
  "counters": {
    "total": 0,
    "risky": 0,
    "safe": 0
  },
  "graph": [
    {
      "tick": "1550793600000",
      "date": "2019-02-22T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1550880000000",
      "date": "2019-02-23T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1550966400000",
      "date": "2019-02-24T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551052800000",
      "date": "2019-02-25T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551139200000",
      "date": "2019-02-26T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551225600000",
      "date": "2019-02-27T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551312000000",
      "date": "2019-02-28T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551398400000",
      "date": "2019-03-01T00:00:00Z",
      "risky": 0,
      "safe": 0
    }
  ]
}

Reports end users vulnerabilities due to detection of their usernames in the darkweb databases.

HTTP Request

GET https://api.cymaticsecurity.com/v1/credentials/sites/<sdk_uuid>/darkweb/usernames

REQUEST ARGUMENTS

Parameter Type Required Description
seen_after epoch timestamp required Start date to look for records. Current time marks the end of the search.
report string optional If set , it will stream a file with the search data. Valid values: csv
timezone string optional Timezone for search context. It defaults to UTC

RESPONSE

Field Description
counters See ids section.
graph See ids section.

Devices

Data in the devices endpoints are related to properties of browsers, os and mobile devices and their vulnerabilities as determined in the Common Vulnerabilities Enumeration by NIST. The properties and risks are reported from least to more granular from the Account's, Site's and User's levels.

Site Devices

Example Request

  curl GET https://api.cymaticsecurity.com/v1/devices/sites/<sdk_uuid>?seen_after=1550815200000 \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \

Example Response

{
  "counters": {
    "total": 0,
    "risky": 0,
    "safe": 0
  },
  "graph": [
    {
      "tick": "1550880000000",
      "date": "2019-02-23T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1550966400000",
      "date": "2019-02-24T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551052800000",
      "date": "2019-02-25T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551139200000",
      "date": "2019-02-26T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551225600000",
      "date": "2019-02-27T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551312000000",
      "date": "2019-02-28T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551398400000",
      "date": "2019-03-01T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551484800000",
      "date": "2019-03-02T00:00:00Z",
      "risky": 0,
      "safe": 0
    }
  ]
}

Reports devices vulnerabilities as determined by CVE reports from NIST.

HTTP Request

GET https://api.cymaticsecurity.com/v1/devices/sites/<sdk_uuid>

REQUEST ARGUMENTS

Parameter Type Required Description
seen_after epoch timestamp required Start date to look for records. Current time marks the end of the search.
report string optional If set , it will stream a file with the search data. Valid values: csv
timezone string optional Timezone for search context. It defaults to UTC

RESPONSE

Field Description
counters See ids section.
graph See ids section.

Profile Devices

Example Request

  curl GET https://api.cymaticsecurity.com/v1/devices/sites/<sdk_uuid>/profiles/<c_uuid>?seen_after=1550815200000 \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \

Example Response

{
  "counters": {
    "total": 0,
    "risky": 0,
    "safe": 0
  },
  "graph": [
    {
      "tick": "1550880000000",
      "date": "2019-02-23T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1550966400000",
      "date": "2019-02-24T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551052800000",
      "date": "2019-02-25T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551139200000",
      "date": "2019-02-26T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551225600000",
      "date": "2019-02-27T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551312000000",
      "date": "2019-02-28T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551398400000",
      "date": "2019-03-01T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551484800000",
      "date": "2019-03-02T00:00:00Z",
      "risky": 0,
      "safe": 0
    }
  ]
}

Reports devices vulnerabilities as determined by CVE reports from NIST.

HTTP Request

GET https://api.cymaticsecurity.com/v1/devices/sites/<sdk_uuid>/profiles/<c_uuid>

REQUEST ARGUMENTS

Parameter Type Required Description
seen_after epoch timestamp required Start date to look for records. Current time marks the end of the search.
report string optional If set , it will stream a file with the search data. Valid values: csv
timezone string optional Timezone for search context. It defaults to UTC

RESPONSE

Field Description
counters See ids section.
graph See ids section.

Devices Risks

Example Request

  curl GET https://api.cymaticsecurity.com/v1/devices/sites/<sdk_uuid>/risks/seen_after=1550815200000 \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \

Example Response

{
  "counters": {
    "total": 0,
    "risky": 0,
    "safe": 0
  },
  "graph": [
    {
      "tick": "1550880000000",
      "date": "2019-02-23T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1550966400000",
      "date": "2019-02-24T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551052800000",
      "date": "2019-02-25T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551139200000",
      "date": "2019-02-26T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551225600000",
      "date": "2019-02-27T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551312000000",
      "date": "2019-02-28T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551398400000",
      "date": "2019-03-01T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551484800000",
      "date": "2019-03-02T00:00:00Z",
      "risky": 0,
      "safe": 0
    }
  ]
}

Reports devices vulnerabilities as determined by CVE reports from NIST.

HTTP Request

GET https://api.cymaticsecurity.com/v1/devices/sites/<sdk_uuid>/risks

REQUEST ARGUMENTS

Parameter Type Required Description
seen_after epoch timestamp required Start date to look for records. Current time marks the end of the search.
report string optional If set , it will stream a file with the search data. Valid values: csv
timezone string optional Timezone for search context. It defaults to UTC

RESPONSE

Field Description
counters See ids section.
graph See ids section.

Profile Devices Risks

Example Request

  curl GET https://api.cymaticsecurity.com/sites/<sdk_uuid>/devices/profiles/<c_uuid>/risks/seen_after=1550815200000 \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \

Example Response

{
  "counters": {
    "total": 0,
    "risky": 0,
    "safe": 0
  },
  "graph": [
    {
      "tick": "1550880000000",
      "date": "2019-02-23T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1550966400000",
      "date": "2019-02-24T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551052800000",
      "date": "2019-02-25T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551139200000",
      "date": "2019-02-26T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551225600000",
      "date": "2019-02-27T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551312000000",
      "date": "2019-02-28T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551398400000",
      "date": "2019-03-01T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551484800000",
      "date": "2019-03-02T00:00:00Z",
      "risky": 0,
      "safe": 0
    }
  ]
}

Reports devices vulnerabilities as determined by CVE reports from NIST.

HTTP Request

GET https://api.cymaticsecurity.com/v1/devices/sites/<sdk_uuid>/profiles/<c_uuid>/risks

REQUEST ARGUMENTS

Parameter Type Required Description
seen_after epoch timestamp required Start date to look for records. Current time marks the end of the search.
report string optional If set , it will stream a file with the search data. Valid values: csv
timezone string optional Timezone for search context. It defaults to UTC

RESPONSE

Field Description
counters See ids section.
graph See ids section.

Devices Top Risks

Example Request

  curl GET https://api.cymaticsecurity.com/v1/devices/sites/<sdk_uuid>/toprisks/seen_after=1550815200000 \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \

Example Response

{
  "counters": {
    "total": 0,
    "risky": 0,
    "safe": 0
  },
  "graph": [
    {
      "tick": "1550880000000",
      "date": "2019-02-23T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1550966400000",
      "date": "2019-02-24T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551052800000",
      "date": "2019-02-25T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551139200000",
      "date": "2019-02-26T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551225600000",
      "date": "2019-02-27T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551312000000",
      "date": "2019-02-28T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551398400000",
      "date": "2019-03-01T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551484800000",
      "date": "2019-03-02T00:00:00Z",
      "risky": 0,
      "safe": 0
    }
  ]
}

Reports devices vulnerabilities as determined by CVE reports from NIST.

HTTP Request

GET https://api.cymaticsecurity.com/v1/devices/sites/<sdk_uuid>/toprisks

REQUEST ARGUMENTS

Parameter Type Required Description
seen_after epoch timestamp required Start date to look for records. Current time marks the end of the search.
report string optional If set , it will stream a file with the search data. Valid values: csv
timezone string optional Timezone for search context. It defaults to UTC

RESPONSE

Field Description
counters See ids section.
graph See ids section.

Profile Devices Top Risks

Example Request

  curl GET https://api.cymaticsecurity.com/sites/<sdk_uuid>/devices/profiles/<c_uuid>/toprisks/seen_after=1550815200000 \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \

Example Response

{
  "counters": {
    "total": 0,
    "risky": 0,
    "safe": 0
  },
  "graph": [
    {
      "tick": "1550880000000",
      "date": "2019-02-23T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1550966400000",
      "date": "2019-02-24T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551052800000",
      "date": "2019-02-25T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551139200000",
      "date": "2019-02-26T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551225600000",
      "date": "2019-02-27T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551312000000",
      "date": "2019-02-28T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551398400000",
      "date": "2019-03-01T00:00:00Z",
      "risky": 0,
      "safe": 0
    },
    {
      "tick": "1551484800000",
      "date": "2019-03-02T00:00:00Z",
      "risky": 0,
      "safe": 0
    }
  ]
}

Reports devices vulnerabilities as determined by CVE reports from NIST.

HTTP Request

GET https://api.cymaticsecurity.com/v1/devices/sites/<sdk_uuid>/profiles/<c_uuid>/toprisks

REQUEST ARGUMENTS

Parameter Type Required Description
seen_after epoch timestamp required Start date to look for records. Current time marks the end of the search.
report string optional If set , it will stream a file with the search data. Valid values: csv
timezone string optional Timezone for search context. It defaults to UTC

RESPONSE

Field Description
counters See ids section.
graph See ids section.

IPs

Site IPs

Example Request

  curl -X GET https://api.cymaticsecurity.com/v1/ips/sites/<sdk_uuid>?seen_after=1550815200000 \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \

Example Response

{
  "resources": [
    {
      "ip": "104.218.140.34",
      "threats": [],
      "risk": "trustworthy",
      "last_seen": 1552019437870,
      "first_seen": 1552006799351
    },
    {
      "ip": "187.234.15.192",
      "threats": [],
      "risk": "trustworthy",
      "last_seen": 1552066064073,
      "first_seen": 1551462800105
    },
    {
      "ip": "104.218.143.66",
      "threats": [],
      "risk": "trustworthy",
      "last_seen": 1552065919533,
      "first_seen": 1551982938547
    },
    {
      "ip": "108.41.0.235",
      "threats": [],
      "risk": "trustworthy",
      "last_seen": 1551842888110,
      "first_seen": 1551465925821
    },
    {
      "ip": "187.194.8.249",
      "threats": [],
      "risk": "trustworthy",
      "last_seen": 1552009471815,
      "first_seen": 1551839326850
    }
  ],
  "totalResults": 0,
  "totalCount": 5
}

Reports all IPs where we have seen end users registered in the site coming from. They can or not have threats detected by our internal IP intelligence service.

HTTP Request

GET https://api.cymaticsecurity.com/v1/ips/sites/<sdk_uuid>/

REQUEST ARGUMENTS

Parameter Type Required Description
seen_after epoch timestamp required Start date to look for records. Current time marks the end of the search.

RESPONSE

Field Description
resources List containing the target results.
resources.ip An IPv4 string where the request to the platform was initiated. It represents with a high probability the origin of the visiting user.
resources.threats Represents a list of detected network threats such as spam origins, delinquent proxies, etc, detected by our IP Intel engine.
resources.risk The level of risk associated with the presence and level of the threats list.
resources.last_seen The first time we see any profile coming from the target IP.
resources.first_seen The last time we see any profile coming from the target IP.
totalResults The total of results for the search contained in the current page.
totalCount The total of records for the search present in the database.

Profile IPs

Example Request

  curl -X GET https://api.cymaticsecurity.com/v1/ips/sites/<sdk_uuid>/profiles/<sdk_uuid>?seen_after=1550815200000 \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \

Example Response

{
  "resources": [
    {
      "ip": "187.234.15.192",
      "threats": [],
      "risk": "trustworthy",
      "last_seen": 1552003157747,
      "first_seen": 1551461487269
    },
    {
      "ip": "187.194.8.249",
      "threats": [],
      "risk": "trustworthy",
      "last_seen": 1552009471815,
      "first_seen": 1551839326850
    }
  ],
  "totalResults": 0,
  "totalCount": 2
}

Reports IPs where we have seen the profile coming from. They can or not have threats detected by our internal IP intelligence service.

HTTP Request

GET https://api.cymaticsecurity.com/v1/ips/sites/<sdk_uuid>/profiles/<c_uuid>

REQUEST ARGUMENTS

Parameter Type Required Description
seen_after epoch timestamp required Start date to look for records. Current time marks the end of the search.

RESPONSE

Field Description
resources List containing the target results.
resources.ip An IPv4 string where the request to the platform was initiated. It represents with a high probability the origin of the visiting user.
resources.threats Represents a list of detected network threats such as spam origins, delinquent proxies, etc, detected by our IP Intel engine.
resources.risk The level of risk associated with the presence and level of the threats list.
resources.last_seen The first time we see the target profile coming from the target IP.
resources.first_seen The last time we see the target profile coming from the target IP.
totalResults The total of results for the searchcontained in the current page.
totalCount The total of records for the search present in the database.

Site Locations

Example Request

  curl -X GET https://api.cymaticsecurity.com/v1/ips/sites/<sdk_uuid>/locations?seen_after=1550815200000 \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \

Example Response

{
  "resources": [
    {
      "coord": [
        19.7419,
        -103.4528
      ]
    },
    {
      "coord": [
        19.2548,
        -103.6982
      ]
    }
  ],
  "totalResults": 0,
  "totalCount": 2
}

Reports exact coordinates for all the IPs we see the end users coming from by using geolocation.

HTTP Request

GET https://api.cymaticsecurity.com/v1/ips/sites/<sdk_uuid>/locations/

REQUEST ARGUMENTS

Parameter Type Required Description
seen_after epoch timestamp required Start date to look for records. Current time marks the end of the search.

RESPONSE

Field Description
resources List containing the target results.
resources.coord Tuples of latitude and longitude where we detect our users coming from.

Profile Locations

Example Request

  curl -X GET https://api.cymaticsecurity.com/v1/ips/sites/<sdk_uuid>/profiles/<c_uuid>/locations?seen_after=1550815200000 \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \

Example Response

{
  "resources": [
    {
      "coord": [
        19.7419,
        -103.4528
      ]
    },
    {
      "coord": [
        19.2548,
        -103.6982
      ]
    }
  ],
  "totalResults": 0,
  "totalCount": 2
}

Reports exact coordinates for all the IPs we see a specific end user coming from by using geolocation.

HTTP Request

GET https://api.cymaticsecurity.com/v1/ips/sites/<sdk_uuid>/profiles/<c_uuid>/locations/

REQUEST ARGUMENTS

Parameter Type Required Description
seen_after epoch timestamp required Start date to look for records. Current time marks the end of the search.

RESPONSE

Field Description
resources List containing the target results.
resources.coord Tuples of latitude and longitude where we detect the end user coming from.

Site Locations Cities

Example Request

  curl -X GET https://api.cymaticsecurity.com/v1/ips/sites/<sdk_uuid>/locations/cities?seen_after=1550815200000 \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \

Example Response

{
  "resources": [
    {
      "location": "Ciudad Guzmán, Jalisco, MX",
      "count": 219,
      "first_seen": 1551839326850,
      "last_seen": 1552074418658
    },
    {
      "location": "Colima, Colima, MX",
      "count": 500,
      "first_seen": 1551724978182,
      "last_seen": 1552071035710
    }
  ],
  "totalResults": 0,
  "totalCount": 2
}

Similar to site locations, but in this case the coordinates are mapped to the geopolitical cities they represent. Payload also includes a count on how many times ANY end user has been seen coming from the referenced city.

HTTP Request

GET https://api.cymaticsecurity.com/v1/ips/sites/<sdk_uuid>/locations/cities

REQUEST ARGUMENTS

Parameter Type Required Description
seen_after epoch timestamp required Start date to look for records. Current time marks the end of the search.

RESPONSE

Field Description
location Representation the geopolitical division: country, state, city, the end user has been seen coming from.
count Number of times we have seen any end user coming from this geopolitical division.
first_seen First time we saw any end user coming from this geopolitical division.
last_seen Last time we saw any end user coming from this geopolitical division.

Profile Locations Cities

Example Request

  curl -X GET https://api.cymaticsecurity.com/v1/ips/sites/<sdk_uuid>/profiles/<c_uuid>/locations/cities?seen_after=1550815200000 \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \

Example Response

{
  "resources": [
    {
      "location": "Ciudad Guzmán, Jalisco, MX",
      "count": 93,
      "first_seen": 1551839326850,
      "last_seen": 1552074418658
    },
    {
      "location": "Colima, Colima, MX",
      "count": 225,
      "first_seen": 1551724978182,
      "last_seen": 1552071035710
    }
  ],
  "totalResults": 0,
  "totalCount": 2
}

Similar to profile locations, but in this case the coordinates are mapped to the geopolitical cities they represent. Payload also includes a count on how many times the end user has been seen coming from the referenced city.

HTTP Request

GET https://api.cymaticsecurity.com/v1/ips/sites/<sdk_uuid>/profiles/<c_uuid>/locations/cities

REQUEST ARGUMENTS

Parameter Type Required Description
seen_after epoch timestamp required Start date to look for records. Current time marks the end of the search.

RESPONSE

Field Description
resources List containing the target results.
resources.location Representation the geopolitical division: country, state, city, the end user has been seen coming from.
resources.count Number of times we have seen the end user coming from this geopolitical division.
resources.first_seen First time we saw the end user coming from this geopolitical division.
resources.last_seen Lastt time we saw the end user coming from this geopolitical division.

Sessions

Site Sessions

Example Request

  curl -X GET https://api.cymaticsecurity.com/v1/sessions/sites/<sdk_uuid>?seen_after=1550815200000 \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \

Example Response

  {
    "resources": [
      {
        "c_uuid": "df235c1b-f766-429b-97b6-d9cfd20f7dd1",
        "alias": "[email protected]",
        "ip": "104.218.143.66",
        "location_data": {
          "city": "Brooklyn",
          "country": "US",
          "postal": "11201",
          "region": "New York",
          "coords": [
            40.694,
            -73.9903
          ]
        },
        "trusted": true,
        "session_id": "pRMN_mgBYUVC5cIcGsNc",
        "device_id": "5c4bde7a33c793000f029372",
        "signals": {
          "bio": {
            "type": "timeout",
            "score": -5
          },
          "device": {
            "type": "score",
            "score": 100
          },
          "geo": {
            "type": "fence",
            "score": 100
          }
        },
        "flags": [],
        "created_at": 1550450498072
      },
      {
        "c_uuid": "07161e76-05f2-4e97-aa4a-d8d7157e94f2",
        "alias": "[email protected]",
        "ip": "74.108.27.39",
        "location_data": {
          "city": "Brooklyn",
          "country": "US",
          "postal": "11201",
          "region": "New York",
          "coords": [
            40.694,
            -73.9903
          ]
        },
        "trusted": true,
        "session_id": "3xOUqWgBYUVC5cIc5b-y",
        "device_id": "5c4bde7a33c793000f029372",
        "signals": {
          "bio": {
            "type": "timeout",
            "score": -5
          },
          "device": {
            "type": "score",
            "score": 100
          },
          "geo": {
            "type": "fence",
            "score": 100
          }
        },
        "flags": [
          {
            "flag_type": "password_strength",
            "payload": {
              "vulnerabilities": [
                "No uppercase characters",
                "No numeric characters",
                "No special symbols"
              ],
              "strength": "Weak"
            }
          },
          {
            "flag_type": "darkweb",
            "payload": {
              "breach_count": 951
            }
          }
        ],
        "created_at": 1549033333766
      }],
    "totalResults": 0,
    "totalCount": 2
  }

HTTP Request

GET https://api.cymaticsecurity.com/v1/sessions/sites/<sdk_uuid>

REQUEST ARGUMENTS

Parameter Type Required Description
seen_after epoch timestamp required Start date to look for records. Current time marks the end of the search.

RESPONSE

Field Description
c_uuid Cymatic's unique identifier for an end user.
alias Cymatic's alias name matching a c_uuid.
ip IPv4 detected as being the origin of the session request's.
location_data Last time we saw any end user coming from this geopolitical division.
trusted Flag that determines whether the unique user is clean or has been already identified as a risk within our network of trust.
device_id Unique cymatic identifier assigned to the mobile/desktop device identified as origin of the requests.
session_id Unique identifier assigned to all traffic records belonging to the opened websocket session of the end user.
signals This field contains pieces that sum up to the identity (high probability) of the opened session.
flags This field contains the pieces that are factors of the risk involved with the opened session.
created_at Timestamp marking the opening of the session.

Profile Sessions

Example Request

  curl -X GET https://api.cymaticsecurity.com/v1/sessions/sites/<sdk_uuid>/profiles/<c_uuid>?seen_after=1550815200000 \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \

Example Response

  {
    "resources": [
      {
        "c_uuid": "44545CD9-4C82-43B8-89EB-81D33FE24B58",
        "alias": "[email protected]",
        "ip": "104.218.143.66",
        "location_data": {
          "city": "Brooklyn",
          "country": "US",
          "postal": "11201",
          "region": "New York",
          "coords": [
            40.694,
            -73.9903
          ]
        },
        "trusted": true,
        "session_id": "pRMN_mgBYUVC5cIcGsNc",
        "device_id": "5c4bde7a33c793000f029372",
        "signals": {
          "bio": {
            "type": "timeout",
            "score": -5
          },
          "device": {
            "type": "score",
            "score": 100
          },
          "geo": {
            "type": "fence",
            "score": 100
          }
        },
        "flags": [],
        "created_at": 1550450498072
      },
      {
        "c_uuid": "44545CD9-4C82-43B8-89EB-81D33FE24B58",
        "alias": "[email protected]",
        "ip": "74.108.27.39",
        "location_data": {
          "city": "Brooklyn",
          "country": "US",
          "postal": "11201",
          "region": "New York",
          "coords": [
            40.694,
            -73.9903
          ]
        },
        "trusted": true,
        "session_id": "3xOUqWgBYUVC5cIc5b-y",
        "device_id": "5c4bde7a33c793000f029372",
        "signals": {
          "bio": {
            "type": "timeout",
            "score": -5
          },
          "device": {
            "type": "score",
            "score": 100
          },
          "geo": {
            "type": "fence",
            "score": 100
          }
        },
        "flags": [
          {
            "flag_type": "password_strength",
            "payload": {
              "vulnerabilities": [
                "No uppercase characters",
                "No numeric characters",
                "No special symbols"
              ],
              "strength": "Weak"
            }
          },
          {
            "flag_type": "darkweb",
            "payload": {
              "breach_count": 951
            }
          }
        ],
        "created_at": 1549033333766
      }],
    "totalResults": 0,
    "totalCount": 2
  }

HTTP Request

GET https://api.cymaticsecurity.com/v1/sessions/sites/<sdk_uuid>/profiles/<c_uuid>

REQUEST ARGUMENTS

Parameter Type Required Description
seen_after epoch timestamp required Start date to look for records. Current time marks the end of the search.

RESPONSE

Field Description
c_uuid Cymatic's unique identifier for an end user.
alias Cymatic's alias name matching a c_uuid.
ip IPv4 detected as being the origin of the session request's.
location_data Last time we saw any end user coming from this geopolitical division.
trusted Flag that determines whether the unique user is clean or has been already identified as a risk within our network of trust.
device_id Unique cymatic identifier assigned to the mobile/desktop device identified as origin of the requests.
session_id Unique identifier assigned to all traffic records belonging to the opened websocket session of the end user.
signals This field contains pieces that sum up to the identity (high probability) of the opened session.
flags This field contains the pieces that are factors of the risk involved with the opened session.
created_at Timestamp marking the opening of the session.

Verifications

Site Verifications

Example Request

  curl -X GET https://api.cymaticsecurity.com/v1/verifications/sites/<sdk_uuid>?seen_after=1550815200000 \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \

Example Response

  {
    "resources": [
      {
        "c_uuid": "df235c1b-f766-429b-97b6-d9cfd20f7fg1",
        "alias": "[email protected]",
        "ip": "104.218.143.66",
        "location_data": {
          "city": "Brooklyn",
          "country": "US",
          "postal": "11201",
          "region": "New York",
          "coords": [
            40.694,
            -73.9903
          ]
        },
        "trusted": true,
        "session_id": "pRMN_mgBYUVC5cIcGsNc",
        "device_id": "5c4bde7a33c793000f029372",
        "signals": {
          "bio": {
            "type": "timeout",
            "score": -5
          },
          "device": {
            "type": "score",
            "score": 100
          },
          "geo": {
            "type": "fence",
            "score": 100
          }
        },
        "flags": [],
        "created_at": 1550450498072
      },
      {
        "c_uuid": "07161e76-05f2-4e97-aa4a-d8d7157e94g3",
        "alias": "[email protected]",
        "ip": "74.108.27.39",
        "location_data": {
          "city": "Brooklyn",
          "country": "US",
          "postal": "11201",
          "region": "New York",
          "coords": [
            40.694,
            -73.9903
          ]
        },
        "trusted": true,
        "session_id": "3xOUqWgBYUVC5cIc5b-y",
        "device_id": "5c4bde7a33c793000f029372",
        "signals": {
          "bio": {
            "type": "timeout",
            "score": -5
          },
          "device": {
            "type": "score",
            "score": 100
          },
          "geo": {
            "type": "fence",
            "score": 100
          }
        },
        "flags": [
          {
            "flag_type": "password_strength",
            "payload": {
              "vulnerabilities": [
                "No uppercase characters",
                "No numeric characters",
                "No special symbols"
              ],
              "strength": "Weak"
            }
          },
          {
            "flag_type": "darkweb",
            "payload": {
              "breach_count": 951
            }
          }
        ],
        "created_at": 1549033333766
      }],
    "totalResults": 0,
    "totalCount": 2
  }

HTTP Request

GET https://api.cymaticsecurity.com/v1/verifications/sites/<sdk_uuid>

REQUEST ARGUMENTS

Parameter Type Required Description
seen_after epoch timestamp required Start date to look for records. Current time marks the end of the search.

RESPONSE

Field Description
c_uuid Cymatic's unique identifier for an end user.
alias Cymatic's alias name matching a c_uuid.
ip IPv4 detected as being the origin of the session request's.
location_data Last time we saw any end user coming from this geopolitical division.
trusted Flag that determines whether the unique user is clean or has been already identified as a risk within our network of trust.
device_id Unique cymatic identifier assigned to the mobile/desktop device identified as origin of the requests.
session_id Unique identifier assigned to all traffic records belonging to the opened websocket session of the end user.
signals This field contains pieces that sum up to the identity (high probability) of the opened session.
flags This field contains the pieces that are factors of the risk involved with the opened session.
created_at Timestamp marking the opening of the session.

Profile Verifications

Example Request

  curl -X GET https://api.cymaticsecurity.com/v1/verifications/sites/<sdk_uuid>/profiles/<c_uuid>?seen_after=1550815200000 \
  -H "Authorization: Bearer 6F63A27A-082D-49F3-9F6B-E143E0F823DA" \
  -H "Content-Type: application/json" \

Example Response

  {
    "resources": [
      {
        "c_uuid": "44545CD9-4C82-43B8-89EB-81D33FE24B58",
        "alias": "[email protected]",
        "ip": "104.218.143.66",
        "location_data": {
          "city": "Brooklyn",
          "country": "US",
          "postal": "11201",
          "region": "New York",
          "coords": [
            40.694,
            -73.9903
          ]
        },
        "trusted": true,
        "session_id": "pRMN_mgBYUVC5cIcGsNc",
        "device_id": "5c4bde7a33c793000f029372",
        "signals": {
          "bio": {
            "type": "timeout",
            "score": -5
          },
          "device": {
            "type": "score",
            "score": 100
          },
          "geo": {
            "type": "fence",
            "score": 100
          }
        },
        "flags": [],
        "created_at": 1550450498072
      },
      {
        "c_uuid": "44545CD9-4C82-43B8-89EB-81D33FE24B58",
        "alias": "[email protected]",
        "ip": "74.108.27.39",
        "location_data": {
          "city": "Brooklyn",
          "country": "US",
          "postal": "11201",
          "region": "New York",
          "coords": [
            40.694,
            -73.9903
          ]
        },
        "trusted": true,
        "session_id": "3xOUqWgBYUVC5cIc5b-y",
        "device_id": "5c4bde7a33c793000f029372",
        "signals": {
          "bio": {
            "type": "timeout",
            "score": -5
          },
          "device": {
            "type": "score",
            "score": 100
          },
          "geo": {
            "type": "fence",
            "score": 100
          }
        },
        "flags": [
          {
            "flag_type": "password_strength",
            "payload": {
              "vulnerabilities": [
                "No uppercase characters",
                "No numeric characters",
                "No special symbols"
              ],
              "strength": "Weak"
            }
          },
          {
            "flag_type": "darkweb",
            "payload": {
              "breach_count": 951
            }
          }
        ],
        "created_at": 1549033333766
      }],
    "totalResults": 0,
    "totalCount": 2
  }

HTTP Request

GET https://api.cymaticsecurity.com/v1/verifications/sites/<sdk_uuid>/profiles/<c_uuid>

REQUEST ARGUMENTS

Parameter Type Required Description
seen_after epoch timestamp required Start date to look for records. Current time marks the end of the search.

RESPONSE

Field Description
c_uuid Cymatic's unique identifier for an end user.
alias Cymatic's alias name matching a c_uuid.
ip IPv4 detected as being the origin of the session request's.
location_data Last time we saw any end user coming from this geopolitical division.
trusted Flag that determines whether the unique user is clean or has been already identified as a risk within our network of trust.
device_id Unique cymatic identifier assigned to the mobile/desktop device identified as origin of the requests.
session_id Unique identifier assigned to all traffic records belonging to the opened websocket session of the end user.
signals This field contains pieces that sum up to the identity (high probability) of the opened session.
flags This field contains the pieces that are factors of the risk involved with the opened session.
created_at Timestamp marking the opening of the session.