Seccl - Create a new Seccl client and sync them into Plannr

Seccl - Create a new Seccl client and sync them into Plannr Run in API Explorer

POST /api/v1/addons/seccl/{addon}/client

Personal access token & O auth2

Path parameters

addon string Required

application/json

Body

client_type string Required

The type of client.

Value Description

Individual INDIVIDUAL

Individual Minor INDIVIDUAL_MINOR

Values are Individual or Individual Minor.
node_id string

The Seccl node ID. Required for adult clients.
parent_id string

The parent client identifier. Required for minor clients. Accepts either a Seccl client ID or a Plannr account UUID.
title string

The client's title. Required for adult clients.

Value Description

Dr Dr

Professor Professor

Mrs Mrs

Miss Miss

Mr Mr

Ms Ms

Mx Mx

Values are Dr, Professor, Mrs, Miss, Mr, Ms, or Mx.
first_name string Required

The client's first name.
surname string Required

The client's surname.
email string(email)

The client's email. Required for adult clients.
nationality string Required

The client's primary nationality (2-letter ISO code).
nationalities array

Array of nationalities with optional identifiers. Exactly one nationality must include identifiers, and exactly one identifier must be marked as available.
nationalities.*.code string Required

The 2-letter ISO country code.
nationalities.*.identifiers array

Array of tax identifiers for this nationality.
nationalities.*.identifiers.*.name string Required

The identifier name (e.g., NINO, TIN, SSN, CONCAT).
nationalities.*.identifiers.*.available boolean Required

Whether this identifier is available for the client.
nationalities.*.identifiers.*.value string

The identifier value. Required when available is true, must not be present when available is false or name is CONCAT.
national_insurance_no string

The client's national insurance number.
date_of_birth string(date) Required

The client's date of birth.
flat_number string

The client's flat number.
building_name string

The client's building name.
building_number string

The client's building number.
address_1 string Required

The client's address line 1.
address_2 string

The client's address line 2.
country string Required

The client's country.
postcode string Required

The client's postcode.
account_uuid string(uuid)

The UUID of an existing Plannr account to link to the newly created Seccl client. When provided, the Seccl client ID will be set as an external reference on that account before syncing.
tax_domicile string

The client's tax domicile (2-letter ISO code, currently only GB supported).
marital_status string

The client's marital status.

Value Description

Single Single

Married Married

Divorced Divorced

Widowed Widowed

Values are Single, Married, Divorced, or Widowed.
retirement_age integer

The client's expected retirement age.

Minimum value is 0, maximum value is 120.
vulnerability array

Vulnerability information for the client.
vulnerability.is_vulnerable boolean Required

Whether the client is vulnerable.
vulnerability.reason array

Array of vulnerability reasons (max 4). Required when is_vulnerable is true.
vulnerability.reason.* string

A vulnerability reason.

Value Description

Health HEALTH

Life event LIFE_EVENT

Resilience RESILIENCE

Capability CAPABILITY

Values are Health, Life event, Resilience, or Capability.
vulnerability.is_support_temporary boolean

Whether the support required is temporary. Required when is_vulnerable is true.
bank_details array

Bank account details for the client.
bank_details.account_number string

The bank account number. Required if requires_debit_mandate is true.

Minimum length is 8, maximum length is 8.
bank_details.sort_code string

The bank sort code. Required if requires_debit_mandate is true.

Minimum length is 6, maximum length is 6.
requires_debit_mandate boolean

Whether a debit mandate is required for this client.

Value	Description
Individual	INDIVIDUAL
Individual Minor	INDIVIDUAL_MINOR

Value	Description
Dr	Dr
Professor	Professor
Mrs	Mrs
Miss	Miss
Mr	Mr
Ms	Ms
Mx	Mx

Value	Description
Single	Single
Married	Married
Divorced	Divorced
Widowed	Widowed

Value	Description
Health	HEALTH
Life event	LIFE_EVENT
Resilience	RESILIENCE
Capability	CAPABILITY

employment_status

string

The client's employment status.

Value	Description
Employed	Employed
Retired	Retired
Self Employed	Self Employed
Care Under 16s	Care Under 16S
Care Over 16	Care Over 16
Education	Education
Unemployed	Unemployed
Other	Other

Values are Employed, Retired, Self Employed, Care Under 16s, Care Over 16, Education, Unemployed, or Other.

employers array

Array of employer information (max 1).
employers.*.company_name string Required

The employer's company name.
employers.*.company_reg_no string Required

The employer's company registration number.
employers.*.address_detail array

The employer's address.
employers.*.address_detail.flat_number string

The employer address flat number.
employers.*.address_detail.building_name string

The employer address building name.
employers.*.address_detail.building_number string

The employer address building number.
employers.*.address_detail.address_1 string

The employer address line 1.
employers.*.address_detail.address_2 string

The employer address line 2.
employers.*.address_detail.country string

The employer address country.
employers.*.address_detail.post_code string

The employer address postcode.
employers.*.bank_details array

The employer's bank details.
employers.*.bank_details.sort_code string

The employer bank sort code.

Minimum length is 6, maximum length is 6.
employers.*.bank_details.account_number string

The employer bank account number.

Minimum length is 8, maximum length is 8.
aml boolean

AML acceptance confirmation. Required and must be accepted for adult clients.

Responses

200 application/json
Hide response attributes Show response attributes object
- id string
  
  The unique identifier of the client
- node_id string
  
  The node ID
- client_type string
  
  The type of client
- title string
  
  The title of the client
- first_name string
  
  The first name of the client
- surname string
  
  The surname of the client
- address_detail object
  
  The address details of the client
  
  Hide address_detail attributes Show address_detail attributes object
  
  flat_number string
  
  building_name string
  
  building_number string
  
  address_1 string
  
  address_2 string
  
  country string
  
  postcode string
- email string
  
  The email address of the client
- mobile object
  
  The primary mobile number of the client
  
  Hide mobile attributes Show mobile attributes object
  
  number string
  
  locale string
  
  isMobile boolean
- nationality string
  
  The primary nationality of the client
- national_insurance_no string
  
  The national insurance number of the client
- date_of_birth string
  
  The date of birth of the client
- tax_domicile string
  
  The tax domicile of the client
- terms_accepted boolean
  
  The terms accepted status of the client
- status string
  
  The status of the client
- bank_details object
  
  The bank details of the client
  
  Hide bank_details attributes Show bank_details attributes object
  
  account_number string
  
  sort_code string
  
  accepted_debit_mandate boolean
  
  accepted_debit_mandate_at string
- vulnerability object
  
  The vulnerability details of the client
  
  Hide vulnerability attributes Show vulnerability attributes object
  
  isVulnerable boolean
  
  reason array[string]
  
  isSupportTemporary boolean
- aml_passed boolean
  
  Whether the client has passed AML checks
- requires_debit_mandate boolean
  
  Does this client require a debit mandate
- employment_status string
  
  The employment status of the client
- employers array[object]
  
  The employers of the client
  
  Hide employers attributes Show employers attributes object
  
  companyName string
  
  companyRegNo string
  
  addressDetail object
  
  Hide addressDetail attributes Show addressDetail attributes object
  
  flat_number string | null
  
  building_name string | null
  
  building_number string
  
  address_1 string
  
  address_2 string
  
  country string
  
  postcode string
  
  bankDetails object
  
  Hide bankDetails attributes Show bankDetails attributes object
  
  sortCode string
  
  accountNumber string
- marital_status string
  
  The marital status of the client
- retirement_age integer
  
  The retirement age of the client
- can_open_accounts_for array[string]
  
  The wrapper types the client can open accounts for
- plannr_account object
  
  The Plannr account associated with the client
  
  Hide plannr_account attributes Show plannr_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
  
  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
- parent_id string
  
  The parent ID of the client

POST /api/v1/addons/seccl/{addon}/client

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/addons/seccl/octopus_money/client' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"client_type":"Individual","node_id":"2","parent_id":"02GG28B","title":"Dr","first_name":"Jane","surname":"Smith","email":"jane.smith@example.com","nationality":"GB","nationalities":[{"code":"GB","identifiers":[{"name":"NINO","value":"AB123456C","available":true}]}],"nationalities.*.code":"GB","nationalities.*.identifiers":[{"name":"NINO","value":"AB123456C","available":true}],"nationalities.*.identifiers.*.name":"NINO","nationalities.*.identifiers.*.available":true,"nationalities.*.identifiers.*.value":"AB123456C","national_insurance_no":"AB123456C","date_of_birth":"1987-05-15","flat_number":"12","building_name":"Suite E","building_number":"10","address_1":"Waterberry Drive","address_2":"Waterlooville","country":"GB","postcode":"PO7 7YH","account_uuid":"a60e25a6-91cd-4a59-9166-2f6b91e39939","tax_domicile":"GB","marital_status":"Single","retirement_age":65,"vulnerability":[{"reason":["Health"],"is_vulnerable":true,"is_support_temporary":false}],"vulnerability.is_vulnerable":true,"vulnerability.reason":["Health"],"vulnerability.reason.*":"Health","vulnerability.is_support_temporary":false,"bank_details":[{"sort_code":"123456","account_number":"12345678"}],"bank_details.account_number":"12345678","bank_details.sort_code":"123456","requires_debit_mandate":false,"employment_status":"Employed","employers":[{"company_name":"Acme Ltd","company_reg_no":"12345678"}],"employers.*.company_name":"Acme Ltd","employers.*.company_reg_no":"12345678","employers.*.address_detail":[{"country":"GB","address_1":"123 Business Park","post_code":"AB1 2CD"}],"employers.*.address_detail.flat_number":"1","employers.*.address_detail.building_name":"Tower A","employers.*.address_detail.building_number":"100","employers.*.address_detail.address_1":"123 Business Park","employers.*.address_detail.address_2":"Industrial Estate","employers.*.address_detail.country":"GB","employers.*.address_detail.post_code":"AB1 2CD","employers.*.bank_details":[{"sort_code":"123456","account_number":"12345678"}],"employers.*.bank_details.sort_code":"123456","employers.*.bank_details.account_number":"12345678","aml":true}'

Request examples

{
  "client_type": "Individual",
  "node_id": "2",
  "parent_id": "02GG28B",
  "title": "Dr",
  "first_name": "Jane",
  "surname": "Smith",
  "email": "jane.smith@example.com",
  "nationality": "GB",
  "nationalities": [
    {
      "code": "GB",
      "identifiers": [
        {
          "name": "NINO",
          "value": "AB123456C",
          "available": true
        }
      ]
    }
  ],
  "nationalities.*.code": "GB",
  "nationalities.*.identifiers": [
    {
      "name": "NINO",
      "value": "AB123456C",
      "available": true
    }
  ],
  "nationalities.*.identifiers.*.name": "NINO",
  "nationalities.*.identifiers.*.available": true,
  "nationalities.*.identifiers.*.value": "AB123456C",
  "national_insurance_no": "AB123456C",
  "date_of_birth": "1987-05-15",
  "flat_number": "12",
  "building_name": "Suite E",
  "building_number": "10",
  "address_1": "Waterberry Drive",
  "address_2": "Waterlooville",
  "country": "GB",
  "postcode": "PO7 7YH",
  "account_uuid": "a60e25a6-91cd-4a59-9166-2f6b91e39939",
  "tax_domicile": "GB",
  "marital_status": "Single",
  "retirement_age": 65,
  "vulnerability": [
    {
      "reason": [
        "Health"
      ],
      "is_vulnerable": true,
      "is_support_temporary": false
    }
  ],
  "vulnerability.is_vulnerable": true,
  "vulnerability.reason": [
    "Health"
  ],
  "vulnerability.reason.*": "Health",
  "vulnerability.is_support_temporary": false,
  "bank_details": [
    {
      "sort_code": "123456",
      "account_number": "12345678"
    }
  ],
  "bank_details.account_number": "12345678",
  "bank_details.sort_code": "123456",
  "requires_debit_mandate": false,
  "employment_status": "Employed",
  "employers": [
    {
      "company_name": "Acme Ltd",
      "company_reg_no": "12345678"
    }
  ],
  "employers.*.company_name": "Acme Ltd",
  "employers.*.company_reg_no": "12345678",
  "employers.*.address_detail": [
    {
      "country": "GB",
      "address_1": "123 Business Park",
      "post_code": "AB1 2CD"
    }
  ],
  "employers.*.address_detail.flat_number": "1",
  "employers.*.address_detail.building_name": "Tower A",
  "employers.*.address_detail.building_number": "100",
  "employers.*.address_detail.address_1": "123 Business Park",
  "employers.*.address_detail.address_2": "Industrial Estate",
  "employers.*.address_detail.country": "GB",
  "employers.*.address_detail.post_code": "AB1 2CD",
  "employers.*.bank_details": [
    {
      "sort_code": "123456",
      "account_number": "12345678"
    }
  ],
  "employers.*.bank_details.sort_code": "123456",
  "employers.*.bank_details.account_number": "12345678",
  "aml": true
}

Response examples (200)

{
  "id": "031DF6J",
  "email": "test@example.com",
  "title": "Ms",
  "mobile": {
    "locale": "en-GB",
    "number": "07777000000",
    "isMobile": true
  },
  "status": "Active",
  "node_id": "1",
  "surname": "Richardson",
  "employers": [
    {
      "bankDetails": {
        "sortCode": "12-34-56",
        "accountNumber": "12345678"
      },
      "companyName": "Acme Corp",
      "companyRegNo": "12345678",
      "addressDetail": {
        "country": "GB",
        "postcode": "BC1 2AB",
        "address_1": "123 Business Rd",
        "address_2": "Business City",
        "flat_number": null,
        "building_name": null,
        "building_number": "123"
      }
    }
  ],
  "parent_id": "031DF6J",
  "aml_passed": true,
  "first_name": "Isabella",
  "client_type": "Individual",
  "nationality": "GB",
  "bank_details": {
    "sort_code": "12-34-56",
    "account_number": "12345678",
    "accepted_debit_mandate": true,
    "accepted_debit_mandate_at": "2025-01-01T00:00:00.000Z"
  },
  "tax_domicile": "GB",
  "date_of_birth": "1980-01-01",
  "vulnerability": {
    "reason": [
      "Mental Health"
    ],
    "isVulnerable": true,
    "isSupportTemporary": true
  },
  "address_detail": {
    "country": "United Kingdom",
    "postcode": "SW1A 2AA",
    "address_1": "Downing Street",
    "address_2": "Westminster",
    "flat_number": "1",
    "building_name": "The White House",
    "building_number": "1"
  },
  "marital_status": "Single",
  "plannr_account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "acb11acc-828b-4320-9949-027d81b9134c",
    "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-17T18:47:47+00:00",
    "first_name": "Gareth",
    "updated_at": "2026-03-17T18:47:47+00:00",
    "with_login": true,
    "inactive_at": "2026-03-17",
    "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-17T18:47:47+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2026-03-17T18:47:47+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "last_interaction_at": "2026-03-17 18:47:47",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2026-03-17T18:47:47+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2026-03-17T18:47:47+00:00"
  },
  "retirement_age": 65,
  "terms_accepted": true,
  "employment_status": "Employed",
  "can_open_accounts_for": [
    "JISA"
  ],
  "national_insurance_no": "AB123456C",
  "requires_debit_mandate": true
}