REST Error Codes

Introduction

This document contains all REST error codes for the Athr-server, Process Manager, and User Data servers.

Common Error Codes

Code	Description
1	An unexpected error occurred.
7	Access to this service is denied.
264	A permission contains an unrecognized type.

Code	Description
220	The JWT could not be parsed.
221	The JWT has no header.
222	The JWT has no kid in the header.
223	The JWT has no alg in the header.
224	The JWT has no body.
225	The JWT issuer is not valid - jwt is not issued by Sky.
226	The JWT owner is not valid - jwt is not issued for person with id %s.

Code	Description
271	A JWT API Key failed validation.
273	A JWT API Key could not be decompressed.
274	A JWT was not correctly constructed.
275	A JWT claim value is not of the required type.
276	A JWT signature failed to validate.
277	A JWT was not in the expected configuration / format.
278	A JWT claim could not be validated.
279	The JWT has expired.
280	A JWT is not yet valid.
281	A JWT has an incorrect claim value.
282	A JWT has a missing claim.

General Error Codes

Athr-server Error Codes

Code	Description
1	An unexpected error occurred.
7	Access to this service is denied.

Code	Description
130	The specified API Key could not be found.
131	An API Key with that name already exists.
133	An API Key was found with the specified ID - but the codes don't match!
134	An API Key was found with the specified ID - but it is not valid!
145	The API Key header, X-API-Key, has not been set.
146	The API Key header, X-AccessToken, must be of the format key.code.

Code	Description
250	The response type is invalid!

Process Manager Error Codes

Code	Description
1	An unexpected error occurred.
7	Access to this service is denied.
9	The API request contains invalid data in one of the input fields: %s
10	The API request is invalid. The following constraints have been violated: %s

Code	Description
100	The specified tenant could not be found.
101	The specified tenant already exists.
102	The tenant domain cannot be created as its domain string is empty or null.
103	Cannot create the tenant domain. The domain string does not contain two regions.
110	The specified process definition could not be found.
111	A process definition with the same name already exists.
112	The status of the process definition cannot be changed from EDITABLE to RETIRED.
113	The status of the process definition cannot be changed to EDITABLE.
114	The status of the process definition cannot be changed from RETIRED.
115	The process definition cannot be changed as it has been deployed.
116	The process definition name cannot be changed.
117	The process definition version cannot be changed.
118	The process definition status cannot be changed except during a deploy operation.
119	No active process definition with the provided name and version can be found.
149	The process definition type cannot be changed.

Code	Description
120	The specified process token could not be found.
121	A process token with the same name already exists.
122	The process token cannot be used as it is inactive.
123	The process token cannot be used as it has reached its max use limit.
124	The process token cannot be used as it not within its specified time window.
125	The process token max count field must be provided and the value greater than 0.
126	The process token not after field must be provided and in the future.
126	The Not After value must be no longer than 1 year after Not Before value.
127	The process token not before field must be provided and before the not after field.
128	The parameters associated with a process token may only be Strings, Booleans or Numbers.
129	The maximum process duration associated with the process token must be less than the maximum duration: %s.

Code	Description
130	The specified process instance could not be found.
131	The process instance has been completed - it cannot be updated.
132	The status of the process instance cannot change from active to pending.
133	The process instance cannot be updated as its status is not active or pending.

Code	Description
134	The process instance cannot be deleted as its status is active or pending.

Code	Description
148	The received bpmn file was invalid. %s

Code	Description
160	The specified script could not be found.
161	A script with the same name already exists.
162	The status of the script cannot be changed from EDITABLE to RETIRED.
163	The status of the script cannot be changed to EDITABLE.
164	The status of the script cannot be changed from RETIRED.
165	The script cannot be changed as it has been deployed.
166	The script name cannot be changed.
167	The script version cannot be changed.
168	The script status cannot be changed except during a deploy operation.
169	No active script with the provided name and version can be found.
170	An unexpected error occurred while attempting to test the script.

Code	Description
180	The specified function could not be found.
181	A function with the same name already exists.
182	The status of the function cannot be changed from EDITABLE to RETIRED.
183	The status of the function cannot be changed to EDITABLE.
184	The status of the function cannot be changed from RETIRED.
185	The function cannot be changed as it has been deployed..
186	The function name cannot be changed.
187	The function version cannot be changed.
188	The function status cannot be changed except during a deploy operation.
189	The function type cannot be changed.
190	No active function with the provided name and version can be found.
191	An unexpected error occurred while attempting to test the function.
192	The cloud function cannot be deleted - this is the latest version, a new version should be added before deleting this one.

Code	Description
193	The specified form could not be found.
194	The custom data form cannot be deleted - this is the latest version, a new version should be added before deleting this one.
195	A custom data form with the same name already exists..
196	The custom data form cannot be changed as it has been deployed.
197	The custom data form name cannot be changed.
198	The custom data form version cannot be changed.
199	The custom data form status cannot be changed except during a deploy operation.

Code	Description
210	The requested process definition template could not be found.
211	Access to process definition template is forbidden.
212	The API request contains invalid data in one of the input fields: %s Error: must not be blank.

Code	Description
213	Cannot find activity definition by skyid.
214	Additional docs version not supported.

Code	Description
11000	The process definition cannot be deleted - there are process tokens using the process definition.
11001	The process definition cannot be deleted - there are process instances using the process definition.
11002	The bpmn file of the process definition does not exist.
11003	The process definition cannot be deleted - this is the latest version, a new version should be added before deleting this one.

Processing Server Error Codes

Code	Description
1	An unexpected error occurred. Please see the log files.
2	We could not process your document, please try again.
3	We could not process your face image, please try again.
4	We could not process your application, please try again.

Code	Description
101	An unexpected error occurred. Please see the log files.
102	We could not process your document, please try again.
103	We could not process your face image, please try again.
104	We could not process your application, please try again.
105	A process instance with this ID is already running.
106	Unauthorized request. Invalid JWT.
120	Error while trying to check face liveness.
121	Exceeded number of total retries.
122	An unexpected error occurred while generating face template.
123	An exception was thrown while generating pre signed url.
124	An exception occurred while checking document quality.
126	Black&White copy detection has failed.
127	Color copy detection has failed.
128	Photo sub detection has failed.

Code	Description
129	An exception occurred while processing document for OCR.
130	The doc key does not exist.

Code	Description
131	Exceeded number of total retries.
130	The doc key does not exist.
132	Exceeded number of total retries.
133	Exceeded number of total retries.
134	An error occurred while checking document quality.

Code	Description
135	An error occurred while checking document liveness.
136	An exception occurred while checking document liveness.

Code	Description
137	The face key does not exist.
138	Error while trying to detect B&W copy.
139	An exception occurred while calling color copy detection service.
140	Error while trying to detect Photo substitution.
141	No valid images were present for document processing.
142	Exceeded number of total retries.
143	An exception occurred while processing document for OCR.
144	Error while trying to detect Photo substitution.
145	No valid images were present for document processing.
146	Exceeded number of total retries.
148	Exceeded number of total retries.
149	Response from document quality service is not valid.

Code	Description
150	Failed to get cloud function from process manager.
151	Error while trying to invoke rule.
152	Error while trying to invoke rule.

Code	Description
160	Document was not accepted as being valid.
161	Exceeded number of total retries.
162	Failed to get cloud secret from process manager.
163	Failed to post process instance redirect status to process-manager.
164	Failed to deserialize additional docs JSON.

Code	Description
170	An error occurred while checking screen replay.
171	An exception occurred while checking screen replay.
172	Exceeded number of total retries.
173	Screen Replay detected.
174	It appears that this image is captured from a screen. Please capture a live document image.

Code	Description
180	Exceeded number of total retries.
181	Doc Processing Fail.

Code	Description
190	Failed to read barcode from the document.
191	Failed to read OCR data from the document.
192	Coviva validation failed.
193	Failed to find the face on the document.
194	Document support decision failed.
195	Document data mapping failed.
196	Document data consolidation failed.
197	Regula processing failed.
198	Document number validation failed.

Code	Description
210	Too many activity execution happened in one process instance.
212	The API request contains invalid data in one of the input fields: %s Error: must not be blank.

Code	Description
220	The form key does not exist.
221	An exception was thrown while trying to send custom data form to client.
222	Failed to get data form from process manager.

Code	Description
250	Error while trying to perform AAMVA verification.
251	AAMVA Verification service not available.

Code	Description
252	Email address is invalid.
253	Phone number is invalid.

Code	Description
300	Could not recognize and read the document.

Code	Description
915	We are unable to read your document's barcode, please recapture the back of your ID.

User Data Error Codes

Code	Description
1	An unexpected error occurred.
9	The API request contains invalid data in one of the input fields: %s
200	The API due to the failure of a downstream service: %s
130	The specified process instance could not be found.

Last updated on

On This Page

REST Error Codes Introduction Common Error Codes General Error Codes Athr-server Error Codes Process Manager Error Codes Processing Server Error Codes User Data Error Codes