PATCH
/v3/businesses/start
Start scanning all the files you submitted for a price-check.
Add this HTTP header to your request: You need to login with a user and api key in order to access this method.
Authorization: Bearer <Your-Login-Token>
Not sure how to generate your login token? Read here .
Request
Body Parameters
Name
Description
trigger
REQUIREDString array Example:
This array can scan up to 100 submissions.
[ "Your-scan-id-1", "Your-scan-id-2" ]
This array can scan up to 100 submissions.
errorHandling
IntegerDefault Value:
0
Possible Values:0
: Cancel 1
: Ignore
Request Example
RAW
cURL
Python
C#
Node.js
PHP
PATCH
https://api.copyleaks.com/v3/businesses/start
Headers
Body
Response
Codes
Status Code
Description
Example
200
{ "success": [ "Your-scan-id" ], "failed": [] }
400
{ "trigger": [ "The trigger is required." ] }
401
Authorization has been denied for this request.
Other resources:
- Exponential Backoff - Algorithm that helps applications define a retry strategy for consuming a network service.

Do you have a technical question?
Use stackoverflow.com to get help from our development team and other Copyleaks users.