POST /api/v1/loa
Personal access token & O auth2

Generates a Letter of Authority document for a client with the specified plans. Groups plans by provider and sends a separate LoA for each provider with only that provider's policy numbers.

Headers

  • X-PLANNR-ACCOUNT-UUID string
application/json

Body Required

  • client_uuid string Required

    The UUID of the client.

  • plan_uuids array[string] Required

    Array of plan UUIDs to include in the LoA.

  • document_template_uuid string Required

    The UUID of the document template to use.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data object
      Hide data attribute Show data attribute object
      • transactions array[object]
        Hide transactions attributes Show transactions attributes object
        • transaction_uuid string
        • provider string
        • policy_numbers string
POST /api/v1/loa 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/loa' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"client_uuid":"53f22fe4-3731-4cdc-aa12-e65bd0b15e52","plan_uuids":["6a6a176d-52bc-47f2-88c3-141d44059bcf"],"document_template_uuid":"043ec548-b3a7-5f2d-b4dd-3947c0d8eaa0"}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "client_uuid": "53f22fe4-3731-4cdc-aa12-e65bd0b15e52",
  "plan_uuids": [
    "6a6a176d-52bc-47f2-88c3-141d44059bcf"
  ],
  "document_template_uuid": "043ec548-b3a7-5f2d-b4dd-3947c0d8eaa0"
}
Response examples (200) 
{
  "data": {
    "transactions": [
      {
        "provider": "Aviva",
        "policy_numbers": "POL123, POL456",
        "transaction_uuid": "abc123-def456-ghi789"
      },
      {
        "provider": "Legal & General",
        "policy_numbers": "POL789",
        "transaction_uuid": "xyz789-abc123-def456"
      }
    ]
  }
}