BOOK A DEMO
LOGIN
Homekeyboard_arrow_rightDocumentationkeyboard_arrow_rightVersion 3keyboard_arrow_rightAccountkeyboard_arrow_rightLogin
POST

https://id.copyleaks.com/v3/account/login/api

Login to the Copyleaks API using your email and API key.

Once logged in, you will get back a login token that will be used to authenticate yourself when calling the other API methods.

After generating the login-token, you should attach the token for your next calls. Attaching the endpoint is done by adding this header to your calls: Authorization: Bearer TOKEN .

A generated token is valid for 48 hours. Within this period of time, you can use it multiple times. Before attaching the Authorization for your next endpoint calls, make sure that the token has not expired. If it expired, generate a new one.

warning
Handle tokens carefully
The Copyleaks API token should be treated as a password. Attackers, who can gain access to this token, can access your private information and modify it.

Request

Body Parameters

Name
Description
emailREQUIRED
Your Copyleaks account email address.
String (email)
Example: "[email protected]"
keyREQUIRED
Your Copyleaks account API key.
String (guid)
Example: "00000000-0000-0000-0000-000000000000"

Request Example

RAW
cURL
Python
C#
Node.js
PHP
POST
https://id.copyleaks.com/v3/account/login/api
Headers
Body
email: "[email protected]"
key: "00000000-0000-0000-0000-000000000000"

Response

Codes

Status Code
Description
Example
200
The command was executed.
{
  "access_token": "ACLNSKNSDAACCAJANCOIUiausoo_saidjaskldjoa...",
  ".issued": "2018-11-24T16:15:38.2431255+02:00",
  ".expires": "2018-11-24T16:15:38.2431255+02:00"
}
See resource description
400
Bad request.
{
  "email": [
    "The email is required."
  ]
}
401
Unauthorized

Wrong email address and \ or key.

{
  "Message": "Bad request. One or several required parameters are missing or incorrect."
}
429
Too many requests have been sent. The request has been rejected.

This may happen when sending too many scans in Sandbox mode.

TIP: Reuse your key as much as possible.

Description

Name
Description
access_token
Your API token details. Use this token to access your private Copyleaks API services.
String
Treat this value as a password.
.issued
Token issue date
String (datetime)
Time zone: UTC+0
.expires
Token expiration date. Your token will be deactivated after this date.
String (datetime)
Time zone: UTC+0

Other resources:

  • Performance Considerations Important! - How to improve your scan performance.
  • Exponential Backoff - Algorithm that helps applications define a retry strategy for consuming a network service.
stack-overflow_icon.png

Do you have a technical question?

Use stackoverflow.com to get help from our development team and other Copyleaks users.

Ask a Question

PRODUCTS

Scans
Pricing
Copyleaks.com

RESOURCES

Documentation
Plagiarism Report
Help Center
System Status
Security

ABOUT

About us
Careers
Terms of Use
Privacy Policy
Sitemap

Copyleaks, Inc.

700 Canal St.
Stamford, CT 06902 USA

[email protected]

Copyleaks, Inc. All rights reserved. Use of this website signifies your agreement to the Terms of Use.

Copy