Complete a fact-find request for a given fact-find pass
Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Path parameters
-
factFindRequest_uuid
string Required
Body
Required
-
fact_find_pass_uuid
string Required The fact-find pass that is completing the fact-find.
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":"f947909c-d265-463c-82e1-2a8c4ab5c12c"}'
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": "f947909c-d265-463c-82e1-2a8c4ab5c12c"
}
Response examples (200)
{
"uuid": "1d4eb59c-556d-4cf8-808c-eaf4f355ce5f",
"schema": {
"name": "Default fact-find",
"uuid": "da4a76ab-4a78-4b5a-8a7d-cd3eff777315",
"created_at": "2025-04-22T13:44:20+01:00",
"public_url": "https://plannr.valet/fact-find/b45ceb6f-2d58-4d81-bdbf-b8e8c6caee94",
"updated_at": "2025-04-22T13:44:20+01:00",
"archived_at": "2025-04-21T13:44:20+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": "c5c518ca-6001-425a-9260-0a9b0935e2f2",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-04-22T13:44:20+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-22T13:44:20+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"created_at": "2025-04-22T13:44:20+01:00",
"updated_at": "2025-04-22T13:44:20+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": "c02b7f01-cf78-4375-acb0-bb8e61e16d42",
"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": "115c9de6-5e86-4da5-8695-255440c43583"
},
"created_at": "2025-04-22T13:44:20+01:00",
"updated_at": "2025-04-22T13:44:20+01:00",
"folder_name": "folder 2",
"uploaded_at": "2025-04-22T13:44:20+01:00",
"documentable": "Object",
"download_url": "https://plannr.valet/file/c3c666a2-1d9b-4fbd-a43d-8a92903bc32e/download",
"last_modified": "2025-04-22T13:44:20+01:00",
"documentable_type": "account",
"original_created_at": "2025-04-22T13:44:20+01:00"
},
"completed_at": "2025-04-17T13:44:20+01:00",
"invitation_url": "https://plannr.valet/fact-find/3202e2c8-8ec3-4332-8aa5-b00e19e93aa9/2880fde2-24cb-4932-9829-5382c524ed77",
"invitation_text": "Please complete this fact-find!",
"fact_find_passes": {
"firm": {
"name": "Codepotato Ltd",
"uuid": "4bddf070-bf04-4ede-a994-d82ef4d11fbb"
},
"uuid": "b1dd09da-d6fc-4902-a9eb-93bb3bde75e7",
"circle": {
"name": "The Codepotato Gang",
"uuid": "f94c1df7-fd96-4d7c-8e95-b8e68aef287a"
},
"account": "App\\Http\\Resources\\MinimalAccountResource",
"progress": 50,
"created_at": "2025-04-22T13:44:20+01:00",
"expires_at": "2025-04-22T13:44:20+01:00",
"updated_at": "2025-04-22T13:44:20+01:00",
"is_complete": false,
"completed_sections": 2
}
}