Responses

When you submit a request, you’ll receive one of the following responses to inform you if it was accepted or not:

201 Created
The verification process was created and returned processId and checkoutUrl, where the shopper should be now redirected to.

400 Bad request
We cannot accept the payload from the request you sent because the data is invalid or malformed. The response will contain a description of the actual problem.

401 Access denied
Your credentials were invalid. It may be that the token you’ve used has expired. You will need to re-authenticate and then resubmit this request with valid or updated credentials. This is usually because you have not supplied a valid authentication token.

403 Not authorised
Although your credentials are correct, your access to the API has been disabled or limited. Subsequent requests to this endpoint (even with valid data) will not be processed.

Example success response
{
   "processId": "e6d4c6e5-5efa-49e5-ae1b-ba440643acf3",
   "checkoutUrl": "http://checkout.example.com?auth=jwt.token&language=en&country=EN"
}
General error response layout
{
   "exception": {
      "code": "Some-Internal-Error-Code",
      "message": "Some error exception description"
   }
}
Example validation error payload
{
   "exception": {
      "code": "Volt-Exception-Validation-ConstraintValidation",
      "message": "Validation exception",
      "errors": [
         {
            "property": "uniqueReference",
            "message": "This value is too long. It should have 36 characters or less."
         },
         {
            "property": "country",
            "message": "This value is not a valid country."
         }
      ]
   }
}