GET /api/v2/portal/fact-find-session/{factFindSession_uuid}/launch
Personal access token & O auth2

This endpoint allows a client — or an adviser impersonating that client — to launch the client's fact-find session from the portal. On success, a 6-hour authenticated session is established for the fact-find and a 204 response is returned. The frontend is responsible for navigating the user to the fact-find page.

Path parameters

  • factFindSession_uuid string Required
  • factFindSession string Required

    The UUID of the fact-find session.

GET /api/v2/portal/fact-find-session/{factFindSession_uuid}/launch 
curl \
 --request GET 'https://api.plannrcrm.com/api/v2/portal/fact-find-session/6ff8f7f6-1eb3-3525-be4a-3932c805afed/launch' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (204) 
The fact-find session was launched successfully.
Response examples (401) 
No authenticated login was found on the request.
Response examples (403) 
The client does not have access to this fact-find session.
Response examples (404) 
The fact-find session UUID does not exist.