Skip to content

Errors

Akepa KYC/KYB Service Critical Errors

Error Code Label Description Context Status
applicationNotFound Application not found. Check the ID to make sure it is valid and exists.
Context:
applicationId - A cFiApplicationRef in
connectFi		 
{
  "applicationId":
"exgsa_123456789abcdefghi1234"
}
 404
documentNotFound Document not found. Check the document ID to make sure it is valid
and exists.
Context:
documentId - The ID of the document in
connectFi		 
{
  "documentId":
"doc_123456789abcdefghi1234"
}
 400
extAkepa External akepa error An error occurred in the akepa back office undefined 400
fileNotFound File not found. File not found. undefined 400
statusApplicationEntity Entity has status completed. Action cannot be completed. This entity
already has a completed status.		 undefined 400

Error Examples

Error Description Parameters/Request Body Response Body
400 akepa/identification customerNotFound Error REQUEST BODY
{
  "customerId" : "unknownCustomerId",
  "reference": "extRefBApp100",
    "webhookUrl":
"https://your_webhook_url/extRefBApp100"
}		 RESPONSE BODY
{
    "requestId":
"2ea85e1078d411eeb5658f28ab5fe311",
    "code": "customerNotFound",
    "context": {
        "customerId": "unknownCustomerId"
    },
    "message": "Customer not found."
}
400 akepa/identification requestValidateError - Must not have additional properties REQUEST BODY
{
  "customerId" :
"cstap_6reGTr3k8vpAu8uFV7EdiN",
  "reference": "extRefBApp100",
    "webhookUrl":
"https://your_webhook_url/extRefBApp100"
,
    "someAdditionalProperty": "value"
}		 RESPONSE BODY
{
    "requestId":
"5574292078d411eeb5658f28ab5fe311",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "",
            "schemaPath": "#/additionalProperties",
            "keyword": "additionalProperties",
            "params": {
                "additionalProperty":
"someAdditionalProperty"
            },
            "message": "must NOT have additional
properties"
        }
    ]
}
400 akepa/identification requestValidateError - Missing required property REQUEST BODY
{
  "reference": "extRefBApp100",
    "webhookUrl":
"https://your_webhook_url/extRefBApp100"
}		 RESPONSE BODY
{
    "requestId":
"6c5c6b2078d411eeb5658f28ab5fe311",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "",
            "schemaPath": "#/required",
            "keyword": "required",
            "params": {
                "missingProperty": "customerId"
            },
            "message": "must have required property
'customerId'"
        }
    ]
}
400 akepa/identification referenceExists Error REQUEST BODY
{
  "customerId" :
"cstap_5mBHiIx3QbkvEpjGfKsI9k",
    "reference": "extRefApp100",
    "webhookUrl":
"https://your_webhook_url/extRefApp100"
}		 RESPONSE BODY
{
    "requestId":
"c1d73030b9f711eeb6a5bb65dd1aad12",
    "code": "referenceExists",
    "context": {
        "reference": "extRefApp100",
        "entityId": "iapp_ASiuCX9tz9FGwlyiNHba2"
    },
    "message": "Reference already exists."
}
400 akepa/status applicationNotFound Error REQUEST BODY
{
  "customerId" :
"cstap_5mBHiIx3QbkvEpjGfKsI9k",
    "applicationId": "unknownApplicationId"
}		 RESPONSE BODY
{
    "requestId":
"eb91e860b9f811eeb6a5bb65dd1aad12",
    "code": "applicationNotFound",
    "context": {
        "applicationId": "unknownApplicationId"
    },
    "message": "Application not found."
}
400 akepa/status requestValidateError - Missing required property REQUEST BODY
{
  "customerId" :
"cstap_5mBHiIx3QbkvEpjGfKsI9k"
}		 RESPONSE BODY
{
    "requestId":
"a9f5d640b9f911eeb6a5bb65dd1aad12",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "",
            "schemaPath": "#/required",
            "keyword": "required",
            "params": {
                "missingProperty": "applicationId"
            },
            "message": "must have required property
'applicationId'"
        }
    ]
}
400 akepa/list requestValidateError - Must match format REQUEST BODY
{
    "customerId":
"cstap_5mBHiIx3QbkvEpjGfKsI9k",
    "dateCreateFrom": "01-15-2023",
    "dateCreateTo":
"2099-01-17T19:59:59.999Z",
    "numberOfRecords": 20,
    "skipRecords": 0
}		 RESPONSE BODY
{
    "requestId":
"f036a660b9fa11eeb6a5bb65dd1aad12",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "/dateCreateFrom",
            "schemaPath":
"#/properties/dateCreateFrom/format",
            "keyword": "format",
            "params": {
                "format": "dateISO"
            },
            "message": "must match format \"dateISO\""
        }
    ]
}
400 akepa/list greaterNumberOfRecords Error REQUEST BODY
{
    "customerId":
"cstap_5mBHiIx3QbkvEpjGfKsI9k",
    "dateCreateFrom":
"2023-01-15T00:00:00.001Z",
    "dateCreateTo":
"2099-01-17T19:59:59.999Z",
    "numberOfRecords": 1001,
    "skipRecords": 0
}		 RESPONSE BODY
{
    "requestId":
"4bd23020b9fb11eeb6a5bb65dd1aad12",
    "code": "greaterNumberOfRecords",
    "context": {
        "maxNumberOfRecords": 1000
    },
    "message": "The numberOfRecords field is
greater than the request limit"
}
400 akepa/list requestValidateError - Must be greater than or equal to allowed minimum REQUEST BODY
{
    "customerId":
"cstap_5mBHiIx3QbkvEpjGfKsI9k",
    "dateCreateFrom":
"2023-01-15T00:00:00.001Z",
    "dateCreateTo":
"2099-01-17T19:59:59.999Z",
    "numberOfRecords": 20,
    "skipRecords": -1
}		 RESPONSE BODY
{
    "requestId":
"5f1ed4d0b9fb11eeb6a5bb65dd1aad12",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "/skipRecords",
            "schemaPath":
"common#/definitions/skipRecords/minimum
",
            "keyword": "minimum",
            "params": {
                "comparison": ">=",
                "limit": 0
            },
            "message": "must be >= 0"
        }
    ]
}
400 akepa/list requestValidateError - Missing required property REQUEST BODY
{
    "dateCreateFrom":
"2023-01-15T00:00:00.001Z",
    "dateCreateTo":
"2099-01-17T19:59:59.999Z",
    "numberOfRecords": 20,
    "skipRecords": -1
}		 RESPONSE BODY
{
    "requestId":
"ad68a3f0b9fb11eeb6a5bb65dd1aad12",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "",
            "schemaPath": "#/required",
            "keyword": "required",
            "params": {
                "missingProperty": "customerId"
            },
            "message": "must have required property
'customerId'"
        }
    ]
}
400 akepa/document/generate requestValidateError - Missing required property REQUEST BODY
{
  "name": "license",
  "extension": "jpg",
  "type": "license"
}		 RESPONSE BODY
{
    "requestId":
"0799368078d611eeb5658f28ab5fe311",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "",
            "schemaPath": "#/required",
            "keyword": "required",
            "params": {
                "missingProperty": "workflow"
            },
            "message": "must have required property
'workflow'"
        }
    ]
}
400 akepa/document/generate requestValidateError - Must be an allowed value REQUEST BODY
{
  "workflow": "PERSONAL",
  "name": "license",
  "extension": "pdf",
  "type": "license"
}		 RESPONSE BODY
{
    "requestId":
"fe42d500819f11ee9b7427220cc6c212",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "/extension",
            "schemaPath":
"#/properties/extension/enum",
            "keyword": "enum",
            "params": {
                "allowedValues": [
                    "jpg",
                    "png"
                ]
            },
            "message": "must be equal to one of the allowed
values"
        }
    ]
}
400 akepa/document/generate requestValidateError - Must be an allowed value REQUEST BODY
{
  "workflow": "unknownWorkFlow",
  "name": "license",
  "extension": "jpg",
  "type": "license"
}		 RESPONSE BODY
{
    "requestId":
"fbac85f078dc11eeb5658f28ab5fe311",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "/workflow",
            "schemaPath":
"#/definitions/workflow/enum",
            "keyword": "enum",
            "params": {
                "allowedValues": [
                    "BUSINESS",
                    "PERSONAL"
                ]
            },
            "message": "must be equal to one of the allowed
values"
        }
    ]
}
400 akepa/document/upload/:documentId documentNotFound Error PARAMETERS
documentId:unknownDocumentId

RESPONSE BODY
{
    "requestId":
"6cc728f078d611eeb5658f28ab5fe311",
    "code": "documentNotFound",
    "context": {
        "documentId": "unknownDocumentId"
    },
    "message": "Document not found."
}
400 akepa/document/upload/:documentId fileNotFound Error PARAMETERS
documentId:doc_30DWsUZtnyV6gCw7aRtkfU

RESPONSE BODY
{
    "requestId":
"404fc82078dd11eeb5658f28ab5fe311",
    "code": "fileNotFound",
    "message": "File not found."
}
400 akepa/document/upload/:documentId extAkepa Error PARAMETERS
documentId:doc_30DWsUZtnyV6gCw7aRtkfU

RESPONSE BODY
{
    "requestId":
"45dc4cc081a011ee9b7427220cc6c212",
    "code": "extAkepa",
    "subCode": 4091,
    "message": "The specified document has
already been uploaded."
}
400 akepa/update requestValidateError - Missing required property REQUEST BODY
{
  "customerId" :
"cstap_5mBHiIx3QbkvEpjGfKsI9k",
    "documents": [
        {
            "entityId":
"cstap_5mBHiIx3QbkvEpjGfKsI9k",
            "documentId" :
"doc_3aaOADnurXNY7wWwJPcUcq",
            "view" : "front"
        },
        {
            "entityId":
"cstap_5mBHiIx3QbkvEpjGfKsI9k",
            "documentId" :
"doc_3Lg7i4zu7zXZA285OP9gc2",
            "view" : "back"
        }
    ]
}		 RESPONSE BODY
{
    "requestId":
"ca210490b9fd11eeb6a5bb65dd1aad12",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "",
            "schemaPath": "#/required",
            "keyword": "required",
            "params": {
                "missingProperty": "applicationId"
            },
            "message": "must have required property
'applicationId'"
        }
    ]
}
400 akepa/update documentNotFound Error REQUEST BODY
{
  "customerId" :
"cstap_5mBHiIx3QbkvEpjGfKsI9k",
  "applicationId":
"iapp_1BGgJeDQJFo5MCup15zq9A",
    "documents": [
        {
            "entityId":
"cstap_5mBHiIx3QbkvEpjGfKsI9k",
            "documentId" :
"doc_3aaOADnurXNY7wWwJPcUcq1",
            "view" : "front"
        },
        {
            "entityId":
"cstap_5mBHiIx3QbkvEpjGfKsI9k",
            "documentId" :
"doc_3Lg7i4zu7zXZA285OP9gc2",
            "view" : "back"
        }
    ]
}		 RESPONSE BODY
{
    "requestId":
"dd24b960b9fd11eeb6a5bb65dd1aad12",
    "code": "documentNotFound",
    "context": {
        "documentId":
"doc_3aaOADnurXNY7wWwJPcUcq1"
    },
    "message": "Document not found."
}
400 akepa/update applicationNotFound Error REQUEST BODY
{
  "customerId" :
"cstap_5mBHiIx3QbkvEpjGfKsI9k1",
  "applicationId": "unknownApplicationId",
    "documents": [
        {
            "entityId":
"cstap_5mBHiIx3QbkvEpjGfKsI9k1",
            "documentId" :
"doc_3aaOADnurXNY7wWwJPcUcq",
            "view" : "front"
        },
        {
            "entityId":
"cstap_5mBHiIx3QbkvEpjGfKsI9k1",
            "documentId" :
"doc_3Lg7i4zu7zXZA285OP9gc2",
            "view" : "back"
        }
    ]
}		 RESPONSE BODY
{
    "requestId":
"15086ed0b9fe11eeb6a5bb65dd1aad12",
    "code": "applicationNotFound",
    "context": {
        "applicationId": "unknownApplicationId"
    },
    "message": "Application not found."
}
400 akepa/update statusApplicationEntity Error REQUEST BODY
{
  "customerId" :
"cstab_2rw49JIoVAl3PCsaXdNoSS",
  "applicationId":
"iapp_3akMumble7qYVIe8rmjq14",
    "documents": [
        {
            "entityId":
"cstab_2rw49LnrnSuy9206ylJ2bU",
            "documentId" :
"doc_3aaOADnurXNY7wWwJPcUcq",
            "view" : "front"
        },
        {
            "entityId":
"cstab_2rw49LnrnSuy9206ylJ2bU",
            "documentId" :
"doc_3Lg7i4zu7zXZA285OP9gc2",
            "view" : "back"
        }
    ]
}		 RESPONSE BODY
{
    "requestId":
"b0134a30b9fe11eeb6a5bb65dd1aad12",
    "code": "statusApplicationEntity",
    "message": "Entity has status completed."
}