Skip to content
/
Bulk write 'Signabledocum...

Documents (2.0.0)

The 'Documents' application of the Core API

Download OpenAPI description
Download Postman Collection
Download OpenAPI Specification (json)
Download OpenAPI Specification (yaml)
Languages
Servers
https://{environment}.pigello.io

Fileaccessshare

Operations

Organizationuserfileaccessshare

Operations

Folder

Operations

Publicfile

Operations

Signabledocumentpartyfield

Operations

Signabledocument

Operations

Signabledocumentparty

Operations

Bulk write 'Signabledocumentparty'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Bodyapplication/jsonArray [
roleinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
documentobject(Signabledocument)required
document.​idstring(uuid)
answer_authentication_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456789
sub_tenantobject or null(Subtenant)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: organization_user, tenant

sent_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: opened_time, signed_time, rejected_time

rejection_reasonstring or null

Additional Validation Information:

This value requires that the following fields are also set: rejected_time

individually_finished_distribution_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123
finished_dataobject or nullwrite-only
opened_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: signed_time, rejected_time, sent_time

finished_with_ipstring or null(ipv6,ipv4)
orderinteger(int32)[ -2147483648 .. 2147483647 ]
fully_finished_distribution_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123
organization_userobject or null(Organizationuser)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: tenant, sub_tenant

organizationobject or null(Organization)
rejected_timestring or null(date-time)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: signed_time

This value must be set in an proper order, in relation to the following fields: sent_time, opened_time

This value requires that the following fields are also set: started_time

tenantobject or null(Tenant)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: organization_user, sub_tenant

fallback_distribution_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123
signed_timestring or null(date-time)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: rejected_time

This value must be set in an proper order, in relation to the following fields: opened_time, sent_time

This value requires that the following fields are also set: started_time

started_timestring or null(date-time)
invite_distribution_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123
view_authentication_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456789
custom_idstring or null<= 128 characters
finished_with_user_agentstring or null
]
curl -i -X POST \
  https://dev.api.pigello.io/documents/signing/signabledocumentparty/list/ \
  -H 'Content-Type: application/json' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE' \
  -d '[
    {
      "answer_authentication_method": 0,
      "sub_tenant": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "sent_time": "2019-08-24T14:15:22Z",
      "rejection_reason": "string",
      "individually_finished_distribution_method": 0,
      "finished_data": {
        "name": "string",
        "md5_hash": "string",
        "get": "string",
        "post": {
          "url": "string",
          "fields": {}
        }
      },
      "opened_time": "2019-08-24T14:15:22Z",
      "finished_with_ip": "string",
      "order": -2147483648,
      "fully_finished_distribution_method": 0,
      "organization_user": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "rejected_time": "2019-08-24T14:15:22Z",
      "tenant": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "fallback_distribution_method": 0,
      "role": 0,
      "document": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "signed_time": "2019-08-24T14:15:22Z",
      "started_time": "2019-08-24T14:15:22Z",
      "invite_distribution_method": 0,
      "view_authentication_method": 0,
      "custom_id": "string",
      "finished_with_user_agent": "string"
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
roleinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

documentobject(Signabledocument)required
document.​idstring(uuid)
answer_authentication_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456789
created_atstring(date-time)read-only
sub_tenantobject or null(Subtenant)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: organization_user, tenant

sent_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: opened_time, signed_time, rejected_time

rejection_reasonstring or null

Additional Validation Information:

This value requires that the following fields are also set: rejected_time

individually_finished_distribution_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123
opened_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: signed_time, rejected_time, sent_time

finished_with_ipstring or null(ipv6,ipv4)
orderinteger(int32)[ -2147483648 .. 2147483647 ]
fully_finished_distribution_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123
organization_userobject or null(Organizationuser)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: tenant, sub_tenant

organizationobject or null(Organization)
rejected_timestring or null(date-time)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: signed_time

This value must be set in an proper order, in relation to the following fields: sent_time, opened_time

This value requires that the following fields are also set: started_time

tenantobject or null(Tenant)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: organization_user, sub_tenant

fallback_distribution_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123
signed_timestring or null(date-time)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: rejected_time

This value must be set in an proper order, in relation to the following fields: opened_time, sent_time

This value requires that the following fields are also set: started_time

started_timestring or null(date-time)
invite_distribution_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123
view_authentication_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456789
custom_idstring or null<= 128 characters
finished_with_user_agentstring or null
]
Response
application/json
[
  {
    "answer_authentication_method": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "sub_tenant": { … },
    "sent_time": "2019-08-24T14:15:22Z",
    "rejection_reason": "string",
    "individually_finished_distribution_method": 0,
    "opened_time": "2019-08-24T14:15:22Z",
    "finished_with_ip": "string",
    "order": -2147483648,
    "fully_finished_distribution_method": 0,
    "organization_user": { … },
    "organization": { … },
    "rejected_time": "2019-08-24T14:15:22Z",
    "tenant": { … },
    "fallback_distribution_method": 0,
    "role": 0,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "document": { … },
    "signed_time": "2019-08-24T14:15:22Z",
    "started_time": "2019-08-24T14:15:22Z",
    "invite_distribution_method": 0,
    "view_authentication_method": 0,
    "custom_id": "string",
    "finished_with_user_agent": "string"
  }
]

Create 'Signabledocumentparty'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Bodyapplication/json
roleinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
documentobject(Signabledocument)required
document.​idstring(uuid)
answer_authentication_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456789
sub_tenantobject or null(Subtenant)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: organization_user, tenant

sent_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: opened_time, signed_time, rejected_time

rejection_reasonstring or null

Additional Validation Information:

This value requires that the following fields are also set: rejected_time

individually_finished_distribution_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123
finished_dataobject or nullwrite-only
opened_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: signed_time, rejected_time, sent_time

finished_with_ipstring or null(ipv6,ipv4)
orderinteger(int32)[ -2147483648 .. 2147483647 ]
fully_finished_distribution_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123
organization_userobject or null(Organizationuser)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: tenant, sub_tenant

organizationobject or null(Organization)
rejected_timestring or null(date-time)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: signed_time

This value must be set in an proper order, in relation to the following fields: sent_time, opened_time

This value requires that the following fields are also set: started_time

tenantobject or null(Tenant)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: organization_user, sub_tenant

fallback_distribution_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123
signed_timestring or null(date-time)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: rejected_time

This value must be set in an proper order, in relation to the following fields: opened_time, sent_time

This value requires that the following fields are also set: started_time

started_timestring or null(date-time)
invite_distribution_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123
view_authentication_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456789
custom_idstring or null<= 128 characters
finished_with_user_agentstring or null
curl -i -X POST \
  https://dev.api.pigello.io/documents/signing/signabledocumentparty/ \
  -H 'Content-Type: application/json' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE' \
  -d '{
    "answer_authentication_method": 0,
    "sub_tenant": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "sent_time": "2019-08-24T14:15:22Z",
    "rejection_reason": "string",
    "individually_finished_distribution_method": 0,
    "finished_data": {
      "name": "string",
      "md5_hash": "string",
      "get": "string",
      "post": {
        "url": "string",
        "fields": {}
      }
    },
    "opened_time": "2019-08-24T14:15:22Z",
    "finished_with_ip": "string",
    "order": -2147483648,
    "fully_finished_distribution_method": 0,
    "organization_user": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "rejected_time": "2019-08-24T14:15:22Z",
    "tenant": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "fallback_distribution_method": 0,
    "role": 0,
    "document": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "signed_time": "2019-08-24T14:15:22Z",
    "started_time": "2019-08-24T14:15:22Z",
    "invite_distribution_method": 0,
    "view_authentication_method": 0,
    "custom_id": "string",
    "finished_with_user_agent": "string"
  }'

Responses

Successful creation

Bodyapplication/json
roleinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

documentobject(Signabledocument)required
document.​idstring(uuid)
answer_authentication_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456789
created_atstring(date-time)read-only
sub_tenantobject or null(Subtenant)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: organization_user, tenant

sent_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: opened_time, signed_time, rejected_time

rejection_reasonstring or null

Additional Validation Information:

This value requires that the following fields are also set: rejected_time

individually_finished_distribution_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123
opened_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: signed_time, rejected_time, sent_time

finished_with_ipstring or null(ipv6,ipv4)
orderinteger(int32)[ -2147483648 .. 2147483647 ]
fully_finished_distribution_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123
organization_userobject or null(Organizationuser)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: tenant, sub_tenant

organizationobject or null(Organization)
rejected_timestring or null(date-time)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: signed_time

This value must be set in an proper order, in relation to the following fields: sent_time, opened_time

This value requires that the following fields are also set: started_time

tenantobject or null(Tenant)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: organization_user, sub_tenant

fallback_distribution_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123
signed_timestring or null(date-time)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: rejected_time

This value must be set in an proper order, in relation to the following fields: opened_time, sent_time

This value requires that the following fields are also set: started_time

started_timestring or null(date-time)
invite_distribution_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123
view_authentication_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456789
custom_idstring or null<= 128 characters
finished_with_user_agentstring or null
Response
application/json
{
  "answer_authentication_method": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "sub_tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "sent_time": "2019-08-24T14:15:22Z",
  "rejection_reason": "string",
  "individually_finished_distribution_method": 0,
  "opened_time": "2019-08-24T14:15:22Z",
  "finished_with_ip": "string",
  "order": -2147483648,
  "fully_finished_distribution_method": 0,
  "organization_user": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "rejected_time": "2019-08-24T14:15:22Z",
  "tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "fallback_distribution_method": 0,
  "role": 0,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "document": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "signed_time": "2019-08-24T14:15:22Z",
  "started_time": "2019-08-24T14:15:22Z",
  "invite_distribution_method": 0,
  "view_authentication_method": 0,
  "custom_id": "string",
  "finished_with_user_agent": "string"
}

Delete 'Signabledocumentparty'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Path
pkstringwrite-onlyrequired
curl -i -X DELETE \
  'https://dev.api.pigello.io/documents/signing/signabledocumentparty/{pk}/' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE'

Responses

Successful deletion

Response
No content
© Pigello. All rights reserved.