GET /api/v1/document-signing/{signatureTransaction_uuid}
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • signatureTransaction_uuid string Required

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.

      Hide participants attributes Show participants attributes object
      • uuid string
      • created_at string
      • updated_at string
      • alphatrust_id integer
      • name string
      • status string
    • documents array[object]

      Documents of the document signing process.

      Hide documents attributes Show documents attributes object
      • uuid string
      • created_at string
      • updated_at string
      • alphatrust_id integer
      • name string
      • status string
    • launched_by object

      Account that launched the document signing process.

      Hide launched_by attributes Show launched_by attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • firm string
      • primary_phone_number string
      • primary_email string
      • current_time_entry string
      • assigned_adviser string
      • assigned_administrator string
      • assigned_paraplanner string
      • introduced_by string
      • groups string
      • tags string
      • owners string
      • first_contact_date string
      • next_review_date string
      • previous_review_date string
      • anniversary_review_date string
      • with_login boolean
      • has_joint_account boolean
      • can_be_deleted string
      • joint_account_circle string
      • circles string
      • ownership_percentage integer
      • inactive_at string
      • last_interaction_at string
      • referral_code string
      • permissions object
        Hide permissions attributes Show permissions attributes object
        • firm:read array[string]
        • network:read array[string]
      • custom_fields string
      • external_references string
GET /api/v1/document-signing/{signatureTransaction_uuid} 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/document-signing/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "name": 1000243230,
  "uuid": "4e704922-9fd6-4600-b3aa-aa6774cdc76f",
  "status": "pending",
  "documents": [
    {
      "name": "Welcome Pack",
      "uuid": "a32fb3ef-b94d-48a8-aa64-1b5cca5d3971",
      "status": "pending",
      "created_at": "2026-04-08T15:40:47+01:00",
      "updated_at": "2026-04-08T15:40:47+01:00",
      "alphatrust_id": 1000455612
    }
  ],
  "created_at": "2026-04-08T15:40:47+01:00",
  "updated_at": "2026-04-08T15:40:47+01:00",
  "launched_by": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "44a9f0a2-fe9f-401e-8b16-49976d5c07a0",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "created_at": "2026-04-08T15:40:47+01:00",
    "first_name": "Gareth",
    "updated_at": "2026-04-08T15:40:47+01:00",
    "with_login": true,
    "inactive_at": "2026-04-08",
    "permissions": {
      "firm:read": [
        "firm"
      ],
      "network:read": [
        "network:uuid"
      ]
    },
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "referral_code": "ABC12345",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2026-04-08T15:40:47+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2026-04-08T15:40:47+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "last_interaction_at": "2026-04-08 15:40:47",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2026-04-08T15:40:47+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2026-04-08T15:40:47+01:00"
  },
  "participants": [
    {
      "name": "Gareth Thompson",
      "uuid": "e7ab16d1-c892-4e17-92b1-e127fddabe08",
      "status": "pending",
      "created_at": "2026-04-08T15:40:47+01:00",
      "updated_at": "2026-04-08T15:40:47+01:00",
      "alphatrust_id": 1000145124
    }
  ]
}