Raise letters of authority for a client Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}

Close
POST /api/v1/addons/pensionlab/clients/{client_id}/letters-of-authority

Raises one letter per plan. Every required client, firm, provider and policy detail is checked first, and all problems are returned together in a 422 before anything is sent to PensionLab. Retrying after a failure does not create duplicate letters.

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • client_id string Required

    The ID of the client.

application/json

Body Required

  • plans array[object] Required

    The plans to raise letters for.

    Hide plans attributes Show plans attributes object
    • plan string Required

      The plan UUID.

    • pensionlab_provider string

      The PensionLab provider UUID, needed when the plan's provider has no unique PensionLab match.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]
      Hide data attributes Show data attributes object
      • uuid string
      • created_at string
      • updated_at string
      • client object
        Hide client attributes Show client 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
        • external_references object
          Hide external_references attributes Show external_references attributes object
          • uuid

            The UUID of the resource.

          • created_at

            The timestamp of when the resource was created.

          • updated_at

            The timestamp of when the resource was updated.

          • third_party

            The third party provider with the reference.

          • reference

            The third party reference.

      • second_owner object
        Hide second_owner attributes Show second_owner 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
        • external_references object
          Hide external_references attributes Show external_references attributes object
          • uuid

            The UUID of the resource.

          • created_at

            The timestamp of when the resource was created.

          • updated_at

            The timestamp of when the resource was updated.

          • third_party

            The third party provider with the reference.

          • reference

            The third party reference.

      • plan object
        Hide plan attributes Show plan attributes object
        • uuid string
        • created_at string
        • updated_at string
        • opened_at string
        • name string
        • type string
        • sub_type string
        • abstract_type string
        • policy_number string
        • proposal_reference string
        • status string
        • inactive_at string
        • inactive_reason string
        • is_group_scheme boolean
        • is_sub_group_scheme boolean
        • is_group_scheme_member boolean
        • is_wrap_product boolean
        • is_wrap_child boolean
      • pensionlab_provider object
        Hide pensionlab_provider attributes Show pensionlab_provider attributes object
        • uuid string
        • name string
        • policy_number_format string
        • policy_number_is_nino boolean
        • is_db_only boolean
        • response_estimate_days integer
        • provider object
          Hide provider attributes Show provider attributes object
          • uuid

            UUID of the provider

          • created_at

            The timestamp of when the resource was created.

          • updated_at

            The timestamp of when the resource was updated.

          • name

            Provider name

          • slug

            Provider name slug

      • requested_by object
        Hide requested_by attributes Show requested_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
        • external_references object
          Hide external_references attributes Show external_references attributes object
          • uuid

            The UUID of the resource.

          • created_at

            The timestamp of when the resource was created.

          • updated_at

            The timestamp of when the resource was updated.

          • third_party

            The third party provider with the reference.

          • reference

            The third party reference.

      • policy_number string
      • policy_type string
      • ownership string
      • pensionlab_reference string
      • state string
      • signature_status string
      • closed_sub_state string
      • issues array[string]
      • notes string
      • estimated_completion string
      • finished_policies_fraction string
      • client_signed_at string
      • second_owner_signed_at string
      • signed_at string
      • sent_at string
      • completed_at string
      • closed_at string
      • last_synced_at string
      • sync_error string
      • raised_at string
  • 422 application/json

    Validation error

    Hide response attributes Show response attributes object
    • message string Required

      A human-readable description of the error.

    • errors object

      Validation messages keyed by the field that failed.

      Hide errors attribute Show errors attribute object
      • * array[string] Additional properties
POST /api/v1/addons/pensionlab/clients/{client_id}/letters-of-authority
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/addons/pensionlab/clients/architecto/letters-of-authority' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{
  "plans": [
    []
  ]
}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "plans": [
    []
  ]
}
Response examples (200)
{
  "data": [
    {
      "uuid": "17b7137f-863f-44e7-9e32-0711379475bb",
      "created_at": "2026-11-16T13:00:53+00:00",
      "updated_at": "2026-11-16T13:00:53+00:00",
      "client": {
        "uuid": "67785f94-e077-4a73-9532-44e241a596b4",
        "created_at": "2026-11-16T13:00:53+00:00",
        "updated_at": "2026-11-16T13:00:53+00:00",
        "type": "client",
        "role": "client",
        "first_name": "Gareth",
        "last_name": "Thompson",
        "name": "Gareth Thompson",
        "email": "gareth@codepotato.co.uk",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "external_references": {
          "uuid": "da4de829-57ae-478a-bf37-1414f7626c4f",
          "created_at": "2026-11-16T13:00:59+00:00",
          "updated_at": "2026-11-16T13:00:59+00:00",
          "third_party": "nucleus",
          "reference": "AB123456"
        }
      },
      "second_owner": {
        "uuid": "09eda53e-140f-43f1-b48b-e33101c44c93",
        "created_at": "2026-11-16T13:00:53+00:00",
        "updated_at": "2026-11-16T13:00:53+00:00",
        "type": "client",
        "role": "client",
        "first_name": "Gareth",
        "last_name": "Thompson",
        "name": "Gareth Thompson",
        "email": "gareth@codepotato.co.uk",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "external_references": {
          "uuid": "da4de829-57ae-478a-bf37-1414f7626c4f",
          "created_at": "2026-11-16T13:00:59+00:00",
          "updated_at": "2026-11-16T13:00:59+00:00",
          "third_party": "nucleus",
          "reference": "AB123456"
        }
      },
      "plan": {
        "uuid": "e0c1f6e4-ca0f-46ac-99e1-6387d676194e",
        "created_at": "2026-11-16T13:00:53+00:00",
        "updated_at": "2026-11-16T13:00:53+00:00",
        "opened_at": "2026-11-16T13:00:53+00:00",
        "name": "Johns ISA",
        "type": "cash_account",
        "sub_type": "lifetime isa",
        "abstract_type": "asset",
        "policy_number": "AVIVA-123",
        "proposal_reference": "AB123456",
        "status": "inactive",
        "inactive_at": "2026-11-16T13:00:53+00:00",
        "inactive_reason": "claimed",
        "is_group_scheme": false,
        "is_sub_group_scheme": false,
        "is_group_scheme_member": false,
        "is_wrap_product": false,
        "is_wrap_child": false
      },
      "pensionlab_provider": {
        "uuid": "0324bbeb-ad67-4f9a-9491-f5ff0981f322",
        "name": "Aviva Life & Pensions UK Ltd",
        "policy_number_format": "123456/PP",
        "policy_number_is_nino": false,
        "is_db_only": false,
        "response_estimate_days": 14,
        "provider": {
          "uuid": "2adc7992-7b0f-485a-9e82-f2883f0bf08f",
          "created_at": "2026-11-16T13:00:59+00:00",
          "updated_at": "2026-11-16T13:00:59+00:00",
          "name": "AJ Bell",
          "slug": "aj-bell"
        }
      },
      "requested_by": {
        "uuid": "4b46b31d-9939-4af3-9cdf-c6c668b05671",
        "created_at": "2026-11-16T13:00:53+00:00",
        "updated_at": "2026-11-16T13:00:53+00:00",
        "type": "client",
        "role": "client",
        "first_name": "Gareth",
        "last_name": "Thompson",
        "name": "Gareth Thompson",
        "email": "gareth@codepotato.co.uk",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "external_references": {
          "uuid": "da4de829-57ae-478a-bf37-1414f7626c4f",
          "created_at": "2026-11-16T13:00:59+00:00",
          "updated_at": "2026-11-16T13:00:59+00:00",
          "third_party": "nucleus",
          "reference": "AB123456"
        }
      },
      "policy_number": "123456/PP",
      "policy_type": "pension",
      "ownership": "single",
      "pensionlab_reference": "loa123",
      "state": "created",
      "signature_status": "Awaiting signature",
      "closed_sub_state": "chased out",
      "issues": [
        "Date of birth"
      ],
      "notes": "Provider confirmed receipt.",
      "estimated_completion": "7 days",
      "finished_policies_fraction": "2/5",
      "client_signed_at": "2026-10-27T09:00:00+00:00",
      "second_owner_signed_at": "2026-10-27T09:30:00+00:00",
      "signed_at": "2026-10-27T09:30:00+00:00",
      "sent_at": "2026-10-27T10:00:00+00:00",
      "completed_at": "2026-11-03T10:00:00+00:00",
      "closed_at": "2026-11-03T10:00:00+00:00",
      "last_synced_at": "2026-10-27T10:05:00+00:00",
      "sync_error": "credentials_unavailable",
      "raised_at": "2026-10-26T10:00:00+00:00",
      "signing_link_sent_at": "2026-10-26T10:05:00+00:00",
      "signing_link_sent_by": {
        "uuid": "011e6960-1d84-41d7-8bb4-d57cae8ca778",
        "created_at": "2026-11-16T13:00:53+00:00",
        "updated_at": "2026-11-16T13:00:53+00:00",
        "type": "client",
        "role": "client",
        "first_name": "Gareth",
        "last_name": "Thompson",
        "name": "Gareth Thompson",
        "email": "gareth@codepotato.co.uk",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "external_references": {
          "uuid": "da4de829-57ae-478a-bf37-1414f7626c4f",
          "created_at": "2026-11-16T13:00:59+00:00",
          "updated_at": "2026-11-16T13:00:59+00:00",
          "third_party": "nucleus",
          "reference": "AB123456"
        }
      }
    }
  ]
}
Response examples (422)
{
  "message": "The given data was invalid.",
  "errors": {
    "field": [
      "The field is invalid."
    ]
  }
}