HTTP Responses

HTTP Status Code	Status Name	Status Message
200	SUCCESS	Success
200	SITE_NOT_CONFIGURED	Data has been received for this profile, though the site still needs to be configured to calculate an accurate result.
200	NOT_ENOUGH_INTERACTION_DATA	Data has been received for this profile, though some signals may have insufficient data to calculate a result.
400	BAD_REQUEST	Malformed request
400	MISSING_REQUIRED_QUERY_PARAMETER	Missing a required query parameter
401	MISSING_API_KEY	Missing API key
401	UNAUTHORIZED_API_KEY	API key does not have access to this site ID or resource
401	UNAUTHORIZED_ACCESS	Invalid API key
403	ACCESS_DENIED	Access denied
404	NOT_FOUND	Resource not found
404	PROFILE_NOT_FOUND	No profiles found for the given ID and Site ID
406	NOT_ACCEPTABLE	Not Acceptable
500	UNKNOWN_ERROR	An unknown server error occurred

Example Response Objects

200 SUCCESS

{
  "status": "SUCCESS",
  "message": "success",
  "moreInfo": null,
  "profile": {
    "id": "MY-USER-ID",
    "siteId": "form_mySiteID",
    "funnel": "funnelNameIfConfigured",
    "clientId": "browserID",
    "signals": [
      {
        "model": "fraud_ring_indicator",
        "label": "true"
      },
      {
        "model": "automated_activity",
        "label": "false"
      },
      {
        "model": "combined_digital_intent",
        "label": "risky"
      },
      {
        "model": "familiarity",
        "label": "medium"
      },
      {
        "model": "risky_device",
        "label": "true"
      }
    ]
  }
}

200 SITE_NOT_CONFIGURED

{
  "status": "SITE_NOT_CONFIGURED",
  "message": "Data has been received for this profile, though the site still needs to be configured to calculate an accurate result.",
  "moreInfo": "https://neuro-id.readme.io/reference/analytics-api-v41#200-site_not_configured",
  "profile": {
    "id": "MY-USER-ID",
    "siteId": "form_mySiteID",
    "funnel": "funnelNameIfConfigured",
    "clientId": "browserID",
    "signals": [
      {
        "model": "fraud_ring_indicator",
        "label": "false"
      },
      {
        "model": "automated_activity",
        "label": "false"
      },
      {
        "model": "combined_digital_intent",
        "label": "insufficient data"
      },
      {
        "model": "familiarity",
        "label": "insufficient data"
      },
      {
        "model": "risky_device",
        "label": "false"
      }
    ]
  }
}

200 NOT_ENOUGH_INTERACTION_DATA

{
  "status": "NOT_ENOUGH_INTERACTION_DATA",
  "message": "Data has been received for this profile, though some signals may have insufficient data to calculate a result.",
  "moreInfo": "https://neuro-id.readme.io/reference/analytics-api-v41#200-not_enough_interaction_data",
  "profile": {
    "id": "MY-USER-ID",
    "siteId": "form_mySiteID",
    "funnel": "funnelNameIfConfigured",
    "clientId": "browserID",
    "signals": [
      {
        "model": "fraud_ring_indicator",
        "label": "false"
      },
      {
        "model": "automated_activity",
        "label": "false"
      },
      {
        "model": "combined_digital_intent",
        "label": "insufficient data"
      },
      {
        "model": "familiarity",
        "label": "insufficient data"
      },
      {
        "model": "risky_device",
        "label": "false"
      }
    ]
  }
}

400 BAD_REQUEST

{
  "status": "BAD_REQUEST",
  "message": "Malformed request",
  "moreInfo": "https://neuro-id.readme.io/reference/analytics-api-v41#400-bad_request"
}

400 MISSING_REQUIRED_QUERY_PARAMETER

{
  "status": "MISSING_REQUIRED_QUERY_PARAMETER",
  "message": "Missing a required query parameter",
  "moreInfo": "https://neuro-id.readme.io/reference/analytics-api-v41#400-missing_required_query_parameter"
 }

401 MISSING_API_KEY

{
  "status": "MISSING_API_KEY",
  "message": "Missing API key",
  "moreInfo": "https://neuro-id.readme.io/reference/analytics-api-v41#401-missing_api_key"
 }

401 UNAUTHORIZED_API_KEY

{
  "status": "UNAUTHORIZED_API_KEY",
  "message": "API key does not have access to this site ID or resource",
  "moreInfo": "https://neuro-id.readme.io/reference/analytics-api-v41#401-unauthorized_api_key"
}

401 UNAUTHORIZED_ACCESS

{
  "status": "UNAUTHORIZED_ACCESS",
  "message": "Invalid API key",
  "moreInfo": "https://neuro-id.readme.io/reference/analytics-api-v41#401-unauthorized_access"
}

403 ACCESS_DENIED

{
  "status": "ACCESS_DENIED",
  "message": "Access denied",
  "moreInfo": "https://neuro-id.readme.io/reference/analytics-api-v41#403-access_denied"
}

404 NOT_FOUND

{
  "status": "NOT_FOUND",
  "message": "Resource not found",
  "moreInfo": "https://neuro-id.readme.io/reference/analytics-api-v41#404-not_found"
}

404 PROFILE_NOT_FOUND

{
  "status": "PROFILE_NOT_FOUND",
  "message": "No profiles found for the given ID and Site ID",
  "moreInfo": "https://neuro-id.readme.io/reference/analytics-api-v41#404-profile_not_found"
}

406 NOT_ACCEPTABLE

{
  "status": "NOT_ACCEPTABLE",
  "message": "Not Acceptable",
  "moreInfo": "https://neuro-id.readme.io/reference/analytics-api-v41#406-not_acceptable"
}

500 UNKNOWN_ERROR

{
  "status": "UNKNOWN_ERROR",
  "message": "An unknown server error occurred",
  "moreInfo": "https://neuro-id.readme.io/reference/analytics-api-v41#500-unknown_error"
}

*HTTP Status 200 Responses can have the possible label values for its signals:

Signal Name	Label Values
fraud_ring_indicator	true, false, insufficient data
automated_activity	true, false, insufficient data
combined_digital_intent	risky, neutral, genuine, insufficient data
familiarity	low, medium, high, insufficient data
risky_device	true, false
login_risky_device	true, false
session_login_fraud_ring_indicator	true, false, insufficient data
session_login_automated	true, false, insufficient data