Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejava
themeEclipse
{
    "Documents": [{
            "FileId": "c5a229ae-1234-1234-b6e8-d4eb9fd7bcf5",
            "DocumentNumber": 1
        }
    ],
    "Name": "Test",
    "Activities": [{
            "Action": {
                "Sign": {
                    "RecipientConfiguration": {
                        "ContactInformation": {
                            "Email": "janedoe@sample.com",
                            "GivenName": "Jane",
                            "Surname": "Doe",
                            "LanguageCode": "EN"
                        }
                    },
                    "Elements": {
                        "Signatures": [{
                                "TaskConfiguration": {
                                    "OrderDefinition": {
                                        "OrderIndex": 0
                                    }
                                },
                                "IdElementId": "sample sig clicktosign",
                                "Required": true,
                                "DocumentNumber": 1,
                                "DisplayName": "Sign here",
                                "AllowedSignatureTypes": {
                                    "ClickToSign": {
                                    }
                                },
                                "FieldDefinition": {
                                    "Position": {
                                        "PageNumber": 1,
                                        "X": 100,
                                        "Y": 200
                                    },
                                    "Size": {
                                        "Width": 100,
                                        "Height": 70
                                    }
                                }
                            }
                        ]
                    },
                    "SigningGroup": "firstSigner"
                }
            }
        }
    ]
}

...

Code Block
languagejava
themeEclipse
titleSignature information
"Signatures": [
              {
                "IdElementId": "string",
                "Required": true,
                "DocumentNumber": 0,
                "DisplayName": "string",
                "FieldDescription": "string",
 				"AllowedSignatureTypes": {

...

Please note the following available values for the "SignaturePositioning":

ValueDescription
intersects with fieldThe signature has to start within the signature field, but the signer is allowed to leave the boundaries of the box while signing
within fieldThe signature must be completely within the boundaries of the signature field
on pageThe signature can start anywhere on the page, even without intersecting with the signature field


Code Block
languagejava
themeEclipse
titleBiometric
"Biometric": {
                    "BiometricVerification": true,
                    "AllowBiometricStoringOnly": true,
                    "StoreSignedResponseWithoutBioData": true,
                    "AllowSkipBiometricVerification": true,
                    "BiometricServerUserId": "string",
                    "SignaturePositioning": "WithinField",
                    "Preferred": true,
                    "StampImprintConfiguration": {
                      "DisplayExtraInformation": true,
                      "DisplayEmail": true,
                      "DisplayTransactionId": true,
                      "DisplayTransactionToken": true,
                      "DisplayPhoneNumber": true,
                      "UseCustomStampImprint": true,
                      "DisplayIp": true,
                      "DisplayName": true,
                      "DisplaySignatureDate": true,
                      "FontName": "string",
                      "FontSizeInPt": 0
                    }
                  },

...