The DocumentValidation object

Attributes

• documentNumber - String - Optional The number associated with the document being validated.

---

• documentType - String - Required The type of document, such as ID, Passport, or Driver License.

---

• documentCategory - String - Optional Category of the document with possible values:

  • ID

  • Passport

  • IDv2

  • ForeignerID

  • DriverLicense

  • Unknown Default: Unknown.

---

• customDocumentType - String - Optional Custom type of document if any specific classification is required.

---

• country - String - Optional Country where the document was issued.

---

• nationality - String - Optional Nationality of the document holder.

---

• age - String - Optional Age of the document holder as recorded on the document.

---

• gender - String - Optional Gender of the document holder.

---

• project - ObjectId - Optional Reference to the Project object associated with this document validation.

---

• projectFlow - ObjectId - Optional Reference to the ProjectFlow object associated with this document validation.

---

• url - String - Optional URL where the document can be accessed.

---

• backUrl - String - Optional URL for the back side of the document, if applicable.

---

• status - String - Required Current status of the document validation. Possible values:

  • ASSESSING

  • ACTIVE

  • FAILED

  • NEEDS_MANUAL_VERIFICATION

  • NOT_FOUND

  • EXPIRED

  • ACTIVE_BUT_UNVERIFIED Default: ASSESSING.

---

• imageValidated - Boolean - Optional Indicates if the document image has been validated. Default: false.

---

• validationMethod - String - Required Method used for validation. Possible values:

  • MANUAL

  • OCR

  • SCAN_PROMPT

  • SCAN_STUDIO Default: MANUAL.

---

• inputMethod - String - Required Method used to input the document. Possible values:

  • CAMERA

  • FILE_UPLOAD

  • NOT_SET Default: NOT_SET.

---

• namesMatch - Boolean - Optional Indicates if the names on the document match the expected names. Default: false.

---

• fullNameMatchPercentage - Number - Optional Percentage of match for the full name. Default: 0.

---

• firstNameMatchPercentage - Number - Optional Percentage of match for the first name. Default: 0.

---

• lastNameMatchPercentage - Number - Optional Percentage of match for the last name. Default: 0.

---

• OCRExtraction - Object - Optional Object containing OCR extraction data if OCR was used.

---

• scoreValidated - Boolean - Optional Indicates if a validation score is available. Default: false.

---

• scoreValidation - Object - Optional Object to store validation scores and details.

---

• type - String - Required Type of validation process. Possible values:

  • validation

  • login

  • signup

  • ocr

  • demo Default: validation.

---

• redirectUrl - String - Optional URL to redirect after validation.

---

• webhookUrl - String - Optional URL for webhook callback after validation.

---

• webhook - ObjectId - Optional Reference to the associated Webhook object.

---

• appRegistration - ObjectId - Optional Reference to the associated AppRegistration object.

---

• client - ObjectId - Optional Reference to the associated Client object.

---

Example JSON Representation

{
  "documentNumber": "123456789",
  "documentType": "Passport",
  "documentCategory": "ID",
  "customDocumentType": "NationalID",
  "country": "USA",
  "nationality": "American",
  "age": "30",
  "gender": "M",
  "project": "ObjectId('...')",
  "projectFlow": "ObjectId('...')",
  "url": "https://example.com/document-front",
  "backUrl": "https://example.com/document-back",
  "status": "ASSESSING",
  "imageValidated": false,
  "validationMethod": "OCR",
  "inputMethod": "CAMERA",
  "namesMatch": true,
  "fullNameMatchPercentage": 98,
  "firstNameMatchPercentage": 100,
  "lastNameMatchPercentage": 97,
  "OCRExtraction": {
    "documentNumber": "123456789",
    "fullName": "John Doe"
  },
  "scoreValidated": true,
  "scoreValidation": {
    "score": 90,
    "threshold": 85
  },
  "type": "validation",
  "redirectUrl": "https://example.com/redirect",
  "webhookUrl": "https://example.com/webhook",
  "webhook": "ObjectId('...')",
  "appRegistration": "ObjectId('...')",
  "client": "ObjectId('...')"
}