API Error Responses

Description of possible errors that you might receive when making requests from API4All endpoints.

Authentication

Generate Access Token & Refresh Access Token

POST - /api/oauth/token

Error Code	Description	Case	Result
400	Bad Request	Invalid credentials	{ "error": "…", "error_description": "…", "hint": "…", "message": "…" }

---

Credit Risk Services

Offline Credit Risk reporting

Get Client Price List by Country Code

GET - /reports/price-list/country/:country_code

Error Code	Description	Case	Result
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Get Client Price List

GET - /reports/price-list?type=

Error Code	Description	Case	Result
404	Not Found	Report type not found	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Get Client Price List By Country Code and Report Type

GET - /reports/price-list/report/:report_type_id/country/:country_code

Error Code	Description	Case	Result
404	Not Found	Report type not found	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Create Order

POST - /orders

Error Code	Description	Case	Result
422	Unprocessable Content	Required fields missing	{ "message": "The given data was invalid.", "errors": { "items.0.type": ["The items.0.type field is required."], "items.0.country_code": ["The items.0.country code field is required."], "items.0.report_type_id": ["The items.0.report type id field is required."], "items.0.price_list_id": ["The items.0.price list id field is required."] }}
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Cancel Order

POST - /orders/:order_id/cancel

Error Code	Description	Case	Result
404	Not Found	Order Not Found	{ "success": false, "error": "No order found with this id." }
400	Bad Request	Wrong order id type	{ "success": false, "error": "The order id must be a number" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Cancel Item

POST - /orders/:order_id/item/:item_id/cancel

Error Code	Description	Case	Result
404	Not Found	Item Not Found	{ "success": false, "error": "No item found with this id." }
400	Bad Request	Wrong order id type	{ "success": false, "error": "The order id must be a number" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Get Order Basic Info

GET - /orders/:order_id/info

Error Code	Description	Case	Result
404	Not Found	Order Not Found	{ "success": false, "error": "No order found." }
400	Bad Request	Wrong order id type	{ "success": false, "error": "The order id must be a number" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Get Order Details

GET - /orders/orders/:order_id

Error Code	Description	Case	Result
404	Not Found	Order Not Found	{ "success": false, "error": "No order found." }
400	Bad Request	Wrong order id type	{ "success": false, "error": "The order id must be a number" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Get Order Statuses

GET - /orders/orders/statuses/:order_id

Error Code	Description	Case	Result
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Get Items Details

GET - /orders/orders/:order_id/item/:item_id

Error Code	Description	Case	Result
404	Not Found	Order Not Found	{ "success": false, "error": "No order found." }
400	Bad Request	Wrong order id type	{ "success": false, "error": "The order id and item id must be a number" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Get Items Available Files

GET - /orders/orders/:order_id/item/:item_id/files

Error Code	Description	Case	Result
404	Not Found	Order Not Found	{ "success": false, "error": "No order found with id: …" }
404	Not Found	Order Item Not Found	{ "success": false, "error": "No order item found with id: …" }
400	Bad Request	Wrong order id or order item id type	{ "success": false, "error": "The order id and item id must be a number" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Get Item Expired Files

GET - /orders/orders/:order_id/item/:item_id/expired-files

Error Code	Description	Case	Result
404	Not Found	Order Not Found	{ "success": false, "error": "No order found with id: …" }
404	Not Found	Order Items expired files not found	{ "success": false, "error": "No expired files found." }
400	Bad Request	Wrong order id or order item id type	{ "success": false, "error": "The order id and item id must be a number" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Download File

GET - /orders/orders/files/:media_uuid/download?access_key=

Error Code	Description	Case	Result
403	Forbidden	Wrong access key	{ "success": false, "error": "You do not have access to this file." }
400	Bad Request	Wrong media_suuid field format	{ "success": false, "error": "media_uuid doesn't have the correct format" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }
403	Forbidden	Invalid file access key	{ "success": false, "error": "You do not have access to this file." }

Download User File

GET - /orders/orders/user-files/:media_uuid/download

Error Code	Description	Case	Result
400	Bad Request	Wrong media_suuid field format	{ "success": false, "error": "media_uuid doesn't have the correct format" }
404	Not Found	File not found	{ "success": false, "error": "No file found." }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Online Credit Risk Reporting

Search By Company Name or Registration No

GET - search/company/search

Error Code	Description	Case	Result
422	Unprocessable Entity	Required fields are missing	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Get All Companies By Country Code

GET - /search/get-all-companies

Error Code	Description	Case	Result
422	Unprocessable Entity	Required fields are missing	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Get All Companies by Directors

GET - /search/get-companies-by-directors

Error Code	Description	Case	Result
422	Unprocessable Entity	Required fields are missing	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Company Basic Report

GET - /reports/company/basic/:country_code/:reg_no

Error Code	Description	Case	Result
404	Not Found	Company Not Found	{ "success": true, "data": { "message": "Company not found" } }
422	Unprocessable Entity	Required fields are missing	{ "success": false, "error": "…" }
403	Forbidden	No access to use this country code	{ "success": false, "error": "You do not have access to this report for this country." }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Company Structure Report

GET - /reports/company/structure/:country_code/:reg_no

Error Code	Description	Case	Result
404	Not Found	Company Not Found	{ "success": true, "data": { "message": "Company not found" } }
422	Unprocessable Entity	Required fields are missing	{ "success": false, "error": "…" }
403	Forbidden	No access to use this country code	{ "success": false, "error": "You do not have access to this report for this country." }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Credit Report

GET - /reports/company/credit-online

Error Code	Description	Case	Result
404	Not Found	Company Not Found	{ "success": true, "data": { "message": "Company not found" } }
400	Bad Request	Required fields are missing	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Company Comprehensive Report

GET - /company/comprehensive/:country_code/:reg_no

Error Code	Description	Case	Result
404	Not Found	Company Not Found	{ "success": true, "data": { "message": "Company not found" } }
403	Forbidden	No access to use this country code	{ "success": false, "error": "You do not have access to this report for this country." }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Basic Scoring Report

GET - /reports/company/basic-scoring/:country_code/:reg_no

Error Code	Description	Case	Result
404	Not Found	Company Not Found	{ "success": true, "data": { "message": "Company not found" } }
422	Unprocessable Entity	Required fields are missing	{ "success": false, "error": "…" }
403	Forbidden	No access to use this country code	{ "success": false, "error": "You do not have access to this report for this country." }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Company International Report

GET - /reports/company/basic-scoring/:country_code/:reg_no

Error Code	Description	Case	Result
404	Not Found	Company Not Found	{ "success": true, "data": { "message": "Company not found" } }
403	Forbidden	No access to use this country code	{ "success": false, "error": "You do not have access to this report for this country." }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Person Bankruptcies

GET - /reports/company/basic-scoring/:country_code/:reg_no

Error Code	Description	Case	Result
422	Unprocessable Entity	Required fields are missing	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Compliance Services

Identity Verification (WorldID)

Search Screening

GET - /screen/screening

Error Code	Description	Case	Result
422	Unprocessable Entity	Required fields are missing	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Begin Verification

POST - /verification/verifications

Error Code	Description	Case	Result
400	Bad Request	Company Key is missing	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Verification Result

POST - /verification/verifications/result

Error Code	Description	Case	Result
400	Bad Request	Session id not found	{ "success": false, "error": "…" }
400	Bad Request	Company Key is missing	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Delete Verification

POST - /verification/verifications/result

Error Code	Description	Case	Result
400	Bad Request	Session id not found	{ "success": false, "error": "…" }
400	Bad Request	Company Key is missing	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Card Front

POST - /verification/verifications/card-front

Error Code	Description	Case	Result
400	Bad Request	Session id not found	{ "success": false, "error": "…" }
400	Bad Request	Company Key is missing	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Card Back

POST - /verification/verifications/card-back

Error Code	Description	Case	Result
400	Bad Request	Session id not found	{ "success": false, "error": "…" }
400	Bad Request	Company Key is missing	{ "success": false, "error": "…" }

| 403 | Forbidden | Invalid or no Access Token | { "success": false, "error": "…" } |

Passport

POST - /verification/verifications/passport

Error Code	Description	Case	Result
400	Bad Request	Session id not found	{ "success": false, "error": "…" }
400	Bad Request	Company Key is missing	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Face

POST - /verification/verifications/face

Error Code	Description	Case	Result
400	Bad Request	Session id not found	{ "success": false, "error": "…" }
400	Bad Request	Company Key is missing	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Face Video

POST - /verification/verifications/face-video

Error Code	Description	Case	Result
400	Bad Request	Session id not found	{ "success": false, "error": "…" }
400	Bad Request	Company Key is missing	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Face Document

POST - /verification/verifications/face-document

Error Code	Description	Case	Result
400	Bad Request	Session id not found	{ "success": false, "error": "…" }
400	Bad Request	Company Key is missing	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

General Document

POST - /verification/verifications/general-document

Error Code	Description	Case	Result
400	Bad Request	Session id not found	{ "success": false, "error": "…" }
400	Bad Request	Company Key is missing	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Compare Faces

POST - /verification/verifications/compare-faces

Error Code	Description	Case	Result
400	Bad Request	Session id not found	{ "success": false, "error": "…" }
400	Bad Request	Company Key is missing	{ "success": false, "error": "…" }
400	Bad Request	face2 field is missing	{ "success": false, "error": "Face1 is required" }
400	Bad Request	face2 field is missing	{ "success": false, "error": "Face2 is required" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

List Session Activities

POST - /verification/verifications/list-session-activities

Error Code	Description	Case	Result
400	Bad Request	Session id not found	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

List Session Activities (session statistical summary)

POST - /verification/verifications/get-session-statistical-summary

Error Code	Description	Case	Result
400	Bad Request	Session id not found	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Get Session Main Document Face Photo

POST - /verification/verifications/get-session-main-document-face-photo

Error Code	Description	Case	Result
400	Bad Request	Session id not found	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Manual Verification – Card Front

POST - /verification/card/front

Error Code	Description	Case	Result
400	Bad Request	Image file missing or not recognized	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Manual Verification – Card Back

POST - /verification/card/back

Error Code	Description	Case	Result
400	Bad Request	Image file missing or not recognized	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Manual Verification – License Front

POST - /verification/license/front

Error Code	Description	Case	Result
400	Bad Request	Image file missing or not recognized	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Manual Verification – License Back

POST - /verification/license/back

Error Code	Description	Case	Result
400	Bad Request	Image file missing or not recognized	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Manual Verification – Residence Front

POST - /verification/residence/front

Error Code	Description	Case	Result
400	Bad Request	Image file missing or not recognized	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Manual Verification – Residence Back

POST - /verification/residence/back

Error Code	Description	Case	Result
400	Bad Request	Image file missing or not recognized	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Manual Verification – Passport

POST - /verification/passport

Error Code	Description	Case	Result
400	Bad Request	Image file missing or not recognized	{ "success": false, "error": "…" }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

---

Email Screening Services

Email Screening

POST - /screen/email-screening?email=

Error Code	Description	Case	Result
422	Unprocessable Content	Required fields are missing	{ "first_name": ["The first name field is required."], "last_name": ["The last name field is required."], "email": ["The email field is required."] }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

---

Compliance Screening and Monitoring

Get Monitoring Searches

GET - /monitor/monitoring/searches?id=

Error Code	Description	Case	Result
422	Unprocessable Content	Required fields are missing	{ "id": ["The id is required"] }
404	Not Found	Search Not Found with that id	{ "success": false, "error": "Search Not found" }\
422	Unprocessable Content	Wrong id type	{ "id": ["The id must be a number."] } \
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" } \

Update Monitored Searches

POST - /monitor/monitoring/searches/update

Error Code	Description	Case	Result
404	Not Found	Search not found with that id	{ "success": false, "error": "Search Not found" }
422	Unprocessable Content	Required fields are missing	{ "id": ["The id is required"] }
422	Unprocessable Content	Wrong id type	{ "id": ["The id must be a number."] }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Get Search Details

GET - /monitor/monitoring/searches/details?id=

Error Code	Description	Case	Result
404	Not Found	Search not found with that id	{ "success": false, "error": "Search Not found" }
422	Unprocessable Content	Required fields are missing	{ "id": ["The id is required"] }
422	Unprocessable Content	Wrong id type	{ "id": ["The id must be a number."] }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Get Comments

GET - /monitoring/searches/comments?id=

Error Code	Description	Case	Result
404	Not Found	Search not found with that id	{ "success": false, "error": "Search Not found" }
422	Unprocessable Content	Required fields are missing	{ "id": ["The id is required"] }
422	Unprocessable Content	Wrong id type	{ "id": ["The id must be a number."] }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }

Post Comment

POST - /monitoring/searches/comment

Error Code	Description	Case	Result
404	Not Found	Search not found with that id	{ "success": false, "error": "Search Not found" }
422	Unprocessable Content	Required fields are missing	{ "id": ["The id is required"], "comment": ["The comment field is required."], "entity_id": ["The entity id field is required."] }
422	Unprocessable Content	Wrong id type	{ "id": ["The id must be a number."] }
403	Forbidden	Invalid or no Access Token	{ "success": false, "error": "…" }