{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/product/partner/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["fields","field","admonition"]},"type":"markdown"},"seo":{"title":"Case message types","siteUrl":"https://docs.wise.com","projectTitle":"Wise Platform","description":"Wise Platform offer domestic and cross-border payments tools for technology platforms, banks and financial institutions.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"case-message-types","__idx":0},"children":["Case message types"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This page describes the submission data structure and accepted values for each message submission type supported by the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/case/casesubmitmessage"},"children":["Submit a Message"]}," endpoint."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Structured responses: Use the case subType appended with _SUBMISSION (e.g., DEPOSIT_SANCTION_HIT_SUBMISSION, RECIPIENT_LOCATION_HIT_SUBMISSION)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Free text responses: Use FREEFORM."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"supported-submission-types","__idx":1},"children":["Supported submission types"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Submission type"},"children":["Submission type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Valid for case sub-types"},"children":["Valid for case sub-types"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#freeform"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREEFORM"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Free-text message for general communication."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#deposit_sanction_hit_submission"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DEPOSIT_SANCTION_HIT_SUBMISSION"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Submit entity information for deposit sanction hit cases."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DEPOSIT_SANCTION_HIT"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#recipient_sanction_hit_submission"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RECIPIENT_SANCTION_HIT_SUBMISSION"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Submit entity information for recipient sanction hit cases."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RECIPIENT_SANCTION_HIT"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#reference_sanction_hit_submission"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REFERENCE_SANCTION_HIT_SUBMISSION"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Submit entity information for reference sanction hit cases."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REFERENCE_SANCTION_HIT"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#reference_location_hit_submission"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REFERENCE_LOCATION_HIT_SUBMISSION"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Submit location-related information for reference location hit cases."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REFERENCE_LOCATION_HIT"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#recipient_location_hit_submission"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RECIPIENT_LOCATION_HIT_SUBMISSION"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Submit location-related information for recipient location hit cases."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RECIPIENT_LOCATION_HIT"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"entity-types-for-sanction-hit-submissions","__idx":2},"children":["Entity types for sanction hit submissions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Sanction hit submissions support different entity types depending on the submission type:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Entity type"},"children":["Entity type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"center","data-label":"DEPOSIT"},"children":["DEPOSIT"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"center","data-label":"RECIPIENT"},"children":["RECIPIENT"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"center","data-label":"REFERENCE"},"children":["REFERENCE"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["individual"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["organisation"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vessel"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["multiple"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["other"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["Yes"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"freeform","__idx":3},"children":["FREEFORM"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Free-text message for general communication on a case. Use this to provide additional context, ask questions, or share documentation references."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Prerequisites:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Case must not be in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RESOLVED"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FAILED"]}," status"]}]},{"$$mdtype":"Tag","name":"Fields","attributes":{"title":"Request Fields"},"children":[{"$$mdtype":"Tag","name":"Field","attributes":{"name":"type","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREEFORM"]}]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.freeText","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. The free-text message to submit. Minimum length: 1 character. Maximum length: 10,000 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData example","format":"A JSON string"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"type\": \"FREEFORM\",\n  \"submissionData\": {\n    \"freeText\": \"Following up on the requested documentation. We have verified the recipient identity through our internal KYC process.\"\n  }\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"deposit_sanction_hit_submission","__idx":4},"children":["DEPOSIT_SANCTION_HIT_SUBMISSION"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Submit entity information for deposit sanction hit cases. The deposit sanction hit occurs when a depositor's details match against sanctions screening."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Valid entity types:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["individual"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["organisation"]}," (exactly one required)"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"deposit-individual","__idx":5},"children":["Deposit Individual"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Submit information about an individual depositor."]},{"$$mdtype":"Tag","name":"Fields","attributes":{"title":"Request Fields"},"children":[{"$$mdtype":"Tag","name":"Field","attributes":{"name":"type","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DEPOSIT_SANCTION_HIT_SUBMISSION"]}]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.individual.name","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Full name of the individual. Maximum length: 255 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.individual.dob","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Date of birth. Accepted formats: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DD/MM/YYYY"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["YYYY-MM-DD"]},". Maximum length: 10 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.individual.nationality","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Nationality of the individual. Maximum length: 100 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData example","format":"A JSON string"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"type\": \"DEPOSIT_SANCTION_HIT_SUBMISSION\",\n  \"submissionData\": {\n    \"individual\": {\n      \"name\": \"Maria Garcia Rodriguez\",\n      \"dob\": \"12/05/1988\",\n      \"nationality\": \"Spanish\"\n    }\n  }\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"deposit-organisation","__idx":6},"children":["Deposit Organisation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Submit information about an organisation depositor."]},{"$$mdtype":"Tag","name":"Fields","attributes":{"title":"Request Fields"},"children":[{"$$mdtype":"Tag","name":"Field","attributes":{"name":"type","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DEPOSIT_SANCTION_HIT_SUBMISSION"]}]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.organisation.name","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Name of the organisation. Maximum length: 255 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.organisation.streetAddress","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Street address of the organisation. Maximum length: 500 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.organisation.city","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. City where the organisation is located. Maximum length: 100 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.organisation.postCode","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Postal code of the organisation's address. Maximum length: 20 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.organisation.countryIso3","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. ISO 3166-1 alpha-3 country code. Exactly 3 uppercase letters. Pattern: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["^[A-Z]{3}$"]},". Example: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GBR"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USA"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DEU"]},"."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.organisation.natureOfBusiness","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Description of the organisation's business activities. Maximum length: 500 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.organisation.website","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Organisation's website URL. Must be a valid URI format. Maximum length: 500 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData example","format":"A JSON string"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"type\": \"DEPOSIT_SANCTION_HIT_SUBMISSION\",\n  \"submissionData\": {\n    \"organisation\": {\n      \"name\": \"Tech Solutions Europe S.A.\",\n      \"streetAddress\": \"Av. de la Liberté 25\",\n      \"city\": \"Luxembourg\",\n      \"postCode\": \"1931\",\n      \"countryIso3\": \"LUX\",\n      \"natureOfBusiness\": \"Software Development\",\n      \"website\": \"https://www.techsolutions-eu.com\"\n    }\n  }\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"recipient_sanction_hit_submission","__idx":7},"children":["RECIPIENT_SANCTION_HIT_SUBMISSION"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Submit entity information for recipient sanction hit cases. The recipient sanction hit occurs when a recipient's details match against sanctions screening."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Valid entity types:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["individual"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["organisation"]}," (exactly one required)"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"recipient-individual","__idx":8},"children":["Recipient Individual"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Submit information about an individual recipient."]},{"$$mdtype":"Tag","name":"Fields","attributes":{"title":"Request Fields"},"children":[{"$$mdtype":"Tag","name":"Field","attributes":{"name":"type","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RECIPIENT_SANCTION_HIT_SUBMISSION"]}]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.individual.name","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Full name of the individual. Maximum length: 255 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.individual.countryOfResidenceIso3","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. ISO 3166-1 alpha-3 country code for country of residence. Exactly 3 uppercase letters. Pattern: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["^[A-Z]{3}$"]},". Example: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GBR"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SGP"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USA"]},"."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.individual.dob","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Date of birth. Accepted formats: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DD/MM/YYYY"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["YYYY-MM-DD"]},". Maximum length: 10 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.individual.nationality","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Nationality of the individual. Maximum length: 100 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData example","format":"A JSON string"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"type\": \"RECIPIENT_SANCTION_HIT_SUBMISSION\",\n  \"submissionData\": {\n    \"individual\": {\n      \"name\": \"Li Wei Chen\",\n      \"countryOfResidenceIso3\": \"SGP\",\n      \"dob\": \"03/11/1982\",\n      \"nationality\": \"Singaporean\"\n    }\n  }\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"recipient-organisation","__idx":9},"children":["Recipient Organisation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Submit information about an organisation recipient."]},{"$$mdtype":"Tag","name":"Fields","attributes":{"title":"Request Fields"},"children":[{"$$mdtype":"Tag","name":"Field","attributes":{"name":"type","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RECIPIENT_SANCTION_HIT_SUBMISSION"]}]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.organisation.name","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Name of the organisation. Maximum length: 255 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.organisation.streetAddress","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Street address of the organisation. Maximum length: 500 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.organisation.city","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. City where the organisation is located. Maximum length: 100 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.organisation.postCode","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Postal code of the organisation's address. Maximum length: 20 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.organisation.countryIso3","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. ISO 3166-1 alpha-3 country code. Exactly 3 uppercase letters. Pattern: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["^[A-Z]{3}$"]},"."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.organisation.natureOfBusiness","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Description of the organisation's business activities. Maximum length: 500 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.organisation.website","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Organisation's website URL. Must be a valid URI format. Maximum length: 500 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData example","format":"A JSON string"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"type\": \"RECIPIENT_SANCTION_HIT_SUBMISSION\",\n  \"submissionData\": {\n    \"organisation\": {\n      \"name\": \"Pacific Rim Trading Co.\",\n      \"streetAddress\": \"88 Marina Boulevard\",\n      \"city\": \"Singapore\",\n      \"postCode\": \"018984\",\n      \"countryIso3\": \"SGP\",\n      \"natureOfBusiness\": \"Commodities Trading\"\n    }\n  }\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"reference_sanction_hit_submission","__idx":10},"children":["REFERENCE_SANCTION_HIT_SUBMISSION"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Submit entity information for reference sanction hit cases. The reference sanction hit occurs when a payment reference or memo field matches against sanctions screening."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Valid entity types:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["individual"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["organisation"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vessel"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["multiple"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["other"]}," (exactly one required)"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Important"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["individual"]}," submissions, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["countryOfResidenceIso3"]}," is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REQUIRED"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"reference-individual","__idx":11},"children":["Reference Individual"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Submit information about an individual referenced in the payment."]},{"$$mdtype":"Tag","name":"Fields","attributes":{"title":"Request Fields"},"children":[{"$$mdtype":"Tag","name":"Field","attributes":{"name":"type","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REFERENCE_SANCTION_HIT_SUBMISSION"]}]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.individual.name","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Full name of the individual. Maximum length: 255 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.individual.countryOfResidenceIso3","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. ISO 3166-1 alpha-3 country code for country of residence. Exactly 3 uppercase letters. Pattern: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["^[A-Z]{3}$"]},"."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.individual.dob","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Date of birth. Accepted formats: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DD/MM/YYYY"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["YYYY-MM-DD"]},". Maximum length: 10 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.individual.nationality","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Nationality of the individual. Maximum length: 100 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData example","format":"A JSON string"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"type\": \"REFERENCE_SANCTION_HIT_SUBMISSION\",\n  \"submissionData\": {\n    \"individual\": {\n      \"name\": \"Robert Downy Jr\",\n      \"countryOfResidenceIso3\": \"EGY\",\n      \"dob\": \"22/08/1975\",\n      \"nationality\": \"Egyptian\"\n    }\n  }\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"reference-organisation","__idx":12},"children":["Reference Organisation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Submit information about an organisation referenced in the payment."]},{"$$mdtype":"Tag","name":"Fields","attributes":{"title":"Request Fields"},"children":[{"$$mdtype":"Tag","name":"Field","attributes":{"name":"type","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REFERENCE_SANCTION_HIT_SUBMISSION"]}]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.organisation.name","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Name of the organisation. Maximum length: 255 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.organisation.streetAddress","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Street address of the organisation. Maximum length: 500 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.organisation.city","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. City where the organisation is located. Maximum length: 100 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.organisation.postCode","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Postal code of the organisation's address. Maximum length: 20 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.organisation.countryIso3","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. ISO 3166-1 alpha-3 country code. Exactly 3 uppercase letters. Pattern: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["^[A-Z]{3}$"]},"."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.organisation.natureOfBusiness","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Description of the organisation's business activities. Maximum length: 500 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.organisation.website","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Organisation's website URL. Must be a valid URI format. Maximum length: 500 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData example","format":"A JSON string"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"type\": \"REFERENCE_SANCTION_HIT_SUBMISSION\",\n  \"submissionData\": {\n    \"organisation\": {\n      \"name\": \"Global Trading Partners LLC\",\n      \"streetAddress\": \"1500 Commerce Street, Suite 400\",\n      \"city\": \"Dubai\",\n      \"postCode\": \"00000\",\n      \"countryIso3\": \"ARE\",\n      \"natureOfBusiness\": \"Import/Export Trading\",\n      \"website\": \"https://www.globaltrading-partners.com\"\n    }\n  }\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"reference-vessel","__idx":13},"children":["Reference Vessel"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Submit information about a vessel referenced in the payment."]},{"$$mdtype":"Tag","name":"Fields","attributes":{"title":"Request Fields"},"children":[{"$$mdtype":"Tag","name":"Field","attributes":{"name":"type","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REFERENCE_SANCTION_HIT_SUBMISSION"]}]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.vessel.vesselImoNumber","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. International Maritime Organization (IMO) number of the vessel. IMO numbers are 7-digit identifiers. Maximum length: 20 characters. Pattern: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["^(IMO)?\\s?\\d{7}$"]},". Examples: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["9074729"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IMO 9074729"]},"."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData example","format":"A JSON string"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"type\": \"REFERENCE_SANCTION_HIT_SUBMISSION\",\n  \"submissionData\": {\n    \"vessel\": {\n      \"vesselImoNumber\": \"9074729\"\n    }\n  }\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"reference-multiple","__idx":14},"children":["Reference Multiple"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Submit information when multiple entities are involved in the payment reference. Use this when the payment involves a consortium, group payment arrangement, or multiple beneficiaries."]},{"$$mdtype":"Tag","name":"Fields","attributes":{"title":"Request Fields"},"children":[{"$$mdtype":"Tag","name":"Field","attributes":{"name":"type","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REFERENCE_SANCTION_HIT_SUBMISSION"]}]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.multiple.explanation","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Explanation describing the multiple entities involved. Should include details about all parties and their relationship. Maximum length: 2,000 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData example","format":"A JSON string"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"type\": \"REFERENCE_SANCTION_HIT_SUBMISSION\",\n  \"submissionData\": {\n    \"multiple\": {\n      \"explanation\": \"This payment reference involves a consortium of three companies: Alpha Corp (USA), Beta Ltd (UK), and Gamma GmbH (Germany). The payment is for a joint infrastructure project where funds are distributed proportionally: 40% to Alpha Corp, 35% to Beta Ltd, and 25% to Gamma GmbH.\"\n    }\n  }\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"reference-other","__idx":15},"children":["Reference Other"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Submit information for entity types not covered by standard categories. Use this for government entities, NGOs, trusts, or other special entity types."]},{"$$mdtype":"Tag","name":"Fields","attributes":{"title":"Request Fields"},"children":[{"$$mdtype":"Tag","name":"Field","attributes":{"name":"type","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REFERENCE_SANCTION_HIT_SUBMISSION"]}]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.other.explanation","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Free-form explanation describing the entity. Should include the entity type, registration details, and any relevant compliance information. Maximum length: 2,000 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData example","format":"A JSON string"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"type\": \"REFERENCE_SANCTION_HIT_SUBMISSION\",\n  \"submissionData\": {\n    \"other\": {\n      \"explanation\": \"The payment reference relates to a charitable foundation registered with the UN. The Foundation for Educational Development (FED) is a non-profit organization established in 2010, registered under Swiss law with headquarters in Geneva. Registration number: CH-660.0.000.000-1.\"\n    }\n  }\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"reference_location_hit_submission","__idx":16},"children":["REFERENCE_LOCATION_HIT_SUBMISSION"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Submit location-related information for reference location hit cases. This occurs when a payment reference triggers a location-based compliance check."]},{"$$mdtype":"Tag","name":"Fields","attributes":{"title":"Request Fields"},"children":[{"$$mdtype":"Tag","name":"Field","attributes":{"name":"type","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REFERENCE_LOCATION_HIT_SUBMISSION"]}]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.other.relatedToLocation","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Explanation of how the reference is related to the flagged location. Maximum length: 2,000 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.other.paymentExplanation","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Explanation of the purpose of the payment. Describe what goods or services are being paid for. Maximum length: 2,000 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.other.location","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. The specific location being addressed. Maximum length: 255 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.other.referenceDescription","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Description of the payment reference that triggered the location hit. Maximum length: 2,000 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData example","format":"A JSON string"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"type\": \"REFERENCE_LOCATION_HIT_SUBMISSION\",\n  \"submissionData\": {\n    \"other\": {\n      \"relatedToLocation\": \"The payment reference mentions Crimea due to historical business operations that were fully wound down in 2014.\",\n      \"paymentExplanation\": \"Current payment is for consulting services rendered in London, UK.\",\n      \"location\": \"Crimea, Ukraine\",\n      \"referenceDescription\": \"Invoice CRM-2026-0042 - Consulting services for Q2 2026. The CRM prefix is a legacy system identifier.\"\n    }\n  }\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"recipient_location_hit_submission","__idx":17},"children":["RECIPIENT_LOCATION_HIT_SUBMISSION"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Submit location-related information for recipient location hit cases. This occurs when a recipient's location triggers a compliance check."]},{"$$mdtype":"Tag","name":"Fields","attributes":{"title":"Request Fields"},"children":[{"$$mdtype":"Tag","name":"Field","attributes":{"name":"type","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RECIPIENT_LOCATION_HIT_SUBMISSION"]}]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.other.relatedToLocation","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Explanation of how the recipient is related to the flagged location. Maximum length: 2,000 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.other.paymentExplanation","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. Explanation of the purpose of the payment. Maximum length: 2,000 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.other.location","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required. The specific location being addressed. Maximum length: 255 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData.other.businessWebsite","format":"string"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Website of the recipient's business (optional). Must be a valid URI format. Maximum length: 500 characters."]}]},{"$$mdtype":"Tag","name":"Field","attributes":{"name":"submissionData example","format":"A JSON string"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"type\": \"RECIPIENT_LOCATION_HIT_SUBMISSION\",\n  \"submissionData\": {\n    \"other\": {\n      \"relatedToLocation\": \"Recipient company has a branch registration in the flagged jurisdiction for administrative purposes only.\",\n      \"paymentExplanation\": \"Payment for software licenses delivered electronically. Recipient's operational headquarters are in Dublin, Ireland.\",\n      \"location\": \"Minsk, Belarus\",\n      \"businessWebsite\": \"https://www.recipient-software.ie\"\n    }\n  }\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-responses","__idx":18},"children":["Error responses"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"validation-errors-400-bad-request","__idx":19},"children":["Validation errors (400 Bad Request)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returned when required fields are missing or invalid."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"error\": \"BAD_REQUEST\",\n  \"message\": \"Validation failed for request body\",\n  \"timestamp\": \"2026-08-03T10:30:00.000Z\",\n  \"path\": \"/public/v2/cases/12345678/messages\",\n  \"errors\": [\n    {\n      \"field\": \"submissionData.individual.name\",\n      \"message\": \"name is required for individual submission\"\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"missing-countryofresidenceiso3-422-unprocessable-entity","__idx":20},"children":["Missing countryOfResidenceIso3 (422 Unprocessable Entity)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returned when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["countryOfResidenceIso3"]}," is missing for recipient or reference individual submissions."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"error\": \"UNPROCESSABLE_ENTITY\",\n  \"message\": \"countryOfResidenceIso3 is required for recipient individual\",\n  \"timestamp\": \"2026-08-03T10:30:00.000Z\",\n  \"path\": \"/public/v2/cases/12345678/messages\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"submission-type-mismatch-422-unprocessable-entity","__idx":21},"children":["Submission type mismatch (422 Unprocessable Entity)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returned when the submission type doesn't match the case sub-type."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"error\": \"UNPROCESSABLE_ENTITY\",\n  \"message\": \"Submission type DEPOSIT_SANCTION_HIT_SUBMISSION is not valid for case sub-type RECIPIENT_SANCTION_HIT\",\n  \"timestamp\": \"2026-08-03T10:30:00.000Z\",\n  \"path\": \"/public/v2/cases/12345678/messages\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"invalid-entity-type-for-submission-422-unprocessable-entity","__idx":22},"children":["Invalid entity type for submission (422 Unprocessable Entity)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returned when using an entity type not supported by the submission type (e.g., vessel for deposit sanction hit)."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"error\": \"UNPROCESSABLE_ENTITY\",\n  \"message\": \"Vessel submission is only valid for REFERENCE_SANCTION_HIT_SUBMISSION\",\n  \"timestamp\": \"2026-08-03T10:30:00.000Z\",\n  \"path\": \"/public/v2/cases/12345678/messages\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"case-not-found-404-not-found","__idx":23},"children":["Case not found (404 Not Found)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returned when the case ID doesn't exist."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"error\": \"RESOURCE_NOT_FOUND\",\n  \"message\": \"Case with id 99999999 not found\",\n  \"timestamp\": \"2026-08-03T10:30:00.000Z\",\n  \"path\": \"/public/v2/cases/99999999/messages\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"case-in-invalid-status-409-conflict","__idx":24},"children":["Case in invalid status (409 Conflict)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returned when attempting to submit a message to a case in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RESOLVED"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FAILED"]}," status."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"error\": \"CONFLICT\",\n  \"message\": \"Cannot submit message: case is in RESOLVED status\",\n  \"timestamp\": \"2026-08-03T10:30:00.000Z\",\n  \"path\": \"/public/v2/cases/12345678/messages\"\n}\n","lang":"json"},"children":[]}]},"headings":[{"value":"Case message types","id":"case-message-types","depth":1},{"value":"Supported submission types","id":"supported-submission-types","depth":2},{"value":"Entity types for sanction hit submissions","id":"entity-types-for-sanction-hit-submissions","depth":2},{"value":"FREEFORM","id":"freeform","depth":2},{"value":"DEPOSIT_SANCTION_HIT_SUBMISSION","id":"deposit_sanction_hit_submission","depth":2},{"value":"Deposit Individual","id":"deposit-individual","depth":3},{"value":"Deposit Organisation","id":"deposit-organisation","depth":3},{"value":"RECIPIENT_SANCTION_HIT_SUBMISSION","id":"recipient_sanction_hit_submission","depth":2},{"value":"Recipient Individual","id":"recipient-individual","depth":3},{"value":"Recipient Organisation","id":"recipient-organisation","depth":3},{"value":"REFERENCE_SANCTION_HIT_SUBMISSION","id":"reference_sanction_hit_submission","depth":2},{"value":"Reference Individual","id":"reference-individual","depth":3},{"value":"Reference Organisation","id":"reference-organisation","depth":3},{"value":"Reference Vessel","id":"reference-vessel","depth":3},{"value":"Reference Multiple","id":"reference-multiple","depth":3},{"value":"Reference Other","id":"reference-other","depth":3},{"value":"REFERENCE_LOCATION_HIT_SUBMISSION","id":"reference_location_hit_submission","depth":2},{"value":"RECIPIENT_LOCATION_HIT_SUBMISSION","id":"recipient_location_hit_submission","depth":2},{"value":"Error responses","id":"error-responses","depth":2},{"value":"Validation errors (400 Bad Request)","id":"validation-errors-400-bad-request","depth":3},{"value":"Missing countryOfResidenceIso3 (422 Unprocessable Entity)","id":"missing-countryofresidenceiso3-422-unprocessable-entity","depth":3},{"value":"Submission type mismatch (422 Unprocessable Entity)","id":"submission-type-mismatch-422-unprocessable-entity","depth":3},{"value":"Invalid entity type for submission (422 Unprocessable Entity)","id":"invalid-entity-type-for-submission-422-unprocessable-entity","depth":3},{"value":"Case not found (404 Not Found)","id":"case-not-found-404-not-found","depth":3},{"value":"Case in invalid status (409 Conflict)","id":"case-in-invalid-status-409-conflict","depth":3}],"frontmatter":{"seo":{"title":"Case message types"}},"lastModified":"2026-08-06T22:10:53.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/product/partner/submission-types","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}