checkLogin — Checking if a login already exists

The checkLogin method checks if a user login already exists in the SiteLock database. A login can be the user’s email address or just an alphanumeric combination.

The API endpoint is:

https://api.sitelock.com/v1/partner

Request format

SiteLockOnlineRequest: This element is used to delineate the full API request.
- authentication: The partner’s username, password, and branding
  - username: The partner’s API username
  - password: The partner’s API password
  - partner: (Optional) The brand name to use in messaging
- checkLogin: The method name
  - login: The login to check

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>xxx</user>
        <password>x</password>
    </authentication>
    <checkLogin>
        <login>[email protected]</login>
    </checkLogin>
</SiteLockOnlineRequest>

Response format

SiteLockOnlineResponse: This element is used to delineate the full API response.
- checkLogin: The method name
  - login: The login that was checked
  - message: The detailed success or error message
  - status: The status of the request. The value can be one of the following:
    
    ok: The request was successful. In the context of this request, this means no such login exists.
    
    error: An error occurred. The message element contains more detail.

Example success response

<SiteLockOnlineResponse>
    <checkLogin>
        <login>[email protected]</login>
        <message>login is available</message>
        <status>ok</status>
    </checkLogin>
</SiteLockOnlineResponse>

Example error response

<SiteLockOnlineResponse>
    <checkLogin>
          <login>[email protected]</login>
          <message>Login is in use by another account.</message>
          <status>error</status>
    </checkLogin>
</SiteLockOnlineResponse>