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

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

Headers

Path parameters

application/json

Body 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.

    • 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}/complete 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/fact-find/request/factFindRequest_uuid/complete' \
 --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}" \
 --data '{"fact_find_pass_uuid":"8921b9af-e1b7-49fb-a90e-b73e1eb45520"}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "fact_find_pass_uuid": "8921b9af-e1b7-49fb-a90e-b73e1eb45520"
}
Response examples (200) 
{
  "uuid": "dcdbe704-b6ed-475a-9cb3-7fb4d4d01f2a",
  "schema": {
    "name": "Default fact-find",
    "uuid": "2830da64-1add-49de-80e1-47937fc2a2d6",
    "created_at": "2025-04-02T13:27:58+01:00",
    "public_url": "https://plannr.valet/fact-find/1a6f6338-980f-4918-b375-d755055ca0f2",
    "updated_at": "2025-04-02T13:27:58+01:00",
    "archived_at": "2025-04-01T13:27:58+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": "32dc9e44-898e-4528-ab65-3cdf699ef91e",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-04-02T13:27:58+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-04-02T13:27:58+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "created_at": "2025-04-02T13:27:58+01:00",
  "updated_at": "2025-04-02T13:27:58+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": "98205236-2fa0-4df9-a4a0-02dea681bc20",
    "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": "c3bf4564-78e8-46c6-927a-78d235fb2068"
    },
    "created_at": "2025-04-02T13:27:58+01:00",
    "updated_at": "2025-04-02T13:27:58+01:00",
    "folder_name": "folder 2",
    "uploaded_at": "2025-04-02T13:27:58+01:00",
    "documentable": "Object",
    "download_url": "https://plannr.valet/file/51256a8a-f795-4267-a074-f12d6148bfda/download",
    "last_modified": "2025-04-02T13:27:58+01:00",
    "documentable_type": "account",
    "original_created_at": "2025-04-02T13:27:58+01:00"
  },
  "completed_at": "2025-03-28T13:27:58+00:00",
  "invitation_url": "https://plannr.valet/fact-find/5f6cd9e4-c4c9-448c-b148-ff4bd1e135ae/5e1f4ea3-62c6-4bea-86b8-6fb35b51029f",
  "invitation_text": "Please complete this fact-find!",
  "fact_find_passes": {
    "firm": {
      "name": "Codepotato Ltd",
      "uuid": "d90018b7-401f-4d35-828d-b2a1ea4a25bc"
    },
    "uuid": "bea152e7-c21f-4e31-846a-695180678eb7",
    "circle": {
      "name": "The Codepotato Gang",
      "uuid": "bc024d18-c56b-47b8-a627-cbccd45cae71"
    },
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "progress": 50,
    "created_at": "2025-04-02T13:27:58+01:00",
    "expires_at": "2025-04-02T13:27:58+01:00",
    "updated_at": "2025-04-02T13:27:58+01:00",
    "is_complete": false,
    "completed_sections": 2
  }
}