Get a signature transaction

GET /api/v1/document-signing/{signatureTransaction_uuid}

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • name integer

      Transaction ID on Alphatrust

    • status string

      Current status of the document signing process.

    • participants array[object]

      Participants of the document signing process.

      Additional properties are allowed.

    • documents array[object]

      Documents of the document signing process.

      Additional properties are allowed.

    • launched_by object

      Account that launched the document signing process.

      Additional properties are allowed.
GET /api/v1/document-signing/{signatureTransaction_uuid} 
curl \
 -X GET https://api.plannrcrm.com/api/v1/document-signing/signatureTransaction_uuid \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "name": 1000243230,
  "uuid": "737aad8c-449d-4c86-a884-cfdfd8c57d00",
  "status": "pending",
  "documents": [
    {
      "name": "Welcome Pack",
      "uuid": "aac6d63d-e702-4098-9258-b23132f4c9d5",
      "status": "pending",
      "created_at": "2025-01-17T11:18:31+00:00",
      "updated_at": "2025-01-17T11:18:31+00:00",
      "alphatrust_id": 1000455612
    }
  ],
  "created_at": "2025-01-17T11:18:31+00:00",
  "updated_at": "2025-01-17T11:18:31+00:00",
  "launched_by": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "a9e71263-9059-4dc8-bed6-603fccab3934",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-01-17T11:18:31+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-01-17T11:18:31+00:00",
    "with_login": true,
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2025-01-17T11:18:31+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-01-17T11:18:31+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2025-01-17T11:18:31+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-01-17T11:18:31+00:00"
  },
  "participants": [
    {
      "name": "Gareth Thompson",
      "uuid": "8c1e6608-e3e1-4960-95ef-bdf472f61676",
      "status": "pending",
      "created_at": "2025-01-17T11:18:31+00:00",
      "updated_at": "2025-01-17T11:18:31+00:00",
      "alphatrust_id": 1000145124
    }
  ]
}