Appearance
Submissions
These are the answers to the questionnaires that generate the documents.
Get Submission
This API endpoint enables you to fetch a submission using its unique identifier.
Input
HTTP request headers
Content-Type string
Setting to application/json is required.
Authorization string
This is the token you fetched e.g. Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS…
Output
Http status codes
| Status Code | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 404 | Resource not found |
| 500 | Internal Server Error |
Request example
bash
curl -X GET \
'https://client.willsuite.co.uk/engine/api/submissions/195f1aeb-8a35-4d84-8614-c0b8567dd9e3' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...'php
<?php
$client = new http\Client;
$request = new http\Client\Request;
$request->setRequestUrl('https://client.willsuite.co.uk/engine/api/submissions/195f1aeb-8a35-4d84-8614-c0b8567dd9e3');
$request->setRequestMethod('GET');
$request->setHeaders([
'Content-Type' => 'application/json',
'Authorization' => 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();Response
json
{
"id": "a1b2c3d4-5678-90ab-cdef-ghijklmnopqr",
"questionnaire_ref": "will",
"customer_case_id": "d5e6f7g8-9abc-def0-1234-567890abcdef",
"user_id": "h1i2j3k4-lmno-pqrs-tuvw-xyz123456789",
"answers": {
"will.pets": null,
"will.mirror": null,
"will.partner": null,
"will.uk_only": null,
"will.brussels": null,
"will.chattels": null,
"will.testator": {
"dob": "10/10/1959",
"title": "Mr",
"gender": "male",
"address": {
"postcode": "XW1 2YZ",
"address_1": "Legacy House",
"address_2": "1a The Circle",
"address_3": "Cityville"
},
"last_name": "Anonymous",
"first_names": "John"
},
"will.trustees": [
{
"dob": "23/11/1989",
"title": "Mr",
"gender": "male",
"last_name": "Doe",
"first_names": "Jane"
}
],
"will.guardians": null,
"will.pet_carer": null,
"will.pet_money": null,
"will.exclusions": null,
"will.pets_rspca": null,
"will.foreign_will": null,
"will.funeral_body": null,
"will.contemplation": "no",
"will.funeral_other": null,
"will.gift_of_money": "yes",
"will.monetry_gifts": [
{
"iht": "recipient",
"gift": {
"recipient": {
"dob": "23/11/1989",
"title": "Mr",
"gender": "male",
"last_name": "Doe",
"first_names": "Jane"
},
"has_fallback": "yes",
"fallback_type": "specific",
"gift_multiple": "no",
"recipient_type": "person",
"specific_fallback": {
"recipient": {
"name": "Charity XYZ",
"reg_no": "987654",
"address": {
"postcode": "AB1 2CD",
"address_1": "3 Charity Lane",
"address_3": "Townsville"
},
"is_charity": "yes"
},
"has_fallback": "no",
"gift_multiple": "no",
"recipient_type": "organisation"
}
},
"amount": "£15,000",
"provisions": "subject to them surviving me by 30 days",
"index_linked": "no"
},
{
"gift": {
"recipient": [
{
"name": "Animal Shelter ABC",
"reg_no": "123456",
"address": {
"postcode": "EF5 6GH",
"address_1": "Rural R S P C A",
"address_2": "Animal Haven",
"address_3": "Green Meadows"
},
"is_charity": "yes"
},
{
"name": "Children's Aid",
"reg_no": "789012",
"address": {
"postcode": "IJ7 8KL",
"address_1": "Save The Kids",
"address_2": "Hope House",
"address_3": "24 Sunshine Street"
},
"is_charity": "yes"
},
{
"name": "Nature Conservation Society",
"reg_no": "345678",
"address": {
"postcode": "MN9 0OP",
"address_1": "Nature N A M H",
"address_2": "Green Oasis",
"address_3": "25 Harmony Avenue"
},
"is_charity": "yes"
}
],
"gift_split": "absolute",
"has_fallback": "no",
"gift_multiple": "yes",
"recipient_type": "organisation"
},
"amount": "£1,000",
"index_linked": "no"
}
],
"will.pet_sub_carer": null,
"will.both_excluding": null,
"will.marital_status": "single",
"will.organ_donation": "no",
"will.property_gifts": null,
"will.property_trust": null,
"will.residual_gifts": null,
"will.specific_gifts": [
{
"gift": {
"recipient": {
"name": "Nature Conservation Society",
"reg_no": "345678",
"address": {
"postcode": "MN9 0OP",
"address_1": "Nature N A M H",
"address_2": "Green Oasis",
"address_3": "25 Harmony Avenue"
},
"is_charity": "yes"
},
"has_fallback": "no",
"gift_multiple": "no",
"recipient_type": "organisation"
},
"name": "my collection of rare artifacts",
"expenses": "estate"
}
],
"will.excluded_people": null,
"will.property_abroad": "no",
"will.residue_charity": null,
"will.step_provisions": null,
"will.survival_clause": null,
"will.flit_life_tenant": null,
"will.memorandum_gifts": null,
"will.chattels_fallback": null,
"will.debt_release_from": null,
"will.digital_executors": "no",
"will.exclusion_details": null,
"will.gift_chattels_iht": null,
"will.pet_monetary_gift": null,
"will.release_from_debt": null,
"will.specify_sub_carer": null,
"will.substitute_signer": null,
"will.testator_national": null,
"will.business_interests": "no",
"will.different_trustees": null,
"will.exclude_section_33": null,
"will.flit_beneficiaries": null,
"will.partner_as_trustee": null,
"will.recipient_chattels": null,
"will.testamentary_claim": null,
"will.exclude_section_18a": null,
"will.leave_property_gift": null,
"will.partner_as_guardian": null,
"will.pets_testator_death": null,
"will.property_abroad_eea": null,
"will.residual_substitute": null,
"will.substitute_trustees": null,
"will.testamentary_memory": null,
"will.testator_has_minors": "no",
"will.witness_one_details": null,
"will.witness_two_details": null,
"will.fifth_level_trustees": null,
"will.fifth_property_trust": null,
"will.leave_specific_gifts": "yes",
"will.residue_distribution": null,
"will.sixth_property_trust": null,
"will.substitute_guardians": null,
"will.third_level_residual": null,
"will.third_level_trustees": null,
"will.third_property_trust": null,
"will.fifth_level_executors": null,
"will.fifth_level_guardians": null,
"will.foreign_will_location": null,
"will.fourth_level_residual": null,
"will.fourth_level_trustees": null,
"will.fourth_property_trust": null,
"will.include_cypres_clause": null,
"will.professional_executor": null,
"will.professional_trustees": null,
"will.testamentary_capacity": null,
"will.testamentary_physical": null,
"will.third_level_executors": null,
"will.third_level_guardians": null,
"will.age_restrict_executors": "no",
"will.fourth_level_executors": null,
"will.fourth_level_guardians": null,
"will.include_property_trust": null,
"will.negate_survival_clause": null,
"will.specific_guardianships": null,
"will.specify_specific_loans": null,
"will.testamentary_provision": null,
"will.testamentary_signature": null,
"will.flit_final_distribution": null,
"will.include_exlusion_reason": null,
"will.include_hotchpot_clause": null,
"will.include_witness_details": null,
"will.organ_donation_purposes": null,
"will.organ_donation_specific": null,
"will.pass_residue_to_partner": null,
"will.residue_charity_minimum": null,
"will.specific_hotchpot_loans": null,
"will.testamentary_influenced": null,
"will.guardianship_take_effect": null,
"will.residue_charity_multiple": null,
"will.additional_property_trust": null,
"will.chattels_specify_fallback": null,
"will.include_exclusion_details": null,
"will.residue_charity_recipient": null,
"will.testamentary_disabilities": null,
"will.testamentary_instructions": null,
"will.appoint_different_trustees": "no",
"will.testamentary_peoplepresent": null,
"will.third_level_residual_gifts": null,
"will.fourth_level_residual_gifts": null,
"will.testamentary_second_witness": null,
"willl.are_further_residual_gifts": null,
"will.business_grant_trustee_power": null,
"will.include_fifth_property_trust": null,
"will.include_receipt_minor_clause": null,
"will.include_sixth_property_trust": null,
"will.include_third_property_trust": null,
"will.partner_receives_possessions": null,
"will.residue_charity_restrict_iht": null,
"will.specify_funeral_arrangements": "no",
"will.testamentary_native_language": null,
"will.appoint_fifth_level_guardians": null,
"will.appoint_professional_executor": "no",
"will.appoint_professional_trustees": null,
"will.client_testamentary_signature": null,
"will.different_substitute_trustees": null,
"will.include_fourth_property_trust": null,
"will.appoint_fourth_level_guardians": null,
"will.business_property_relief_trust": null,
"will.residue_charity_minimum_amount": null,
"will.specify_executors_age_restrict": null,
"will.residue_charity_recipient_split": null,
"will.substitute_professional_executor": null,
"will.substitute_professional_trustees": null,
"will.choose_seperate_business_trustees": null,
"will.choose_seperate_digital_executors": null,
"will.fifth_level_professional_executor": null,
"will.fifth_level_professional_trustees": null,
"will.include_additional_property_trust": null,
"will.third_level_professional_executor": null,
"will.third_level_professional_trustees": null,
"will.appoint_seperate_business_trustees": null,
"will.appoint_seperate_digital_executors": null,
"will.fourth_level_professional_executor": null,
"will.fourth_level_professional_trustees": null,
"will.residual_gifts.pass_shares_of_gifts": null,
"will.residue_flit.choose_seperate_trustees": null,
"will.include_business_property_relief_trust": null,
"will.monetary_gifts.passing_shares_of_gifts": null,
"will.property_gifts.passing_shares_of_gifts": null,
"will.residue_flit.appoint_seperate_trustees": null,
"will.specific_gifts.passing_shares_of_gifts": null,
"will.appoint_third_level_substitute_guardians": null,
"will.residue_flit.power_to_revoke_life_interest": null
},
"notes": [],
"created_at": "2023-05-12 13:53:31",
"updated_at": "2023-05-12 14:02:46",
"deleted_at": null,
"customer_id": "f1g2h3i4-jklm-nopq-rstu-vwxyz1234567",
"mirror_id": null,
"pipeline_current": null,
"is_complete": null,
"pipeline_updated_at": null,
"pipeline_step_id": null,
"current_pipeline_update_id": null,
"current_pipeline_step_id": null
}json
{
"type": "object",
"properties": {
"id": {"type": "string"},
"questionnaire_ref": {"type": "string"},
"customer_case_id": {"type": "string"},
"user_id": {"type": "string"},
"answers": {
"type": "object",
"properties": {
"will.pets": {"type": ["null", "string"]},
"will.mirror": {"type": ["null", "string"]},
"will.partner": {"type": ["null", "string"]},
"will.uk_only": {"type": ["null", "string"]},
"will.brussels": {"type": ["null", "string"]},
"will.chattels": {"type": ["null", "string"]},
"will.testator": {
"type": "object",
"properties": {
"dob": {"type": ["null", "string"]},
"title": {"type": ["null", "string"]},
"gender": {"type": ["null", "string"]},
"address": {
"type": "object",
"properties": {
"postcode": {"type": ["null", "string"]},
"address_1": {"type": ["null", "string"]},
"address_2": {"type": ["null", "string"]},
"address_3": {"type": ["null", "string"]}
},
"required": ["postcode", "address_1", "address_2", "address_3"],
"additionalProperties": false
},
"last_name": {"type": ["null", "string"]},
"first_names": {"type": ["null", "string"]}
},
"required": ["dob", "title", "gender", "address", "last_name", "first_names"],
"additionalProperties": false
},
"will.trustees": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dob": {"type": ["null", "string"]},
"title": {"type": ["null", "string"]},
"gender": {"type": ["null", "string"]},
"last_name": {"type": ["null", "string"]},
"first_names": {"type": ["null", "string"]}
},
"required": ["dob", "title", "gender", "last_name", "first_names"],
"additionalProperties": false
}
},
"will.guardians": {"type": ["null", "string"]},
"will.pet_carer": {"type": ["null", "string"]},
"will.pet_money": {"type": ["null", "string"]},
"will.exclusions": {"type": ["null", "string"]},
"will.pets_rspca": {"type": ["null", "string"]},
"will.foreign_will": {"type": ["null", "string"]},
"will.funeral_body": {"type": ["null", "string"]},
"will.contemplation": {"type": ["null", "string"]},
"will.funeral_other": {"type": ["null", "string"]},
"will.gift_of_money": {"type": ["null", "string"]},
"will.monetry_gifts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"iht": {"type": ["null", "string"]},
"gift": {
"type": "object",
"properties": {
"recipient": {
"type": "object",
"properties": {
"dob": {"type": ["null", "string"]},
"title": {"type": ["null", "string"]},
"gender": {"type": ["null", "string"]},
"last_name": {"type": ["null", "string"]},
"first_names": {"type": ["null", "string"]}
},
"required": ["dob", "title", "gender", "last_name", "first_names"],
"additionalProperties": false
},
"has_fallback": {"type": ["null", "string"]},
"fallback_type": {"type": ["null", "string"]},
"gift_multiple": {"type": ["null", "string"]},
"recipient_type": {"type": ["null", "string"]},
"specific_fallback": {
"type": "object",
"properties": {
"recipient": {
"type": "object",
"properties": {
"name": {"type": ["null", "string"]},
"reg_no": {"type": ["null", "string"]},
"address": {
"type": "object",
"properties": {
"postcode": {"type": ["null", "string"]},
"address_1": {"type": ["null", "string"]},
"address_2": {"type": ["null", "string"]},
"address_3": {"type": ["null", "string"]}
},
"required": ["postcode", "address_1", "address_2", "address_3"],
"additionalProperties": false
},
"is_charity": {"type": ["null", "string"]}
},
"required": ["name", "reg_no", "address", "is_charity"],
"additionalProperties": false
},
"has_fallback": {"type": ["null", "string"]},
"gift_multiple": {"type": ["null", "string"]},
"recipient_type": {"type": ["null", "string"]}
},
"additionalProperties": false
}
},
"required": ["recipient", "has_fallback", "fallback_type", "gift_multiple", "recipient_type"],
"additionalProperties": false
},
"amount": {"type": ["null", "string"]},
"provisions": {"type": ["null", "string"]},
"index_linked": {"type": ["null", "string"]}
},
"required": ["iht", "gift", "amount", "provisions", "index_linked"],
"additionalProperties": false
}
},
"will.pet_sub_carer": {"type": ["null", "string"]},
"will.both_excluding": {"type": ["null", "string"]},
"will.marital_status": {"type": ["null", "string"]},
"will.organ_donation": {"type": ["null", "string"]},
"will.property_gifts": {"type": ["null", "string"]},
"will.property_trust": {"type": ["null", "string"]},
"will.residual_gifts": {"type": ["null", "string"]},
"will.specific_gifts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"gift": {
"type": "object",
"properties": {
"recipient": {
"type": "object",
"properties": {
"name": {"type": ["null", "string"]},
"reg_no": {"type": ["null", "string"]},
"address": {
"type": "object",
"properties": {
"postcode": {"type": ["null", "string"]},
"address_1": {"type": ["null", "string"]},
"address_2": {"type": ["null", "string"]},
"address_3": {"type": ["null", "string"]}
},
"required": ["postcode", "address_1", "address_2", "address_3"],
"additionalProperties": false
},
"is_charity": {"type": ["null", "string"]}
},
"required": ["name", "reg_no", "address", "is_charity"],
"additionalProperties": false
},
"has_fallback": {"type": ["null", "string"]},
"gift_multiple": {"type": ["null", "string"]},
"recipient_type": {"type": ["null", "string"]}
},
"required": ["recipient", "has_fallback", "gift_multiple", "recipient_type"],
"additionalProperties": false
},
"name": {"type": ["null", "string"]},
"expenses": {"type": ["null", "string"]}
},
"required": ["gift", "name", "expenses"],
"additionalProperties": false
}
},
"will.excluded_people": {"type": ["null", "string"]},
"will.property_abroad": {"type": ["null", "string"]},
"will.residue_charity": {"type": ["null", "string"]},
"will.step_provisions": {"type": ["null", "string"]},
"will.survival_clause": {"type": ["null", "string"]},
"will.flit_life_tenant": {"type": ["null", "string"]},
"will.memorandum_gifts": {"type": ["null", "string"]},
"will.chattels_fallback": {"type": ["null", "string"]},
"will.debt_release_from": {"type": ["null", "string"]},
"will.digital_executors": {"type": ["null", "string"]},
"will.exclusion_details": {"type": ["null", "string"]},
"will.gift_chattels_iht": {"type": ["null", "string"]},
"will.pet_monetary_gift": {"type": ["null", "string"]},
"will.release_from_debt": {"type": ["null", "string"]},
"will.specify_sub_carer": {"type": ["null", "string"]},
"will.substitute_signer": {"type": ["null", "string"]},
"will.testator_national": {"type": ["null", "string"]},
"will.business_interests": {"type": ["null", "string"]},
"will.different_trustees": {"type": ["null", "string"]},
"will.exclude_section_33": {"type": ["null", "string"]},
"will.flit_beneficiaries": {"type": ["null", "string"]},
"will.partner_as_trustee": {"type": ["null", "string"]},
"will.recipient_chattels": {"type": ["null", "string"]},
"will.testamentary_claim": {"type": ["null", "string"]},
"will.exclude_section_18a": {"type": ["null", "string"]},
"will.leave_property_gift": {"type": ["null", "string"]},
"will.partner_as_guardian": {"type": ["null", "string"]},
"will.pets_testator_death": {"type": ["null", "string"]},
"will.property_abroad_eea": {"type": ["null", "string"]},
"will.residual_substitute": {"type": ["null", "string"]},
"will.substitute_trustees": {"type": ["null", "string"]},
"will.testamentary_memory": {"type": ["null", "string"]},
"will.testator_has_minors": {"type": ["null", "string"]},
"will.witness_one_details": {"type": ["null", "string"]},
"will.witness_two_details": {"type": ["null", "string"]},
"will.fifth_level_trustees": {"type": ["null", "string"]},
"will.fifth_property_trust": {"type": ["null", "string"]},
"will.leave_specific_gifts": {"type": ["null", "string"]},
"will.residue_distribution": {"type": ["null", "string"]},
"will.sixth_property_trust": {"type": ["null", "string"]},
"will.substitute_guardians": {"type": ["null", "string"]},
"will.third_level_residual": {"type": ["null", "string"]},
"will.third_level_trustees": {"type": ["null", "string"]},
"will.third_property_trust": {"type": ["null", "string"]},
"will.fifth_level_executors": {"type": ["null", "string"]},
"will.fifth_level_guardians": {"type": ["null", "string"]},
"will.appoint_professional_executor": {"type": "string", "enum": ["no"]},
"will.appoint_professional_trustees": {"type": ["null", "object"]},
"will.client_testamentary_signature": {"type": ["null", "object"]},
"will.different_substitute_trustees": {"type": ["null", "object"]},
"will.include_fourth_property_trust": {"type": ["null", "object"]},
"will.appoint_fourth_level_guardians": {"type": ["null", "object"]},
"will.business_property_relief_trust": {"type": ["null", "object"]},
"will.residue_charity_minimum_amount": {"type": ["null", "object"]},
"will.specify_executors_age_restrict": {"type": ["null", "object"]},
"will.residue_charity_recipient_split": {"type": ["null", "object"]},
"will.substitute_professional_executor": {"type": ["null", "object"]},
"will.substitute_professional_trustees": {"type": ["null", "object"]},
"will.choose_separate_business_trustees": {"type": ["null", "object"]},
"will.choose_separate_digital_executors": {"type": ["null", "object"]},
"will.fifth_level_professional_executor": {"type": ["null", "object"]},
"will.fifth_level_professional_trustees": {"type": ["null", "object"]},
"will.include_additional_property_trust": {"type": ["null", "object"]},
"will.third_level_professional_executor": {"type": ["null", "object"]},
"will.third_level_professional_trustees": {"type": ["null", "object"]},
"will.appoint_separate_business_trustees": {"type": ["null", "object"]},
"will.appoint_separate_digital_executors": {"type": ["null", "object"]},
"will.fourth_level_professional_executor": {"type": ["null", "object"]},
"will.fourth_level_professional_trustees": {"type": ["null", "object"]},
"will.residual_gifts.pass_shares_of_gifts": {"type": ["null", "object"]},
"will.residue_flit.choose_separate_trustees": {"type": ["null", "object"]},
"will.include_business_property_relief_trust": {"type": ["null", "object"]},
"will.monetary_gifts.passing_shares_of_gifts": {"type": ["null", "object"]},
"will.property_gifts.passing_shares_of_gifts": {"type": ["null", "object"]},
"will.residue_flit.appoint_separate_trustees": {"type": ["null", "object"]},
"will.specific_gifts.passing_shares_of_gifts": {"type": ["null", "object"]},
"will.appoint_third_level_substitute_guardians": {"type": ["null", "object"]},
"will.residue_flit.power_to_revoke_life_interest": {"type": ["null", "object"]}
},
},
"notes": {"type": "array", "items": {}},
"created_at": {"type": "string"},
"updated_at": {"type": "string"},
"deleted_at": {"type": ["null", "string"]},
"customer_id": {"type": "string"},
"mirror_id": {"type": ["null", "string"]},
"pipeline_current": {"type": ["null", "object"]},
"is_complete": {"type": ["null", "string"]},
"pipeline_updated_at": {"type": ["null", "object"]},
"pipeline_step_id": {"type": ["null", "string"]},
"current_pipeline_update_id": {"type": ["null", "string"]},
"current_pipeline_step_id": {"type": ["null", "string"]},
"required": ["id", "questionnaire_ref", "customer_case_id", "user_id", "answers", "notes", "created_at", "updated_at", "customer_id"]
}