Digital Onboarding Documentation
  • Introduction
    • Obtaining The API Key
  • API Reference
    • Document Upload Error Responses
    • Uploading Face Image
    • Face Image Error Responses
    • Liveliness Verification
    • Liveliness Error Responses
    • Creating an eKYC Request
    • Accepting eKYC Request
    • Retrieving eKYC Request
    • Retrieving Single eKYC Request
    • Clearing eKYC Request
    • Deleting eKYC Request
Powered by GitBook
On this page
  1. API Reference

Document Upload Error Responses

Types and causes of error responses when uploading document to the Lapis eKYC API

Error Responses:

  • If the provided API key is invalid, the following error message will be returned. Please ensure that the API key you provide is correct and valid.

Response status: 401

{
    "error": "invalid api key"
}
  • If an invalid image URL is provided, the following error message will be returned. Please ensure that the image URL you provide is correct and accessible.

Response status: 400

{
    "error": "invalid document (front, side, back) image provided"
}
  • If an invalid image base64 is provided, the following error message will be returned. Please ensure that the image base64 is type of png or jpeg.

Response status: 400

{
    "error": "invalid base64 front image provided"
}
  • If two types of image provide for one side of document (URL and base64), the following error message will be returned.

Response status: 400

{
    "error": "only one image is accepted per document side!"
}
  • If sum of base64 images exceeds 30mb, the following error message will be returned.

Response status: 413

Request Entity Too Large
  • If the provided document is not recognized or invalid, it signifies that the document submitted does not meet the required standards and cannot be considered valid for verification.

Response status: 400

{
    "error": "The document supplied is not recognized!"
}
PreviousAPI ReferenceNextUploading Face Image

Last updated 1 year ago