Contents x
    Credential Intelligence API
    • 18 Sep 2023
    • Print
    • Dark
      Light
    Contents

    Credential Intelligence API

    • Updated on 18 Sep 2023
    • Print
    • Dark
      Light
    Article Summary

    This API provides a quick analysis of whether the credentials are flagged by Credential Intelligence collection as compromised or not via a RESTful service.

    Authentication

    TO access the Feedback API:

    1. Generate a valid authentication token as explained in Setting up your Application.
    2. Paste the authentication token into the HTTP Authorization header.
    Authorization: Bearer <TOKEN>

    Endpoint

    HTTP MethodRequest URL
    POSTsapi-<appid>.perimeterx.net/api/v1/is_compromised

    Request Schema

    ParameterTypeValueRequired/Optional
    appIdStringApplication IDRequired
    credentialsString*A hashed, salted, and normalized version of the credential pairRequired

    * Contact us to get the normalization and hashing code

    Example

    {
    "appId": "PXD0RD8T1a",
    "credentials": "de2765c384f9304585d06259d96610fe4de3ca7e883e8941dca241b76dce83cc"
}

    Response Schema

    CodeResponseDescription
    True200The credentials were detected as compromised by Credential Intelligence
    False200The credentials were not detected as compromised by Credential Intelligence
    Null500Internal error. Contact support if the error persists
    Null401Non-authorized. Check the JWT validation and make sure this is the JWT belongs to the correct app ID.
    Null429The rate limit is exceeded. To increase the rate limit, contact support

    Example

    {
    "compromised": "false",
}
    Was this article helpful?
    What's Next