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":"93a27845-c4a6-4499-ab8a-11cd81527007"}'
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": "93a27845-c4a6-4499-ab8a-11cd81527007"
}
Response examples (200) 
{
  "uuid": "3b66a3aa-aec3-43e4-8615-c49cb6d10902",
  "schema": {
    "name": "Default fact-find",
    "uuid": "4beb678c-0e3d-42d7-a449-375853c4733e",
    "created_at": "2025-05-14T18:27:15+01:00",
    "public_url": "https://plannr.valet/fact-find/5ef4863d-1e27-47aa-80d6-2611cfce8e4a",
    "updated_at": "2025-05-14T18:27:15+01:00",
    "archived_at": "2025-05-13T18:27:15+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": "e3f55217-7944-4c33-8b43-d4a1fe8f7768",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-05-14T18:27:15+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-05-14T18:27:15+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "created_at": "2025-05-14T18:27:15+01:00",
  "updated_at": "2025-05-14T18:27:15+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": "5f25857f-7763-4e84-9dcc-6aa41f6d0185",
    "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": "1e8c02f9-8391-4c28-98f6-5f623795465b"
    },
    "created_at": "2025-05-14T18:27:15+01:00",
    "updated_at": "2025-05-14T18:27:15+01:00",
    "folder_name": "folder 2",
    "uploaded_at": "2025-05-14T18:27:15+01:00",
    "documentable": "Object",
    "download_url": "https://plannr.valet/file/700b35bb-9b06-4c23-98ea-7e1864835952/download",
    "last_modified": "2025-05-14T18:27:15+01:00",
    "documentable_type": "account",
    "original_created_at": "2025-05-14T18:27:15+01:00"
  },
  "completed_at": "2025-05-09T18:27:15+01:00",
  "invitation_url": "https://plannr.valet/fact-find/bc5685b8-4e63-4a2d-84e0-f768badf4c4e/2cb0e001-e3a5-4155-a23a-99943184d1f1",
  "invitation_text": "Please complete this fact-find!",
  "fact_find_passes": {
    "firm": {
      "name": "Codepotato Ltd",
      "uuid": "73b40c0d-b3ee-4a15-a4b8-e3d26aae5643"
    },
    "uuid": "2711a3da-2716-40f6-b92c-885fbe7022d3",
    "circle": {
      "name": "The Codepotato Gang",
      "uuid": "6c586563-5fee-4a5c-bb34-52968f5bd141"
    },
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "progress": 50,
    "created_at": "2025-05-14T18:27:15+01:00",
    "expires_at": "2025-05-14T18:27:15+01:00",
    "updated_at": "2025-05-14T18:27:15+01:00",
    "is_complete": false,
    "completed_sections": 2
  }
}