Designations via API

Providing designation coordinates via API is a great solution if you have few document templates to manage, and the designations have predictable X/Y coordinates.

❗️

Only Available via Add Document endpoint

We do not support including signing designations via the Create Transaction endpoint at this time.

Adding Designations for Signers

To apply designations for a signer via API, first you must provide an external_id for the signer via the Create Transaction endpoint:

POST /transactions
{
  "signers": [
    {
      "email": "[email protected]",
      "external_id": "abc123
    }
  ],
  "documents": [
      {
          "resource": "https://static.notarize.com/Example.pdf"
      }
  ]
}

Then, call the Add Document endpoint and include the signing_designations parameter in your request:

POST /transactions/ot_xxxxxxx/documents
{
    "resource": "https://static.notarize.com/Example.pdf",
    "requirement": "notarization",
    "signing_designations": [
        { 
            "signer_identifier": "abc123",
            "type": "dob",
            "page_number": 0,
            "x": 100,
            "y": 100,
            "height": 20,
            "width": 20,
            "hint": "Required to complete purchase"
        }
    ]
}

See the signing designation data model for more info.

Adding Designations for Notaries

To apply a designation for a notary via API, simply call the Add Document endpoint and include the signing_designations parameter in your request, and set the signer_identifier parameter to notary:

POST /transactions/ot_xxxxxxx/documents
{
    "resource": "https://static.notarize.com/Example.pdf",
    "requirement": "notarization",
    "signing_designations": [
        { 
            "signer_identifier": "notary",
            "type": "dob",
            "page_number": 0,
            "x": 100,
            "y": 100,
            "height": 20,
            "width": 20,
            "hint": "Required to complete purchase"
        }
    ]
}