Contract Signature

Description

A contract signature.

Properties

Property Description
created read-only

The date on which the entity was created.

ipAddress

The IP address of the user agent recording the signature.

publicId

The public identifier for this contract signature. This is used on all public screens and printable views of the contract as a transaction identifier.

signature

A signature.

signatureType

The type of signature.

Status Description
studio The signature was created by the studio.
client The signature was created by the client.
type

The type of resource represented.

userAgent

The full user agent identifier string of the user agent recording the signature.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "A contract signature.",
  "properties": {
    "created": {
      "$ref": "#/components/schemas/Signature/properties/created"
    },
    "ipAddress": {
      "description": "The IP address of the user agent recording the signature.",
      "format": "ipv4",
      "type": "string"
    },
    "publicId": {
      "description": "The public identifier for this contract signature. This is used on\nall public screens and printable views of the contract as a\ntransaction identifier.",
      "pattern": "^[a-fA-F0-9]{32}$",
      "type": "string"
    },
    "signature": {
      "$ref": "#/components/schemas/Signature"
    },
    "signatureType": {
      "description": "The type of signature.\n\n| Status | Description |\n| ------ | ----------- |\n| `studio` | The signature was created by the studio. |\n| `client` | The signature was created by the client. |",
      "enum": [
        "studio",
        "client"
      ],
      "type": "string"
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Type"
        },
        {
          "enum": [
            "contract-signature"
          ]
        }
      ]
    },
    "userAgent": {
      "description": "The full user agent identifier string of the user agent recording\nthe signature.",
      "type": "string"
    }
  },
  "title": "Contract Signature",
  "type": "object"
}