Get Client's fact find request

GET /api/v2/clients/backoffice/{BackOfficeID}/factfind

Bearer auth

This endpoint allows you to retrieve information regarding a client's active fact find.

Path parameters

BackOfficeID string(uuid) Required

The BackOfficeID for the client whose fact find you want to retrieve.

Query parameters

ExcludeFormattedValues string

If set to any value, formatted values will be excluded from the response.

Responses

200 application/json

Success
Hide response attributes Show response attributes object
- success boolean
  
  Default value is true.
- data object
  
  Hide data attributes Show data attributes object
  
  ClientGUID string(uuid)
  
  RelatedClientGUID string(uuid)
  
  BackOfficeID string
  
  RelatedClientBackOfficeID string
  
  FactFindRequestGUID string(uuid)
  
  FactFindTemplateGUID string(uuid)
  
  WhenRequested string
  
  WhoRequestedGUID string(uuid)
  
  PagesCompleted integer
  
  Status string
  
  WhenLastSeen string
  
  ClientSubmitted integer
  
  PrimaryClientGUID string(uuid)
  
  FormattedValues object
403 application/json

Permission error.
Hide response attributes Show response attributes object
- success boolean
  
  Default value is false.
- message string
404 application/json

Fact Find not enabled for this client
Hide response attributes Show response attributes object
- success boolean
  
  Default value is false.
- message string

GET /api/v2/clients/backoffice/{BackOfficeID}/factfind

curl \
 --request GET 'https://api.fincalc.co.uk/api/v2/clients/backoffice/{BackOfficeID}/factfind' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "success": true,
  "data": {
    "ClientGUID": "61895427-011A-9214-B13E-FCE305CB4112",
    "RelatedClientGUID": "23456137-221Z-9214-G13M-EEQ305KA4771",
    "BackOfficeID": "3A06F92E-3EBD-43CC-9F9C-B6A40B3DC0D4",
    "RelatedClientBackOfficeID": "A9C1667B-A125-44EA-BA72-345FBAC56934",
    "FactFindRequestGUID": "76895427-011A-9214-B13E-FCE305CB4467",
    "FactFindTemplateGUID": "D1123DB7-6C5B-4DEA-9294-BD3CC73F1A0B",
    "WhenRequested": "2023-05-05T10:59:14+00:00",
    "WhoRequestedGUID": "11EF1721-A43C-71CA-86F2-BBE995FAD6CC",
    "PagesCompleted": 0,
    "Status": "Not Yet Started",
    "WhenLastSeen": "2023-05-05T11:17:03+00:00",
    "ClientSubmitted": 1,
    "PrimaryClientGUID": "C51DA9AA-AB26-4CBA-B4D5-2C558A248FBB",
    "FormattedValues": {
      "ClientSubmitted": "Yes",
      "WhoRequestedGUID": "James Burton",
      "FactFindTemplateGUID": "FinCalc Default"
    }
  }
}

Response examples (403)

{
  "success": false,
  "message": "You do not have permission to view that client."
}

Response examples (404)

{
  "success": false,
  "message": "Fact Find not enabled for this client."
}