Create fact find session

POST /api/v2/clients/backoffice/{BackOfficeID}/factfind/session

Bearer auth

This endpoint allows you to create a new fact find session for a client.

Path parameters

BackOfficeID string(uuid) Required

The BackOfficeID of the client.

application/json

Body

SessionType string Required

SessionType must be either 'client', 'adviser' or 'prefill'.
BackOfficeAccountID string(uuid) | null

The BackOfficeAccountID of the client(s)

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
  
  URL string
  
  ExpiryDate string
422 application/json

Validation error.
Hide response attributes Show response attributes object
- success boolean
  
  Default value is false.
- message string
- data object
  
  Example validation error message.
  
  Hide data attribute Show data attribute object
  
  SessionType array[string]
403 application/json

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

Client not found.
Hide response attributes Show response attributes object
- success boolean
  
  Default value is false.
- message string
500 application/json

Internal Server Error.
Hide response attributes Show response attributes object
- success boolean
  
  Default value is false.
- message string

POST /api/v2/clients/backoffice/{BackOfficeID}/factfind/session

curl \
 -X POST https://api.fincalc.co.uk/api/v2/clients/backoffice/{BackOfficeID}/factfind/session \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"SessionType":"client","BackOfficeAccountID":"E93EE908-5FF2-4D4C-9723-D8E1D7F805F5"}'

Request examples

{
  "SessionType": "client",
  "BackOfficeAccountID": "E93EE908-5FF2-4D4C-9723-D8E1D7F805F5"
}

Response examples (200)

{
  "success": true,
  "data": {
    "URL": "https://fincalc.co.uk/portal/login/factfind/AB8A075D-F481-4056-AF3D-67C75F4600B2/256",
    "ExpiryDate": "2023-05-04 12:10:01"
  }
}

Response examples (422)

{
  "success": false,
  "message": "Validation Error",
  "data": {
    "SessionType": [
      "The session type is required."
    ]
  }
}

Response examples (403)

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

Response examples (404)

{
  "success": false,
  "message": "Client not found."
}

Response examples (500)

{
  "success": false,
  "message": "Internal server error."
}