Lookup Credentials Check

POST api.ravelin.com/v2/lookup/credentials/check

username string
required

The username to check in our breached credentials database.

passwordHash string
required

The SHA256 hash of the password being used with the username, to check in our breached credentials database. This should be hex encoded and be 64 characters long.

Do not send plaintext passwords.

We do not store the hashed passwords, we discard them immediately after processing the request.

Response

usernameBreached boolean

Indicates that the username was found in our breached credentials database.

passwordBreached boolean

Indicates that the password is either associated with the given username in our breached credentials database, or that the password is one of the most commonly used passwords.

numBreachedPasswords integer

The number of breached passwords found for the given username.

status integer

If there was an error, the response HTTP status code.

message string

If there was an error, a description of the error.

timestamp integer

If there was an error, the time the error occurred.

traceId string

If there was an error, a trace ID for the request, to be used internally by Ravelin.

Feedback

© Ravelin Technology Ltd. All rights reserved