API Error Messages

This is an example error message from /slverify

{
    "errorCode": "DATA_VALIDATION_ERROR",
    "errorDescription": "Missing attribute. This service requires attribute FullName but it was not found. Please check your inputs and retry."
}

When you encounter an error in the AXN API, you will receive an Error Code and an Error Description.

Error Code describes the category of error.

Error Descriptions describe the error in greater detail. The most common error messages are below:

Error Code:	Error Description:	Recommendation
`AUTHORIZATION FAILURE`	Invalid granttype. Expected: client_credentials	Check the request parameters and make sure they match the expected values from IDW documentation.
AUTHORIZATION_FAILURE	Token provided is not valid for reason:	The token provided in the request is not valid. If possible, the AXN will try to provide a detailed reason as to why the token is not valid. In some cases, the reason will be unknown. In this case, create a new token and try again. If this persists, contact IDW support.
AUTHORIZATION_MISSING	Error extracting information from auth headers Authorization header missing or empty.	Check the header in your request, make sure the Authorization header is present and properly formatted.
INVALID_INPUT	An error ocurred when parsing the input attributes.	There was a general error when trying to parse the provided attributes, please verify that they match the IDW documentation and try again.
INVALID_INPUT	Error validating auth headers. Incorrect shared secret.	The authentication header provided was invalid. Check that the authentication information, specifically the shared secret, is correct and formatted appropriately and try again.
INVALID_INPUT_PARAMETERS	User not found with passed mbun.	The MBUN identifier provided for this user does not exist.
INCORRECT_ARGUMENTS	Missing required field: . Missing or invalid value for required field:	A required field was missing - please check the fields you have provided and try again.
INCORRECT_ARGUMENTS	This service is not properly configured to send PINCode using the specified method. Missing required attribute:	The service is attempting to send a PIN to an attribute but the service and parameters are not properly configured. Double check that you have configured and sent the correct attributes for your PIN service.
INVALID_METHOD	Method must be either SMS, VOICE or EMAIL	The method parameter provided was not a valid method. See IDW documentation for valid methods for PIN verification.
INVALID_ASI	Unable to retrieve session for ASI	The ASI provided is either invalid, malformed, or no longer exists.
INVALID_ATTRIBUTE	Invalid Attribute ID	Check the configuration and attributes provided for this service
INVALID_DIAL_CODE	Invalid Dial Code	Attribute provided is invalid or missing.
INVALID_PHONE_NUMBER	Invalid Phone Number	Attribute provided is invalid or missing.
INVALID_EMAIL_ADDRESS	Invalid Email Address	Attribute provided is invalid or missing.
USER_NOT_FOUND	User with passed credential not found. Please use /verify post method instead.	User found for this session does not exist. Check that the parameters are correct and start again.
INVALID_INPUT_PARAMETERS	User not found with passed mbun.	User found for this session does not exist. Check that the parameters are correct and start again.
INVALID_SERVICE	Service not configured in AXN with input apikey.	APIKey is invalid, verify and try again.
INVALID_INPUTS	Error validating auth headers. Incorrect shared secret.	Shared secret is invalid, verify and try again.
FILE_NOT_FOUND	File not found	Cannot retrieve document file, files have expired or have been deleted. Retry the verification process.
LINK_EXPIRED	Link has expired	This link used has expired - generate a new link and try again.
DOWNLOAD_LIMIT_REACHED	Max view count has been reached	The number of download attempts has been exceeded and you will need to start the verification process again.
INVALID_PRESIGNED_URL	Failed to retrieve the file for asi:	This link used has expired - generate a new link and try again.
INVALID_SERVICE_OFFERING	Service Offering is not an OOB PIN Verification Service	In order for this service to send PIN messages, it needs to have a PIN service configured properly.
MAXIMUM_PIN_RESENDS_EXCEEDED	Maximum number of PIN re-sends has been exceeded	You have exceeded the PIN re-send limit for this service, and will need to validate the existing PIN or move on.
INVALID_ASI_OR_ATTRIBUTE	Unable to retrieve PIN data for the ASI and Attribute given	The information provided is invalid, double check the values and try again.
MAXIMUM_PIN_VERIFICATIONS_EXCEEDED	Maximum number of PIN verifications has been exceeded	You have exceeded the PIN limit for this service, and will need to move on or try again.
INCORRECT_PIN	Incorrect PIN	The PIN provided does not match what was expected.
SERVER_ERROR	Server Error	While trying to send a PIN code, there was a general fatal error and we cannot continue the transaction. Try again and if the issue persists, contact IDW support
EXPIRED_PIN	PIN has expired	The PIN has expired and you will need to start again.
GENERAL_PROCESSING_ERROR	Error occurred with link account processing.	Account Link failed, check account settings and try again.
AP_GATEWAY_FAILURE	Exception occurred with verification:	The AXN encountered an exception while trying to communicate with a vendor, that transaction cannot continue. The AXN may attempt to set the assertions to “unverified” and continue without them.
API_SERVICE_FAILURE	Error while processing SOs: <Attribute Provider(s)>	There was a general and fatal error when processing an Attribute Provider. Try again and if the issue persists, Contact IDW support
API_SERVICE_FAILURE	Input AXN session id could not be located. Please try again.	The session you are using (ASI) is invalid, and the api cannot continue. Check the ASI used and retry. If this persists, contact IDW support.
API_SERVICE_FAILURE	Error occurred when getting doc capture status for asi:	The Document Capture session is invalid, and the api cannot continue. Check the ASI used and retry. If this persists, contact IDW support.
API_SERVICE_FAILURE	The request attributes are not properly populated. Missing required attribute:	A required attribute was missing - please check the fields you have provided and try again.
API_SERVICE_FAILURE	Exception occurred with verification:	The AXN encountered a general exception and cannot continue. The AXN may attempt to set the assertions to “unverified” and continue without them. Please verify that the configuration for this service or workflow is correct and try again. If the issue persists, contact IDW support.
API_SERVICE_FAILURE	Exception occurred processing fallback service offerings	There was a general and fatal error when processing a fallback Attribute Provider. Try again and if the issue persists, contact IDW support.
DATA_VALIDATION_ERROR	`<Various descriptions>`	A Data Validation Error means that our API tried to parse an Attribute value that was passed in, but one or more fields were missing, malformed, or otherwise not readable. The Error Description will describe which field failed validation along with a reason why, if possible. Check the formatting for your input Attributes and adjust.
GENERIC_PROCESSING_FAILURE API_GENERAL_FAILURE GENERAL_FAILURE	`<Various descriptions>`	The AXN encountered a fatal and unexpected error and cannot continue. Please double check your service configuration and request parameters and try again. If this persists, please contact IDW support.