GET /api/v2/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 the session data is returned so the frontend can render the fact-find page.

When the request is authenticated via the mobile app, no session cookie is set. Instead, a X-Fact-Find-Session-Token header is returned containing a bearer token that must be included on all subsequent fact-find requests in place of the session cookie.

Path parameters

  • factFindSession_uuid string Required
  • factFindSession string Required

    The UUID of the fact-find session.

GET /api/v2/fact-find-session/{factFindSession_uuid}/launch 
curl \
 --request GET 'https://api.plannrcrm.com/api/v2/fact-find-session/6ff8f7f6-1eb3-3525-be4a-3932c805afed/launch' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
The fact-find session was launched successfully and is returned in the response body.
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.