Perform a recipient action on a signature request | Solvimon

curl -X POST https://test.api.solvimon.com/v1/signature-requests//recipient-action \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "recipient_id": "a1b2c3d4e5f6g7h8i9j0",
  "action": "VIEW"
}'

{
  "object_type": "signature_request",
  "id": "sr_1234567890abcdef",
  "created_at": "2024-05-20T10:15:30Z",
  "updated_at": "2024-05-21T08:45:00Z",
  "status": "IN_PROGRESS",
  "type": "QUOTE_VERSION",
  "quote_version": {
    "quote_version_id": "qv_0987654321fedcba"
  },
  "recipients": [
    {
      "id": "rec_1122334455",
      "contact_id": "cont_6677889900",
      "name": {
        "first_name": "Emily",
        "last_name": "Johnson",
        "infix": "van"
      },
      "email": "emily.van.johnson@example.com",
      "role": "SIGNER",
      "status": "PENDING"
    }
  ]
}

Requires the SIGNATURE_REQUEST.UPDATE permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

resourceIdstringRequiredDefaults to

The ID of the resource to be requested.

Request

This endpoint expects an object.

recipient_idstringRequired

The recipient ID of the recipient performing the action.

actionenumRequired

The action the recipient is performing.

Allowed values:

Response

object_typestring or nullRead-only

idstring or nullRead-only

created_atstring or nullRead-only

updated_atstring or nullRead-only

statusenum or nullRead-only

The status of the signature request.

Allowed values:

typeenum or nullRead-only

The type of the signature request.

Allowed values:

quote_versionobject

recipientslist of objects or nullRead-only

The recipients of the signature request.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors