Complete a fact-find request for a given fact-find pass

POST /api/v1/fact-find/request/{factFindRequest_uuid}/complete

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • factFindRequest_uuid string Required
application/json

Body Required

  • fact_find_pass_uuid string Required

    The fact-find pass that is completing the fact-find.

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.

    • status string

      The status of the fact-find request. Available options: in_progress,complete

    • completed_at string

      The datetime when the fact-find request has been completed

    • invitation_text string

      The text that is used in the notification/email sent out to the client.

    • schema object

      The fact-find schema used for the fact-find request.

      Hide schema attributes Show schema attributes object
      • uuid string
      • created_at string
      • updated_at string
      • archived_at string
      • is_archived boolean
      • name string
      • introduction_html string
      • sections_count integer
      • public_url string
    • latest_file object

      The latest file that has been generated for the fact-find request.

      Hide latest_file attributes Show latest_file attributes object
      • uuid string
      • created_at string
      • original_created_at string
      • updated_at string
      • uploaded_at string
      • status string
      • filename string
      • name string
      • extension string
      • type string
      • size string
      • path string
      • last_modified string
      • progress string
      • download_url string
      • folder_name string
      • folder string
      • documentable_type string
      • documentable string
      • navigator object
        Hide navigator attributes Show navigator attributes object
        • model_type string
        • model_uuid string
      • firm string
      • account string
      • tags string
    • account object

      The account that the fact-find request was sent to. Only visible when listing fact-find requests for a circle.

      Hide account attributes Show account 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 string
    • invitation_url string

      The invitation URL sent to the client.

    • fact_find_passes object

      The fact find passes added to the fact-find request.

      Hide fact_find_passes attributes Show fact_find_passes attributes object
      • uuid string
      • created_at string
      • updated_at string
      • firm object
        Hide firm attributes Show firm attributes object
        • uuid string
        • name string
      • account string
      • circle object
        Hide circle attributes Show circle attributes object
        • uuid string
        • name string
      • expires_at string
      • progress integer
      • is_complete boolean
      • completed_sections integer
POST /api/v1/fact-find/request/{factFindRequest_uuid}/complete
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/fact-find/request/6ff8f7f6-1eb3-3525-be4a-3932c805afed/complete' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"fact_find_pass_uuid":"cae9365c-779c-4cb9-914a-ab4229d2dc36"}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "fact_find_pass_uuid": "cae9365c-779c-4cb9-914a-ab4229d2dc36"
}
Response examples (200)
{
  "uuid": "e2a99c75-90ea-4c19-aba7-5bf7d31d3229",
  "schema": {
    "name": "Default fact-find",
    "uuid": "61e19760-1b03-4944-b100-e7a08205afe9",
    "created_at": "2025-08-27T17:31:27+01:00",
    "public_url": "https://api.plannrcrm.com/fact-find/96d18553-75f9-46d5-b59d-d9c61a6307ee",
    "updated_at": "2025-08-27T17:31:27+01:00",
    "archived_at": "2025-08-26T17:31:27+01:00",
    "is_archived": false,
    "sections_count": 5,
    "introduction_html": "Welcome to our fact-find! <b>You can use some HTML too.</b>"
  },
  "status": "complete",
  "account": {
    "name": "Gareth Thompson",
    "role": "client",
    "type": "client",
    "uuid": "06854d12-3697-40a7-92d4-c48f69562598",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-08-27T17:31:27+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-08-27T17:31:27+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "created_at": "2025-08-27T17:31:27+01:00",
  "updated_at": "2025-08-27T17:31:27+01:00",
  "latest_file": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Welcome to Plannr",
    "path": "Gareth Thompson/Subfolder/Welcome to Plannr.pdf",
    "size": "21691783",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "type",
    "uuid": "9f9fdb0c-3d19-4636-9705-85604276dc9c",
    "folder": "App\\Http\\Resources\\FolderResource",
    "status": "uploaded",
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "filename": "Welcome to Plannr.pdf",
    "progress": "100",
    "extension": "pdf",
    "navigator": {
      "model_type": "account",
      "model_uuid": "0f8bc9ce-7d2c-46d8-b7f3-639597e5daed"
    },
    "created_at": "2025-08-27T17:31:27+01:00",
    "updated_at": "2025-08-27T17:31:27+01:00",
    "folder_name": "folder 2",
    "uploaded_at": "2025-08-27T17:31:27+01:00",
    "documentable": "Object",
    "download_url": "https://api.plannrcrm.com/file/3ca327b0-5adf-4888-92cb-c6c7befb817c/download",
    "last_modified": "2025-08-27T17:31:27+01:00",
    "documentable_type": "account",
    "original_created_at": "2025-08-27T17:31:27+01:00"
  },
  "completed_at": "2025-08-22T17:31:27+01:00",
  "invitation_url": "https://api.plannrcrm.com/fact-find/e54b7ff7-d160-456a-900c-aac7f72d2088/42a2fa30-d8fa-4254-9738-ad862bf01029",
  "invitation_text": "Please complete this fact-find!",
  "fact_find_passes": {
    "firm": {
      "name": "Codepotato Ltd",
      "uuid": "29bd464d-36be-4291-9f93-70ad913d97b1"
    },
    "uuid": "3a95074c-3dd9-4d93-b642-69fbad2ed6f5",
    "circle": {
      "name": "The Codepotato Gang",
      "uuid": "ed2be107-6422-43a2-b45f-42ffdeb50ae7"
    },
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "progress": 50,
    "created_at": "2025-08-27T17:31:27+01:00",
    "expires_at": "2025-08-27T17:31:27+01:00",
    "updated_at": "2025-08-27T17:31:27+01:00",
    "is_complete": false,
    "completed_sections": 2
  }
}