Create a risk assessment

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

Headers

Path parameters

client_uuid string Required

application/json

Body Required

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 date Required

Date of risk assessment completion.
completed_by string 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
- 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.

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

curl \
 -X POST https://api.plannrcrm.com/api/v1/client/client_uuid/risk \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 -d '{"level":52,"level_string":"Moderately Aggressive","completed_at":"2023-10-16T11:10:13+01:00","completed_by":"8a1b82ec-7c24-42df-b7e7-5956a5db2e9e","risk_assessment_provider":"Defaqto","time_horizon":"For the next 5 years"}'

Request examples

# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "level": 52,
  "level_string": "Moderately Aggressive",
  "completed_at": "2023-10-16T11:10:13+01:00",
  "completed_by": "8a1b82ec-7c24-42df-b7e7-5956a5db2e9e",
  "risk_assessment_provider": "Defaqto",
  "time_horizon": "For the next 5 years"
}

Response examples (201)

{
  "uuid": "fd12886d-4af1-45ca-8c12-bd2212a90ad4",
  "level": 52,
  "created_at": "2024-10-16T11:10:13+01:00",
  "updated_at": "2024-10-16T11:10:13+01:00",
  "completed_at": "2023-10-16T11:10:13+01:00",
  "completed_by": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "7817995a-c2f7-43f0-8ed4-7c4f00693059",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-10-16T11:10:13+01:00",
    "first_name": "Gareth",
    "updated_at": "2024-10-16T11:10:13+01:00",
    "with_login": true,
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2024-10-16T11:10:13+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-10-16T11:10:13+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-10-16T11:10:13+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-10-16T11:10:13+01:00"
  },
  "level_string": "Moderately Aggressive",
  "time_horizon": "For the next 5 years",
  "time_horizon_set_at": "2024-09-16T11:10:13+01:00",
  "risk_assessment_provider": "Defaqto"
}