The Conferma API will return an error response body containing additional error details. The following is an example error response:

{
  "errorCode": "error_code",
  "message": "error_description",
  "details": [ 
  {
    "field": "field_name",
    "issue": "problem_with_field"
  }]
}

Validation Errors

For validation errors, the API returns the HTTP 400 Bad Request status code.

To prevent validation errors, ensure that the parameters are the right type and conform to these constraints:

Validation Type	Description
Character Limit	Names, addresses, references, labels etc. all have maximum character limits.
Character Sets	All `String` input types have an applied validation group, restricting the permitted character sets.
Numeric	Amount, percentages and limits must use non-negative numeric values.
Required	Must be included in the request. For example, when you create a new card deployment, you must provide an amount.
Range	Dates and numeric values may have a minimum or maximum value.

Authentication Errors

The API will return the HTTP 401 Unauthorized status code for authentication errors.

Access token related issues often cause authentication errors. Ensure the access token is present, valid and not expired.