Finish the fact-find request

POST /api/v1/fact-find/request/{factFindRequest_uuid}/finish
Personal access token & O auth2

Will mark the fact-find request as completed overall regardless of fact-find pass progress.

Headers

Path parameters

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.

    • latest_file object

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

    • account object

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

    • invitation_url string

      The invitation URL sent to the client.

    • fact_find_passes object

      The fact find passes added to the fact-find request.
POST /api/v1/fact-find/request/{factFindRequest_uuid}/finish 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/fact-find/request/factFindRequest_uuid/finish' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "uuid": "b72f7e64-95a5-4eac-b747-a064a0988dc9",
  "schema": {
    "name": "Default fact-find",
    "uuid": "56055146-1903-4ea9-b7ca-e373ff866854",
    "created_at": "2025-04-11T12:55:02+01:00",
    "public_url": "https://plannr.valet/fact-find/a3da07d0-4bb3-4c8d-8b89-32aeb1c4f10b",
    "updated_at": "2025-04-11T12:55:02+01:00",
    "archived_at": "2025-04-10T12:55:02+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": "6adcec98-3c07-48e7-8dd8-9ae039640a7d",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-04-11T12:55:02+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-04-11T12:55:02+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "created_at": "2025-04-11T12:55:02+01:00",
  "updated_at": "2025-04-11T12:55:02+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": "b0a16f87-1fcb-4c63-b5e9-3d200abcd9e6",
    "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": "8f400a29-93e3-44d5-adf2-0a38a1dd339d"
    },
    "created_at": "2025-04-11T12:55:02+01:00",
    "updated_at": "2025-04-11T12:55:02+01:00",
    "folder_name": "folder 2",
    "uploaded_at": "2025-04-11T12:55:02+01:00",
    "documentable": "Object",
    "download_url": "https://plannr.valet/file/6611f61d-7cd2-4431-852c-66ee4f421e8e/download",
    "last_modified": "2025-04-11T12:55:02+01:00",
    "documentable_type": "account",
    "original_created_at": "2025-04-11T12:55:02+01:00"
  },
  "completed_at": "2025-04-06T12:55:02+01:00",
  "invitation_url": "https://plannr.valet/fact-find/1c6c63f2-f75b-4a2a-bffc-f04007f62527/e8312e1c-6885-4b0b-ba82-9825f1e25205",
  "invitation_text": "Please complete this fact-find!",
  "fact_find_passes": {
    "firm": {
      "name": "Codepotato Ltd",
      "uuid": "467c7df9-77ef-49db-a37e-76b9478e7efd"
    },
    "uuid": "3de78e63-8d5f-4161-af77-b1f700620283",
    "circle": {
      "name": "The Codepotato Gang",
      "uuid": "8399a7dd-bee5-4471-8f27-794f30603b93"
    },
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "progress": 50,
    "created_at": "2025-04-11T12:55:02+01:00",
    "expires_at": "2025-04-11T12:55:02+01:00",
    "updated_at": "2025-04-11T12:55:02+01:00",
    "is_complete": false,
    "completed_sections": 2
  }
}