Error Handling

Error Response

Here is a sample object for the error response, check the below table for more detailed information:

{
  "success": false,
  "message": "ERROR MESSAGE",
  "error_code":"<ERROR_CODE>"
}

Property

Description

success

  • *Type**: bool
    A boolean indicates whether the operation completed successfully or not.

message

  • *Type**: string
    A descriptive message that provides additional context about the error.

error_code

  • *Type**: string
    A code that identifies the type of error encountered during the process. Useful for troubleshooting, this code allows developers to pinpoint specific issues and consult related documentation or support resources. Please check below for possible error codes.

Error Codes

Error Code

Description

API Applicability

Response Status

missing_authorization_header

The request does not include an Authorization header, which is required for authentication.

all APIs

401

invalid_credentials

The credentials provided in the request are invalid. This error typically occurs when the username/ password or API Key/API Secret are incorrect or do not match the records.

all APIs

401

invalid_authentication_format

The authentication information provided in the request is improperly formatted. This error typically occurs when the Authorization header does not adhere to the required structure (e.g., missing token type or malformed token).

all APIs

401

unauthorized

The credentials provided in the request belong to a different environment (e.g., sandbox or live) or tenant. This error occurs when there is a mismatch between the authentication key and the target resource. Double check the API Key/API Secret pair you are using belong to the correct tenant and environment of the journey you are trying to access

all APIs

403

not_allowed_ip_address

The request has been denied because the IP address of the client is not on the allowed whitelist. Access is restricted to specific IP addresses configured in the system.

all APIs

403

missing_requested_resource

This error typically occurs if the request resource does not exist in the system, or has been deleted.

all APIs

404

invalid_request

The request is not valid for the current state of the resource or operation.

all APIs

400

missing_parameter

This error occurs when mandatory fields are not included in the payload, query string, or headers.

all APIs

400

invalid_flow_definition

The flow definition provided in the request is invalid. This could be due to missing or incorrect steps, or invalid configurations.

start journey

400

invalid_step_id

This error occurs when the step ID is either missing or not defined as part of the flow.

process journey step

400

invalid_image

This error is triggered when the uploaded file is not an image or is a corrupted image file.

process journey step

400

invalid_image_format

This error occurs when the provided image is not in an acceptable format or does not meet the necessary specifications required by the system.

process journey step

400

invalid_image_dimensions

The uploaded image does not meet the required height and width specifications.

process journey step

400

invalid_pdf_password

This error occurs when the provided password for the PDF file is incorrect or missing.

process journey step

400

invalid_spot_check_request

The spot check request is invalid because there is either no accepted associated onboarding journey (Complete or Approved), or the onboarding journey exists but does not include a selfie step.

start journey
process journey step

400

invalid_aml_configuration

The Anti-Money Laundering (AML) configuration provided in the request is invalid. This error occurs when the configuration settings for the AML process are incorrect or incompatible with the system requirements.

update aml whitelist status

400

ogm_error_no_aml_record

The operation could not be completed because no AML record exists for the specified entity.

set ongoing monitoring

400

ogm_error_no_successful_aml

The operation could not be completed because there is no successful AML check for the specified entity.

set ongoing monitoring

400

ogm_error_incomplete_journey

This error occurs when the journey required for enabling ongoing monitoring is incomplete.

set ongoing monitoring

400

update_not_supported

This error occurs the AML record is old or doesn't support OGM or whitelist feature.

set ongoing monitoring update aml whitelist status

400

internal_server_error

This error indicates that an unexpected internal server error occurred while processing the request. This is a generic error for issues within the server.

all APIs

500

generic_error

Indicates a generic or unexpected error. Please reach out to support if the issue persists.

all APIs

Indicates that the IDWise API is temporarily unavailable due to high server load. If no response is received, requests will time out after 30 seconds. Recommended action: Retry the request after a short delay.

all APIs

503