Documents

documents will be defined in a JSON array with the following structure:

[
    "document_index": "integer",
    "document_id": "string",
    "created_at": "timestamp",
    "updated_at": "timestamp",
    "ocr": "boolean",
    "extracted": "object",
    "identity_document_type": "string",
    "submitted_data": "<UserDetails>",
    "asf_breakdown": "object",
    "asf_checked": "boolean",
    "face_photo": "<Asset>",
    "front_document": "<Asset>",
    "back_document": "<Asset>",
    "original_front_document": "<Asset>",
    "original_back_document": "<Asset>",
    "signature_photo": "<Asset>",
    "ghost_photo": "<Asset>",
    "mrz_data": "object"
    "asf_document_result": "object"
]

Check the table below for further details of each field:

🚧
Note:
There will be various responses depending on user activity. There are two categories:

Mandatory: means the field and its value will always be returned, even with null values.

Optional: means the field would not exist in some cases. I.e., the transaction is not completed yet. Thus, some fields are missing.

Fields	Data Type	Mandatory/Optional	Description	Possible Responses
`document_index`	integer	Mandatory	0-based document index.	Starting
`document_id`	string	Mandatory	Unique ID to specify each document.	It will always be present.
`created_at`	timestamp	Mandatory	The timestamp when the document was registered in the database.	It will always be present.
`updated_at`	timestamp	Mandatory	The timestamp when the document was updated in the database.	It will always be present.
`ocr`	boolean	Mandatory	The confirmation that the document has been checked by OCR.	- The value will be `true` if document went through the OCR check. - Otherwise, it will return `false`.
`submitted_data`	UserDetail	Mandatory	An object that contains information about the UserDetail object.	- The field will not exist if the document is not recognized by the IDVerse. - Otherwise, it will always be present.
`asf_breakdown`	object	Mandatory	The Asf check result.	- The field will not exist if the document is not recognized by the IDVerse. - If the data has been redacted, the result will be invalid with `null`. - Otherwise, it will always be present.
`asf_checked`	boolean	Mandatory	The confirmation that the document has been checked by ASF (DFA).	The value will be `true` if the document went through the ASF (DFA) check. - Otherwise, it will return `false`.
`face_photo`	Asset	Mandatory	The user's photo image URL, which is extracted from the ID document.	- The field will not exist if the document is not recognized by the IDVerse. - If the data has been redacted, the result will be invalid with `null`. - Otherwise, it will always be present.
`front_document`	Asset	Mandatory	The cropped document's front side image URL.	It will always be present.
`back_document`	Asset	Mandatory	The cropped document's backside image URL.	- The field will not exist if the document is not recognized by the IDVerse or no back card was required. - If the data has been redacted, the result will be invalid with `null`. - Otherwise, it will always be present.
`original_front_document`	Asset	Mandatory	The resized (normalization of the image resolution) document's front-side image URL.	It will always be present.
`original_back_document`	Asset	Mandatory	The resized (normalization of the image resolution) document's backside image URL.	- The field will not exist if the document is not recognized by the IDVerse or no back card was required. - If the data has been redacted, the result will be invalid with `null`. - Otherwise, it will always be present.
`signature_photo`	Asset	Mandatory	The user's signature image from the scanned document.	- The field will not exist if the document is not recognized by the IDVerse or does not have a signature image on it. - If the data has been redacted, the result will be invalid with `null`. - Otherwise, it will always be present.
`ghost_photo`	Asset	Mandatory	The user's ghost image URL, which is typically found on the passports.	- The field will not exist if the document is not recognized by the IDVerse. - If the data has been redacted, the result will be invalid with `null`. - Otherwise, it will always be present.
`mrz_data`	object	Mandatory	An object that contains data from Machine Readable Zone for passport identification.	- The field will not exist if the document did not have a machine readable zone on it or it has already been redacted. - Otherwise, it will always be present.
`asf_document_result`	object	Mandatory	The ASF check result contains only an overall result: `PASS` or `FLAGGED`.	The field will not exist if the document is not recognised by the IDVerse. - if any of the `asf_breakdown` fields return `FLAGGED` this will return `FLAGGED`. - If the data has been redacted, the result will be invalid with null. - Otherwise, it will always be present.

Below is a sample of the documents array response:

"documents": [
    {
      "created_at": "2022-03-03T03:29:18.595Z",
      "document_id": "your_document_id",
      "extracted": {
        "country": "Australia",
        "id_number": 123456789,
        "address": "FakeData",
        "document_number": 3333333333,
        "city": "FakeData",
        "expiry_date": "31/12/2030",
        "birth_date": "01/01/1980",
        "last_name": "FakeData",
        "given_names": "FakeData",
        "middle_name": "FakeData",
        "country_code": "AUS",
        "full_name": "FakeData",
        "street": "FakeData",
        "post_code": 9999,
        "state": "FakeData",
        "class": "C",
        "first_name": "FakeData",
        "document_type": "Driver Licence"
      },
      "asf_breakdown": {
        "document_integrity": "PASSED",
        "image_composition": "FLAGGED",
        "photo_check": "PASSED",
        "detail_check": "PASSED"
      },
      "identity_document_type": "AUS_NSW_DRIVERLICENCE",
      "updated_at": "2022-03-03T03:29:18.595Z",
      "ocr": true,
      "face_photo": {
        "url": "https://fakedomain.url",
        "size": 7392,
        "content_type": "image/jpeg"
      },
      "front_document": {
        "url": "https://fakedomain.url",
        "size": 70064,
        "content_type": "image/jpeg"
      },
      "original_front_document": {
        "url": "https://fakedomain.url",
        "size": 100400,
        "content_type": "image/jpeg"
      },
      "signature_photo": {
        "url": "https://fakedomain.url",
        "size": 23056,
        "content_type": "image/jpeg"
      }
    }
  ]

💬 We Are Here to Help!

If you encounter an issue, a bug, or require assistance, please contact our support page here to find the solution. Don't forget to provide any important information on the issue.

🚧Note:

💬 We Are Here to Help!

🚧
Note: