Document Model

The OneSpan Identity Verification Document model is a section of the Transaction model. It defines documents that are included in an instance of the OneSpan Identity Verification workflow. This workflow can include different types of documents:

• Documents that will be presented to the user for review and acceptance.

• Documents that will be presented for signing.

• Raw data collected from the ID validation process (OneSpan Identity Verification module).

• ...

The Document model contains information that is required for the following document actions:

• Pre-process electronic document(s):

  • Splitting / joining

  • Signature location extraction

  • Customization (forms, annotations)

  • Watermarking

• Apply signatures associated with the users’ intent to sign.

• Apply tamper seals.

• Render documents for viewing.

• Add documents to the single evidence pack.

Document properties

Document properties lists the document properties in OneSpan Identity Verification.

Document resource definition: .../properties/transaction/properties/documents/items

Example document properties

{

  "id": "ee02adab-4946-4fae-884f-d8990aaf776a",
  "version": 1,
  "title": "Agreement to sign",
  "description": "Electronic retail credit agreement.",
  "document_template_id": "babdf419-6144-4e01-b8fb-98c863c9a2f2",
  "content": "TWFuIGlzIG...VyZS4=",
  "groups":["agreements"],
  "signatures": [{
    "id": "922b4d10-beb1-4120-b642-2ecb040411d2",
    "status": "signed",
    "role": "signer1",
    "...": "..."
    }, {
    "id": "922b4d10-beb1-4120-b642-2ecb040411d2",
    "status": "signed",
    "role": "signer2",
    "...": "..."
    }
},
  "watermark": [{
    "text": "COPY"
    "font-name": "Arial",
    "font-size": "12"
    }
  ],
  "number_of_pages": "3"
}

Signature properties

The signature defines the location, the type, and the role associated with the document signing. The role determines which signer is required to sign or accept the document.

Signatures can have a predefined location in the document, or they can be anchored to a particular text tag in the document. The signature location is only required for visible signatures (type signature). Signatures of the types acceptance and tamperseal do not visibly appear in the document.

Signature properties lists the signature properties in OneSpan Identity Verification.

• Path: http://dealflo.com/transaction.3.0.signature.json

• Signature object JSON schema

• Type: object

Example signature properties

[

  {
    "id": "922b4d10-beb1-4120-b642-2ecb040411d2",
    "status": "unsigned",
    "role": "signer1",

    "anchor_text": "SignHere:",

    "anchor_offset_x": "5"

    "anchor_offset_y": "10",
    "page_number": "1",
    "x": "1000",

    "y":"2000",

    "x_percent": "65",

    "y_percent": "35",

    "width": "250",

    "height": "50",
    "percent_width": "0.251",
    "percent_height": "0.082",
    "signature_block_text": "Signedby:{$signer}\non{$date_time}",
    "type": "signature"
},
{
    "id": "922b4d10-beb1-4120-b642-2ecb040411d2",
    "status": "signed",
    "role": "signer2",

    "anchor_text": "SignHere:",

    "anchor_offset_x": "5"

    "anchor_offset_y": "10",
    "page_number": "3",
    "x": "1000",

    "y": "2000",

    "x_percent": "65",

    "y_percent": "35",

    "width": "250",

    "height": "50",
    "percent_width": "0.251",
    "percent_height": "0.082",
    "signature_block_text": "Signedby:{$signer}\non{$date_time}",
    "type": "tamperseal"
  }
]

Watermark properties

With watermarks, you can mark a copy of a document as review only, or a printable copy that should not be signed. Watermark text can be defined for a given transaction instance. The watermark font can be configured to match the typography of a document.

A watermark is added to all pages of the document if the watermark operation is found in the list of pre-processing operations.

Watermark properties lists the watermark properties in OneSpan Identity Verification.

• Path: http://dealflo.com/transaction.3.0.watermark.json

• Watermark object JSON schema

• Type: object

Example watermark properties

{

  "text": "COPY",
  "font_name": "Arial",
  "font_size": "12"

}