LogoSignature Service
REST APISigning requests

Retrieve a signing request

GET
/admin/api/v3/organizations/{organizationId}/rooms/{signingRoomId}/requests/{signingRequestId}

Authorization

basicAuth
AuthorizationBasic <token>

In: header

Path Parameters

organizationId*string
signingRoomId*string
signingRequestId*string

Response Body

application/json

curl -X GET "https://example.com/admin/api/v3/organizations/string/rooms/string/requests/string"
{  "auditTrailAvailable": true,  "canceledAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "createdBy": {    "displayName": "string"  },  "deliveryOptions": {    "recipients": [      {        "email": "string",        "locale": "string"      }    ]  },  "documents": [    {      "id": "string",      "payloadSigned": true,      "payloadType": "PDF",      "responses": [        {          "decision": "ACCEPTED",          "id": "string",          "payloadSigned": true,          "rejectionMessage": "string",          "repliedAt": "2019-08-24T14:15:22Z",          "signatory": {            "displayName": "string",            "email": "string",            "firstname": "string",            "id": "string",            "lastname": "string",            "locale": "string",            "manager": true,            "phoneNumber": "string",            "signatoryAttributes": [              {                "displayName": "string",                "key": "string",                "required": true,                "value": "string"              }            ],            "signingRoomPermission": "SIGNATORY",            "username": "string"          }        }      ],      "thumbnail": "string",      "title": "string"    }  ],  "expiresAt": "2019-08-24T14:15:22Z",  "id": "string",  "lastModifiedAt": "2019-08-24T14:15:22Z",  "message": "string",  "retainedUntil": "2019-08-24T14:15:22Z",  "signatories": [    {      "displayName": "string",      "email": "string",      "firstname": "string",      "id": "string",      "lastname": "string",      "locale": "string",      "manager": true,      "phoneNumber": "string",      "signatoryAttributes": [        {          "displayName": "string",          "key": "string",          "required": true,          "value": "string"        }      ],      "signingRoomPermission": "SIGNATORY",      "username": "string"    }  ],  "signingOrder": "SEQUENTIAL",  "state": "PENDING",  "workflow": {    "deliveryOptions": {      "allowManagerToAddRecipients": true,      "domainNames": [        "string"      ],      "sendSigningReportToAllManager": true    },    "description": "string",    "electronicSeal": true,    "enabledByDefault": true,    "id": "string",    "identification": true,    "name": "string",    "preassignedSignatories": {      "allowEdition": true,      "signatories": [        {          "email": "string",          "locale": "string"        }      ]    },    "smartContractIdentifier": "string"  }}

Retrieve the signing invitations GET

This API can be used to retrieve signing invitations for a signing request. In the case of a collective signatures, the signing invitations are sorted accordingly to the sequential signature order and are only valid during the interval the signing request is awaiting user's signature.

Retrieve the signed payload of a document GET

This API can be used to retrieve the document signed by all signatories.