Organisations

Creates a new Organisation

post/api/v2/partner/organisations

Request

  • Base URL: http://localhost:5100
  • URL: http://localhost:5100/api/v2/partner/organisations
  • Auth: API key in header Authorization

Request body

namestring required

Name of the Organisation

organisation_type'NHS' | 'Non NHS' | 'Council LGPS' required

One of two values:

  • "NHS" - for NHS organisations
  • "Non NHS" - for non NHS organisations
enabledboolean required

Is the organisation enabled?

  • true - if we want to start off in an enabled state ready for users to register.
  • false - if we want to start off disabled.
staff_countinteger

Count of the staff available for that organisation

partner_client_idstring

Partner's client identifier which they will be passing as part of SSO

subdomainstring

The subdomain of the organisation portal Contact the Vivup team if you require subdomain set-up.

contact_email1string
address1string
address2string
postcodestring
contact_email2string
contract_start_datestring date

The start date of the organisation

contract_end_datestring date

The end date of the organisation

telstring
tel2string
project_lead_namestring
project_lead_job_titlestring
project_lead_phone_numberstring
project_lead_email_addressstring
project_lead_fax_numberstring
supplementary_contact_namestring
supplementary_contact_job_titlestring
supplementary_contact_phone_numberstring
supplementary_contact_email_addressstring
supplementary_contact_fax_numberstring
finance_contact_namestring
finance_contact_job_titlestring
finance_contact_phone_numberstring
finance_contact_email_addressstring
finance_contact_fax_numberstring
invoice_contact_namestring
invoice_contact_job_titlestring
invoice_billing_addressstring
invoice_billing_address2string
invoice_billing_address3string
invoice_billing_address4string
invoice_billing_postcodestring
invoice_contact_telephone_numberstring
invoice_contact_emailstring
invoice_contact_faxstring
invoice_methodstring
payroll_contact_namestring
payroll_contact_job_titlestring
payroll_contact_phone_numberstring
payroll_contact_email_addressstring
payroll_contact_fax_numberstring
payslip_attachmentstring
quote_typestring
invoice_billing_address5string
main_textstring
hyperlink_to_carsstring
hyperlink_to_childcarestring
hyperlink_to_gymsstring
hyperlink_to_bikesstring
childcare_override_hyperlinkstring
gyms_override_hyperlinkstring
cars_override_hyperlinkstring
wage_twenty_onenumber
wage_eighteennumber
wage_sixteennumber
wage_twenty_threenumber
payroll_cut_offstring
hyperlink_to_neyberstring
notesstring
communications_contact_namestring
communications_contact_phone_numberstring
communications_contact_email_addressstring
communications_contact_job_titlestring
hyperlink_to_discountsstring
sales_regionstring
rejected_employee_usersstring
calculator_lower_ratenumber
calculator_higher_ratenumber
client_services_manager_idinteger
portal_provider_idinteger
mfa_employee_deadlinestring date
mfa_employer_deadlinestring date
portal_introduction_linkstring
monthly_nmw_capnumber float
journey_periodinteger
terc_eap_numberstring
mapp_org_namestring
mapp_group_idstring
highfive_company_idinteger
privacy_notice_contact_emailstring
trading_asstring
legal_namestring
hapi_client_idstring
partner_idinteger
portal_urlstring

This is the URL the user gets redirected to through SSO after placing an Order on vivup or after the user logs out of vivup.

login_urlstring

This is the URL the user gets redirected to. Usually used in partner email

requires_number_validationboolean
validation_number_requiredboolean
default_highfive_syncboolean
show_logged_out_bannerboolean
enable_support_chatboolean
organisation_privacy_noticeboolean
hire_agreement_signatory_contact_namestring

Name of the person that appears as the person hiring the bike to the employee on the hire agreement (C2W)

hire_agreement_signatory_contact_phone_numberstring

Phone number of the person that appears as the person hiring the bike to the employee on the hire agreement (C2W)

hire_agreement_signatory_contact_email_addressstring

Email of the person that appears as the person hiring the bike to the employee on the hire agreement (C2W)

hire_agreement_signatory_contact_job_titlestring

Job title of the person that appears as the person hiring the bike to the employee on the hire agreement (C2W)

terc_eap_codestring
is_demoboolean
enable_payroll_payboolean
enable_help_and_supportboolean
epoints_sso_company_namestring
enable_top_noticeboardboolean
enable_bottom_noticeboardboolean
enable_portal_bannerboolean
is_mojboolean
validation_number_type'employee_number' | 'membership_number' | 'policy_number' | 'PSI_number' | 'validation_ni_number' | 'payroll_number' | 'validation_code' | 'uea_username'
terc_eap'disabled' | 'hidden' | 'level_1' | 'level_2' | 'level_3' | 'level_4' | 'level_5'

Level of TERC

salary_bracket_state'required' | 'optional' | 'hidden'
journey'vivup' | 'hi5' | 'hi5_rewards' | 'removing_he_finance' | 'launching_group_reg' | 'your_care' | 'open_he' | 'lets_connect_registered' | 'automatically_accept_invitation'
date_of_birth_state'optional' | 'hidden'
mobile_number_state'hidden' | 'optional' | 'required'
security_question_idsinteger[]

Comma-separated IDs (e.g. [1,2,3])

disable_registrationboolean

Disable/Enable the registration of a user

Example request

{
  "name": "Acme Ltd",
  "organisation_type": "NHS",
  "enabled": true,
  "partner_client_id": "partner-x-client-789",
  "contact_email1": "contact@acme.com",
  "address1": "123 Acme Street",
  "address2": "Suite 4",
  "postcode": "AB12 3CD",
  "contact_email2": "support@acme.com",
  "contract_start_date": "2025-01-01",
  "contract_end_date": "2025-12-31",
  "tel": "+44 123 456 7890",
  "tel2": "+44 123 456 7891",
  "project_lead_name": "John Doe",
  "project_lead_job_title": "Project Manager",
  "project_lead_phone_number": "+44 123 456 7892",
  "project_lead_email_address": "johndoe@acme.com",
  "project_lead_fax_number": "+44 123 456 7893",
  "supplementary_contact_name": "Jane Doe",
  "supplementary_contact_job_title": "Assistant Project Manager",
  "supplementary_contact_phone_number": "+44 123 456 7894",
  "supplementary_contact_email_address": "janedoe@acme.com",
  "supplementary_contact_fax_number": "+44 123 456 7895",
  "finance_contact_name": "Alice Smith",
  "finance_contact_job_title": "Finance Director",
  "finance_contact_phone_number": "+44 123 456 7896",
  "finance_contact_email_address": "alicesmith@acme.com",
  "finance_contact_fax_number": "+44 123 456 7897",
  "invoice_contact_name": "Robert Brown",
  "invoice_contact_job_title": "Billing Manager",
  "invoice_billing_address": "123 Acme Street",
  "invoice_billing_address2": "Suite 4",
  "invoice_billing_address3": "Floor 2",
  "invoice_billing_address4": "Acme Tower",
  "invoice_billing_postcode": "AB12 3CD",
  "invoice_contact_telephone_number": "+44 123 456 7898",
  "invoice_contact_email": "robertbrown@acme.com",
  "invoice_contact_fax": "+44 123 456 7899",
  "invoice_method": "Email",
  "payroll_contact_name": "Mary Johnson",
  "payroll_contact_job_title": "Payroll Manager",
  "payroll_contact_phone_number": "+44 123 456 78910",
  "payroll_contact_email_address": "maryjohnson@acme.com",
  "payroll_contact_fax_number": "+44 123 456 78911",
  "payslip_attachment": "https://example.com/payslips/12345.pdf",
  "quote_type": "NHS",
  "invoice_billing_address5": "Acme Headquarters",
  "main_text": "Welcome to Acme Ltd.",
  "hyperlink_to_cars": "https://acme.com/cars",
  "hyperlink_to_childcare": "https://acme.com/childcare",
  "hyperlink_to_gyms": "https://acme.com/gyms",
  "hyperlink_to_bikes": "https://acme.com/bikes",
  "childcare_override_hyperlink": "https://acme.com/override-childcare",
  "gyms_override_hyperlink": "https://acme.com/override-gyms",
  "cars_override_hyperlink": "https://acme.com/override-cars",
  "wage_twenty_one": 12.21,
  "wage_eighteen": 10,
  "wage_sixteen": 7.55,
  "wage_twenty_three": 12.21,
  "payroll_cut_off": "2025-05-01",
  "hyperlink_to_neyber": "https://acme.com/neyber",
  "notes": "This is a note for Acme Ltd.",
  "communications_contact_name": "Tom Clark",
  "communications_contact_phone_number": "+44 123 456 78912",
  "communications_contact_email_address": "tomclark@acme.com",
  "communications_contact_job_title": "Communications Manager",
  "hyperlink_to_discounts": "https://acme.com/discounts",
  "sales_region": "North",
  "rejected_employee_users": "user123, user456",
  "calculator_lower_rate": 9.5,
  "calculator_higher_rate": 19.44,
  "client_services_manager_id": 42,
  "portal_provider_id": 3,
  "mfa_employee_deadline": "2025-12-01",
  "mfa_employer_deadline": "2025-11-01",
  "portal_introduction_link": "https://acme.com/portal-introduction",
  "monthly_nmw_cap": 10,
  "journey_period": 1,
  "terc_eap_number": "123456",
  "mapp_org_name": "Acme Group",
  "mapp_group_id": "acme-group-789",
  "highfive_company_id": 123,
  "privacy_notice_contact_email": "privacy@acme.com",
  "trading_as": "Acme Trading",
  "legal_name": "Acme Limited",
  "hapi_client_id": "hapi-789",
  "partner_id": 42,
  "portal_url": "https://acme.example.com",
  "login_url": "https://acme.example.com/login",
  "show_logged_out_banner": true,
  "enable_support_chat": true,
  "hire_agreement_signatory_contact_name": "Emma Thompson",
  "hire_agreement_signatory_contact_phone_number": "+44 123 456 78913",
  "hire_agreement_signatory_contact_email_address": "emmathompson@acme.com",
  "hire_agreement_signatory_contact_job_title": "HR Manager",
  "terc_eap_code": "level_3",
  "enable_payroll_pay": true,
  "enable_help_and_support": true,
  "epoints_sso_company_name": "Acme Ltd",
  "enable_top_noticeboard": true,
  "enable_bottom_noticeboard": true,
  "validation_number_type": "employee_number",
  "terc_eap": "level_3",
  "salary_bracket_state": "required",
  "journey": "vivup",
  "date_of_birth_state": "optional",
  "mobile_number_state": "hidden",
  "security_question_ids": [
    1,
    2,
    3
  ]
}

Response

Organisation created

successboolean

Example response

{
  "success": true,
  "organisation": {
    "id": 1,
    "name": "Acme Ltd",
    "enabled": true,
    "staff_count": "150",
    "organisation_type": "NHS",
    "terc_eap": "level_3",
    "terc_eap_code": "ABC123",
    "partner_id": 42,
    "partner_client_id": "partner-x-client-789",
    "login_url": "https://acme.example.com/login",
    "portal_url": "https://acme.example.com",
    "subdomain": "acme",
    "contract_start_date": "2025-01-01",
    "contract_end_date": "2025-12-31",
    "created_at": "2025-05-10T08:30:00Z",
    "updated_at": "2025-05-11T12:00:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.