Checks

Endpoints for interacting with EyeDP checks

Document risk

Returns document risk checks for a document. This check is triggered as soon as a document is uploaded to EyeDP.

Endpoint	/api/checks/document-risk?caseId={caseId}&documentId={docId}
Method	GET

Response

The response has the status of the check and the list of risks found on the document.

While the check is in progress the endpoint will return a status of 'InProgress':

{
    "status": "InProgress",
    "checks": []
}

When the check is completed the endpoint will return all of the found risks:

{
    "status": "Completed",
    "checks": [
        {
            "results": [
                {
                    "title": "Low quality document",
                    "description": "This document contains images with very low resolution, which may prevent reliable analysis or disable some detection features.",
                    "riskLevel": "High"
                },
                {
                    "title": "Document with fake components",
                    "description": "This document shares characteristics with documents created by known fake document generators. These tools often reuse document templates and include fabricated signatures, synthetic faces, artificial backgrounds, and other generated elements.",
                    "riskLevel": "High"
                },
                {
                    "title": "Serial fraud",
                    "description": "This document contains visual content, metadata, or features that are highly similar to previously processed documents, suggesting it is part of a series created using the same document template, the same device, or the same scene composition. This is a strong indication of fraud.",
                    "riskLevel": "High"
                }
            ]
        }
    ]
}

If the document was found to be legitimate and have nothing wrong with it the endpoint returns an empty checks list:

{
    "status": "Completed",
    "checks": []
}

Details

The check status has 4 possible options

Status	Description
Pending	The check has been scheduled in the EpeDP platform
InProgress	The check is currently under way
Completed	The check has been completed
Failed	The check has failed for an unknown reason. This shouldn't happen. But if it does please contact our support team to help find the issue and rerun the check.

The results of the document risk check contain the following fields

Field	Description
Title	Short title of the risk
Description	Detailed description with more information of the risk
Risk level	The risk level is the seriousness of the risk. It has three levels: Informational, Warning or High

ℹ️ Informational risk example

Monzo Bank Ltd logo

This document contains a logo commonly associated with Monzo Bank Ltd, suggesting it was issued by that bank.

⚠️ Warning risk example

Different Document Type Detected

We detected the document to be a Unkown but the user selected Bank Statement

‼️ High risk example

Document with fake components

This document shares characteristics with documents created by known fake document generators. These tools often reuse document templates and include fabricated signatures, synthetic faces, artificial backgrounds, and other generated elements.

Case risk

This type of check runs a set of rules against the contents of uploaded documents and the case itself. The check is initiated by executing a workflow.

The rules enabled in your setup can be accessed through the Portal: https://portal.eyedp.com

Endpoint	/api/checks/case-risk?caseId={caseId}
Method	GET

Response

If any of the rules have failed the endpoint will return the rules with the status as 'Failed':

{
    "status": "Completed",
    "rules": [
        {
            "status": "Failed",
            "name": "Name",
            "description": "The platform will flag an Alert if the name on the document is different to the name on the Case",
            "documentIds": [
                675
            ]
        },
        {
            "status": "Failed",
            "name": "Date of Birth",
            "description": "The platform will flag an Alert if the date of birth on the document is different to the date of birth on the Case",
            "documentIds": [
                675
            ]
        }
    ]
}

Passed rules will return a status of 'Passed':

{
    "status": "Completed",
    "rules": [
        {
            "status": "Passed",
            "name": "Joint account",
            "description": "The platform will flag an alert if the document is in joint names",
            "documentIds": [
                717
            ]
        },
        {
            "status": "Passed",
            "name": "Transfer to/from self (BETA)",
            "description": "The platform will flag an alert if there are transfers to/from another account in the Case name",
            "documentIds": [
                717
            ]
        }
    ]
}

If a workflow has not been executed yet the overall check status will be set to 'Pending':

{
    "status": "Pending",
    "rules": []
}

Details

The check status has 4 possible options

Status	Description
Pending	The check has been scheduled in the EpeDP platform
InProgress	The check is currently under way
Completed	The check has been completed
Failed	The check has failed for an unknown reason. This shouldn't happen. But if it does please contact our support team to help find the issue and rerun the check.

The rules of the check contains the following fields

Field	Description
Status	Status can be one of 3 options: Pending, Passed or Failed. Pending only appears while the rule is executing. Generally this is very quick so you probably won't see it. You're most likely to see it as either Passed or Failed which are the results of the rule.
Name	Short name of the rule
Description	Longer more detailed description of the rule
DocumentIds	The documents involved in the rule. Rules that compare document contents like a Name against the case will only show a single Id. If the rule is looking at trends across documents all the document ids will be included.