Skip to main content
PUT
/
api
/
customer
/
{customerId}
/
document
/
{documentId}
/
ocr
updateOcrResult
curl --request PUT \
  --url https://api.artemis.cynopsis.co/api/customer/{customerId}/document/{documentId}/ocr \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Domain-ID: <x-domain-id>' \
  --data '{
  "error": "<string>",
  "result": {
    "race": "<string>",
    "gender": "<string>",
    "status": "<string>",
    "address": "<string>",
    "domicile": "<string>",
    "employer": "<string>",
    "full_name": "<string>",
    "full_name2": "<string>",
    "last_name": "<string>",
    "birth date": "2023-12-25",
    "final hash": "<string>",
    "first_name": "<string>",
    "identifier": "<string>",
    "issue_date": "2023-12-25",
    "profession": "<string>",
    "expiry date": "<string>",
    "expiry_date": "<string>",
    "nationality": "<string>",
    "docver_check": {
      "dataCheck": {
        "overall": {
          "result": "<string>",
          "certaintyLevel": "<string>"
        },
        "mrzCheck": {
          "parsed": "<string>",
          "overall": "<string>",
          "checkDigits": "<string>"
        },
        "logicCheck": {
          "overall": "<string>",
          "dateLogicCheck": {
            "overall": "<string>",
            "dateOfBirthInPastCheck": "<string>",
            "dateOfIssueInPastCheck": "<string>",
            "dateOfBirthBeforeDateOfIssueCheck": "<string>",
            "dateOfBirthBeforeDateOfExpiryCheck": "<string>",
            "dateOfIssueBeforeDateOfExpiryCheck": "<string>"
          },
          "documentNumberLogic": {
            "overall": "<string>"
          },
          "customerIdNumberLogic": {
            "overall": "<string>"
          },
          "personalIdNumberLogic": {
            "overall": "<string>"
          },
          "documentDiscriminatorLogic": {
            "overall": "<string>"
          },
          "inventoryControlNumberLogic": {
            "overall": "<string>"
          }
        },
        "matchCheck": {
          "overall": {
            "result": "<string>"
          },
          "raceMatch": {
            "type": "<string>",
            "check": "<string>"
          },
          "addressMatch": {
            "type": "<string>",
            "check": "<string>"
          },
          "employerMatch": {
            "type": "<string>",
            "check": "<string>"
          },
          "fullNameMatch": {
            "type": "<string>",
            "check": "<string>"
          },
          "lastNameMatch": {
            "type": "<string>",
            "check": "<string>"
          },
          "religionMatch": {
            "type": "<string>",
            "check": "<string>"
          },
          "firstNameMatch": {
            "type": "<string>",
            "check": "<string>"
          },
          "professionMatch": {
            "type": "<string>",
            "check": "<string>"
          },
          "dateOfBirthMatch": {
            "type": "<string>",
            "check": "<string>"
          },
          "dateOfIssueMatch": {
            "type": "<string>",
            "check": "<string>"
          },
          "dateOfExpiryMatch": {
            "type": "<string>",
            "check": "<string>"
          },
          "placeOfBirthMatch": {
            "type": "<string>",
            "check": "<string>"
          },
          "maritalStatusMatch": {
            "type": "<string>",
            "check": "<string>"
          },
          "documentNumberMatch": {
            "type": "<string>",
            "check": "<string>"
          },
          "personalIdNumberMatch": {
            "type": "<string>",
            "check": "<string>"
          },
          "residentialStatusMatch": {
            "type": "<string>",
            "check": "<string>"
          },
          "documentAdditionalNumberMatch": {
            "type": "<string>",
            "check": "<string>"
          },
          "documentOptionalAdditionalNumberMatch": {
            "type": "<string>",
            "check": "<string>"
          }
        },
        "formatCheck": {
          "overall": "<string>",
          "sexCheck": {
            "type": "<string>",
            "check": "<string>"
          },
          "religionCheck": {
            "type": "<string>",
            "check": "<string>"
          },
          "dateOfBirthCheck": {
            "type": "<string>",
            "check": "<string>"
          },
          "dateOfIssueCheck": {
            "type": "<string>",
            "check": "<string>"
          },
          "nationalityCheck": {
            "type": "<string>",
            "check": "<string>"
          },
          "dateOfExpiryCheck": {
            "type": "<string>",
            "check": "<string>"
          },
          "maritalStatusCheck": {
            "type": "<string>",
            "check": "<string>"
          },
          "documentNumberCheck": {
            "type": "<string>",
            "check": "<string>"
          },
          "classExpiryDateCheck": {
            "type": "<string>",
            "check": "<string>"
          },
          "issuingAuthorityCheck": {
            "type": "<string>",
            "check": "<string>"
          },
          "personalIdNumberCheck": {
            "type": "<string>",
            "check": "<string>"
          },
          "classEffectiveDateCheck": {
            "type": "<string>",
            "check": "<string>"
          },
          "documentAdditionalNumberCheck": {
            "type": "<string>",
            "check": "<string>"
          },
          "additionalPersonalIdNumberCheck": {
            "type": "<string>",
            "check": "<string>"
          },
          "documentOptionalAdditionalNumberCheck": {
            "type": "<string>",
            "check": "<string>"
          }
        },
        "dataIntegrityCheck": "<string>",
        "barcodeAnomalyCheck": {
          "overall": {
            "result": "<string>"
          },
          "readCheck": "<string>",
          "contentCheck": "<string>"
        },
        "suspiciousDataCheck": {
          "overall": {
            "result": "<string>",
            "certaintyLevel": "<string>"
          },
          "sampleStringCheck": {
            "result": "<string>",
            "certaintyLevel": "<string>"
          },
          "suspiciousNumberCheck": {
            "result": "<string>",
            "certaintyLevel": "<string>"
          }
        }
      },
      "visualCheck": {
        "overall": {
          "result": "<string>"
        },
        "securityFeatures": {
          "overall": {
            "result": "<string>"
          },
          "segmentResult": [
            {}
          ]
        },
        "photoForgeryCheck": {
          "result": "<string>"
        }
      },
      "extractionResult": {
        "sex": {
          "latin": "<string>"
        },
        "backViz": {
          "dateOfBirth": "2023-12-25",
          "dateOfIssue": "2023-12-25",
          "dateOfExpiry": "2023-12-25",
          "dateOfExpiryPermanent": true,
          "driverLicenseDetailedInfo": {
            "vehicleClassesInfo": [
              {}
            ]
          }
        },
        "barcode": {
          "sex": "<string>",
          "race": "<string>",
          "address": "<string>",
          "employer": "<string>",
          "fullName": "<string>",
          "lastName": "<string>",
          "religion": "<string>",
          "firstName": "<string>",
          "middleName": "<string>",
          "profession": "<string>",
          "stringData": "<string>",
          "dateOfBirth": "2023-12-25",
          "dateOfIssue": "2023-12-25",
          "nationality": "<string>",
          "dateOfExpiry": "2023-12-25",
          "placeOfBirth": "<string>",
          "maritalStatus": "<string>",
          "rawDataBase64": "<string>",
          "documentNumber": "<string>",
          "extendedElements": [
            {}
          ],
          "issuingAuthority": "<string>",
          "personalIdNumber": "<string>",
          "residentialStatus": "<string>",
          "addressDetailedInfo": {
            "city": "<string>",
            "street": "<string>",
            "postalCode": "<string>",
            "jurisdiction": "<string>"
          },
          "documentAdditionalNumber": "<string>",
          "additionalNameInformation": "<string>",
          "driverLicenseDetailedInfo": {
            "conditions": "<string>",
            "endorsements": "<string>",
            "restrictions": "<string>",
            "vehicleClass": "<string>",
            "vehicleClassesInfo": [
              {}
            ]
          }
        },
        "mrzData": {
          "opt1": "<string>",
          "gender": "<string>",
          "issuer": "<string>",
          "mrzParsed": true,
          "primaryId": "<string>",
          "issuerName": "<string>",
          "dateOfBirth": {
            "day": 123,
            "year": 123,
            "month": 123,
            "originalString": "<string>",
            "successfullyParsed": true,
            "filledByDomainKnowledge": true
          },
          "mrzVerified": true,
          "nationality": "<string>",
          "secondaryId": "<string>",
          "dateOfExpiry": {
            "day": 123,
            "year": 123,
            "month": 123,
            "originalString": "<string>",
            "successfullyParsed": true,
            "filledByDomainKnowledge": true
          },
          "documentCode": "<string>",
          "documentType": "<string>",
          "rawMrzString": "<string>",
          "documentNumber": "<string>",
          "nationalityName": "<string>"
        },
        "frontViz": {
          "dateOfBirth": "2023-12-25",
          "dateOfIssue": "2023-12-25",
          "dateOfExpiry": "2023-12-25",
          "dateOfExpiryPermanent": true,
          "driverLicenseDetailedInfo": {
            "vehicleClassesInfo": [
              {}
            ]
          }
        },
        "lastName": {
          "latin": "<string>"
        },
        "classInfo": {
          "type": "<string>",
          "region": "<string>",
          "country": "<string>",
          "countryName": "<string>",
          "isoAlpha2CountryCode": "<string>",
          "isoAlpha3CountryCode": "<string>",
          "isoNumericCountryCode": "<string>"
        },
        "firstName": {
          "latin": "<string>"
        },
        "dateOfBirth": {
          "day": 123,
          "year": 123,
          "month": 123,
          "originalString": {
            "latin": "<string>"
          },
          "successfullyParsed": true,
          "filledByDomainKnowledge": true
        },
        "dateOfIssue": "2023-12-25",
        "nationality": {
          "latin": "<string>"
        },
        "dateOfExpiry": {
          "day": 123,
          "year": 123,
          "month": 123,
          "originalString": {
            "latin": "<string>"
          },
          "successfullyParsed": true,
          "filledByDomainKnowledge": true
        },
        "documentNumber": {
          "latin": "<string>"
        },
        "dataMatchResult": {
          "dateOfBirth": "<string>",
          "dateOfExpiry": "<string>",
          "documentNumber": "<string>",
          "dataMatchResult": "<string>",
          "personalIdNumber": "<string>",
          "documentAdditionalNumber": "<string>",
          "documentOptionalAdditionalNumber": "<string>"
        },
        "recognitionMode": "<string>",
        "processingStatus": "<string>",
        "recognitionStatus": "<string>",
        "backProcessingStatus": "<string>",
        "dateOfExpiryPermanent": true,
        "frontProcessingStatus": "<string>",
        "scanningFirstSideDone": true,
        "backImageAnalysisResult": {
          "blurred": true,
          "cardRotation": "<string>",
          "cardOrientation": "<string>",
          "mrzDetectionStatus": "<string>",
          "faceDetectionStatus": "<string>",
          "realIDDetectionStatus": "<string>",
          "barcodeDetectionStatus": "<string>",
          "documentImageColorStatus": "<string>",
          "documentImageMoireStatus": "<string>"
        },
        "frontImageAnalysisResult": {
          "blurred": true,
          "cardRotation": "<string>",
          "cardOrientation": "<string>",
          "mrzDetectionStatus": "<string>",
          "faceDetectionStatus": "<string>",
          "realIDDetectionStatus": "<string>",
          "barcodeDetectionStatus": "<string>",
          "documentImageColorStatus": "<string>",
          "documentImageMoireStatus": "<string>"
        },
        "driverLicenseDetailedInfo": {
          "vehicleClassesInfo": [
            {}
          ]
        },
        "backAdditionalProcessingInfo": {
          "extraPresentFields": [
            {}
          ],
          "invalidCharacterFields": [
            {}
          ],
          "missingMandatoryFields": [
            {}
          ]
        },
        "frontAdditionalProcessingInfo": {
          "extraPresentFields": [
            {}
          ],
          "invalidCharacterFields": [
            {}
          ],
          "missingMandatoryFields": [
            {}
          ]
        }
      },
      "processingStatus": "<string>",
      "imageQualityCheck": {
        "overall": {
          "result": "<string>",
          "certaintyLevel": "<string>"
        }
      },
      "overallFraudCheck": {
        "result": {
          "result": "<string>",
          "certaintyLevel": "<string>"
        },
        "performedChecks": 123
      },
      "recognitionStatus": "<string>",
      "documentLivenessCheck": {
        "overall": {
          "result": "<string>"
        },
        "screenCheck": {
          "result": "<string>",
          "matchLevel": "<string>"
        },
        "photocopyCheck": {
          "result": "<string>",
          "matchLevel": "<string>"
        },
        "handPresenceCheck": "<string>"
      },
      "documentValidityCheck": {
        "overall": "<string>",
        "expiredCheck": "<string>",
        "versionCheck": "<string>"
      }
    },
    "date_of_birth": "<string>",
    "document_type": "<string>",
    "optional_data": "<string>",
    "ignored_fields": [
      "<string>"
    ],
    "missing_fields": [
      {}
    ],
    "mrz_raw_string": "<string>",
    "birth date hash": "<string>",
    "document_number": "<string>",
    "issuing_country": "<string>",
    "passport_number": "<string>",
    "country_of_birth": "<string>",
    "expiry date hash": "<string>",
    "optional data hash": "<string>",
    "personal_id_number": "<string>",
    "valid country code": "<string>",
    "valid genre format": "<string>",
    "document number hash": "<string>",
    "document type format": "<string>",
    "optional data format": "<string>",
    "passport_expiry_date": "<string>",
    "document number format": "<string>",
    "valid nationality code": "<string>"
  },
  "task_id": "<string>",
  "description": "<string>",
  "status_task": "<string>"
}'
{
  "id": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdBy": {
    "email": "<string>",
    "firstName": "<string>",
    "fullName": "<string>",
    "id": 123,
    "lastName": "<string>"
  },
  "updatedBy": {
    "email": "<string>",
    "firstName": "<string>",
    "fullName": "<string>",
    "id": 123,
    "lastName": "<string>"
  },
  "customerId": 123,
  "frontName": "<string>",
  "backName": "<string>",
  "type": "<string>",
  "number": "<string>",
  "authenticity": "<string>",
  "issueDate": "2023-12-25",
  "expiryDate": "2023-12-25",
  "showExpiryNotification": true,
  "front": "<string>",
  "back": "<string>",
  "docverCheckStatus": "PERFORMED",
  "faceCompare": {},
  "liveness": {},
  "other": {},
  "allowedDocumentFormat": true
}
Description: Manually put a new OCR result into Artemis via API.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
X-Domain-ID
integer
required

X-Domain-ID

Path Parameters

​
customerId
integer
required

customerId

​
documentId
integer
required

documentId

Body

application/json

OcrResultRequestDto

​
error
string
​
result
object
​
task_id
string
​
description
string
​
status_task
string

Response

OK

​
id
integer
​
createdAt
string<date-time>
​
updatedAt
string<date-time>
​
createdBy
object
​
updatedBy
object
​
customerId
integer
​
frontName
string
​
backName
string
​
type
string
​
number
string
​
authenticity
string
​
issueDate
string<date>
​
expiryDate
string<date>
​
showExpiryNotification
boolean
​
front
string
​
back
string
​
docverCheckStatus
enum<string>
Available options:
PERFORMED,
NOT_PERFORMED
​
faceCompare
object
​
liveness
object
​
other
object
​
allowedDocumentFormat
boolean