Create a risk assessment | PlannrCRM API documentation

Create a risk assessment Run in API Explorer

POST /api/v1/client/{client_uuid}/risk

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

client_uuid string Required

application/json

Body

level integer

The risk level of the clients risk assessment. Number between 1 and 1,000. Cannot be set with level_string
level_string string

The risk level of the client as a string/text. Cannot be set with level.
completed_at string(date) Required

Date of risk assessment completion.
completed_by string(uuid) Required

Uuid of the employee that completed the risk assessment
risk_assessment_provider string

Name of provider for the risk assessment
time_horizon string

Time horizon: how long the risk assessment will last for the client.

Responses

201 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- level integer
  
  The risk level of the clients risk assessment. Cannot be set with level_string
- level_string string
  
  The risk level of the client as a string/text. Cannot be set with level.
- completed_at string
  
  Date of risk assessment completion.
- completed_by object
  
  Account of the employee that completed the risk assessment
  
  Hide completed_by attributes Show completed_by attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  firm string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  circles string
  
  ownership_percentage integer
  
  inactive_at string
  
  last_interaction_at string
  
  referral_code string
  
  custom_fields string
  
  external_references string
- risk_assessment_provider string
  
  Name of the risk assessment provider.
- time_horizon string
  
  How long the risk assessment will last for the client.
- time_horizon_set_at string
  
  The date the time_horizon was set. Can be used as a reference point against time horizon for users.
- account object
  
  The account who owns the Risk. This may not be included when viewing all risks. Refer to the documentation to include this field.
  
  Hide account attributes Show account attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  external_references string

POST /api/v1/client/{client_uuid}/risk

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/client/6ff8f7f6-1eb3-3525-be4a-3932c805afed/risk' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"level":52,"level_string":"Moderately Aggressive","completed_at":"2025-03-18","completed_by":"9431678b-e31b-4feb-bf4a-74b077839ea3","risk_assessment_provider":"Defaqto","time_horizon":"For the next 5 years"}'

Request examples

# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "level": 52,
  "level_string": "Moderately Aggressive",
  "completed_at": "2025-03-18",
  "completed_by": "9431678b-e31b-4feb-bf4a-74b077839ea3",
  "risk_assessment_provider": "Defaqto",
  "time_horizon": "For the next 5 years"
}

Response examples (201)

{
  "uuid": "835ea562-1886-4c8a-a64b-dbb04650d88a",
  "level": 52,
  "account": {
    "name": "Gareth Thompson",
    "role": "client",
    "type": "client",
    "uuid": "fdac5f85-3316-4c13-85b8-2201071de0a1",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2026-03-18T16:05:25+00:00",
    "first_name": "Gareth",
    "updated_at": "2026-03-18T16:05:25+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "created_at": "2026-03-18T16:05:25+00:00",
  "updated_at": "2026-03-18T16:05:25+00:00",
  "completed_at": "2025-03-18T16:05:25+00:00",
  "completed_by": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "5c349b7d-e41c-4621-9aa7-952b3304d79f",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "created_at": "2026-03-18T16:05:25+00:00",
    "first_name": "Gareth",
    "updated_at": "2026-03-18T16:05:25+00:00",
    "with_login": true,
    "inactive_at": "2026-03-18",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "referral_code": "ABC12345",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2026-03-18T16:05:25+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2026-03-18T16:05:25+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "last_interaction_at": "2026-03-18 16:05:25",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2026-03-18T16:05:25+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2026-03-18T16:05:25+00:00"
  },
  "level_string": "Moderately Aggressive",
  "time_horizon": "For the next 5 years",
  "time_horizon_set_at": "2026-02-18T16:05:25+00:00",
  "risk_assessment_provider": "Defaqto"
}