Calling Verify API
Requests to the Verify API can either be sent via:
-
An
application/json
body (POST) -
An HTTP header.
POST Request Parameters
This table shows the parameters that should be included within the POST requests.
Information on the current Verify API request and response schema is in the documentation at Verify Request and Response Schemas. The source information for it is at the following URLs. Please substitute your own customized URL for the descriptions and examples used in this document.
-
Verify request schema:
<company>-verify.arkoselabs.com/api/v4/verify/schema/request
-
Verify response schema:
<company>-verify.arkoselabs.com/api/v4/verify/schema/response
e.g.
https://acme-verify.arkoselabs.com/api/v4/verify/schema/request
https://acme-verify.arkoselabs.com/api/v4/verify/schema/response
Here is an example of how to get the response schema using cURL:
curl https://<company>-verify.arkoselabs.com/api/v4/verify/schema/request
The generic URLs will continue working until all customers are using their personalized URLs; e.g.
http://verify.arkoselabs.com/api/v4/verify/schema/request
http://verify.arkoselabs.com/api/v4/verify/schema/response
Parameter Name | Required / Optional | Description |
---|---|---|
private_key | Required | The private key issued by Arkose Labs along with the public key used for the client-side API. |
session_token | Required | The token value contained within the token key of the client-side API response object. This object is provided within the client-side onComplete callback. |
log_data | Optional | A freeform string that allows information to be passed to the Verify API. This can be used to pass basic information that you want stored by Arkose with the session data. This can be used internally by Arkose when performing manual traffic analysis. |
POST request
The POST request requires the use of the request body. Below is an example of a JSON request body using the parameters from the table above. Note that you can send the email_address
field only via POST requests.
Arkose Email Intelligence Available As An Add-On Feature
Email Intelligence, which involves assessing the risk based on the email address, is an add-on feature to Arkose Bot Manager. For more information, see the Knowledge Base (support login required) here and here.
Talk to your account rep to check if you qualify for a free trial.
{
"private_key" : "_PRIVATE_KEY_HERE_",
"session_token" : "_SESSION_TOKEN_HERE_",
"log_data" : "_LOG_DATA_HERE_",
"email_address" : "_EMAIL_ADDRESS_HERE_"
}
HTTP Header Request
Requests using HTTP headers do not support
log_data
In the instructions above, the private key and session token are passed via the URL query parameters or POST body. An alternative method of passing the private key and session token to the Verify API is via HTTP headers on the request. The table below shows the name of the headers that should be used.
Parameter Name | Required / Optional | Description |
---|---|---|
Arkose-Private-Key | Required | This is the private key issued by Arkose Labs along with the public key used for the client-side API |
Arkose-Session-Token | Required | This is the token value contained within the token key of the client-side API response object. This object is provided within the client-side onComplete callback |
Here is an example of providing the required data using the headers listed above in a simple Curl command.
curl -H "Content-Type: application/json" -H "Arkose-Private-Key: <your private key>" -H "Arkose-Session-Token: <value of verification-token>" https://<company>-verify.arkoselabs.com/api/v4/verify/
Updated about 1 month ago