/dataAccess/createDocument/

The /dataAccess/createDocument/ endpoint creates a new document for an existing document container which is currently being constructed.

A new document instance will be retained during the lifetime of the user session in principal but unpublished document containers may be removed automatically after a certain period of time.

Request

POST {{server}}/VPE/dataAccess/createDocument/
Content-Type: application/json

{
    "DeviceId": "device-id",
    "SessionId": "...",

    "ContainerId": "...",
    "DocumentType": 0,
    "Document": {
        "FeedbackPersonMatches": 1
    }
}

CreateDocumentRequest.ContainerId

= ContainerId

The unique identifier of the document container for which a new document is being created.

CreateDocumentRequest.DocumentType

= DocumentType

The document type of the new document if the type of the document is known at the time of creation.

See also

DocumentType for more information about the document type.

CreateDocumentRequest.Mrz

= Mrz

The machine-readable zone (MRZ) that is printed on some security documents, such as passport documents. Usually, the machine-readable zone is inferred from image data. However, sometimes the machine-readable zone might already be known in which case it can be submitted via this property.

CreateDocumentRequest.RfidMrz

= RfidMrz

The machine-readable zone (MRZ) that has been obtained from the RFID chip of the security document - if present and known.

CreateDocumentRequest.ScannerType

= ScannerType

The scanner type that has been used to capture the document.

CreateDocumentRequest.Document

= Document

Some document properties may be declared as initial data that is known about the document before any further information is inferred from image data or the machine-readable zone.

For example the Document.FeedbackPersonMatches property might be declared in order to define if the person who carried out the scan has verified that the person who presented the document is matching the picture of the document holder.

{
    ...
    "Document": {
        "FeedbackPersonMatches": 1
    }
}

See also

Document model for further information about all document properties that may appear as initial document data.

Response

{
    "Success": true,
    "Message": "Operation executed successfully.",

    "ContainerId": "...",
    "DocumentId": "..."
}

CreateDocumentResponse.ContainerId

= ContainerId

Unique identifier of the document container.

CreateDocumentResponse.DocumentId

= DocumentId

Unique identifier of the document that was created by the TrustID Cloud.