{"openapi":"3.1.0","info":{"title":"Advanced Screening and Monitoring API","description":"Dow Jones\n\n### Rate limits\n\nMost endpoints are subject to a general rate limit of 10,000 requests per user per 15 minutes.\n\nSome endpoints are also subject to a global concurrent request limit of 5 simultaneous requests per customer.","version":"3","license":{},"contact":{}},"servers":[{"url":"API_INSTANCE"}],"security":[{"basicAuth":[]},{"jwt":[]},{"clientCert":[]}],"paths":{"\/alert\/{alert_id}\/close":{"post":{"summary":"Close an alert","description":"Close an alert with the specified reasons, actions and consequences.\nNOTE: Alerts can only be closed if they are eligible for closure according to the workflow configuration.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n*Generated from limited sample size.*\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 552 ms |\n| 90th percentile | 1.4 s |\n| 95th percentile | 2.4 s |\n| 98th percentile | 3.0 s |\n| 99th percentile | 3.2 s |\n<!-- operational-characteristics:end -->\n","operationId":"alertClose","parameters":[{"name":"alert_id","in":"path","required":true,"description":"The ID of the alert to close","schema":{"type":"number"}}],"tags":["Alert"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-11T10:43:09.536Z).\n","latencyDistribution":{"median":551.06,"p90":1382.98,"p95":2437.39,"p98":3040.02,"p99":3235.88,"sampleSize":26}},"requestBody":{"required":true,"content":{"application\/json":{"schema":{"allOf":[{"type":"object","required":["status","reason"],"properties":{"comment":{"type":"string","description":"a comment providing details of the closure decision."},"status":{"type":"number","description":"A 3 digit number made up of internal alert state (1 digit) and the alert status as configured by your system administrator (2 digits).","example":300},"reason":{"type":"number","description":"The ID of the closure reason. Reasons are configured by your system administrator."}}},{"type":"object","description":"The reasons, actions and consequence associated with the alert closure. Note that different attributes are required depending on the closure status selected.","required":["consequence"],"properties":{"consequence":{"type":"number","description":"The ID of the consequence to apply to the closure. Consequences are configured by your system administrator."}}}]},"example":{"comment":"Comment providing details of closure","status":201,"reason":4,"consequence":0}}}},"responses":{"200":{"description":"The updated alert","content":{"application\/json":{"schema":{"type":"object","description":"Alert object","properties":{"id":{"type":"integer","description":"The id of the alert","example":10001},"namespace":{"type":"string","description":"Internal field"},"target":{"type":"string","description":"The target object (client) that encapsulates the activity","example":"eoi:10001"},"description":{"type":"string","description":"A brief description of the alert","example":"torch"},"clientKey":{"type":"string","description":"Internal field"},"state":{"type":"string","description":"Current state of the alert","example":"OPENED","enum":["MONITORING","OPENED","CLOSED","REOPENED","OPENED_FIXED_PERIOD"]},"mode":{"type":"string","description":"alert mode","example":"sum"},"threshold":{"type":"integer","description":"The value of the threshold to breach an alert when this alert breached","example":100},"score":{"type":"integer","description":"Score of the alert, based on the evidence accrued","example":100},"sortKey":{"type":"integer","description":"Internal field"},"currentStatus":{"type":"object","description":"records details of the alerts status (versus state)","properties":{"status":{"type":"integer","description":"the current status value","example":101},"timestamp":{"type":"integer","description":"timestamp of the last status change","example":1590989346512}}},"assignedUsers":{"type":"array","description":"list of user ids the alert has been assigned to.","items":{"type":"number","example":990}},"assignedGroups":{"type":"array","description":"list of group ids the alert has been assigned to, where appropriate.","items":{"type":"number","example":10}},"time":{"type":"object","description":"set of relevant timestamps for the alert","properties":{"created":{"type":"integer","description":"when the alert was created","example":1600427478761},"lastUpdated":{"type":"integer","description":"when the alert last received updated information","example":1600427478761},"breached":{"type":"integer","description":"when the alert transitioned from monitoring to opened","example":1600427478860},"lastEvidence":{"type":"integer","description":"when the last piece of evidence was added to the alert","example":1600427478860}}},"security":{"type":"object","description":"The alert\\'s security object","example":{}},"tags":{"type":"array","description":"list of tags that relevant to the alert.","items":{"type":"string","example":"policy-20037"}},"client":{"type":"object","description":"details of the alert's associated client"}}},"example":{"id":187504,"namespace":"torch","target":"eoi:cba_entity_55","description":"alert for Pedro Castillo","clientKey":"sandbox","state":"CLOSED","mode":"sum","threshold":100,"score":100,"sortKey":400,"docCount":1,"currentStatus":{"status":201,"consequence":0,"reason":4,"timestamp":1706707504238,"comment":{"value":"Comment providing details of closure","user":{"id":10024,"email":"sandbox1677001704151@ripjar.com","externalId":"sandbox1677001704151@ripjar.com","cn":"sandbox1677001704151@ripjar.com"}}},"assignedUsers":[10024],"assignedGroups":[],"time":{"created":1705550372510,"lastUpdated":1706707504238,"breached":1705550373303,"lastEvidence":1705550373303,"lastAssigned":1706705385116,"closed":1706707504238},"security":{},"tags":["context-alerting","dj:sanctions","policy-10119"],"client":{"id":"eoi:cba_entity_55","_start_rev":20287,"_revision":20287,"clientId":"cba_entity_55","status":"ACTIVE","lastReviewed":1420070400000,"entityType":"PERSON","name":"Pedro Castillo","clientKey":"sandbox","alertsDisabled":false,"monitorStartDate":1420070400000,"displayname":"Pedro Castillo","_type":"person","relationships":[],"relationshipGrouping":[],"observedEntityIds":[]}}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"type":"object","required":["status","message"],"properties":{"status":{"type":"integer","description":"The HTTP status code of the error","example":500},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable","example":"Internal server error"},"details":{"type":"object","description":"A JSON object containing additional details relating to the error"}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","required":["status","message"],"properties":{"status":{"type":"integer","description":"The HTTP status code of the error","example":500},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable","example":"Internal server error"},"details":{"type":"object","description":"A JSON object containing additional details relating to the error"}}}}}},"403":{"description":"Forbidden (e.g. the user does not have the CloseAlert permission or the alert evidence has not been assessed and the alert type has mandatoryAssessment set to true)","content":{"application\/json":{"schema":{"type":"object","required":["status","message"],"properties":{"status":{"type":"integer","description":"The HTTP status code of the error","example":500},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable","example":"Internal server error"},"details":{"type":"object","description":"A JSON object containing additional details relating to the error"}}}}}},"404":{"description":"Not Found (e.g. the alert could not be found or the alert status and close reason were not found in configuration)","content":{"application\/json":{"schema":{"type":"object","required":["status","message"],"properties":{"status":{"type":"integer","description":"The HTTP status code of the error","example":500},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable","example":"Internal server error"},"details":{"type":"object","description":"A JSON object containing additional details relating to the error"}}}}}},"409":{"description":"Conflict (e.g. the alert is already closed)","content":{"application\/json":{"schema":{"type":"object","required":["status","message"],"properties":{"status":{"type":"integer","description":"The HTTP status code of the error","example":500},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable","example":"Internal server error"},"details":{"type":"object","description":"A JSON object containing additional details relating to the error"}}}}}},"422":{"description":"Unprocessable Entity (e.g. the alert is in monitoring state)","content":{"application\/json":{"schema":{"type":"object","required":["status","message"],"properties":{"status":{"type":"integer","description":"The HTTP status code of the error","example":500},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable","example":"Internal server error"},"details":{"type":"object","description":"A JSON object containing additional details relating to the error"}}}}}},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","required":["status","message"],"properties":{"status":{"type":"integer","description":"The HTTP status code of the error","example":500},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable","example":"Internal server error"},"details":{"type":"object","description":"A JSON object containing additional details relating to the error"}}}}}}}}},"\/alert\/{alert_id}\/assign":{"post":{"summary":"Assign alert to user","description":"Assign an alert to a user, optionally changing the status. NOTE: Alerts can only be assigned if they are eligible for assignment to the specified user in the specified status according to the workflow configuration. ### Rate Limits\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"alertAssign","parameters":[{"name":"alert_id","in":"path","required":true,"description":"The ID of the alert to assign","schema":{"type":"number"}}],"tags":["Alert"],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","description":"Details of the users to be assigned \/ unassigned and the optional new status","required":["users"],"properties":{"users":{"type":"object","description":"The users to be added \/ removed from the assignment. Note that one one user can be assigned to an alert at a time.","oneOf":[{"required":["add","remove"]},{"required":["addExternalIds","remove"]},{"required":["add","removeExternalIds"]},{"required":["addExternalIds","removeExternalIds"]}],"required":["add","remove","addExternalIds","removeExternalIds"],"properties":{"add":{"type":"array","description":"internal user id to add. Cannot be used in conjunction with addExternalIds.","maxlength":1,"items":{"type":"number","example":10006}},"addExternalIds":{"type":"array","description":"external user id to add. Cannot be used in conjunction with add.","maxlength":1,"items":{"type":"string","example":"john.smith@ripjar.com"}},"remove":{"type":"array","description":"internal user id to remove. Cannot be used in conjunction with removeExternalIds.","maxlength":1,"items":{"type":"number","example":10005}},"removeExternalIds":{"type":"array","description":"external user id to remove. Cannot be used in conjunction with remove.","maxlength":1,"items":{"type":"string","example":"john.smith@ripjar.com"}}}},"newStatus":{"type":"object","description":"New status","properties":{"status":{"type":"integer","description":"New status code"}}}}}}}},"responses":{"200":{"description":"The updated alert","content":{"application\/json":{"schema":{"type":"object","description":"The details of the alert following the requested changes being applied.","properties":{"alert":{"type":"object","properties":{"assignedUsers":{"description":"Details of the user currently assigned to the alert","type":"array","example":[{"username":"John Smith","email":"john.smith@ripjar.com","externalId":"john.smith@ripjar.com","mobile":"01234567890","roles":["ROLE_1"],"cn":"john.smith@ripjar.com","clientKey":"lowercasekey","customerExcludedApps":["app"],"security":{},"lastLogin":1596188918065,"username_lowercase":"john smith","lineNumber":4,"lastModified":1595437138430,"id":10003,"dateCreated":1595437138459}],"oneOf":[{"type":"array","description":"IDs of users assigned to the result, returned when results enrichment is disabled","items":{"type":"number"},"example":[1]},{"type":"array","description":"Objects representing users assigned to the result, returned when results enrichment is enabled","items":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}},"components":{"schemas":{"AssignedUserEnriched":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}}}}}]},"assignedGroups":{"type":"array","description":"assignment to groups is not currently supported.","items":{"type":"number"}},"tags":{"type":"array","description":"list of tags that relevant to the alert.","items":{"type":"string","example":"policy-20037"}},"state":{"type":"integer","description":"A number representing the overall state of the alert.\n0 = Monitoring\n1 = Open\n2 = Closed\n3 = Reopened\n","enum":[0,1,2,3]},"score":{"type":"integer","description":"The total alert score, calculated from the evidence within the alert"},"sortKey":{"type":"number"},"currentStatus":{"type":"object"},"time":{"type":"object","description":"set of relevant timestamps for the alert","example":{"created":1664330051195,"lastUpdated":1664468061574,"breached":1664330051277,"lastEvidence":1664340367378,"lastAssigned":1664468061574},"properties":{"created":{"type":"integer","description":"when the alert was created","example":1600427478761},"lastUpdated":{"type":"integer","description":"when the alert last received updated information","example":1600427478761},"breached":{"type":"integer","description":"when the alert transitioned from monitoring to opened","example":1600427478860},"lastEvidence":{"type":"integer","description":"when the last piece of evidence was added to the alert","example":1600427478860},"lastAssigned":{"type":"integer","description":"when the alert was last assigned","example":1600427478860}}},"namespace":{"type":"string"},"type":{"type":"number"},"target":{"type":"string"},"security":{"type":"object","description":"The alert\\'s security object"},"description":{"type":"string","example":"alert for some company"},"name":{"type":"string","example":"alert"},"clientKey":{"type":"string","example":"lowercasekey"},"mode":{"type":"string","example":"sum"},"id":{"type":"number","example":12345},"threshold":{"type":"number","example":0},"sortKey2":{"type":"number","example":1.1959140198},"history":{"type":"array","description":"The assignment history of the alert","items":{"type":"object","properties":{"assignedUsers":{"type":"array","description":"The user objects for the assigned users.","items":{"type":"object","description":"An object representing a user in the system.","required":["username","email","cn"],"properties":{"excludedApps":{"type":"array","items":{"type":"string"},"description":"A list of the applications that this user is excluded from accessing. Not used in Screening."},"username":{"type":"string","description":"The name of the user. This is the value displayed when the user is referenced in the UI."},"email":{"type":"string","description":"The email address of the user. Can be used as part of basic authentication."},"mobile":{"type":"string","description":"The mobile\/cell phone number of the user."},"roles":{"type":"array","items":{"type":"string"},"description":"A list of the user roles that this user has.\nLabyrinth Screening makes use of defined user roles to control the actions a user may perform and to tailor the interface to the needs of particular users.\nEach role is made up of a set of permissions which provide fine grained control over the actions a user can perform. Roles can be configured to match the business roles required by the users of the Screening system.\nThese permissions used by the Screening system are described in the Ripjar Security Implementation document.\nWhen users are loaded into the system, each user account should include the list of roles they are allowed to perform.\n"},"password":{"type":"string","description":"The user's password, used for basic authentication or to retrieve a bearer auth (JWT) token. Not available in API responses. Required when creating or updating users.\n"},"cn":{"type":"string","description":"The user's canonical name. Used to lookup user accounts when performing certificate-based authentication."},"externalId":{"type":"string","description":"The user's ID external to the system. Typically maps to a username or ID in an external user entitlement system."},"security":{"type":"object","description":"The security attributes for this user.\nA user's security attributes govern the data items in the system (such as clients, alerts and assessments) that the user has visibility of. These are distinct from the user's roles, which govern the operations a user can carry out in the system.\nThe security schema contains a set of generic attributes that the user can be assigned. The meaning of these attributes varies depending on the security policy installed on the system.\nBy default, the security policy will compare the list of strings (also known as tags) in dataRolesN fields of the user to the list of strings in the orTagsN field in the security attributes of the data item. If the user has any of the tags that appear on the data item, they can view that item.\nIf the data item has multiple orTags fields, for example orTags1 and orTags2, the user must has at least one of the tags in each of the corresponding dataRoles fields, i.e. there is an AND logic between each attribute.\n","properties":{"dataRoles1":{"type":"array","items":{"type":"string"}},"dataRoles2":{"type":"array","items":{"type":"string"}},"dataRoles3":{"type":"array","items":{"type":"string"}},"compositeDataRoles1":{"type":"array","items":{"type":"object"}}}}}}},"timestamp":{"type":"integer","description":"The timestamp for when the alert was assigned"},"state":{"type":"integer","description":"The state code"},"status":{"type":"integer","description":"The status code"}}}},"lastActivity":{"type":"object","properties":{"id":{"type":"number","example":121212,"description":"activity id"},"createdAt":{"type":"number","example":1664468061625,"description":"Activity timestamp"},"type":{"type":"string","example":"alertAssigned"},"description":{"type":"string","example":"Alert assignment was changed","description":"Activity description"},"data":{"type":"object","properties":{"users":{"type":"object","properties":{"add":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"user ID","example":10006},"username":{"type":"string","example":"KYC - Admin"}}}},"remove":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"user ID","example":10006},"username":{"type":"string","example":"KYC - Admin"}}}}}},"groups":{"type":"object"},"newStatus":{"type":"object","properties":{"status":{"type":"number","example":103}}}}},"security":{"type":"object","description":"The alert\\'s security object","example":{}},"target":{"type":"string","example":"alert-10351"},"tags":{"type":"array","items":{"type":"string","example":"context-alerting"}},"namespace":{"type":"string","example":"torch"},"createdBy":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}},"clientKey":{"type":"string","example":"lowercasekey"}}},"bookmarks":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"string"}},"sort":{"type":"string"},"total":{"type":"number"}}},"eoi":{"type":"object"},"transitions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":101,"description":"ID of transition"},"constraints":{"type":"array","items":{"type":"object","description":"Different type of constrains","required":["key"],"properties":{"value":{"oneOf":[{"type":"number","example":101},{"type":"array","example":[101,102],"items":{"type":"number"}}]},"key":{"type":"string","example":"status"},"isSet":{"type":"boolean"},"isSameAs":{"type":"string","example":"currentUser"}}}}}}}}},"activity":{"type":"object","properties":{"id":{"type":"number","example":121212,"description":"activity id"},"createdAt":{"type":"number","example":1664468061625,"description":"Activity timestamp"},"type":{"type":"string","example":"alertAssigned"},"description":{"type":"string","example":"Alert assignment was changed","description":"Activity description"},"data":{"type":"object","properties":{"users":{"type":"object","properties":{"add":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"user ID","example":10006},"username":{"type":"string","example":"KYC - Admin"}}}},"remove":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"user ID","example":10006},"username":{"type":"string","example":"KYC - Admin"}}}}}},"groups":{"type":"object"},"newStatus":{"type":"object","properties":{"status":{"type":"number","example":103}}}}},"security":{"type":"object","description":"The alert\\'s security object","example":{}},"target":{"type":"string","example":"alert-10351"},"tags":{"type":"array","items":{"type":"string","example":"context-alerting"}},"namespace":{"type":"string","example":"torch"},"createdBy":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}},"clientKey":{"type":"string","example":"lowercasekey"}}}}},"example":{"alert":{"assignedUsers":[{"username":"sandbox","email":"sandbox1677001704151@ripjar.com","cn":"sandbox1677001704151@ripjar.com","clientKey":"sandbox","roles":["ADMINISTRATOR"],"security":{"enabled":true,"dataRoles1":["X"],"dataRoles2":["B"]},"id":10024,"externalId":"sandbox1677001704151@ripjar.com","mobile":"","customerExcludedApps":null,"username_lowercase":"sandbox","accountLocked":false,"failed_login_attempts":0,"failed_login_timestamp":-1,"lastLogin":1706705113674,"vosId":6}],"assignedGroups":[],"tags":["context-alerting","dj:sanctions","policy-10119"],"listEntityIds":["listEntity:list_entity-urn:ripjar:sot-fuv-xoy-vof"],"state":1,"score":100,"sortKey":400,"docCount":1,"currentStatus":{"status":101,"timestamp":1706709612389},"time":{"created":1705547024213,"lastUpdated":1706709612389,"breached":1705547024445,"lastEvidence":1705547024445,"lastAssigned":1706709612389},"namespace":"torch","clientKey":"sandbox","type":10119,"target":"eoi:cba_person_23","name":"Gulnara Karimova","description":"alert for Gulnara Karimova","security":{},"mode":"sum","id":187497,"riskTags":["PEP-inactive","OOL-active","SAN-active","SIP-active","NEWS-active"],"threshold":100,"history":[{"assignedUsers":[],"state":1,"status":100,"timestamp":1706709612376}],"lastActivity":{"id":1909371,"createdAt":1706709612435,"type":"alertAssigned","description":"Alert assignment was changed","data":{"users":{"add":[{"_id":"63f503e85454811117036567","username":"sandbox","id":10024}],"remove":[]},"newStatus":{"status":101},"groups":{"add":[],"remove":[]}},"security":{},"target":"alert-187497","tags":["context-alerting"],"namespace":"torch","createdBy":{"username":"sandbox","email":"sandbox1677001704151@ripjar.com","cn":"sandbox1677001704151@ripjar.com","clientKey":"sandbox","roles":["ADMINISTRATOR"],"security":{"enabled":true,"dataRoles1":["X"],"dataRoles2":["B"]},"id":10024,"externalId":"sandbox1677001704151@ripjar.com","mobile":"","customerExcludedApps":null,"username_lowercase":"sandbox","accountLocked":false,"failed_login_attempts":0,"failed_login_timestamp":-1,"lastLogin":1706705113674,"vosId":6},"clientKey":"sandbox"},"bookmarks":{"annotations":[],"sort":"time.created:-1","total":0},"eoi":{"id":"eoi:cba_person_23","_start_rev":20284,"_revision":20284,"clientId":"cba_person_23","status":"ACTIVE","lastReviewed":1420070400000,"entityType":"PERSON","name":"Gulnara Karimova","nationalityCodes":["UZ"],"dateOfBirth":"1972-08-08","clientKey":"sandbox","alertsDisabled":false,"nationalities":["Uzbekistan"],"monitorStartDate":1420070400000,"displayname":"Gulnara Karimova","_type":"person","relationships":[],"relationshipGrouping":[],"observedEntityIds":[]},"transitions":[{"id":101,"constraints":[{"key":"state","value":[0,1,3]},{"key":"status","value":101},{"key":"assignedTo","isSet":true}]},{"id":102,"constraints":[{"key":"state","value":[0,1,3]},{"key":"status","value":102},{"key":"assignedTo","isSet":true}]},{"id":103,"constraints":[{"key":"state","value":[0,1,3]},{"key":"status","value":103},{"key":"assignedTo","isSet":true}]},{"id":104,"constraints":[{"key":"state","value":[0,1,3]},{"key":"status","value":104},{"key":"assignedTo","isSet":true}]},{"id":200,"constraints":[{"key":"state","value":2},{"key":"status","value":200},{"key":"assignedTo","isSet":true,"isSameAs":"currentUser"}]},{"id":201,"constraints":[{"key":"state","value":2},{"key":"status","value":201},{"key":"assignedTo","isSet":true,"isSameAs":"currentUser"}]}]},"activity":{"id":1909371,"createdAt":1706709612435,"type":"alertAssigned","description":"Alert assignment was changed","data":{"users":{"add":[{"_id":"63f503e85454811117036567","username":"sandbox","id":10024}],"remove":[]},"newStatus":{"status":101},"groups":{"add":[],"remove":[]}},"security":{},"target":"alert-187497","tags":["context-alerting"],"namespace":"torch","createdBy":{"username":"sandbox","email":"sandbox1677001704151@ripjar.com","cn":"sandbox1677001704151@ripjar.com","clientKey":"sandbox","roles":["ADMINISTRATOR"],"security":{"enabled":true,"dataRoles1":["X"],"dataRoles2":["B"]},"id":10024,"externalId":"sandbox1677001704151@ripjar.com","mobile":"","customerExcludedApps":null,"username_lowercase":"sandbox","accountLocked":false,"failed_login_attempts":0,"failed_login_timestamp":-1,"lastLogin":1706705113674,"vosId":6},"clientKey":"sandbox"}}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"type":"object","required":["status","message"],"properties":{"status":{"type":"integer","description":"The HTTP status code of the error","example":500},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable","example":"Internal server error"},"details":{"type":"object","description":"A JSON object containing additional details relating to the error"}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","required":["status","message"],"properties":{"status":{"type":"integer","description":"The HTTP status code of the error","example":500},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable","example":"Internal server error"},"details":{"type":"object","description":"A JSON object containing additional details relating to the error"}}}}}},"403":{"description":"Forbidden (e.g. the user does not have the correct permission)","content":{"application\/json":{"schema":{"type":"object","required":["status","message"],"properties":{"status":{"type":"integer","description":"The HTTP status code of the error","example":500},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable","example":"Internal server error"},"details":{"type":"object","description":"A JSON object containing additional details relating to the error"}}}}}},"404":{"description":"Not Found (e.g. the alert could not be found or the alert status and close reason were not found in configuration)","content":{"application\/json":{"schema":{"type":"object","required":["status","message"],"properties":{"status":{"type":"integer","description":"The HTTP status code of the error","example":500},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable","example":"Internal server error"},"details":{"type":"object","description":"A JSON object containing additional details relating to the error"}}}}}},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","required":["status","message"],"properties":{"status":{"type":"integer","description":"The HTTP status code of the error","example":500},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable","example":"Internal server error"},"details":{"type":"object","description":"A JSON object containing additional details relating to the error"}}}}}}}}},"\/alert\/{alert_id}\/assign\/previous":{"post":{"summary":"Assign alert to the previous assignee","description":"Assign the alert to the previous assignee in the previous status. NOTE: The alert must have been assigned to a previous user in a different status. NOTE: Alerts can only be assigned if they are eligible for assignment to the specified user in the specified status according to the workflow configuration. ### Rate Limits\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"alertAssignPrevious","parameters":[{"name":"alert_id","in":"path","required":true,"schema":{"type":"number"}}],"tags":["Alert"],"responses":{"200":{"description":"The updated alert details","content":{"application\/json":{"schema":{"type":"object","description":"The details of the alert following the requested changes being applied.","properties":{"alert":{"type":"object","properties":{"assignedUsers":{"description":"Details of the user currently assigned to the alert","type":"array","example":[{"username":"John Smith","email":"john.smith@ripjar.com","externalId":"john.smith@ripjar.com","mobile":"01234567890","roles":["ROLE_1"],"cn":"john.smith@ripjar.com","clientKey":"lowercasekey","customerExcludedApps":["app"],"security":{},"lastLogin":1596188918065,"username_lowercase":"john smith","lineNumber":4,"lastModified":1595437138430,"id":10003,"dateCreated":1595437138459}],"oneOf":[{"type":"array","description":"IDs of users assigned to the result, returned when results enrichment is disabled","items":{"type":"number"},"example":[1]},{"type":"array","description":"Objects representing users assigned to the result, returned when results enrichment is enabled","items":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}},"components":{"schemas":{"AssignedUserEnriched":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}}}}}]},"assignedGroups":{"type":"array","description":"assignment to groups is not currently supported.","items":{"type":"number"}},"tags":{"type":"array","description":"list of tags that relevant to the alert.","items":{"type":"string","example":"policy-20037"}},"state":{"type":"integer","description":"A number representing the overall state of the alert.\n0 = Monitoring\n1 = Open\n2 = Closed\n3 = Reopened\n","enum":[0,1,2,3]},"score":{"type":"integer","description":"The total alert score, calculated from the evidence within the alert"},"sortKey":{"type":"number"},"currentStatus":{"type":"object"},"time":{"type":"object","description":"set of relevant timestamps for the alert","example":{"created":1664330051195,"lastUpdated":1664468061574,"breached":1664330051277,"lastEvidence":1664340367378,"lastAssigned":1664468061574},"properties":{"created":{"type":"integer","description":"when the alert was created","example":1600427478761},"lastUpdated":{"type":"integer","description":"when the alert last received updated information","example":1600427478761},"breached":{"type":"integer","description":"when the alert transitioned from monitoring to opened","example":1600427478860},"lastEvidence":{"type":"integer","description":"when the last piece of evidence was added to the alert","example":1600427478860},"lastAssigned":{"type":"integer","description":"when the alert was last assigned","example":1600427478860}}},"namespace":{"type":"string"},"type":{"type":"number"},"target":{"type":"string"},"security":{"type":"object","description":"The alert\\'s security object"},"description":{"type":"string","example":"alert for some company"},"name":{"type":"string","example":"alert"},"clientKey":{"type":"string","example":"lowercasekey"},"mode":{"type":"string","example":"sum"},"id":{"type":"number","example":12345},"threshold":{"type":"number","example":0},"sortKey2":{"type":"number","example":1.1959140198},"history":{"type":"array","description":"The assignment history of the alert","items":{"type":"object","properties":{"assignedUsers":{"type":"array","description":"The user objects for the assigned users.","items":{"type":"object","description":"An object representing a user in the system.","required":["username","email","cn"],"properties":{"excludedApps":{"type":"array","items":{"type":"string"},"description":"A list of the applications that this user is excluded from accessing. Not used in Labyrinth Screening."},"username":{"type":"string","description":"The name of the user. This is the value displayed when the user is referenced in the UI."},"email":{"type":"string","description":"The email address of the user. Can be used as part of basic authentication."},"mobile":{"type":"string","description":"The mobile\/cell phone number of the user."},"roles":{"type":"array","items":{"type":"string"},"description":"A list of the user roles that this user has.\nLabyrinth Screening makes use of defined user roles to control the actions a user may perform and to tailor the interface to the needs of particular users.\nEach role is made up of a set of permissions which provide fine grained control over the actions a user can perform. Roles can be configured to match the business roles required by the users of the Screening system.\nThese permissions used by the Screening system are described in the Ripjar Security Implementation document.\nWhen users are loaded into the system, each user account should include the list of roles they are allowed to perform.\n"},"password":{"type":"string","description":"The user's password, used for basic authentication or to retrieve a bearer auth (JWT) token. Not available in API responses. Required when creating or updating users.\n"},"cn":{"type":"string","description":"The user's canonical name. Used to lookup user accounts when performing certificate-based authentication."},"externalId":{"type":"string","description":"The user's ID external to the system. Typically maps to a username or ID in an external user entitlement system."},"security":{"type":"object","description":"The security attributes for this user.\nA user's security attributes govern the data items in the system (such as clients, alerts and assessments) that the user has visibility of. These are distinct from the user's roles, which govern the operations a user can carry out in the system.\nThe security schema contains a set of generic attributes that the user can be assigned. The meaning of these attributes varies depending on the security policy installed on the system.\nBy default, the security policy will compare the list of strings (also known as tags) in dataRolesN fields of the user to the list of strings in the orTagsN field in the security attributes of the data item. If the user has any of the tags that appear on the data item, they can view that item.\nIf the data item has multiple orTags fields, for example orTags1 and orTags2, the user must has at least one of the tags in each of the corresponding dataRoles fields, i.e. there is an AND logic between each attribute.\n","properties":{"dataRoles1":{"type":"array","items":{"type":"string"}},"dataRoles2":{"type":"array","items":{"type":"string"}},"dataRoles3":{"type":"array","items":{"type":"string"}},"compositeDataRoles1":{"type":"array","items":{"type":"object"}}}}}}},"timestamp":{"type":"integer","description":"The timestamp for when the alert was assigned"},"state":{"type":"integer","description":"The state code"},"status":{"type":"integer","description":"The status code"}}}},"lastActivity":{"type":"object","properties":{"id":{"type":"number","example":121212,"description":"activity id"},"createdAt":{"type":"number","example":1664468061625,"description":"Activity timestamp"},"type":{"type":"string","example":"alertAssigned"},"description":{"type":"string","example":"Alert assignment was changed","description":"Activity description"},"data":{"type":"object","properties":{"users":{"type":"object","properties":{"add":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"user ID","example":10006},"username":{"type":"string","example":"KYC - Admin"}}}},"remove":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"user ID","example":10006},"username":{"type":"string","example":"KYC - Admin"}}}}}},"groups":{"type":"object"},"newStatus":{"type":"object","properties":{"status":{"type":"number","example":103}}}}},"security":{"type":"object","description":"The alert\\'s security object","example":{}},"target":{"type":"string","example":"alert-10351"},"tags":{"type":"array","items":{"type":"string","example":"context-alerting"}},"namespace":{"type":"string","example":"torch"},"createdBy":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}},"clientKey":{"type":"string","example":"lowercasekey"}}},"bookmarks":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"string"}},"sort":{"type":"string"},"total":{"type":"number"}}},"eoi":{"type":"object"},"transitions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":101,"description":"ID of transition"},"constraints":{"type":"array","items":{"type":"object","description":"Different type of constrains","required":["key"],"properties":{"value":{"oneOf":[{"type":"number","example":101},{"type":"array","example":[101,102],"items":{"type":"number"}}]},"key":{"type":"string","example":"status"},"isSet":{"type":"boolean"},"isSameAs":{"type":"string","example":"currentUser"}}}}}}}}},"activity":{"type":"object","properties":{"id":{"type":"number","example":121212,"description":"activity id"},"createdAt":{"type":"number","example":1664468061625,"description":"Activity timestamp"},"type":{"type":"string","example":"alertAssigned"},"description":{"type":"string","example":"Alert assignment was changed","description":"Activity description"},"data":{"type":"object","properties":{"users":{"type":"object","properties":{"add":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"user ID","example":10006},"username":{"type":"string","example":"KYC - Admin"}}}},"remove":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"user ID","example":10006},"username":{"type":"string","example":"KYC - Admin"}}}}}},"groups":{"type":"object"},"newStatus":{"type":"object","properties":{"status":{"type":"number","example":103}}}}},"security":{"type":"object","description":"The alert\\'s security object","example":{}},"target":{"type":"string","example":"alert-10351"},"tags":{"type":"array","items":{"type":"string","example":"context-alerting"}},"namespace":{"type":"string","example":"torch"},"createdBy":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}},"clientKey":{"type":"string","example":"lowercasekey"}}}}}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"403":{"description":"Forbidden (e.g. the user does not have the correct permission)","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"404":{"description":"Not Found (e.g. the alert could not be found or the alert status and close reason were not found in configuration)","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/alert\/{alert_id}\/reopen":{"post":{"summary":"Reopen an alert","description":"Reopen a closed alert.  NOTE: Alerts can only be reopened if they are eligible for reopening and can transition to the specified status according to the workflow configuration. ### Rate Limits\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"alertReopen","parameters":[{"name":"alert_id","in":"path","required":true,"schema":{"type":"number"}}],"tags":["Alert"],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["status","reason"],"properties":{"comment":{"type":"string","description":"a comment providing details of the closure decision."},"status":{"type":"number","description":"A 3 digit number made up of internal alert state (1 digit) and the alert status as configured by your system administrator (2 digits).","example":300},"reason":{"type":"number","description":"The ID of the closure reason. Reasons are configured by your system administrator."}}}}}},"responses":{"200":{"description":"The updated alert","content":{"application\/json":{"schema":{"type":"object","description":"Alert object","properties":{"id":{"type":"integer","description":"The id of the alert","example":10001},"namespace":{"type":"string","description":"Internal field"},"target":{"type":"string","description":"The target object (client) that encapsulates the activity","example":"eoi:10001"},"description":{"type":"string","description":"A brief description of the alert","example":"torch"},"clientKey":{"type":"string","description":"Internal field"},"state":{"type":"string","description":"Current state of the alert","example":"OPENED","enum":["MONITORING","OPENED","CLOSED","REOPENED","OPENED_FIXED_PERIOD"]},"mode":{"type":"string","description":"alert mode","example":"sum"},"threshold":{"type":"integer","description":"The value of the threshold to breach an alert when this alert breached","example":100},"score":{"type":"integer","description":"Score of the alert, based on the evidence accrued","example":100},"sortKey":{"type":"integer","description":"Internal field"},"currentStatus":{"type":"object","description":"records details of the alerts status (versus state)","properties":{"status":{"type":"integer","description":"the current status value","example":101},"timestamp":{"type":"integer","description":"timestamp of the last status change","example":1590989346512}}},"assignedUsers":{"type":"array","description":"list of user ids the alert has been assigned to.","items":{"type":"number","example":990}},"assignedGroups":{"type":"array","description":"list of group ids the alert has been assigned to, where appropriate.","items":{"type":"number","example":10}},"time":{"type":"object","description":"set of relevant timestamps for the alert","properties":{"created":{"type":"integer","description":"when the alert was created","example":1600427478761},"lastUpdated":{"type":"integer","description":"when the alert last received updated information","example":1600427478761},"breached":{"type":"integer","description":"when the alert transitioned from monitoring to opened","example":1600427478860},"lastEvidence":{"type":"integer","description":"when the last piece of evidence was added to the alert","example":1600427478860}}},"security":{"type":"object","description":"The alert\\'s security object","example":{}},"tags":{"type":"array","description":"list of tags that relevant to the alert.","items":{"type":"string","example":"policy-20037"}},"client":{"type":"object","description":"details of the alert's associated client"}}}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"403":{"description":"Forbidden (e.g. the user does not have the ReopenAlert permission)","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"404":{"description":"Not Found (e.g. the alert could not be found or the alert status and close reason were not found in configuration)","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"422":{"description":"Unprocessable Entity (e.g. the alert is in monitoring state)","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/alert\/{alert_id}\/status":{"post":{"summary":"Update status\/assignment of an alert","description":"Update status and optionally the assigned user of an alert. NOTE: Alerts can only be assigned or change status if they are eligible for assignment to the specified user in the specified status according to the workflow configuration. ### Rate Limits\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"alertStatus","parameters":[{"name":"alert_id","in":"path","required":true,"schema":{"type":"number"}}],"tags":["Alert"],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["newStatus"],"properties":{"users":{"type":"object","description":"Add and remove user.","oneOf":[{"required":["add","remove"]},{"required":["addExternalIds","remove"]},{"required":["add","removeExternalIds"]},{"required":["addExternalIds","removeExternalIds"]}],"required":["add","remove","addExternalIds","removeExternalIds"],"properties":{"add":{"type":"array","description":"internal user id to add. Cannot be used in conjunction with addExternalIds.","maxlength":1,"items":{"type":"number","example":10006}},"addExternalIds":{"type":"array","description":"external user id to add. Cannot be used in conjunction with add.","maxlength":1,"items":{"type":"string","example":"john.smith@ripjar.com"}},"remove":{"type":"array","description":"internal user id to remove. Cannot be used in conjunction with removeExternalIds.","maxlength":1,"items":{"type":"number","example":10005}},"removeExternalIds":{"type":"array","description":"external user id to remove. Cannot be used in conjunction with remove.","maxlength":1,"items":{"type":"string","example":"john.smith@ripjar.com"}}}},"newStatus":{"type":"object","description":"New status to transition to.","properties":{"status":{"type":"integer","description":"New status code"}}}}}}}},"responses":{"200":{"description":"The updated alert","content":{"application\/json":{"schema":{"type":"object","properties":{"alert":{"type":"object","properties":{"assignedUsers":{"description":"Details of the user currently assigned to the alert","type":"array","example":[{"username":"John Smith","email":"john.smith@ripjar.com","externalId":"john.smith@ripjar.com","mobile":"01234567890","roles":["ROLE_1"],"cn":"john.smith@ripjar.com","clientKey":"lowercasekey","customerExcludedApps":["app"],"security":{},"lastLogin":1596188918065,"username_lowercase":"john smith","lineNumber":4,"lastModified":1595437138430,"id":10003,"dateCreated":1595437138459}],"oneOf":[{"type":"array","description":"IDs of users assigned to the result, returned when results enrichment is disabled","items":{"type":"number"},"example":[1]},{"type":"array","description":"Objects representing users assigned to the result, returned when results enrichment is enabled","items":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}},"components":{"schemas":{"AssignedUserEnriched":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}}}}}]},"assignedGroups":{"type":"array","description":"assignment to groups is not currently supported.","items":{"type":"number"}},"tags":{"type":"array","description":"list of tags that relevant to the alert.","items":{"type":"string","example":"policy-20037"}},"state":{"type":"integer","description":"A number representing the overall state of the alert.\n0 = Monitoring\n1 = Open\n2 = Closed\n3 = Reopened\n","enum":[0,1,2,3]},"score":{"type":"integer","description":"The total alert score, calculated from the evidence within the alert"},"sortKey":{"type":"number"},"currentStatus":{"type":"object"},"time":{"type":"object","description":"set of relevant timestamps for the alert","example":{"created":1664330051195,"lastUpdated":1664468061574,"breached":1664330051277,"lastEvidence":1664340367378,"lastAssigned":1664468061574},"properties":{"created":{"type":"integer","description":"when the alert was created","example":1600427478761},"lastUpdated":{"type":"integer","description":"when the alert last received updated information","example":1600427478761},"breached":{"type":"integer","description":"when the alert transitioned from monitoring to opened","example":1600427478860},"lastEvidence":{"type":"integer","description":"when the last piece of evidence was added to the alert","example":1600427478860},"lastAssigned":{"type":"integer","description":"when the alert was last assigned","example":1600427478860}}},"namespace":{"type":"string"},"type":{"type":"number"},"target":{"type":"string"},"security":{"type":"object","description":"The alert\\'s security object"},"description":{"type":"string","example":"alert for some company"},"name":{"type":"string","example":"alert"},"clientKey":{"type":"string","example":"lowercasekey"},"mode":{"type":"string","example":"sum"},"id":{"type":"number","example":12345},"threshold":{"type":"number","example":0},"sortKey2":{"type":"number","example":1.1959140198},"history":{"type":"array","description":"The assignment history of the alert","items":{"type":"object","properties":{"assignedUsers":{"type":"array","description":"The user objects for the assigned users.","items":{"type":"object","description":"An object representing a user in the system.","required":["username","email","cn"],"properties":{"excludedApps":{"type":"array","items":{"type":"string"},"description":"A list of the applications that this user is excluded from accessing. Not used in Labyrinth Screening."},"username":{"type":"string","description":"The name of the user. This is the value displayed when the user is referenced in the UI."},"email":{"type":"string","description":"The email address of the user. Can be used as part of basic authentication."},"mobile":{"type":"string","description":"The mobile\/cell phone number of the user."},"roles":{"type":"array","items":{"type":"string"},"description":"A list of the user roles that this user has.\nLabyrinth Screening makes use of defined user roles to control the actions a user may perform and to tailor the interface to the needs of particular users.\nEach role is made up of a set of permissions which provide fine grained control over the actions a user can perform. Roles can be configured to match the business roles required by the users of the Screening system.\nThese permissions used by the Screening system are described in the Ripjar Security Implementation document.\nWhen users are loaded into the system, each user account should include the list of roles they are allowed to perform.\n"},"password":{"type":"string","description":"The user's password, used for basic authentication or to retrieve a bearer auth (JWT) token. Not available in API responses. Required when creating or updating users.\n"},"cn":{"type":"string","description":"The user's canonical name. Used to lookup user accounts when performing certificate-based authentication."},"externalId":{"type":"string","description":"The user's ID external to the system. Typically maps to a username or ID in an external user entitlement system."},"security":{"type":"object","description":"The security attributes for this user.\nA user's security attributes govern the data items in the system (such as clients, alerts and assessments) that the user has visibility of. These are distinct from the user's roles, which govern the operations a user can carry out in the system.\nThe security schema contains a set of generic attributes that the user can be assigned. The meaning of these attributes varies depending on the security policy installed on the system.\nBy default, the security policy will compare the list of strings (also known as tags) in dataRolesN fields of the user to the list of strings in the orTagsN field in the security attributes of the data item. If the user has any of the tags that appear on the data item, they can view that item.\nIf the data item has multiple orTags fields, for example orTags1 and orTags2, the user must has at least one of the tags in each of the corresponding dataRoles fields, i.e. there is an AND logic between each attribute.\n","properties":{"dataRoles1":{"type":"array","items":{"type":"string"}},"dataRoles2":{"type":"array","items":{"type":"string"}},"dataRoles3":{"type":"array","items":{"type":"string"}},"compositeDataRoles1":{"type":"array","items":{"type":"object"}}}}}}},"timestamp":{"type":"integer","description":"The timestamp for when the alert was assigned"},"state":{"type":"integer","description":"The state code"},"status":{"type":"integer","description":"The status code"}}}},"lastActivity":{"type":"object","properties":{"id":{"type":"number","example":121212,"description":"activity id"},"createdAt":{"type":"number","example":1664468061625,"description":"Activity timestamp"},"type":{"type":"string","example":"alertAssigned"},"description":{"type":"string","example":"Alert assignment was changed","description":"Activity description"},"data":{"type":"object","properties":{"users":{"type":"object","properties":{"add":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"user ID","example":10006},"username":{"type":"string","example":"KYC - Admin"}}}},"remove":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"user ID","example":10006},"username":{"type":"string","example":"KYC - Admin"}}}}}},"groups":{"type":"object"},"newStatus":{"type":"object","properties":{"status":{"type":"number","example":103}}}}},"security":{"type":"object","description":"The alert\\'s security object","example":{}},"target":{"type":"string","example":"alert-10351"},"tags":{"type":"array","items":{"type":"string","example":"context-alerting"}},"namespace":{"type":"string","example":"torch"},"createdBy":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}},"clientKey":{"type":"string","example":"lowercasekey"}}},"bookmarks":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"string"}},"sort":{"type":"string"},"total":{"type":"number"}}},"eoi":{"type":"object"},"transitions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":101,"description":"ID of transition"},"constraints":{"type":"array","items":{"type":"object","description":"Different type of constrains","required":["key"],"properties":{"value":{"oneOf":[{"type":"number","example":101},{"type":"array","example":[101,102],"items":{"type":"number"}}]},"key":{"type":"string","example":"status"},"isSet":{"type":"boolean"},"isSameAs":{"type":"string","example":"currentUser"}}}}}}}}},"activity":{"type":"object","properties":{"id":{"type":"number","example":121212,"description":"activity id"},"createdAt":{"type":"number","example":1664468061625,"description":"Activity timestamp"},"type":{"type":"string","example":"alertAssigned"},"description":{"type":"string","example":"Alert assignment was changed","description":"Activity description"},"data":{"type":"object","properties":{"users":{"type":"object","properties":{"add":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"user ID","example":10006},"username":{"type":"string","example":"KYC - Admin"}}}},"remove":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"user ID","example":10006},"username":{"type":"string","example":"KYC - Admin"}}}}}},"groups":{"type":"object"},"newStatus":{"type":"object","properties":{"status":{"type":"number","example":103}}}}},"security":{"type":"object","description":"The alert\\'s security object","example":{}},"target":{"type":"string","example":"alert-10351"},"tags":{"type":"array","items":{"type":"string","example":"context-alerting"}},"namespace":{"type":"string","example":"torch"},"createdBy":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}},"clientKey":{"type":"string","example":"lowercasekey"}}},"externalNotification":{"type":"object","properties":{"notifications":{"type":"array","items":{"type":"object"}}}}}}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"403":{"description":"Forbidden (e.g. the user does not have the UpdateAlert permission or the alert evidence has not been assessed and the alert type has mandatoryAssessment set to true)","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"404":{"description":"Not Found (e.g. the alert could not be found or the alert status and close reason were not found in configuration)","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/alert\/assign":{"post":{"summary":"Bulk assign alerts","description":"Bulk assign alerts to the specified user, optionally changing the status of the alerts to the specified status.\nNOTE: Alerts can only be assigned if they are eligible for assignment to the specified user in the specified status according to the workflow configuration.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 99 ms |\n| 90th percentile | 230 ms |\n| 95th percentile | 397 ms |\n| 98th percentile | 967 ms |\n| 99th percentile | 1.7 s |\n<!-- operational-characteristics:end -->\n","operationId":"alertBulkAssign","tags":["Alert"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":98.43,"p90":229.51,"p95":396.14,"p98":966.32,"p99":1665.62,"sampleSize":1930}},"requestBody":{"required":true,"content":{"application\/json":{"schema":{"allOf":[{"type":"object","description":"Details of the users to be assigned \/ unassigned and the optional new status","required":["users"],"properties":{"users":{"type":"object","description":"The users to be added \/ removed from the assignment. Note that one one user can be assigned to an alert at a time.","oneOf":[{"required":["add","remove"]},{"required":["addExternalIds","remove"]},{"required":["add","removeExternalIds"]},{"required":["addExternalIds","removeExternalIds"]}],"required":["add","remove","addExternalIds","removeExternalIds"],"properties":{"add":{"type":"array","description":"internal user id to add. Cannot be used in conjunction with addExternalIds.","maxlength":1,"items":{"type":"number","example":10006}},"addExternalIds":{"type":"array","description":"external user id to add. Cannot be used in conjunction with add.","maxlength":1,"items":{"type":"string","example":"john.smith@ripjar.com"}},"remove":{"type":"array","description":"internal user id to remove. Cannot be used in conjunction with removeExternalIds.","maxlength":1,"items":{"type":"number","example":10005}},"removeExternalIds":{"type":"array","description":"external user id to remove. Cannot be used in conjunction with remove.","maxlength":1,"items":{"type":"string","example":"john.smith@ripjar.com"}}}},"newStatus":{"type":"object","description":"New status","properties":{"status":{"type":"integer","description":"New status code"}}}}},{"type":"object","required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"number","example":11001}}}}]}}}},"responses":{"200":{"description":"The bulk assign alert result","content":{"application\/json":{"schema":{"type":"object","properties":{"alert":{"type":"array","items":{"type":"object","properties":{"assignedUsers":{"description":"Details of the user currently assigned to the alert","type":"array","example":[{"username":"John Smith","email":"john.smith@ripjar.com","externalId":"john.smith@ripjar.com","mobile":"01234567890","roles":["ROLE_1"],"cn":"john.smith@ripjar.com","clientKey":"lowercasekey","customerExcludedApps":["app"],"security":{},"lastLogin":1596188918065,"username_lowercase":"john smith","lineNumber":4,"lastModified":1595437138430,"id":10003,"dateCreated":1595437138459}],"oneOf":[{"type":"array","description":"IDs of users assigned to the result, returned when results enrichment is disabled","items":{"type":"number"},"example":[1]},{"type":"array","description":"Objects representing users assigned to the result, returned when results enrichment is enabled","items":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}},"components":{"schemas":{"AssignedUserEnriched":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}}}}}]},"assignedGroups":{"type":"array","description":"assignment to groups is not currently supported.","items":{"type":"number"}},"tags":{"type":"array","description":"list of tags that relevant to the alert.","items":{"type":"string","example":"policy-20037"}},"state":{"type":"integer","description":"A number representing the overall state of the alert.\n0 = Monitoring\n1 = Open\n2 = Closed\n3 = Reopened\n","enum":[0,1,2,3]},"score":{"type":"integer","description":"The total alert score, calculated from the evidence within the alert"},"sortKey":{"type":"number"},"currentStatus":{"type":"object"},"time":{"type":"object","description":"set of relevant timestamps for the alert","example":{"created":1664330051195,"lastUpdated":1664468061574,"breached":1664330051277,"lastEvidence":1664340367378,"lastAssigned":1664468061574},"properties":{"created":{"type":"integer","description":"when the alert was created","example":1600427478761},"lastUpdated":{"type":"integer","description":"when the alert last received updated information","example":1600427478761},"breached":{"type":"integer","description":"when the alert transitioned from monitoring to opened","example":1600427478860},"lastEvidence":{"type":"integer","description":"when the last piece of evidence was added to the alert","example":1600427478860},"lastAssigned":{"type":"integer","description":"when the alert was last assigned","example":1600427478860}}},"namespace":{"type":"string"},"type":{"type":"number"},"target":{"type":"string"},"security":{"type":"object","description":"The alert\\'s security object"},"description":{"type":"string","example":"alert for some company"},"name":{"type":"string","example":"alert"},"clientKey":{"type":"string","example":"lowercasekey"},"mode":{"type":"string","example":"sum"},"id":{"type":"number","example":12345},"threshold":{"type":"number","example":0},"sortKey2":{"type":"number","example":1.1959140198},"history":{"type":"array","description":"The assignment history of the alert","items":{"type":"object","properties":{"assignedUsers":{"type":"array","description":"The user objects for the assigned users.","items":{"type":"object","description":"An object representing a user in the system.","required":["username","email","cn"],"properties":{"excludedApps":{"type":"array","items":{"type":"string"},"description":"A list of the applications that this user is excluded from accessing. Not used in Labyrinth Screening."},"username":{"type":"string","description":"The name of the user. This is the value displayed when the user is referenced in the UI."},"email":{"type":"string","description":"The email address of the user. Can be used as part of basic authentication."},"mobile":{"type":"string","description":"The mobile\/cell phone number of the user."},"roles":{"type":"array","items":{"type":"string"},"description":"A list of the user roles that this user has.\nLabyrinth Screening makes use of defined user roles to control the actions a user may perform and to tailor the interface to the needs of particular users.\nEach role is made up of a set of permissions which provide fine grained control over the actions a user can perform. Roles can be configured to match the business roles required by the users of the Screening system.\nThese permissions used by the Screening system are described in the Ripjar Security Implementation document.\nWhen users are loaded into the system, each user account should include the list of roles they are allowed to perform.\n"},"password":{"type":"string","description":"The user's password, used for basic authentication or to retrieve a bearer auth (JWT) token. Not available in API responses. Required when creating or updating users.\n"},"cn":{"type":"string","description":"The user's canonical name. Used to lookup user accounts when performing certificate-based authentication."},"externalId":{"type":"string","description":"The user's ID external to the system. Typically maps to a username or ID in an external user entitlement system."},"security":{"type":"object","description":"The security attributes for this user.\nA user's security attributes govern the data items in the system (such as clients, alerts and assessments) that the user has visibility of. These are distinct from the user's roles, which govern the operations a user can carry out in the system.\nThe security schema contains a set of generic attributes that the user can be assigned. The meaning of these attributes varies depending on the security policy installed on the system.\nBy default, the security policy will compare the list of strings (also known as tags) in dataRolesN fields of the user to the list of strings in the orTagsN field in the security attributes of the data item. If the user has any of the tags that appear on the data item, they can view that item.\nIf the data item has multiple orTags fields, for example orTags1 and orTags2, the user must has at least one of the tags in each of the corresponding dataRoles fields, i.e. there is an AND logic between each attribute.\n","properties":{"dataRoles1":{"type":"array","items":{"type":"string"}},"dataRoles2":{"type":"array","items":{"type":"string"}},"dataRoles3":{"type":"array","items":{"type":"string"}},"compositeDataRoles1":{"type":"array","items":{"type":"object"}}}}}}},"timestamp":{"type":"integer","description":"The timestamp for when the alert was assigned"},"state":{"type":"integer","description":"The state code"},"status":{"type":"integer","description":"The status code"}}}},"lastActivity":{"type":"object","properties":{"id":{"type":"number","example":121212,"description":"activity id"},"createdAt":{"type":"number","example":1664468061625,"description":"Activity timestamp"},"type":{"type":"string","example":"alertAssigned"},"description":{"type":"string","example":"Alert assignment was changed","description":"Activity description"},"data":{"type":"object","properties":{"users":{"type":"object","properties":{"add":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"user ID","example":10006},"username":{"type":"string","example":"KYC - Admin"}}}},"remove":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"user ID","example":10006},"username":{"type":"string","example":"KYC - Admin"}}}}}},"groups":{"type":"object"},"newStatus":{"type":"object","properties":{"status":{"type":"number","example":103}}}}},"security":{"type":"object","description":"The alert\\'s security object","example":{}},"target":{"type":"string","example":"alert-10351"},"tags":{"type":"array","items":{"type":"string","example":"context-alerting"}},"namespace":{"type":"string","example":"torch"},"createdBy":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}},"clientKey":{"type":"string","example":"lowercasekey"}}},"bookmarks":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"string"}},"sort":{"type":"string"},"total":{"type":"number"}}},"eoi":{"type":"object"},"transitions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":101,"description":"ID of transition"},"constraints":{"type":"array","items":{"type":"object","description":"Different type of constrains","required":["key"],"properties":{"value":{"oneOf":[{"type":"number","example":101},{"type":"array","example":[101,102],"items":{"type":"number"}}]},"key":{"type":"string","example":"status"},"isSet":{"type":"boolean"},"isSameAs":{"type":"string","example":"currentUser"}}}}}}}}}},"activity":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":121212,"description":"activity id"},"createdAt":{"type":"number","example":1664468061625,"description":"Activity timestamp"},"type":{"type":"string","example":"alertAssigned"},"description":{"type":"string","example":"Alert assignment was changed","description":"Activity description"},"data":{"type":"object","properties":{"users":{"type":"object","properties":{"add":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"user ID","example":10006},"username":{"type":"string","example":"KYC - Admin"}}}},"remove":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"user ID","example":10006},"username":{"type":"string","example":"KYC - Admin"}}}}}},"groups":{"type":"object"},"newStatus":{"type":"object","properties":{"status":{"type":"number","example":103}}}}},"security":{"type":"object","description":"The alert\\'s security object","example":{}},"target":{"type":"string","example":"alert-10351"},"tags":{"type":"array","items":{"type":"string","example":"context-alerting"}},"namespace":{"type":"string","example":"torch"},"createdBy":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}},"clientKey":{"type":"string","example":"lowercasekey"}}}},"externalNotification":{"type":"object","properties":{"notifications":{"type":"array","items":{"type":"object"}}}}}}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden (e.g. the user does not have the correct permission)"},"404":{"description":"Not Found (e.g. the alert could not be found or the alert status and close reason were not found in configuration)"},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/alert\/{alert_id}\/evidence\/{evidence_id}\/assess":{"post":{"summary":"Assess an item of evidence on an alert","description":"Marks an evidence item as Relevant\/Not Relevant based on the assessment code passed in. Returns the assessed evidence item.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n*Generated from limited sample size.*\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 511 ms |\n| 90th percentile | 1.9 s |\n| 95th percentile | 3.0 s |\n| 98th percentile | 3.8 s |\n| 99th percentile | 4.3 s |\n<!-- operational-characteristics:end -->\n","operationId":"alertEvidenceAssess","tags":["Alert"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-11T10:43:09.536Z).\n","latencyDistribution":{"median":510.93,"p90":1862.71,"p95":2974.34,"p98":3801.81,"p99":4275.14,"sampleSize":37}},"parameters":[{"name":"alert_id","in":"path","required":true,"schema":{"type":"number"}},{"name":"evidence_id","in":"path","required":true,"schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["assessmentCodes"],"properties":{"assessmentCodes":{"type":"array","items":{"type":"number"},"example":[10001]},"comment":{"type":"string"}}},"example":{"assessmentCodes":[10001],"comment":"string"}}}},"responses":{"200":{"description":"Returns the assessed evidence item and activity entry\n","content":{"application\/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"number","description":"evidence ID","example":161325},"matchScore":{"type":"number","description":"the confidence that the match between the assessed entity and the one found in the evidence piece is correct","example":0.7002781604436024},"totalRisk":{"type":"number","description":"the sum of all risk for the evidence. each match reason contributes to the total risk.","example":100},"matchDate":{"type":"number","description":"the unix timestamp when the evidence was created","example":1603295488656},"isGroupMaster":{"type":"boolean","description":"indicates whether the evidence item is the master version","example":true},"tags":{"type":"array","description":"Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and\u2014when custom categories apply\u2014entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property.\n","items":{"type":"string"},"example":["policy-20037","risk-Financial Crime","userTag-Fin Crime-active"]},"riskTags":{"type":"array","description":"Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags).\n","items":{"type":"string"},"example":["PEP-active","cc42-active"]}}}],"properties":{"type":{"type":"string","description":"the type of evidence","enum":["risk","list"],"example":"risk"}}},"example":{"id":562306,"type":"list","title":null,"publisher":null,"name":"John Doe","lists":[{"name":"Lower Threshold","active":true,"id":"dj:minor:81","listActive":true,"hierarchy":[{"name":"Special Interest Person (SIP)","id":"dj:major:SIP"},{"parent":"dj:major:SIP","name":"Organised Crime","id":"dj:mid:7"},{"parent":"dj:mid:7","name":"Lower Threshold","id":"dj:minor:81"}],"tags":["category"]}],"publicationDate":1680048000000,"matchScore":0.9048489263065257,"totalRisk":100,"matchDate":1713948492066,"assessment":{"codes":[10001],"timestamp":1713952064427,"truePositive":true,"user":{"id":10040}},"isGroupMaster":true,"tags":["dj:major:SIP","policy-10054"],"riskTags":["SIP-active"]}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden (e.g. the user does not have the EvidenceAssess permission)"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"\/alert\/export\/jsonl":{"post":{"summary":"Export alerts","description":"Request to export alerts in the system as JSON-L format.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes, and a global concurrent request limit of 5 simultaneous requests per customer.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 90 ms |\n| 90th percentile | 460 ms |\n| 95th percentile | 561 ms |\n| 98th percentile | 651 ms |\n| 99th percentile | 755 ms |\n<!-- operational-characteristics:end -->\n\nEach alert includes `riskTags` (including custom category stamps such as `cc42-active`) and `tags`\n(including `userTag-{pillLabel}-active|inactive` entries derived from those stamps when custom\ncategories are enabled). No separate `customCategories` property is returned.\n\nPlease note, at scale some queries to this endpoint may slowdown. Please test your particular access pattern at the scale you are running at.\n","operationId":"alertExport","tags":["Alert Export"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":89.07,"p90":459.66,"p95":560.44,"p98":650.23,"p99":754.4,"sampleSize":196722846}},"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["alertFilter"],"properties":{"alertFilter":{"allOf":[{"type":"object","required":["filters"],"properties":{"filters":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"tags":{"oneOf":[{"type":"array","items":{"type":"string"},"example":["policy-10127"]},{"type":"string","example":"policy-10127"}]},"previousAssignees":{"type":"object","properties":{"includes":{"type":"array","items":{"type":"number"},"example":[10034]},"excludes":{"type":"array","items":{"type":"number"},"example":[10034]}}},"id":{"oneOf":[{"type":"array","items":{"type":"number"},"example":[10001]},{"type":"number","example":10001}]},"type":{"oneOf":[{"type":"array","items":{"type":"number"},"example":[10127]},{"type":"number","example":10127}]},"state":{"oneOf":[{"type":"array","items":{"type":"integer"},"example":[10127]},{"type":"integer","example":10127}]},"score":{"type":"object","properties":{"gte":{"type":"number","example":0},"lte":{"type":"number","example":120},"gt":{"type":"number","example":40},"lt":{"type":"number","example":100}}},"docCount":{"type":"object","properties":{"gte":{"type":"number","example":0},"lte":{"type":"number","example":120},"gt":{"type":"number","example":40},"lt":{"type":"number","example":100}}},"currentStatus.status":{"type":"object","properties":{"gte":{"type":"number","example":10},"lte":{"type":"number","example":2000},"gt":{"type":"number","example":1},"lt":{"type":"number","example":100}}},"time.created":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590973346512},"gt":{"type":"number","example":1590973346512},"lt":{"type":"number","example":1590973346512}}},"time.lastEvidence":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590973346512},"gt":{"type":"number","example":1590973346512},"lt":{"type":"number","example":1590973346512}}},"time.lastUpdated":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590973346512},"gt":{"type":"number","example":1590973346512},"lt":{"type":"number","example":1590973346512}},"target":{"description":"The IDs of the client of clients to fetch alerts for. Note that the client IDs must have the prefix \"eoi:\"","oneOf":[{"type":"array","items":{"type":"string"},"example":["eoi:<client id>"]},{"type":"string","example":"eoi:<client id>"}]}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters","type":"object","required":["filters"],"properties":{"filters":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"tags":{"oneOf":[{"type":"array","items":{"type":"string"},"example":["policy-10127"]},{"type":"string","example":"policy-10127"}]},"previousAssignees":{"type":"object","properties":{"includes":{"type":"array","items":{"type":"number"},"example":[10034]},"excludes":{"type":"array","items":{"type":"number"},"example":[10034]}}},"id":{"oneOf":[{"type":"array","items":{"type":"number"},"example":[10001]},{"type":"number","example":10001}]},"type":{"oneOf":[{"type":"array","items":{"type":"number"},"example":[10127]},{"type":"number","example":10127}]},"state":{"oneOf":[{"type":"array","items":{"type":"integer"},"example":[10127]},{"type":"integer","example":10127}]},"score":{"type":"object","properties":{"gte":{"type":"number","example":0},"lte":{"type":"number","example":120},"gt":{"type":"number","example":40},"lt":{"type":"number","example":100}}},"docCount":{"type":"object","properties":{"gte":{"type":"number","example":0},"lte":{"type":"number","example":120},"gt":{"type":"number","example":40},"lt":{"type":"number","example":100}}},"currentStatus.status":{"type":"object","properties":{"gte":{"type":"number","example":10},"lte":{"type":"number","example":2000},"gt":{"type":"number","example":1},"lt":{"type":"number","example":100}}},"time.created":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590973346512},"gt":{"type":"number","example":1590973346512},"lt":{"type":"number","example":1590973346512}}},"time.lastEvidence":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590973346512},"gt":{"type":"number","example":1590973346512},"lt":{"type":"number","example":1590973346512}}},"time.lastUpdated":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590973346512},"gt":{"type":"number","example":1590973346512},"lt":{"type":"number","example":1590973346512}},"target":{"description":"The IDs of the client of clients to fetch alerts for. Note that the client IDs must have the prefix \"eoi:\"","oneOf":[{"type":"array","items":{"type":"string"},"example":["eoi:<client id>"]},{"type":"string","example":"eoi:<client id>"}]}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters"}}}]}}}}}}]}}}},{"type":"object","properties":{"skip":{"type":"integer","default":0,"description":"The number of records to skip."},"limit":{"type":"integer","default":100,"description":"The number of records to return. Setting this to zero (0) returns all records."},"sort":{"type":"string","example":"time.created:-1","enum":["id:-1","id:1","time.created:-1","time.created:1","time.lastEvidence:-1","time.lastEvidence:1","time.lastUpdated:-1","time.lastUpdated:1","currentStatus.status:-1","currentStatus.status:1","target:-1","target:1","state:-1","state:1","score:-1","score:1","docCount:1","docCount:-1"]},"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]}}}]},"projections":{"type":"object","description":"set of fields to return","example":{"client":{"clientId":true,"name":true,"entityType":true}},"properties":{"client":{"type":"object","description":"An object defining the client fields that should be returned in the response.  The object should consist of properties whose names match the client field to be included, and whose value should been the boolean flag `true`. Consult the client import schema for details.\n","links":{"clientImport":{"operationId":"clientBulkImport"}},"properties":{"clientFieldName":{"type":"boolean","description":"Replace clientFieldName with the name of the client field to be returned, for example `name`"}}}}}},"components":{"schemas":{"AlertFilter":{"allOf":[{"type":"object","required":["filters"],"properties":{"filters":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"tags":{"oneOf":[{"type":"array","items":{"type":"string"},"example":["policy-10127"]},{"type":"string","example":"policy-10127"}]},"previousAssignees":{"type":"object","properties":{"includes":{"type":"array","items":{"type":"number"},"example":[10034]},"excludes":{"type":"array","items":{"type":"number"},"example":[10034]}}},"id":{"oneOf":[{"type":"array","items":{"type":"number"},"example":[10001]},{"type":"number","example":10001}]},"type":{"oneOf":[{"type":"array","items":{"type":"number"},"example":[10127]},{"type":"number","example":10127}]},"state":{"oneOf":[{"type":"array","items":{"type":"integer"},"example":[10127]},{"type":"integer","example":10127}]},"score":{"type":"object","properties":{"gte":{"type":"number","example":0},"lte":{"type":"number","example":120},"gt":{"type":"number","example":40},"lt":{"type":"number","example":100}}},"docCount":{"type":"object","properties":{"gte":{"type":"number","example":0},"lte":{"type":"number","example":120},"gt":{"type":"number","example":40},"lt":{"type":"number","example":100}}},"currentStatus.status":{"type":"object","properties":{"gte":{"type":"number","example":10},"lte":{"type":"number","example":2000},"gt":{"type":"number","example":1},"lt":{"type":"number","example":100}}},"time.created":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590973346512},"gt":{"type":"number","example":1590973346512},"lt":{"type":"number","example":1590973346512}}},"time.lastEvidence":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590973346512},"gt":{"type":"number","example":1590973346512},"lt":{"type":"number","example":1590973346512}}},"time.lastUpdated":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590973346512},"gt":{"type":"number","example":1590973346512},"lt":{"type":"number","example":1590973346512}},"target":{"description":"The IDs of the client of clients to fetch alerts for. Note that the client IDs must have the prefix \"eoi:\"","oneOf":[{"type":"array","items":{"type":"string"},"example":["eoi:<client id>"]},{"type":"string","example":"eoi:<client id>"}]}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters","type":"object","required":["filters"],"properties":{"filters":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"tags":{"oneOf":[{"type":"array","items":{"type":"string"},"example":["policy-10127"]},{"type":"string","example":"policy-10127"}]},"previousAssignees":{"type":"object","properties":{"includes":{"type":"array","items":{"type":"number"},"example":[10034]},"excludes":{"type":"array","items":{"type":"number"},"example":[10034]}}},"id":{"oneOf":[{"type":"array","items":{"type":"number"},"example":[10001]},{"type":"number","example":10001}]},"type":{"oneOf":[{"type":"array","items":{"type":"number"},"example":[10127]},{"type":"number","example":10127}]},"state":{"oneOf":[{"type":"array","items":{"type":"integer"},"example":[10127]},{"type":"integer","example":10127}]},"score":{"type":"object","properties":{"gte":{"type":"number","example":0},"lte":{"type":"number","example":120},"gt":{"type":"number","example":40},"lt":{"type":"number","example":100}}},"docCount":{"type":"object","properties":{"gte":{"type":"number","example":0},"lte":{"type":"number","example":120},"gt":{"type":"number","example":40},"lt":{"type":"number","example":100}}},"currentStatus.status":{"type":"object","properties":{"gte":{"type":"number","example":10},"lte":{"type":"number","example":2000},"gt":{"type":"number","example":1},"lt":{"type":"number","example":100}}},"time.created":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590973346512},"gt":{"type":"number","example":1590973346512},"lt":{"type":"number","example":1590973346512}}},"time.lastEvidence":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590973346512},"gt":{"type":"number","example":1590973346512},"lt":{"type":"number","example":1590973346512}}},"time.lastUpdated":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590973346512},"gt":{"type":"number","example":1590973346512},"lt":{"type":"number","example":1590973346512}},"target":{"description":"The IDs of the client of clients to fetch alerts for. Note that the client IDs must have the prefix \"eoi:\"","oneOf":[{"type":"array","items":{"type":"string"},"example":["eoi:<client id>"]},{"type":"string","example":"eoi:<client id>"}]}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters"}}}]}}}}}}]}}}},{"type":"object","properties":{"skip":{"type":"integer","default":0,"description":"The number of records to skip."},"limit":{"type":"integer","default":100,"description":"The number of records to return. Setting this to zero (0) returns all records."},"sort":{"type":"string","example":"time.created:-1","enum":["id:-1","id:1","time.created:-1","time.created:1","time.lastEvidence:-1","time.lastEvidence:1","time.lastUpdated:-1","time.lastUpdated:1","currentStatus.status:-1","currentStatus.status:1","target:-1","target:1","state:-1","state:1","score:-1","score:1","docCount:1","docCount:-1"]},"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]}}}]},"Filters":{"type":"object","required":["filters"],"properties":{"filters":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"tags":{"oneOf":[{"type":"array","items":{"type":"string"},"example":["policy-10127"]},{"type":"string","example":"policy-10127"}]},"previousAssignees":{"type":"object","properties":{"includes":{"type":"array","items":{"type":"number"},"example":[10034]},"excludes":{"type":"array","items":{"type":"number"},"example":[10034]}}},"id":{"oneOf":[{"type":"array","items":{"type":"number"},"example":[10001]},{"type":"number","example":10001}]},"type":{"oneOf":[{"type":"array","items":{"type":"number"},"example":[10127]},{"type":"number","example":10127}]},"state":{"oneOf":[{"type":"array","items":{"type":"integer"},"example":[10127]},{"type":"integer","example":10127}]},"score":{"type":"object","properties":{"gte":{"type":"number","example":0},"lte":{"type":"number","example":120},"gt":{"type":"number","example":40},"lt":{"type":"number","example":100}}},"docCount":{"type":"object","properties":{"gte":{"type":"number","example":0},"lte":{"type":"number","example":120},"gt":{"type":"number","example":40},"lt":{"type":"number","example":100}}},"currentStatus.status":{"type":"object","properties":{"gte":{"type":"number","example":10},"lte":{"type":"number","example":2000},"gt":{"type":"number","example":1},"lt":{"type":"number","example":100}}},"time.created":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590973346512},"gt":{"type":"number","example":1590973346512},"lt":{"type":"number","example":1590973346512}}},"time.lastEvidence":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590973346512},"gt":{"type":"number","example":1590973346512},"lt":{"type":"number","example":1590973346512}}},"time.lastUpdated":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590973346512},"gt":{"type":"number","example":1590973346512},"lt":{"type":"number","example":1590973346512}},"target":{"description":"The IDs of the client of clients to fetch alerts for. Note that the client IDs must have the prefix \"eoi:\"","oneOf":[{"type":"array","items":{"type":"string"},"example":["eoi:<client id>"]},{"type":"string","example":"eoi:<client id>"}]}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters","type":"object","required":["filters"],"properties":{"filters":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"tags":{"oneOf":[{"type":"array","items":{"type":"string"},"example":["policy-10127"]},{"type":"string","example":"policy-10127"}]},"previousAssignees":{"type":"object","properties":{"includes":{"type":"array","items":{"type":"number"},"example":[10034]},"excludes":{"type":"array","items":{"type":"number"},"example":[10034]}}},"id":{"oneOf":[{"type":"array","items":{"type":"number"},"example":[10001]},{"type":"number","example":10001}]},"type":{"oneOf":[{"type":"array","items":{"type":"number"},"example":[10127]},{"type":"number","example":10127}]},"state":{"oneOf":[{"type":"array","items":{"type":"integer"},"example":[10127]},{"type":"integer","example":10127}]},"score":{"type":"object","properties":{"gte":{"type":"number","example":0},"lte":{"type":"number","example":120},"gt":{"type":"number","example":40},"lt":{"type":"number","example":100}}},"docCount":{"type":"object","properties":{"gte":{"type":"number","example":0},"lte":{"type":"number","example":120},"gt":{"type":"number","example":40},"lt":{"type":"number","example":100}}},"currentStatus.status":{"type":"object","properties":{"gte":{"type":"number","example":10},"lte":{"type":"number","example":2000},"gt":{"type":"number","example":1},"lt":{"type":"number","example":100}}},"time.created":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590973346512},"gt":{"type":"number","example":1590973346512},"lt":{"type":"number","example":1590973346512}}},"time.lastEvidence":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590973346512},"gt":{"type":"number","example":1590973346512},"lt":{"type":"number","example":1590973346512}}},"time.lastUpdated":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590973346512},"gt":{"type":"number","example":1590973346512},"lt":{"type":"number","example":1590973346512}},"target":{"description":"The IDs of the client of clients to fetch alerts for. Note that the client IDs must have the prefix \"eoi:\"","oneOf":[{"type":"array","items":{"type":"string"},"example":["eoi:<client id>"]},{"type":"string","example":"eoi:<client id>"}]}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters"}}}]}}}}}}]}}}},"NestedFilters":{"type":"object","required":["filters"],"properties":{"filters":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"tags":{"oneOf":[{"type":"array","items":{"type":"string"},"example":["policy-10127"]},{"type":"string","example":"policy-10127"}]},"previousAssignees":{"type":"object","properties":{"includes":{"type":"array","items":{"type":"number"},"example":[10034]},"excludes":{"type":"array","items":{"type":"number"},"example":[10034]}}},"id":{"oneOf":[{"type":"array","items":{"type":"number"},"example":[10001]},{"type":"number","example":10001}]},"type":{"oneOf":[{"type":"array","items":{"type":"number"},"example":[10127]},{"type":"number","example":10127}]},"state":{"oneOf":[{"type":"array","items":{"type":"integer"},"example":[10127]},{"type":"integer","example":10127}]},"score":{"type":"object","properties":{"gte":{"type":"number","example":0},"lte":{"type":"number","example":120},"gt":{"type":"number","example":40},"lt":{"type":"number","example":100}}},"docCount":{"type":"object","properties":{"gte":{"type":"number","example":0},"lte":{"type":"number","example":120},"gt":{"type":"number","example":40},"lt":{"type":"number","example":100}}},"currentStatus.status":{"type":"object","properties":{"gte":{"type":"number","example":10},"lte":{"type":"number","example":2000},"gt":{"type":"number","example":1},"lt":{"type":"number","example":100}}},"time.created":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590973346512},"gt":{"type":"number","example":1590973346512},"lt":{"type":"number","example":1590973346512}}},"time.lastEvidence":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590973346512},"gt":{"type":"number","example":1590973346512},"lt":{"type":"number","example":1590973346512}}},"time.lastUpdated":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590973346512},"gt":{"type":"number","example":1590973346512},"lt":{"type":"number","example":1590973346512}},"target":{"description":"The IDs of the client of clients to fetch alerts for. Note that the client IDs must have the prefix \"eoi:\"","oneOf":[{"type":"array","items":{"type":"string"},"example":["eoi:<client id>"]},{"type":"string","example":"eoi:<client id>"}]}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters"}}}]}}}},"FilterKeyValues":{"type":"object","properties":{"tags":{"oneOf":[{"type":"array","items":{"type":"string"},"example":["policy-10127"]},{"type":"string","example":"policy-10127"}]},"previousAssignees":{"type":"object","properties":{"includes":{"type":"array","items":{"type":"number"},"example":[10034]},"excludes":{"type":"array","items":{"type":"number"},"example":[10034]}}},"id":{"oneOf":[{"type":"array","items":{"type":"number"},"example":[10001]},{"type":"number","example":10001}]},"type":{"oneOf":[{"type":"array","items":{"type":"number"},"example":[10127]},{"type":"number","example":10127}]},"state":{"oneOf":[{"type":"array","items":{"type":"integer"},"example":[10127]},{"type":"integer","example":10127}]},"score":{"type":"object","properties":{"gte":{"type":"number","example":0},"lte":{"type":"number","example":120},"gt":{"type":"number","example":40},"lt":{"type":"number","example":100}}},"docCount":{"type":"object","properties":{"gte":{"type":"number","example":0},"lte":{"type":"number","example":120},"gt":{"type":"number","example":40},"lt":{"type":"number","example":100}}},"currentStatus.status":{"type":"object","properties":{"gte":{"type":"number","example":10},"lte":{"type":"number","example":2000},"gt":{"type":"number","example":1},"lt":{"type":"number","example":100}}},"time.created":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590973346512},"gt":{"type":"number","example":1590973346512},"lt":{"type":"number","example":1590973346512}}},"time.lastEvidence":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590973346512},"gt":{"type":"number","example":1590973346512},"lt":{"type":"number","example":1590973346512}}},"time.lastUpdated":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590973346512},"gt":{"type":"number","example":1590973346512},"lt":{"type":"number","example":1590973346512}},"target":{"description":"The IDs of the client of clients to fetch alerts for. Note that the client IDs must have the prefix \"eoi:\"","oneOf":[{"type":"array","items":{"type":"string"},"example":["eoi:<client id>"]},{"type":"string","example":"eoi:<client id>"}]}}}},"Projections":{"type":"object","description":"set of fields to return","example":{"client":{"clientId":true,"name":true,"entityType":true}},"properties":{"client":{"type":"object","description":"An object defining the client fields that should be returned in the response.  The object should consist of properties whose names match the client field to be included, and whose value should been the boolean flag `true`. Consult the client import schema for details.\n","links":{"clientImport":{"operationId":"clientBulkImport"}},"properties":{"clientFieldName":{"type":"boolean","description":"Replace clientFieldName with the name of the client field to be returned, for example `name`"}}}}}}}}}}},"responses":{"200":{"description":"Alert activities returned in JSON-L format","content":{"application\/json":{"schema":{"oneOf":[{"type":"object","description":"Line-delimited JSON alert objects","properties":{"history":{"type":"array","description":"The assignment history of the alert","items":{"type":"object","properties":{"assignedUsers":{"type":"array","description":"IDs of users assigned to the result, returned when results enrichment is disabled","items":{"type":"number"},"example":[1]},"timestamp":{"type":"integer","description":"The timestamp for when the alert was assigned"},"state":{"type":"integer","description":"The state code"},"status":{"type":"integer","description":"The status code"}}}},"assignedUsers":{"type":"array","description":"IDs of users assigned to the result, returned when results enrichment is disabled","items":{"type":"number"},"example":[1]},"assignedGroups":{"type":"array","description":"list of group ids the alert has been assigned to, where appropriate.","items":{"type":"number","example":10}},"tags":{"type":"array","description":"Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and\u2014when custom categories apply\u2014entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property.\n","items":{"type":"string"},"example":["policy-20037","risk-Financial Crime","userTag-Fin Crime-active"]},"riskTags":{"type":"array","description":"Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags).\n","items":{"type":"string"},"example":["PEP-active","cc42-active"]},"listEntityIds":{"type":"array","description":"a list of the IDs of the list entities or risk profiles that have generated evidence within the alert","items":{"type":"string","description":"the ID of the list entity or risk profile, including the namespace prefix","example":"listEntity:internal:test:test:arb-list-test-1"}},"state":{"type":"string","description":"Current state of the alert","example":"OPENED","enum":["MONITORING","OPENED","CLOSED","REOPENED","OPENED_FIXED_PERIOD"]},"score":{"type":"integer","description":"Score of the alert, based on the evidence accrued","example":100},"sortKey":{"type":"integer","description":"Internal field"},"docCount":{"type":"integer","description":"The total number of evidence items in the alert"},"currentStatus":{"type":"object","description":"records details of the alerts status (versus state)","properties":{"status":{"type":"object","description":"The current alert status","properties":{"statusCode":{"type":"integer","description":"The status code"},"label":{"type":"string","description":"The status code name \/ label"}},"example":{"statusCode":100,"label":"Awaiting Allocation"}},"reason":{"type":"object","description":"Closure reason details (if closed)","properties":{"code":{"type":"integer","description":"Closure code"},"withAction":{"type":"boolean","description":"Flag indicating if the alert was closed with further withAction"},"value":{"type":"string","description":"String representation of closure code"},"isTrueHit":{"type":"boolean","description":"Flag representing if this closure reason indicates risk"},"isNoHit":{"type":"boolean","description":"Flag representing if this closure reason indicates no risk"}},"example":{"code":3,"withAction":false,"value":"Duplicate of a previous alert","isTrueHit":true,"isNoHit":false}},"consequence":{"type":"object","description":"Closure consequence details (if closed)","properties":{"code":{"type":"integer","description":"Consequence code"},"value":{"type":"string","description":"String representation of consequence code"},"level":{"type":"string","description":"Severity of the consequence code"}},"example":{"code":0,"value":"Client Communication","level":"Minor"}},"timestamp":{"type":"integer","description":"timestamp of the last status change","example":1590989346512}}},"time":{"type":"object","description":"set of relevant timestamps for the alert","properties":{"created":{"description":"when the alert was created as an epoch timestamp in milliseconds","type":"integer"},"lastUpdated":{"description":"when the alert last received updated information as an epoch timestamp in milliseconds","type":"integer"},"breached":{"description":"when the alert transitioned from monitoring to opened as an epoch timestamp in milliseconds","type":"integer"},"lastEvidence":{"description":"when the last piece of evidence was added to the alert as an epoch timestamp in milliseconds","type":"integer"}}},"namespace":{"type":"string","description":"Internal field"},"target":{"type":"string","description":"The target object (client) that encapsulates the activity","example":"eoi:10001"},"security":{"type":"object","description":"The alert's security object","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"description":{"type":"string","description":"A brief description of the alert","example":"torch"},"clientKey":{"type":"string","description":"Internal field"},"mode":{"type":"string","description":"The client key the activity is owned by","example":"lowercasekey"},"id":{"type":"integer","description":"The id of the alert","example":10001},"threshold":{"type":"integer","description":"The value of the threshold to breach an alert when this alert breached","example":100},"lastActivity":{"description":"The timestamp of the last activity on the alert","type":"integer"},"client":{"type":"object","description":"details of the alert's associated client, conforming to the client schema from the client import API and filtered according to the projection clause of the request.","discriminator":{"propertyName":"entityType","mapping":{"PERSON":".\/PersonClient.yaml","ORGANISATION":".\/OrganisationClient.yaml","VESSEL":".\/VesselClient.yaml","AIRCRAFT":".\/AircraftClient.yaml"}},"anyOf":[{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"description":"Entity specifier for a person. Must provide at least one of the following:\n\n  * name (recommended)\n  * firstName and surname (with optional middleName)\n\nIf all three are provided, the system will use \"name\". Our recommendation is\nfor you to provide a single, whole, name string which we will then analyse.\n\n**Note**: Name structure is a cultural artefact. We strongly recommend using\nthe full name field as we handle many cross-cultural aspects. If you do wish\nto separate out the name then we consider \"firstName\" to be the given name of\nan individual, and \"surname\" to be a \"family\" name.\n","properties":{"entityType":{"const":"PERSON"},"gender":{"type":"string"},"titles":{"type":"array","items":{"type":"string"}},"surname":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"suffixes":{"type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"titles":{"type":"array","items":{"type":"string"}},"surname":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"suffixes":{"type":"array","items":{"type":"string"}},"nameType":{"type":"string"}}}},"dateOfBirth":{"oneOf":[{"type":"string"},{"type":"integer"}]},"birthPlaceCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"deceasedOn":{"oneOf":[{"type":"string"},{"type":"integer"}]},"nationalityCodes":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"domicileCodes":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"occupation":{"type":"string"}}},{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"properties":{"entityType":{"const":"ORGANISATION"},"companyName":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"aliases":{"type":"array","items":{"type":"object","properties":{"companyName":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"nameType":{"type":"string"}}}},"dateOfIncorporation":{"oneOf":[{"type":"string"},{"type":"integer"}]},"incorporationCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"required":["companyName"]},{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"description":"An entity specifier for a maritime vessel. Must provide AT LEAST ONE of:\nname, aliases, vesselCallSigns or vesselImoNumber\n","required":["vesselName"],"properties":{"entityType":{"const":"VESSEL"},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"nameType":{"type":"string"}}}},"vesselName":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"vesselCallSigns":{"type":"array","items":{"type":"string"}},"vesselTypes":{"type":"array","items":{"type":"string"}},"vesselTonnages":{"type":"array","items":{"type":"number"}},"vesselOwners":{"type":"array","items":{"type":"string"}},"vesselCustomers":{"type":"array","items":{"type":"string"}},"vesselGrts":{"type":"array","items":{"type":"number"}},"vesselFlags":{"type":"array","items":{"type":"string"}},"vesselFlagsCode":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"vesselImoNumber":{"type":"string"},"countryOfRegistrationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}}},{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"properties":{"entityType":{"const":"AIRCRAFT"},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"nameType":{"type":"string"}}}},"aircraftManufactureDate":{"oneOf":[{"type":"string"},{"type":"integer"}]},"aircraftModel":{"type":"string"},"aircraftName":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"aircraftOperator":{"type":"string"},"countryOfAffiliationCode":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}}}}]}}},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}]}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthenticated request"},"403":{"description":"The authenticated user is not permitted to export alert activities"},"500":{"description":"An unexpected error occurred when exporting alert activities","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/alert\/activity\/export\/jsonl":{"post":{"summary":"Export alert activities","description":"Request to export alert activities in the system as JSON-L format\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes, and a global concurrent request limit of 5 simultaneous requests per customer.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 21 ms |\n| 90th percentile | 24 ms |\n| 95th percentile | 26 ms |\n| 98th percentile | 28 ms |\n| 99th percentile | 33 ms |\n<!-- operational-characteristics:end -->\n\nPlease note, at scale some queries to this endpoint may slowdown. Please test your particular access pattern at the scale you are running at.\n","operationId":"alertExportActivity","tags":["Alert Export"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":20.46,"p90":23.9,"p95":25.16,"p98":27.88,"p99":32.5,"sampleSize":74466}},"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["activityFilter"],"properties":{"activityFilter":{"oneOf":[{"type":"object","required":["filters"],"properties":{"filters":{"type":"array","items":{"oneOf":[{"type":"object","allOf":[{"not":{"required":["createdBy","createdByExternalIds"]}}],"properties":{"alertIds":{"type":"array","items":{"type":"number","example":10001}},"activityTypes":{"type":"array","items":{"type":"string","example":"alertOpened","enum":["alertOpened","alertReopened","alertClosed","newEvidence","alertAssigned","alertViewed","alertStatusChanged","commentCreated","commentDeleted","commentEdited","evidenceAssessed","evidenceBulkAssessed"]}},"activityDate":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590989346512},"gt":{"type":"number","example":1590989346512},"lt":{"type":"number","example":1590989346512}}},"createdBy":{"description":"Internal IDs of users who performed the activity. Cannot be used in conjunction with createdByExternalIds.","type":"array","items":{"type":"number","example":990}},"createdByExternalIds":{"description":"External IDs of users who performed the activity. Cannot be used in conjunction with createdBy.","type":"array","items":{"type":"string","example":"john.smith@ripjar.com"}},"activityIds":{"type":"array","items":{"type":"number","example":12}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters","type":"object","required":["filters"],"properties":{"filters":{"type":"array","items":{"oneOf":[{"type":"object","allOf":[{"not":{"required":["createdBy","createdByExternalIds"]}}],"properties":{"alertIds":{"type":"array","items":{"type":"number","example":10001}},"activityTypes":{"type":"array","items":{"type":"string","example":"alertOpened","enum":["alertOpened","alertReopened","alertClosed","newEvidence","alertAssigned","alertViewed","alertStatusChanged","commentCreated","commentDeleted","commentEdited","evidenceAssessed","evidenceBulkAssessed"]}},"activityDate":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590989346512},"gt":{"type":"number","example":1590989346512},"lt":{"type":"number","example":1590989346512}}},"createdBy":{"description":"Internal IDs of users who performed the activity. Cannot be used in conjunction with createdByExternalIds.","type":"array","items":{"type":"number","example":990}},"createdByExternalIds":{"description":"External IDs of users who performed the activity. Cannot be used in conjunction with createdBy.","type":"array","items":{"type":"string","example":"john.smith@ripjar.com"}},"activityIds":{"type":"array","items":{"type":"number","example":12}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters"}}}]}}}}}}]}}}},{"type":"object","properties":{"skip":{"type":"integer","default":0,"description":"The number of records to skip."},"limit":{"type":"integer","default":100,"description":"The number of records to return. Setting this to zero (0) returns all records."},"sort":{"type":"string","example":"createdAt:-1","enum":["createdAt:-1","createdAt:1"]}}}]}},"components":{"schemas":{"ActivityFilter":{"oneOf":[{"type":"object","required":["filters"],"properties":{"filters":{"type":"array","items":{"oneOf":[{"type":"object","allOf":[{"not":{"required":["createdBy","createdByExternalIds"]}}],"properties":{"alertIds":{"type":"array","items":{"type":"number","example":10001}},"activityTypes":{"type":"array","items":{"type":"string","example":"alertOpened","enum":["alertOpened","alertReopened","alertClosed","newEvidence","alertAssigned","alertViewed","alertStatusChanged","commentCreated","commentDeleted","commentEdited","evidenceAssessed","evidenceBulkAssessed"]}},"activityDate":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590989346512},"gt":{"type":"number","example":1590989346512},"lt":{"type":"number","example":1590989346512}}},"createdBy":{"description":"Internal IDs of users who performed the activity. Cannot be used in conjunction with createdByExternalIds.","type":"array","items":{"type":"number","example":990}},"createdByExternalIds":{"description":"External IDs of users who performed the activity. Cannot be used in conjunction with createdBy.","type":"array","items":{"type":"string","example":"john.smith@ripjar.com"}},"activityIds":{"type":"array","items":{"type":"number","example":12}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters","type":"object","required":["filters"],"properties":{"filters":{"type":"array","items":{"oneOf":[{"type":"object","allOf":[{"not":{"required":["createdBy","createdByExternalIds"]}}],"properties":{"alertIds":{"type":"array","items":{"type":"number","example":10001}},"activityTypes":{"type":"array","items":{"type":"string","example":"alertOpened","enum":["alertOpened","alertReopened","alertClosed","newEvidence","alertAssigned","alertViewed","alertStatusChanged","commentCreated","commentDeleted","commentEdited","evidenceAssessed","evidenceBulkAssessed"]}},"activityDate":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590989346512},"gt":{"type":"number","example":1590989346512},"lt":{"type":"number","example":1590989346512}}},"createdBy":{"description":"Internal IDs of users who performed the activity. Cannot be used in conjunction with createdByExternalIds.","type":"array","items":{"type":"number","example":990}},"createdByExternalIds":{"description":"External IDs of users who performed the activity. Cannot be used in conjunction with createdBy.","type":"array","items":{"type":"string","example":"john.smith@ripjar.com"}},"activityIds":{"type":"array","items":{"type":"number","example":12}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters"}}}]}}}}}}]}}}},{"type":"object","properties":{"skip":{"type":"integer","default":0,"description":"The number of records to skip."},"limit":{"type":"integer","default":100,"description":"The number of records to return. Setting this to zero (0) returns all records."},"sort":{"type":"string","example":"createdAt:-1","enum":["createdAt:-1","createdAt:1"]}}}]},"Filters":{"type":"object","required":["filters"],"properties":{"filters":{"type":"array","items":{"oneOf":[{"type":"object","allOf":[{"not":{"required":["createdBy","createdByExternalIds"]}}],"properties":{"alertIds":{"type":"array","items":{"type":"number","example":10001}},"activityTypes":{"type":"array","items":{"type":"string","example":"alertOpened","enum":["alertOpened","alertReopened","alertClosed","newEvidence","alertAssigned","alertViewed","alertStatusChanged","commentCreated","commentDeleted","commentEdited","evidenceAssessed","evidenceBulkAssessed"]}},"activityDate":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590989346512},"gt":{"type":"number","example":1590989346512},"lt":{"type":"number","example":1590989346512}}},"createdBy":{"description":"Internal IDs of users who performed the activity. Cannot be used in conjunction with createdByExternalIds.","type":"array","items":{"type":"number","example":990}},"createdByExternalIds":{"description":"External IDs of users who performed the activity. Cannot be used in conjunction with createdBy.","type":"array","items":{"type":"string","example":"john.smith@ripjar.com"}},"activityIds":{"type":"array","items":{"type":"number","example":12}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters","type":"object","required":["filters"],"properties":{"filters":{"type":"array","items":{"oneOf":[{"type":"object","allOf":[{"not":{"required":["createdBy","createdByExternalIds"]}}],"properties":{"alertIds":{"type":"array","items":{"type":"number","example":10001}},"activityTypes":{"type":"array","items":{"type":"string","example":"alertOpened","enum":["alertOpened","alertReopened","alertClosed","newEvidence","alertAssigned","alertViewed","alertStatusChanged","commentCreated","commentDeleted","commentEdited","evidenceAssessed","evidenceBulkAssessed"]}},"activityDate":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590989346512},"gt":{"type":"number","example":1590989346512},"lt":{"type":"number","example":1590989346512}}},"createdBy":{"description":"Internal IDs of users who performed the activity. Cannot be used in conjunction with createdByExternalIds.","type":"array","items":{"type":"number","example":990}},"createdByExternalIds":{"description":"External IDs of users who performed the activity. Cannot be used in conjunction with createdBy.","type":"array","items":{"type":"string","example":"john.smith@ripjar.com"}},"activityIds":{"type":"array","items":{"type":"number","example":12}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters"}}}]}}}}}}]}}}},"NestedFilters":{"type":"object","required":["filters"],"properties":{"filters":{"type":"array","items":{"oneOf":[{"type":"object","allOf":[{"not":{"required":["createdBy","createdByExternalIds"]}}],"properties":{"alertIds":{"type":"array","items":{"type":"number","example":10001}},"activityTypes":{"type":"array","items":{"type":"string","example":"alertOpened","enum":["alertOpened","alertReopened","alertClosed","newEvidence","alertAssigned","alertViewed","alertStatusChanged","commentCreated","commentDeleted","commentEdited","evidenceAssessed","evidenceBulkAssessed"]}},"activityDate":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590989346512},"gt":{"type":"number","example":1590989346512},"lt":{"type":"number","example":1590989346512}}},"createdBy":{"description":"Internal IDs of users who performed the activity. Cannot be used in conjunction with createdByExternalIds.","type":"array","items":{"type":"number","example":990}},"createdByExternalIds":{"description":"External IDs of users who performed the activity. Cannot be used in conjunction with createdBy.","type":"array","items":{"type":"string","example":"john.smith@ripjar.com"}},"activityIds":{"type":"array","items":{"type":"number","example":12}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters"}}}]}}}},"ActivityFilterKeyValues":{"type":"object","allOf":[{"not":{"required":["createdBy","createdByExternalIds"]}}],"properties":{"alertIds":{"type":"array","items":{"type":"number","example":10001}},"activityTypes":{"type":"array","items":{"type":"string","example":"alertOpened","enum":["alertOpened","alertReopened","alertClosed","newEvidence","alertAssigned","alertViewed","alertStatusChanged","commentCreated","commentDeleted","commentEdited","evidenceAssessed","evidenceBulkAssessed"]}},"activityDate":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590989346512},"gt":{"type":"number","example":1590989346512},"lt":{"type":"number","example":1590989346512}}},"createdBy":{"description":"Internal IDs of users who performed the activity. Cannot be used in conjunction with createdByExternalIds.","type":"array","items":{"type":"number","example":990}},"createdByExternalIds":{"description":"External IDs of users who performed the activity. Cannot be used in conjunction with createdBy.","type":"array","items":{"type":"string","example":"john.smith@ripjar.com"}},"activityIds":{"type":"array","items":{"type":"number","example":12}}}}}}},"example":{"activityFilter":{"filters":[{"activityTypes":["alertOpened"],"activityDate":{"gte":0,"lte":1590989346512}},{"operator":"OR","filters":[{"alertIds":[10001]},{"activityIds":[1]}]}],"operator":"OR","skip":0,"limit":0,"sort":"createdAt:-1"}}}}},"responses":{"200":{"description":"Alert activities returned in JSON-L format","content":{"application\/json":{"schema":{"oneOf":[{"type":"object","description":"Line-delimited JSON alert activity objects","properties":{"id":{"type":"number","description":"The activity\\'s ID","example":10001},"createdAt":{"type":"number","description":"Time the activity was created as an Epoch timestamp","example":1590668036303},"type":{"type":"string","description":"The type of the activity","example":"alertReopened","enum":["alertOpened","alertReopened","alertClosed","newEvidence","alertAssigned","alertViewed","alertStatusChanged","commentCreated","commentDeleted","commentEdited","evidenceAssessed","evidenceBulkAssessed"]},"description":{"type":"string","description":"Description of the activity","example":"Evidence added to alert 10001"},"data":{"type":"object","description":"Data relevant to the particular type of activity. This will vary depending on the type of activity that was captured."},"security":{"type":"object","description":"The activity\\'s security object","example":{}},"target":{"type":"string","description":"The target object that encapsulates the activity, prefixed with 'alert-'","example":"alert-10001"},"namespace":{"type":"string","description":"The system namespace in which the activity occurred","example":"torch"},"createdBy":{"description":"details of the user who created the activity","type":"object","properties":{"username":{"type":"string","description":"the name of the user","example":"Example user"},"email":{"type":"string","description":"the email address of the user","example":"example.user@example.com"},"roles":{"type":"array","description":"the roles assigned to the user","items":{"type":"string","example":"ANALYST"}},"id":{"type":"integer","description":"the system user ID of the user","example":10024}}},"clientKey":{"type":"string","description":"The client key the activity is owned by","example":"lowercasekey"},"context":{"type":"string","description":"the ID of the alert associated with the activity, prefixed with 'alert-'","example":"alert-186453"}}},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}]}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"401":{"description":"Unauthenticated request","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"403":{"description":"The authenticated user is not permitted to export alert activities","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"500":{"description":"An unexpected error occurred when export alert activities","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/alert\/evidence\/export\/jsonl":{"post":{"summary":"Export evidence","description":"Streaming filtered export of evidence in jsonl format.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes, and a global concurrent request limit of 5 simultaneous requests per customer.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 254 ms |\n| 90th percentile | 755 ms |\n| 95th percentile | 1.0 s |\n| 98th percentile | 1.4 s |\n| 99th percentile | 1.6 s |\n<!-- operational-characteristics:end -->\n\nEach evidence row includes `riskTags` on that row only (custom categories as `cc{id}` with optional\n`-active` \/ `-inactive`). Exported `tags` include `userTag-{pillLabel}-active|inactive` derived from\nthat row's `riskTags`, not from the parent alert.\n\nPlease note, at scale some queries to this endpoint may slowdown. Please test your particular access pattern at the scale you are running at.\n","operationId":"alertEvidenceExport","tags":["Alert Export"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":253.47,"p90":754.4,"p95":1015.36,"p98":1366.48,"p99":1585.2,"sampleSize":13124171}},"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"evidenceFilter":{"description":"nested filters","oneOf":[{"type":"object","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"alertId":{"type":"array","items":{"type":"integer"},"description":"the alert id of the evidence"},"alertType":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"assessment.codes":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"totalRisk":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to fields greater or equal to this value"},"gt":{"type":"number","description":"Match to fields greater than this value"},"lte":{"type":"number","description":"Match to fields less or equal to this value"},"lt":{"type":"number","description":"Match to fields less than this value"}}},"type":{"description":"the type of alert","enum":["list","risk"]},"createdTimestamp":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}},"assessment.timestamp":{"description":"filter the results based on the evidence assessment timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters","type":"object","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"alertId":{"type":"array","items":{"type":"integer"},"description":"the alert id of the evidence"},"alertType":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"assessment.codes":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"totalRisk":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to fields greater or equal to this value"},"gt":{"type":"number","description":"Match to fields greater than this value"},"lte":{"type":"number","description":"Match to fields less or equal to this value"},"lt":{"type":"number","description":"Match to fields less than this value"}}},"type":{"description":"the type of alert","enum":["list","risk"]},"createdTimestamp":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}},"assessment.timestamp":{"description":"filter the results based on the evidence assessment timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters"}}}]}}}}}}]}}}},{"type":"object","properties":{"skip":{"type":"integer","default":0,"description":"The number of records to skip."},"limit":{"type":"integer","default":100,"description":"The number of records to return. Setting this to zero (0) returns all records."},"sort":{"type":"string","description":"field to sort by and sort order","enum":["alertId:1","alertId:-1","createdTimestamp:1","createdTimestamp:-1","target:1","target:-1","totalRisk:1","totalRisk:-1"]}}}]},"enrich":{"type":"object","description":"Instructions to enrich specific parts to the results","properties":{"assessments":{"type":"boolean","description":"enrich results with evidence assessment details","default":false},"comments":{"type":"boolean","description":"enrich results with comment details","default":false},"matches":{"type":"boolean","description":"enrich results with identity matches details. If using on a closed assessment, this matches field will not be populated.","default":false},"lists":{"type":"boolean","description":"enrich results with list entity details","default":false}}},"projections":{"type":"object","description":"set of fields to return or not return","properties":{"assessments":{"type":"object","description":"set of evidence assessment fields to return or not return"},"evidence":{"type":"object","description":"set of evidence fields to return or not return"},"comments":{"type":"object","description":"set of comments fields to return or not return"},"lists":{"type":"object","description":"set of list entity fields to return or not return","example":{"name":true,"significantProfiles":true,"lists":true},"properties":{"activeStatus":{"type":"boolean"},"additionalNames":{"type":"boolean"},"additionalNamesAliasVariant":{"type":"boolean"},"additionalNamesArabicArabicNormalised":{"type":"boolean"},"additionalNamesDiacriticVariants":{"type":"boolean"},"additionalNamesHomophones":{"type":"boolean"},"additionalNamesLatinArabicNormalised":{"type":"boolean"},"additionalNamesLevenshteinVariants":{"type":"boolean"},"additionalNamesSubtractionVariants":{"type":"boolean"},"additionalNamesTlevVariants":{"type":"boolean"},"additionalNamesTransliterationVariants":{"type":"boolean"},"additionalNamesVariants":{"type":"boolean"},"addresses":{"type":"boolean"},"aliases":{"type":"boolean"},"ameDetails":{"type":"boolean"},"arabicArabicNormalisedName":{"type":"boolean"},"birthPlace":{"type":"boolean"},"birthPlaceCity":{"type":"boolean"},"birthPlaceCountry":{"type":"boolean"},"birthPlaceCountryCode":{"type":"boolean"},"callSignsPrefixCodes":{"type":"boolean"},"callSignsPrefixes":{"type":"boolean"},"callSignsVariants":{"type":"boolean"},"categories":{"type":"boolean"},"citizenship":{"type":"boolean"},"citizenshipCode":{"type":"boolean"},"coreName":{"type":"boolean"},"coreNameAliasVariants":{"type":"boolean"},"coreNameDiacriticVariants":{"type":"boolean"},"coreNameHomophones":{"type":"boolean"},"coreNameVariants":{"type":"boolean"},"countryOfReportedAllegation":{"type":"boolean"},"countryOfReportedAllegationCode":{"type":"boolean"},"dateOfBirthRange":{"type":"boolean"},"dateOfBirthRanges":{"type":"boolean"},"deceased":{"type":"boolean"},"deceasedDateRange":{"type":"boolean"},"deceasedDateRanges":{"type":"boolean"},"descriptions":{"type":"boolean"},"enhancedRiskCountry":{"type":"boolean"},"enhancedRiskCountryCode":{"type":"boolean"},"entityType":{"type":"boolean","default":true},"firstSeen":{"type":"boolean"},"firstSignificantSeen":{"type":"boolean"},"forename":{"type":"boolean"},"formerlySanctionedRegionCode":{"type":"boolean"},"gender":{"type":"boolean"},"hash":{"type":"boolean"},"id":{"type":"boolean","default":true},"identityNumbers":{"type":"boolean"},"imageKeys":{"type":"boolean"},"images":{"type":"boolean"},"initialisedNameVariants":{"type":"boolean"},"initialisedNames":{"type":"boolean"},"internal":{"type":"boolean"},"isSignificantProfile":{"type":"boolean"},"jurisdiction":{"type":"boolean"},"jurisdictionCode":{"type":"boolean"},"keyTerms":{"type":"boolean"},"lastModifiedDateRange":{"type":"boolean"},"lastSeen":{"type":"boolean"},"lastSignificantSeen":{"type":"boolean"},"lastSignificantUpdate":{"type":"boolean"},"latinArabicNormalisedName":{"type":"boolean"},"levSubtractionVariants":{"type":"boolean"},"levenshteinVariants":{"type":"boolean"},"listId":{"type":"boolean"},"lists":{"type":"boolean","default":true},"metadata":{"type":"boolean","default":true},"middlename":{"type":"boolean"},"name":{"type":"boolean","default":true},"nameOrigin":{"type":"boolean"},"ngrams":{"type":"boolean"},"normalisedName":{"type":"boolean"},"originalScriptName":{"type":"boolean"},"otherRoles":{"type":"boolean"},"previousRoles":{"type":"boolean"},"profileNotes":{"type":"boolean"},"residentOf":{"type":"boolean"},"residentOfCode":{"type":"boolean"},"roles":{"type":"boolean"},"sanctionedRegionCode":{"type":"boolean"},"script":{"type":"boolean"},"security":{"type":"boolean"},"significantDocuments":{"type":"boolean"},"significantProfiles":{"type":"boolean"},"singleStringName":{"type":"boolean"},"sources":{"type":"boolean"},"stateOwnershipDetails":{"type":"boolean"},"suffix":{"type":"boolean"},"surname":{"type":"boolean"},"systemEvent":{"type":"boolean"},"titleHonorific":{"type":"boolean"},"tlevVariants":{"type":"boolean"},"transliterationVariants":{"type":"boolean"},"cessationDateRange":{"type":"boolean"},"cessationDateRanges":{"type":"boolean"},"companyUrls":{"type":"boolean"},"countryOfAffiliation":{"type":"boolean"},"countryOfAffiliationCode":{"type":"boolean"},"countryOfRegistration":{"type":"boolean"},"countryOfRegistrationCode":{"type":"boolean"},"dateOfRegistrationRange":{"type":"boolean"},"dateOfRegistrationRanges":{"type":"boolean"},"formerlySanctionedRegion":{"type":"boolean"},"sanctionedRegion":{"type":"boolean"},"vesselAdditionalOperators":{"type":"boolean"},"vesselCallSigns":{"type":"boolean"},"vesselCustomers":{"type":"boolean"},"vesselFlags":{"type":"boolean"},"vesselFlagsCode":{"type":"boolean"},"vesselGrts":{"type":"boolean"},"vesselImoNumber":{"type":"boolean"},"vesselOwners":{"type":"boolean"},"vesselTonnages":{"type":"boolean"},"vesselTypes":{"type":"boolean"},"cities":{"type":"boolean"},"countryCode":{"type":"boolean"},"locationType":{"type":"boolean"}}}}},"enforceClientInEntity":{"type":"boolean","description":"If enabled, `reasons.data.match.entity` will always contain the client entity, and the list profile will be included in `reasons.data.match.matchedData`"}},"components":{"schemas":{"EvidenceFilter":{"description":"nested filters","oneOf":[{"type":"object","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"alertId":{"type":"array","items":{"type":"integer"},"description":"the alert id of the evidence"},"alertType":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"assessment.codes":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"totalRisk":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to fields greater or equal to this value"},"gt":{"type":"number","description":"Match to fields greater than this value"},"lte":{"type":"number","description":"Match to fields less or equal to this value"},"lt":{"type":"number","description":"Match to fields less than this value"}}},"type":{"description":"the type of alert","enum":["list","risk"]},"createdTimestamp":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}},"assessment.timestamp":{"description":"filter the results based on the evidence assessment timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters","type":"object","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"alertId":{"type":"array","items":{"type":"integer"},"description":"the alert id of the evidence"},"alertType":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"assessment.codes":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"totalRisk":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to fields greater or equal to this value"},"gt":{"type":"number","description":"Match to fields greater than this value"},"lte":{"type":"number","description":"Match to fields less or equal to this value"},"lt":{"type":"number","description":"Match to fields less than this value"}}},"type":{"description":"the type of alert","enum":["list","risk"]},"createdTimestamp":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}},"assessment.timestamp":{"description":"filter the results based on the evidence assessment timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters"}}}]}}}}}}]}}}},{"type":"object","properties":{"skip":{"type":"integer","default":0,"description":"The number of records to skip."},"limit":{"type":"integer","default":100,"description":"The number of records to return. Setting this to zero (0) returns all records."},"sort":{"type":"string","description":"field to sort by and sort order","enum":["alertId:1","alertId:-1","createdTimestamp:1","createdTimestamp:-1","target:1","target:-1","totalRisk:1","totalRisk:-1"]}}}]},"Filters":{"type":"object","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"alertId":{"type":"array","items":{"type":"integer"},"description":"the alert id of the evidence"},"alertType":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"assessment.codes":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"totalRisk":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to fields greater or equal to this value"},"gt":{"type":"number","description":"Match to fields greater than this value"},"lte":{"type":"number","description":"Match to fields less or equal to this value"},"lt":{"type":"number","description":"Match to fields less than this value"}}},"type":{"description":"the type of alert","enum":["list","risk"]},"createdTimestamp":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}},"assessment.timestamp":{"description":"filter the results based on the evidence assessment timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters","type":"object","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"alertId":{"type":"array","items":{"type":"integer"},"description":"the alert id of the evidence"},"alertType":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"assessment.codes":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"totalRisk":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to fields greater or equal to this value"},"gt":{"type":"number","description":"Match to fields greater than this value"},"lte":{"type":"number","description":"Match to fields less or equal to this value"},"lt":{"type":"number","description":"Match to fields less than this value"}}},"type":{"description":"the type of alert","enum":["list","risk"]},"createdTimestamp":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}},"assessment.timestamp":{"description":"filter the results based on the evidence assessment timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters"}}}]}}}}}}]}}}},"NestedFilters":{"type":"object","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"alertId":{"type":"array","items":{"type":"integer"},"description":"the alert id of the evidence"},"alertType":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"assessment.codes":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"totalRisk":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to fields greater or equal to this value"},"gt":{"type":"number","description":"Match to fields greater than this value"},"lte":{"type":"number","description":"Match to fields less or equal to this value"},"lt":{"type":"number","description":"Match to fields less than this value"}}},"type":{"description":"the type of alert","enum":["list","risk"]},"createdTimestamp":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}},"assessment.timestamp":{"description":"filter the results based on the evidence assessment timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters"}}}]}}}},"EvidenceFilterKeyValues":{"type":"object","properties":{"alertId":{"type":"array","items":{"type":"integer"},"description":"the alert id of the evidence"},"alertType":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"assessment.codes":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"totalRisk":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to fields greater or equal to this value"},"gt":{"type":"number","description":"Match to fields greater than this value"},"lte":{"type":"number","description":"Match to fields less or equal to this value"},"lt":{"type":"number","description":"Match to fields less than this value"}}},"type":{"description":"the type of alert","enum":["list","risk"]},"createdTimestamp":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}},"assessment.timestamp":{"description":"filter the results based on the evidence assessment timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}}}}}}},"example":{"evidenceFilter":{"filters":[{"alertId":[10001],"totalRisk":{"gte":0,"lte":100},"assessment.timestamp":{"gte":0,"lte":1590973346512}},{"operator":"AND","filters":[{"createdTimestamp":{"gt":0}},{"createdTimestamp":{"lt":1590973346512}}]}],"operator":"OR","skip":0,"limit":0,"sort":"alertId:1"},"enrich":{"assessments":true,"comments":true,"matches":true,"lists":true},"projections":{"assessments":{},"evidence":{},"comments":{},"lists":{}}}}}},"responses":{"200":{"description":"Evidence items returned in line-delimited JSON format","content":{"application\/jsonld":{"schema":{"oneOf":[{"description":"Line-delimited JSON evidence objects","type":"object","properties":{"alertId":{"type":"number","description":"ID of associated alert","example":18793},"documentId":{"type":"string","descrption":"the ID of the underlying evidence document capturing the details of the matched profile","example":"6119b7f33b0a33d02163d0fbeae918b75d7e98d7"},"alertType":{"type":"number","description":"ID of policy that resulted in the associated alert","example":10001},"clientKey":{"type":"string","description":"User's client key","example":"lowercasekey"},"createdTimestamp":{"type":"number","description":"Time evidence was created as an Epoch timestamp","example":1592889012822},"data":{"type":"object","description":"Additional metadata","example":{"documentSource":"Risk Profiles"},"properties":{"documentSource":{"type":"string"}}},"id":{"type":"number","description":"The evidence item\\'s ID","example":39824},"listEntityId":{"type":"string","description":"The ID of the list entity or risk profile associated with the evidence, including the full namespace prefix","example":"listEntity:list_entity-urn:ripjar:fix-jog-nec-pod"},"isGroupMaster":{"type":"boolean","description":"Determines whether the evidence item is a master item","example":true},"matchTypes":{"type":"array","items":{"type":"string","enum":["NAME","ADDRESS","LOCATION"]}},"namespace":{"type":"string","description":"The system\\'s namespace","example":"torch"},"reasons":{"type":"array","items":{"type":"object","properties":{"data":{"type":"object","properties":{"match":{"type":"object","properties":{"active":{"type":"boolean"},"allPoliciesEvaluated":{"type":"boolean"},"cellId":{"type":"string"},"entity":{"description":"The entity of interest sent for matching, either a client or a list depending on if the Alert is breached due to client load or profile load","oneOf":[{"discriminator":{"propertyName":"entityType","mapping":{"PERSON":".\/PersonClient.yaml","ORGANISATION":".\/OrganisationClient.yaml","VESSEL":".\/VesselClient.yaml","AIRCRAFT":".\/AircraftClient.yaml"}},"anyOf":[{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"description":"Entity specifier for a person. Must provide at least one of the following:\n\n  * name (recommended)\n  * firstName and surname (with optional middleName)\n\nIf all three are provided, the system will use \"name\". Our recommendation is\nfor you to provide a single, whole, name string which we will then analyse.\n\n**Note**: Name structure is a cultural artefact. We strongly recommend using\nthe full name field as we handle many cross-cultural aspects. If you do wish\nto separate out the name then we consider \"firstName\" to be the given name of\nan individual, and \"surname\" to be a \"family\" name.\n","properties":{"entityType":{"const":"PERSON"},"gender":{"type":"string"},"titles":{"type":"array","items":{"type":"string"}},"surname":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"suffixes":{"type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"titles":{"type":"array","items":{"type":"string"}},"surname":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"suffixes":{"type":"array","items":{"type":"string"}},"nameType":{"type":"string"}}}},"dateOfBirth":{"oneOf":[{"type":"string"},{"type":"integer"}]},"birthPlaceCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"deceasedOn":{"oneOf":[{"type":"string"},{"type":"integer"}]},"nationalityCodes":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"domicileCodes":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"occupation":{"type":"string"}}},{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"properties":{"entityType":{"const":"ORGANISATION"},"companyName":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"aliases":{"type":"array","items":{"type":"object","properties":{"companyName":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"nameType":{"type":"string"}}}},"dateOfIncorporation":{"oneOf":[{"type":"string"},{"type":"integer"}]},"incorporationCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"required":["companyName"]},{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"description":"An entity specifier for a maritime vessel. Must provide AT LEAST ONE of:\nname, aliases, vesselCallSigns or vesselImoNumber\n","required":["vesselName"],"properties":{"entityType":{"const":"VESSEL"},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"nameType":{"type":"string"}}}},"vesselName":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"vesselCallSigns":{"type":"array","items":{"type":"string"}},"vesselTypes":{"type":"array","items":{"type":"string"}},"vesselTonnages":{"type":"array","items":{"type":"number"}},"vesselOwners":{"type":"array","items":{"type":"string"}},"vesselCustomers":{"type":"array","items":{"type":"string"}},"vesselGrts":{"type":"array","items":{"type":"number"}},"vesselFlags":{"type":"array","items":{"type":"string"}},"vesselFlagsCode":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"vesselImoNumber":{"type":"string"},"countryOfRegistrationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}}},{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"properties":{"entityType":{"const":"AIRCRAFT"},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"nameType":{"type":"string"}}}},"aircraftManufactureDate":{"oneOf":[{"type":"string"},{"type":"integer"}]},"aircraftModel":{"type":"string"},"aircraftName":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"aircraftOperator":{"type":"string"},"countryOfAffiliationCode":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}}}}]},{"description":"The list entity associated with this evidence. Present if the evidence is of type 'list' and the 'lists' enrichment is enabled","oneOf":[{"type":"object","allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}}],"properties":{"person":{"type":"object","description":"The person entity schema must contain the following fileds; firstName, middleName, surname, name\n","properties":{"name":{"type":"string","description":"Full name of the person. Can be used as well as, or instead of, fields for individual name parts"},"firstName":{"type":"string","description":"Given name of the person"},"surname":{"type":"string","description":"Family name of the person"},"aliases":{"type":"array","description":"An aray of alternative names by which a person is known. Fields in each name are as for the main name fields with some additions","items":{"type":"object","properties":{"type":{"type":"string"},"firstName":{"type":"string"},"surname":{"type":"string"},"middleName":{"type":"string"},"titleHonorific":{"type":"string"},"maidenName":{"type":"string"}}}},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER"],"description":"Known gender type of the person, must be in capitals"},"deceased":{"type":"boolean","description":"Is the person deceased?"},"birthPlace":{"type":"string","description":"The name of the persons birthplace. Populated automatically from birthPlaceCountryCode"},"birthPlaceCity":{"type":"string","description":"The persons city of birth"},"dateOfBirthArray":{"type":"array","description":"Possible values for the persons date of birth. This is an array to allow for the uncertanty in reported dates","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"images":{"type":"array","description":"URLs pointing to the images of, or related to, the person","items":{"type":"string"}},"birthPlaceCountryCode":{"type":"string","description":"The country code of the persons birth"},"citizenshipCode":{"type":"array","description":"Country codes of the countries for which the person has citizenship. May be more than one","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"residentOfCode":{"type":"array","description":"Country codes of the countries for which the person is domiciled. May be more than one","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"countryOfReportedAllegationCode":{"type":"array","description":"Country codes of the countries in which alleged misconduct took place. May be more than one","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"middleName":{"type":"string","description":"Middle name of the person"},"roles":{"type":"array","description":"Current jobs or roles of the person","items":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"categoryId":{"type":"string"},"since":{"type":"string","description":"Date in the form yyyy-mm-dd"}}}},"previousRoles":{"type":"array","description":"Past jobs or roles of the person","items":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"categoryId":{"type":"string"},"since":{"type":"string","description":"Date in the form yyyy-mm-dd"},"to":{"type":"string","description":"Date in the form yyyy-mm-dd"}}}},"jurisdictionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"deceasedDateArray":{"type":"array","description":"If the person is deceased (deceased=true), possible values for the persons date of death. This is an array to allow for uncertainty in reported cases"},"suffix":{"type":"string","description":"An honorific that comes after the person's name, rather than before"}}}}},{"type":"object","allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}}],"properties":{"company":{"type":"object","description":"The company entity schema must contain the following fields: name, keyTerms\n","properties":{"name":{"type":"string","description":"The companies main name"},"suffix":{"type":"string","description":"Company suffix, e.g. Ltd, PLC or GmbH"},"aliases":{"type":"array","description":"An array of alternative names by which a company is known","items":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"suffix":{"type":"string"},"entityName":{"type":"string"}}}},"dateOfRegistrationArray":{"type":"array","description":"Company registration dates\n","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"companyURLs":{"type":"array","description":"Associated URLs for the company","items":{"type":"string"}},"countryOfRegistrationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"countryOfAffiliationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"formerlySanctionedRegionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"sanctionedRegionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"cessationDateArray":{"type":"array","description":"For non-active companies, the date(s) on which the company ceased trading","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"keyTerms":{"type":"array","description":"Keywords used in entity matching to automatically match this list entity to client profiles that contain one or more of the key terms. Viewing the list entity will then show all linked client profiles","items":{"keyTerms":{"type":"string"}}}}}}},{"type":"object","allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}}],"properties":{"location":{"type":"object","description":"Location entities are an extension of entities. All of the base fields are included in addition to the fields defined below. \nLocations can be used to represent high risk countries, and can match with location fields on clients or other entities of \ninterest in order to highlight links between the entities and these countries.\n","properties":{"name":{"type":"string","description":"Name of the location"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"The country code of the location","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"locationType":{"type":"string","description":"This must be country"},"cities":{"type":"array","description":"A list of names of cities associated with this location","items":{"type":"string"}}}},"subType":{"type":"string","enum":["country","city","region","sub-region","free-trade-zone","airport","port"],"description":"The sub-type of a location entity"}}},{"allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}},{"type":"object","properties":{"entityType":{"type":"string","enum":["listVessel"]},"vesselCallSigns":{"type":"array","items":{"type":"string"}},"vesselTypes":{"type":"array","items":{"type":"string"}},"vesselTonnages":{"type":"array","items":{"type":"integer"}},"vesselOwners":{"type":"array","items":{"type":"string"}},"vesselCustomers":{"type":"array","items":{"type":"string"}},"vesselGrts":{"type":"array","items":{"type":"integer"}},"vesselFlags":{"type":"array","items":{"type":"string"}},"vesselFlagsCode":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"vesselImoNumber":{"type":"string"},"vesselAdditionalOperators":{"type":"array","items":{"type":"object","properties":{"operatorCategory":{"type":"string","enum":["groupBeneficialOwner","operator","registeredOwner","shipManager","technicalManager"]},"operatorName":{"type":"string"},"countryOfControl":{"type":"string"},"countryOfDomicile":{"type":"string"},"countryOfRegistration":{"type":"string"}}}}}}]},{"type":"object","allOf":[{"type":"object","allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}}],"properties":{"company":{"type":"object","description":"The company entity schema must contain the following fields: name, keyTerms\n","properties":{"name":{"type":"string","description":"The companies main name"},"suffix":{"type":"string","description":"Company suffix, e.g. Ltd, PLC or GmbH"},"aliases":{"type":"array","description":"An array of alternative names by which a company is known","items":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"suffix":{"type":"string"},"entityName":{"type":"string"}}}},"dateOfRegistrationArray":{"type":"array","description":"Company registration dates\n","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"companyURLs":{"type":"array","description":"Associated URLs for the company","items":{"type":"string"}},"countryOfRegistrationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"countryOfAffiliationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"formerlySanctionedRegionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"sanctionedRegionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"cessationDateArray":{"type":"array","description":"For non-active companies, the date(s) on which the company ceased trading","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"keyTerms":{"type":"array","description":"Keywords used in entity matching to automatically match this list entity to client profiles that contain one or more of the key terms. Viewing the list entity will then show all linked client profiles","items":{"keyTerms":{"type":"string"}}}}}}}],"properties":{"aircraft":{"type":"object","description":"Aircraft entities are an extension of company entities. As well as the base fields and aircraft-specific fields, all company properties are also included.\n","properties":{"name":{"type":"string","description":"The aircraft's tail number. The prefix of the tail number is used to determine the aircraft's country of origin."}}}}}],"discriminator":{"propertyName":"entityType","mapping":{"listPerson":".\/ListEntityPerson.yaml","listAircraft":".\/ListEntityAircraft.yaml","listLocation":".\/ListEntityLocation.yaml","listOrganisation":".\/ListEntityOrganisation.yaml","listVessel":".\/ListEntityVessel.yaml"}}}]},"irs_version":{"type":"integer"},"isNew":{"type":"boolean"},"lineNumber":{"type":"integer"},"matchedData":{"description":"Entity that matches the sent entity of interest, trimmed down to only properties required for matching","anyOf":[{"additionalProperties":false,"properties":{"activeStatus":{"type":"string"},"addresses":{"items":{"additionalProperties":false,"properties":{"addressType":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"line":{"type":"string"},"poBox":{"type":"string"},"postcode":{"type":"string"},"province":{"type":"string"}},"type":"object"},"type":"array"},"aliases":{"items":{"additionalProperties":false,"properties":{"firstName":{"type":"string"},"maidenName":{"type":"string"},"middleName":{"type":"string"},"name":{"type":"string"},"suffix":{"type":"string"},"surname":{"type":"string"},"titleHonorific":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"},"associatedCities":{"items":{"type":"string"},"type":"array"},"associatedCountryCodes":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"citizenshipCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"clientKey":{"type":"string"},"dateOfBirthArray":{"items":{"anyOf":[{"type":"string"},{"items":[{"anyOf":[{"type":"number"},{"format":"date-time","type":"string"},{"type":"null"}]},{"anyOf":[{"type":"number"},{"format":"date-time","type":"string"},{"type":"null"}]},{"enum":["year","month","day","range"],"type":"string"}],"maxItems":"3","minItems":"3","type":"array"}]},"type":"array"},"dateOfDeceasedArray":{"items":{"anyOf":[{"type":"string"},{"items":[{"anyOf":[{"type":"number"},{"format":"date-time","type":"string"},{"type":"null"}]},{"anyOf":[{"type":"number"},{"format":"date-time","type":"string"},{"type":"null"}]},{"enum":["year","month","day","range"],"type":"string"}],"maxItems":"3","minItems":"3","type":"array"}]},"type":"array"},"deceased":{"type":"boolean"},"firstName":{"type":"string"},"formerlySanctionedRegionCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"gender":{"enum":["MALE","FEMALE","OTHER"],"type":"string"},"identityNumbers":{"items":{"additionalProperties":false,"properties":{"type":{"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"lastModifiedDate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"lastReviewed":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"},{"type":"string"}]},"lastSignificantUpdate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"lists":{"items":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"additionalFields":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"description":{"type":"string"},"hierarchy":{"items":{"additionalProperties":false,"properties":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"id":{"type":"string"},"jurisdiction":{"type":"string"},"jurisdictionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"listActive":{"type":"boolean"},"name":{"type":"string"},"provider":{"type":"string"},"since":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"sinceRange":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"source":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"to":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"toRange":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"}},"required":["id","name","description","active","listActive","hierarchy"],"type":"object"},"type":"array"},"loadOptions":{"additionalProperties":false,"properties":{"suppressNotification":{"type":"boolean"}},"type":"object"},"middleName":{"type":"string"},"name":{"type":"string"},"profileId":{"type":"string"},"residentOfCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"sanctionedRegionCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"significantDocuments":{"items":{"additionalProperties":false,"properties":{"additionalProperties":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"articleId":{"type":"string"},"dates":{"additionalProperties":false,"properties":{"arrivalDch":{"format":"date-time","type":"string"},"published":{"format":"date-time","type":"string"}},"required":["published","arrivalDch"],"type":"object"},"enTitle":{"type":"string"},"groupId":{"type":"string"},"language":{"type":"string"},"models":{"items":{"additionalProperties":false,"properties":{"confidence":{"type":"number"},"model":{"type":"string"},"name":{"type":"string"}},"required":["name","model","confidence"],"type":"object"},"type":"array"},"properties":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"provider":{"type":"string"},"source":{"type":"string"},"storyline":{"type":"string"},"title":{"type":"string"}},"required":["articleId","title","groupId","provider","source","dates"],"type":"object"},"type":"array"},"status":{"type":"string"},"suffix":{"type":"string"},"surname":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"titleHonorific":{"type":"string"},"type":{"const":"person","type":"string"}},"required":["profileId","type"],"type":"object"},{"additionalProperties":false,"properties":{"activeStatus":{"type":"string"},"addresses":{"items":{"additionalProperties":false,"properties":{"addressType":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"line":{"type":"string"},"poBox":{"type":"string"},"postcode":{"type":"string"},"province":{"type":"string"}},"type":"object"},"type":"array"},"aliases":{"items":{"additionalProperties":false,"properties":{"name":{"type":"string"},"suffix":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"},"associatedCities":{"items":{"type":"string"},"type":"array"},"associatedCountryCodes":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"clientKey":{"type":"string"},"countryOfAffiliationCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"countryOfRegistrationCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"dateOfCessationArray":{"items":{"anyOf":[{"type":"string"},{"items":[{"anyOf":[{"type":"number"},{"format":"date-time","type":"string"},{"type":"null"}]},{"anyOf":[{"type":"number"},{"format":"date-time","type":"string"},{"type":"null"}]},{"enum":["year","month","day","range"],"type":"string"}],"maxItems":"3","minItems":"3","type":"array"}]},"type":"array"},"dateOfRegistrationArray":{"items":{"anyOf":[{"type":"string"},{"items":[{"anyOf":[{"type":"number"},{"format":"date-time","type":"string"},{"type":"null"}]},{"anyOf":[{"type":"number"},{"format":"date-time","type":"string"},{"type":"null"}]},{"enum":["year","month","day","range"],"type":"string"}],"maxItems":"3","minItems":"3","type":"array"}]},"type":"array"},"formerlySanctionedRegionCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"identityNumbers":{"items":{"additionalProperties":false,"properties":{"type":{"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"lastModifiedDate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"lastReviewed":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"},{"type":"string"}]},"lastSignificantUpdate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"lists":{"items":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"additionalFields":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"description":{"type":"string"},"hierarchy":{"items":{"additionalProperties":false,"properties":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"id":{"type":"string"},"jurisdiction":{"type":"string"},"jurisdictionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"listActive":{"type":"boolean"},"name":{"type":"string"},"provider":{"type":"string"},"since":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"sinceRange":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"source":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"to":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"toRange":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"}},"required":["id","name","description","active","listActive","hierarchy"],"type":"object"},"type":"array"},"loadOptions":{"additionalProperties":false,"properties":{"suppressNotification":{"type":"boolean"}},"type":"object"},"name":{"type":"string"},"profileId":{"type":"string"},"sanctionedRegionCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"significantDocuments":{"items":{"additionalProperties":false,"properties":{"additionalProperties":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"articleId":{"type":"string"},"dates":{"additionalProperties":false,"properties":{"arrivalDch":{"format":"date-time","type":"string"},"published":{"format":"date-time","type":"string"}},"required":["published","arrivalDch"],"type":"object"},"enTitle":{"type":"string"},"groupId":{"type":"string"},"language":{"type":"string"},"models":{"items":{"additionalProperties":false,"properties":{"confidence":{"type":"number"},"model":{"type":"string"},"name":{"type":"string"}},"required":["name","model","confidence"],"type":"object"},"type":"array"},"properties":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"provider":{"type":"string"},"source":{"type":"string"},"storyline":{"type":"string"},"title":{"type":"string"}},"required":["articleId","title","groupId","provider","source","dates"],"type":"object"},"type":"array"},"status":{"type":"string"},"suffix":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"type":{"const":"organisation","type":"string"}},"required":["profileId","type"],"type":"object"},{"additionalProperties":false,"properties":{"activeStatus":{"type":"string"},"addresses":{"items":{"additionalProperties":false,"properties":{"addressType":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"line":{"type":"string"},"poBox":{"type":"string"},"postcode":{"type":"string"},"province":{"type":"string"}},"type":"object"},"type":"array"},"aliases":{"items":{"additionalProperties":false,"properties":{"name":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"},"associatedCities":{"items":{"type":"string"},"type":"array"},"associatedCountryCodes":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"clientKey":{"type":"string"},"countryOfAffiliationCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"countryOfRegistrationCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"formerlySanctionedRegionCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"identityNumbers":{"items":{"additionalProperties":false,"properties":{"type":{"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"lastModifiedDate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"lastReviewed":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"},{"type":"string"}]},"lastSignificantUpdate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"lists":{"items":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"additionalFields":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"description":{"type":"string"},"hierarchy":{"items":{"additionalProperties":false,"properties":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"id":{"type":"string"},"jurisdiction":{"type":"string"},"jurisdictionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"listActive":{"type":"boolean"},"name":{"type":"string"},"provider":{"type":"string"},"since":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"sinceRange":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"source":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"to":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"toRange":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"}},"required":["id","name","description","active","listActive","hierarchy"],"type":"object"},"type":"array"},"loadOptions":{"additionalProperties":false,"properties":{"suppressNotification":{"type":"boolean"}},"type":"object"},"name":{"type":"string"},"profileId":{"type":"string"},"sanctionedRegionCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"significantDocuments":{"items":{"additionalProperties":false,"properties":{"additionalProperties":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"articleId":{"type":"string"},"dates":{"additionalProperties":false,"properties":{"arrivalDch":{"format":"date-time","type":"string"},"published":{"format":"date-time","type":"string"}},"required":["published","arrivalDch"],"type":"object"},"enTitle":{"type":"string"},"groupId":{"type":"string"},"language":{"type":"string"},"models":{"items":{"additionalProperties":false,"properties":{"confidence":{"type":"number"},"model":{"type":"string"},"name":{"type":"string"}},"required":["name","model","confidence"],"type":"object"},"type":"array"},"properties":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"provider":{"type":"string"},"source":{"type":"string"},"storyline":{"type":"string"},"title":{"type":"string"}},"required":["articleId","title","groupId","provider","source","dates"],"type":"object"},"type":"array"},"status":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"type":{"const":"vessel","type":"string"},"vesselCallSigns":{"items":{"type":"string"},"type":"array"},"vesselFlagsCode":{"items":{"type":"string"},"type":"array"},"vesselGrts":{"items":{"type":"string"},"type":"array"},"vesselImoNumber":{"type":"string"},"vesselOwners":{"items":{"type":"string"},"type":"array"},"vesselTonnages":{"items":{"type":"string"},"type":"array"},"vesselTypes":{"items":{"type":"string"},"type":"array"}},"required":["profileId","type"],"type":"object"},{"additionalProperties":false,"properties":{"activeStatus":{"type":"string"},"addresses":{"items":{"additionalProperties":false,"properties":{"addressType":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"line":{"type":"string"},"poBox":{"type":"string"},"postcode":{"type":"string"},"province":{"type":"string"}},"type":"object"},"type":"array"},"aliases":{"items":{"additionalProperties":false,"properties":{"name":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"},"associatedCities":{"items":{"type":"string"},"type":"array"},"associatedCountryCodes":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"clientKey":{"type":"string"},"countryOfAffiliationCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"countryOfRegistrationCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"formerlySanctionedRegionCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"identityNumbers":{"items":{"additionalProperties":false,"properties":{"type":{"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"lastModifiedDate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"lastReviewed":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"},{"type":"string"}]},"lastSignificantUpdate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"lists":{"items":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"additionalFields":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"description":{"type":"string"},"hierarchy":{"items":{"additionalProperties":false,"properties":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"id":{"type":"string"},"jurisdiction":{"type":"string"},"jurisdictionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"listActive":{"type":"boolean"},"name":{"type":"string"},"provider":{"type":"string"},"since":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"sinceRange":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"source":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"to":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"toRange":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"}},"required":["id","name","description","active","listActive","hierarchy"],"type":"object"},"type":"array"},"loadOptions":{"additionalProperties":false,"properties":{"suppressNotification":{"type":"boolean"}},"type":"object"},"name":{"type":"string"},"profileId":{"type":"string"},"sanctionedRegionCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"significantDocuments":{"items":{"additionalProperties":false,"properties":{"additionalProperties":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"articleId":{"type":"string"},"dates":{"additionalProperties":false,"properties":{"arrivalDch":{"format":"date-time","type":"string"},"published":{"format":"date-time","type":"string"}},"required":["published","arrivalDch"],"type":"object"},"enTitle":{"type":"string"},"groupId":{"type":"string"},"language":{"type":"string"},"models":{"items":{"additionalProperties":false,"properties":{"confidence":{"type":"number"},"model":{"type":"string"},"name":{"type":"string"}},"required":["name","model","confidence"],"type":"object"},"type":"array"},"properties":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"provider":{"type":"string"},"source":{"type":"string"},"storyline":{"type":"string"},"title":{"type":"string"}},"required":["articleId","title","groupId","provider","source","dates"],"type":"object"},"type":"array"},"status":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"type":{"const":"aircraft","type":"string"}},"required":["profileId","type"],"type":"object"},{"additionalProperties":false,"properties":{"activeStatus":{"type":"string"},"addresses":{"items":{"additionalProperties":false,"properties":{"addressType":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"line":{"type":"string"},"poBox":{"type":"string"},"postcode":{"type":"string"},"province":{"type":"string"}},"type":"object"},"type":"array"},"aliases":{"items":{"additionalProperties":false,"properties":{"name":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"},"associatedCities":{"items":{"type":"string"},"type":"array"},"associatedCountryCodes":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"cities":{"items":{"type":"string"},"type":"array"},"clientKey":{"type":"string"},"formerlySanctionedRegionCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"identityNumbers":{"items":{"additionalProperties":false,"properties":{"type":{"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"lastModifiedDate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"lastReviewed":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"},{"type":"string"}]},"lastSignificantUpdate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"lists":{"items":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"additionalFields":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"description":{"type":"string"},"hierarchy":{"items":{"additionalProperties":false,"properties":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"id":{"type":"string"},"jurisdiction":{"type":"string"},"jurisdictionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"listActive":{"type":"boolean"},"name":{"type":"string"},"provider":{"type":"string"},"since":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"sinceRange":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"source":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"to":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"toRange":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"}},"required":["id","name","description","active","listActive","hierarchy"],"type":"object"},"type":"array"},"loadOptions":{"additionalProperties":false,"properties":{"suppressNotification":{"type":"boolean"}},"type":"object"},"name":{"type":"string"},"profileId":{"type":"string"},"sanctionedRegionCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"significantDocuments":{"items":{"additionalProperties":false,"properties":{"additionalProperties":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"articleId":{"type":"string"},"dates":{"additionalProperties":false,"properties":{"arrivalDch":{"format":"date-time","type":"string"},"published":{"format":"date-time","type":"string"}},"required":["published","arrivalDch"],"type":"object"},"enTitle":{"type":"string"},"groupId":{"type":"string"},"language":{"type":"string"},"models":{"items":{"additionalProperties":false,"properties":{"confidence":{"type":"number"},"model":{"type":"string"},"name":{"type":"string"}},"required":["name","model","confidence"],"type":"object"},"type":"array"},"properties":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"provider":{"type":"string"},"source":{"type":"string"},"storyline":{"type":"string"},"title":{"type":"string"}},"required":["articleId","title","groupId","provider","source","dates"],"type":"object"},"type":"array"},"status":{"type":"string"},"subType":{"type":"string","enum":["country","city","region","sub-region","free-trade-zone","airport","port"],"description":"The sub-type of a location entity"},"tags":{"items":{"type":"string"},"type":"array"},"type":{"const":"location","type":"string"}},"required":["profileId","subType","type"],"type":"object"},{"additionalProperties":false,"properties":{"activeStatus":{"type":"string"},"addresses":{"items":{"additionalProperties":false,"properties":{"addressType":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"line":{"type":"string"},"poBox":{"type":"string"},"postcode":{"type":"string"},"province":{"type":"string"}},"type":"object"},"type":"array"},"aliases":{"anyOf":[{"items":{"additionalProperties":false,"properties":{"name":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"},{"items":{"additionalProperties":false,"properties":{"firstName":{"type":"string"},"maidenName":{"type":"string"},"middleName":{"type":"string"},"name":{"type":"string"},"suffix":{"type":"string"},"surname":{"type":"string"},"titleHonorific":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"},{"items":{"additionalProperties":false,"properties":{"name":{"type":"string"},"suffix":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"}]},"associatedCities":{"items":{"type":"string"},"type":"array"},"associatedCountryCodes":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"clientKey":{"type":"string"},"formerlySanctionedRegionCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"identityNumbers":{"items":{"additionalProperties":false,"properties":{"type":{"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"lastModifiedDate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"lastReviewed":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"},{"type":"string"}]},"lastSignificantUpdate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"lists":{"items":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"additionalFields":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"description":{"type":"string"},"hierarchy":{"items":{"additionalProperties":false,"properties":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"id":{"type":"string"},"jurisdiction":{"type":"string"},"jurisdictionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"listActive":{"type":"boolean"},"name":{"type":"string"},"provider":{"type":"string"},"since":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"sinceRange":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"source":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"to":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"toRange":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"}},"required":["id","name","description","active","listActive","hierarchy"],"type":"object"},"type":"array"},"loadOptions":{"additionalProperties":false,"properties":{"suppressNotification":{"type":"boolean"}},"type":"object"},"name":{"type":"string"},"profileId":{"type":"string"},"sanctionedRegionCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"significantDocuments":{"items":{"additionalProperties":false,"properties":{"additionalProperties":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"articleId":{"type":"string"},"dates":{"additionalProperties":false,"properties":{"arrivalDch":{"format":"date-time","type":"string"},"published":{"format":"date-time","type":"string"}},"required":["published","arrivalDch"],"type":"object"},"enTitle":{"type":"string"},"groupId":{"type":"string"},"language":{"type":"string"},"models":{"items":{"additionalProperties":false,"properties":{"confidence":{"type":"number"},"model":{"type":"string"},"name":{"type":"string"}},"required":["name","model","confidence"],"type":"object"},"type":"array"},"properties":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"provider":{"type":"string"},"source":{"type":"string"},"storyline":{"type":"string"},"title":{"type":"string"}},"required":["articleId","title","groupId","provider","source","dates"],"type":"object"},"type":"array"},"status":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"type":{"const":"unknown","type":"string"}},"required":["profileId","type"],"type":"object"}]},"notificationPolicyCombiner":{"type":"object"},"notificationPolicyResults":{"type":"array","items":{"type":"object","properties":{"className":{"type":"string"},"description":{"type":"string"},"evaluated":{"type":"boolean"},"executionTime":{"type":"number"},"name":{"type":"string"},"params":{"type":"object","properties":{"active_if_new":{"type":"boolean"},"data_source":{"type":"string"},"delta":{"type":"integer"},"diff_record_query":{"type":"object","properties":{"$or":{"type":"array","items":{"type":"object","properties":{"lists.hierarchy.id":{"type":"object","properties":{"$in":{"type":"array","items":{"type":"string"}}}},"tags":{"type":"object","properties":{"$regex":{"type":"string"}}}}}}}},"diff_rules":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"id_field":{"type":"string"},"new_field":{"type":"null"},"reverse":{"type":"boolean"},"type":{"type":"string"}}}},"inclusive":{"type":"boolean"},"operator":{"type":"string"},"threshold":{"type":"integer"}}},"reason":{"type":"string"},"value":{"type":"boolean"},"version":{"type":"string"}}}},"reasons":{"type":"array","items":{"type":"object","properties":{"is_consistent":{"type":"boolean"},"is_match":{"type":"boolean"},"is_property_matcher_mandatory":{"type":"boolean"},"mandatory_group":{"type":"integer"},"match_score":{"type":"integer"},"matching_details":{"type":"array","items":{"type":"object","properties":{"data_source":{"type":"string"},"field":{"type":"string"},"field_label":{"type":"string"},"id":{"type":"string"},"special_score":{"type":"integer"},"value":{"type":"string"}}}},"property_matcher_id":{"type":"integer"},"property_matcher_name":{"type":"string"},"result_reason":{"type":"string"},"weight":{"type":"integer"}}}},"score":{"type":"number"},"individualMatchScore":{"type":"number"},"suppressed":{"type":"boolean"},"uuid":{"type":"string"}}},"policy":{"type":"object","properties":{"_id":{"type":"string"},"active":{"type":"boolean"},"cells":{"type":"array","items":{"type":"object","properties":{"cellId":{"type":"string"},"dataMatchingGroup":{"type":"integer"},"isStructured":{"type":"boolean"},"cellType":{"type":"string","enum":["NAME","ADDRESS","LOCATION"]},"notificationPolicyConfig":{"type":"array","items":{"type":"object","properties":{"class_name":{"type":"string"},"name":{"type":"string"},"params":{"type":"object","properties":{"data_source":{"type":"string"},"delta":{"type":"integer"},"diff_record_query":{"type":"object","properties":{"$or":{"type":"array","items":{"type":"object","properties":{"lists.hierarchy.id":{"type":"object","properties":{"$in":{"type":"array","items":{"type":"string"}}}},"tags":{"type":"object","properties":{"$regex":{"type":"string"}}}}}}}},"diff_rules":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"id_field":{"type":"string"},"type":{"type":"string"}}}},"inclusive":{"type":"boolean"},"operator":{"type":"string"},"threshold":{"type":"integer"}}}}}},"score":{"type":"integer"},"strategyKey":{"type":"string"},"tagQuery1":{"type":"object","properties":{"allTags":{"type":"array","items":{"type":"string"}},"anyTags":{"type":"array","items":{"type":"string"}},"noneTags":{"type":"array","items":{"type":"string"}}}},"tagQuery2":{"type":"object","properties":{"allTags":{"type":"array","items":{"type":"string"}},"anyTags":{"type":"array","items":{"type":"string"}},"noneTags":{"type":"array","items":{"type":"string"}}}}}}},"clientKey":{"type":"string"},"created":{"type":"number"},"dataSource1":{"type":"string"},"dataSource2":{"type":"string"},"default":{"type":"boolean"},"disabled":{"type":"boolean"},"entityGroups":{"type":"array","items":{"type":"integer"}},"id":{"type":"integer"},"lastUpdated":{"type":"number"},"matchOnlyFromDataSource2":{"type":"boolean"},"name":{"type":"string"},"systemGenerated":{"type":"boolean"},"threshold":{"type":"integer"},"type":{"type":"string"},"withExisting":{"type":"boolean"}}}}},"impact":{"type":"integer"},"matchScore":{"type":"number"},"individualMatchScore":{"type":"number"},"reasonType":{"type":"string"}}}},"tags":{"type":"array","description":"Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and\u2014when custom categories apply\u2014entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property.\n","items":{"type":"string"},"example":["policy-20037","risk-Financial Crime","userTag-Fin Crime-active"]},"riskTags":{"type":"array","description":"Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags).\n","items":{"type":"string"},"example":["PEP-active","cc42-active"]},"target":{"type":"string","description":"A representation of the target entity for which this evidence was raised\n","example":"eoi:329164"},"totalRisk":{"type":"number","description":"The total risk contribution the evidence had to the associated alert","example":200},"type":{"type":"string","description":"The evidence type","example":"risk"},"assessment":{"type":"object","description":"Contains data related to the evidence\\'s assessment","example":{"codes":[10001],"user":{"email":"bobby.tables@ripjar.com","username":"Bobby Tables","id":"123","cn":"example","roles":["ROLE1","ROLE2"]},"timestamp":1594050360827},"properties":{"codes":{"type":"array","description":"The assessment codes raised against the evidence","items":{"description":"Depending on configuration","oneOf":[{"type":"number"},{"type":"object","properties":{"code":{"type":"number"},"description":{"type":"string"}},"example":{"code":10001,"description":"There is high confidence that the evidence references a client which has been correctly associated with risk"}}]}},"user":{"type":"object","description":"An object representing a user in the system.","required":["username","email","cn"],"properties":{"excludedApps":{"type":"array","items":{"type":"string"},"description":"A list of the applications that this user is excluded from accessing. Not used in Labyrinth Screening."},"username":{"type":"string","description":"The name of the user. This is the value displayed when the user is referenced in the UI."},"email":{"type":"string","description":"The email address of the user. Can be used as part of basic authentication."},"mobile":{"type":"string","description":"The mobile\/cell phone number of the user."},"roles":{"type":"array","items":{"type":"string"},"description":"A list of the user roles that this user has.\nLabyrinth Screening makes use of defined user roles to control the actions a user may perform and to tailor the interface to the needs of particular users.\nEach role is made up of a set of permissions which provide fine grained control over the actions a user can perform. Roles can be configured to match the business roles required by the users of the Screening system.\nThese permissions used by the Screening system are described in the Ripjar Security Implementation document.\nWhen users are loaded into the system, each user account should include the list of roles they are allowed to perform.\n"},"password":{"type":"string","description":"The user's password, used for basic authentication or to retrieve a bearer auth (JWT) token. Not available in API responses. Required when creating or updating users.\n"},"cn":{"type":"string","description":"The user's canonical name. Used to lookup user accounts when performing certificate-based authentication."},"externalId":{"type":"string","description":"The user's ID external to the system. Typically maps to a username or ID in an external user entitlement system."},"security":{"type":"object","description":"The security attributes for this user.\nA user's security attributes govern the data items in the system (such as clients, alerts and assessments) that the user has visibility of. These are distinct from the user's roles, which govern the operations a user can carry out in the system.\nThe security schema contains a set of generic attributes that the user can be assigned. The meaning of these attributes varies depending on the security policy installed on the system.\nBy default, the security policy will compare the list of strings (also known as tags) in dataRolesN fields of the user to the list of strings in the orTagsN field in the security attributes of the data item. If the user has any of the tags that appear on the data item, they can view that item.\nIf the data item has multiple orTags fields, for example orTags1 and orTags2, the user must has at least one of the tags in each of the corresponding dataRoles fields, i.e. there is an AND logic between each attribute.\n","properties":{"dataRoles1":{"type":"array","items":{"type":"string"}},"dataRoles2":{"type":"array","items":{"type":"string"}},"dataRoles3":{"type":"array","items":{"type":"string"}},"compositeDataRoles1":{"type":"array","items":{"type":"object"}}}}}},"timestamp":{"type":"number","description":"When the assessment was performed, in epoch time","example":1594050360827},"assessments":{"type":"array","description":"Details of each assessment currently applied to the evidence","items":{"properties":{"relevant":{"type":"boolean","example":true},"description":{"type":"string","example":"There is high confidence that the evidence references a client which has been correctly associated with risk"},"list":{"type":"boolean","example":true},"active":{"type":"boolean","example":true},"id":{"type":"string","example":"10001"},"risk":{"type":"boolean","example":true}}}}}},"matches":{"type":"array","description":"Contains data describing the matches between entities and the alerting client in the evidence\n","items":{"type":"object","properties":{"active":{"type":"boolean","example":true},"activate_state":{"type":"number","example":11974},"active_from":{"type":"number","example":1590674133787},"blacklisted":{"type":"boolean","example":false},"reason":{"type":"object","properties":{"property_match_combiner_name":{"type":"string","example":"Person News Combiner"},"is_match":{"type":"boolean","example":true},"result_reason":{"type":"string","example":"All properties were consistent"},"match_score":{"type":"number","example":0.6711888086280882},"property_match_results":{"type":"array","example":[{"property_matcher_id":1,"is_consistent":true,"is_match":true,"result_reason":"entity_types exactly match","match_score":1,"property_matcher_name":"Entity Type","is_property_matcher_mandatory":true,"weight":0}],"items":{"type":"object","description":"Each object represents a match reason"}}}},"security":{"type":"object"},"data_source":{"type":"string"},"id":{"type":"string"}}}},"comments":{"type":"array","items":{"type":"object","properties":{"namespace":{"type":"string","description":"The namespace the comment belongs to","example":"torch"},"target":{"type":"string","description":"The ID of the resource the comment belongs to","example":"document-56350b74-3981-4734-8076-62163bca2255"},"security":{"type":"object","description":"The comment's security block","example":{}},"body":{"type":"string","description":"The comment's content","example":"Hello, world"},"context":{"type":"string","description":"The alert the comment belongs to","example":"alert-10001"},"user":{"type":"object","description":"An object representing a user in the system.","required":["username","email","cn"],"properties":{"excludedApps":{"type":"array","items":{"type":"string"},"description":"A list of the applications that this user is excluded from accessing. Not used in Labyrinth Screening."},"username":{"type":"string","description":"The name of the user. This is the value displayed when the user is referenced in the UI."},"email":{"type":"string","description":"The email address of the user. Can be used as part of basic authentication."},"mobile":{"type":"string","description":"The mobile\/cell phone number of the user."},"roles":{"type":"array","items":{"type":"string"},"description":"A list of the user roles that this user has.\nLabyrinth Screening makes use of defined user roles to control the actions a user may perform and to tailor the interface to the needs of particular users.\nEach role is made up of a set of permissions which provide fine grained control over the actions a user can perform. Roles can be configured to match the business roles required by the users of the Screening system.\nThese permissions used by the Screening system are described in the Ripjar Security Implementation document.\nWhen users are loaded into the system, each user account should include the list of roles they are allowed to perform.\n"},"password":{"type":"string","description":"The user's password, used for basic authentication or to retrieve a bearer auth (JWT) token. Not available in API responses. Required when creating or updating users.\n"},"cn":{"type":"string","description":"The user's canonical name. Used to lookup user accounts when performing certificate-based authentication."},"externalId":{"type":"string","description":"The user's ID external to the system. Typically maps to a username or ID in an external user entitlement system."},"security":{"type":"object","description":"The security attributes for this user.\nA user's security attributes govern the data items in the system (such as clients, alerts and assessments) that the user has visibility of. These are distinct from the user's roles, which govern the operations a user can carry out in the system.\nThe security schema contains a set of generic attributes that the user can be assigned. The meaning of these attributes varies depending on the security policy installed on the system.\nBy default, the security policy will compare the list of strings (also known as tags) in dataRolesN fields of the user to the list of strings in the orTagsN field in the security attributes of the data item. If the user has any of the tags that appear on the data item, they can view that item.\nIf the data item has multiple orTags fields, for example orTags1 and orTags2, the user must has at least one of the tags in each of the corresponding dataRoles fields, i.e. there is an AND logic between each attribute.\n","properties":{"dataRoles1":{"type":"array","items":{"type":"string"}},"dataRoles2":{"type":"array","items":{"type":"string"}},"dataRoles3":{"type":"array","items":{"type":"string"}},"compositeDataRoles1":{"type":"array","items":{"type":"object"}}}}}},"clientKey":{"type":"string","description":"The client key of the comment","example":"lowercasekey"},"commentId":{"type":"number","description":"The ID of the comment","example":10001},"createdTimestamp":{"type":"number","description":"The time the comment was created, in epoch time","example":1602680554666}}}},"listEntity":{"description":"The list entity associated with this evidence. Present if the evidence is of type 'list' and the 'lists' enrichment is enabled","oneOf":[{"type":"object","allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}}],"properties":{"person":{"type":"object","description":"The person entity schema must contain the following fileds; firstName, middleName, surname, name\n","properties":{"name":{"type":"string","description":"Full name of the person. Can be used as well as, or instead of, fields for individual name parts"},"firstName":{"type":"string","description":"Given name of the person"},"surname":{"type":"string","description":"Family name of the person"},"aliases":{"type":"array","description":"An aray of alternative names by which a person is known. Fields in each name are as for the main name fields with some additions","items":{"type":"object","properties":{"type":{"type":"string"},"firstName":{"type":"string"},"surname":{"type":"string"},"middleName":{"type":"string"},"titleHonorific":{"type":"string"},"maidenName":{"type":"string"}}}},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER"],"description":"Known gender type of the person, must be in capitals"},"deceased":{"type":"boolean","description":"Is the person deceased?"},"birthPlace":{"type":"string","description":"The name of the persons birthplace. Populated automatically from birthPlaceCountryCode"},"birthPlaceCity":{"type":"string","description":"The persons city of birth"},"dateOfBirthArray":{"type":"array","description":"Possible values for the persons date of birth. This is an array to allow for the uncertanty in reported dates","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"images":{"type":"array","description":"URLs pointing to the images of, or related to, the person","items":{"type":"string"}},"birthPlaceCountryCode":{"type":"string","description":"The country code of the persons birth"},"citizenshipCode":{"type":"array","description":"Country codes of the countries for which the person has citizenship. May be more than one","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"residentOfCode":{"type":"array","description":"Country codes of the countries for which the person is domiciled. May be more than one","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"countryOfReportedAllegationCode":{"type":"array","description":"Country codes of the countries in which alleged misconduct took place. May be more than one","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"middleName":{"type":"string","description":"Middle name of the person"},"roles":{"type":"array","description":"Current jobs or roles of the person","items":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"categoryId":{"type":"string"},"since":{"type":"string","description":"Date in the form yyyy-mm-dd"}}}},"previousRoles":{"type":"array","description":"Past jobs or roles of the person","items":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"categoryId":{"type":"string"},"since":{"type":"string","description":"Date in the form yyyy-mm-dd"},"to":{"type":"string","description":"Date in the form yyyy-mm-dd"}}}},"jurisdictionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"deceasedDateArray":{"type":"array","description":"If the person is deceased (deceased=true), possible values for the persons date of death. This is an array to allow for uncertainty in reported cases"},"suffix":{"type":"string","description":"An honorific that comes after the person's name, rather than before"}}}}},{"type":"object","allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}}],"properties":{"company":{"type":"object","description":"The company entity schema must contain the following fields: name, keyTerms\n","properties":{"name":{"type":"string","description":"The companies main name"},"suffix":{"type":"string","description":"Company suffix, e.g. Ltd, PLC or GmbH"},"aliases":{"type":"array","description":"An array of alternative names by which a company is known","items":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"suffix":{"type":"string"},"entityName":{"type":"string"}}}},"dateOfRegistrationArray":{"type":"array","description":"Company registration dates\n","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"companyURLs":{"type":"array","description":"Associated URLs for the company","items":{"type":"string"}},"countryOfRegistrationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"countryOfAffiliationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"formerlySanctionedRegionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"sanctionedRegionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"cessationDateArray":{"type":"array","description":"For non-active companies, the date(s) on which the company ceased trading","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"keyTerms":{"type":"array","description":"Keywords used in entity matching to automatically match this list entity to client profiles that contain one or more of the key terms. Viewing the list entity will then show all linked client profiles","items":{"keyTerms":{"type":"string"}}}}}}},{"type":"object","allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}}],"properties":{"location":{"type":"object","description":"Location entities are an extension of entities. All of the base fields are included in addition to the fields defined below. \nLocations can be used to represent high risk countries, and can match with location fields on clients or other entities of \ninterest in order to highlight links between the entities and these countries.\n","properties":{"name":{"type":"string","description":"Name of the location"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"The country code of the location","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"locationType":{"type":"string","description":"This must be country"},"cities":{"type":"array","description":"A list of names of cities associated with this location","items":{"type":"string"}}}},"subType":{"type":"string","enum":["country","city","region","sub-region","free-trade-zone","airport","port"],"description":"The sub-type of a location entity"}}},{"allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}},{"type":"object","properties":{"entityType":{"type":"string","enum":["listVessel"]},"vesselCallSigns":{"type":"array","items":{"type":"string"}},"vesselTypes":{"type":"array","items":{"type":"string"}},"vesselTonnages":{"type":"array","items":{"type":"integer"}},"vesselOwners":{"type":"array","items":{"type":"string"}},"vesselCustomers":{"type":"array","items":{"type":"string"}},"vesselGrts":{"type":"array","items":{"type":"integer"}},"vesselFlags":{"type":"array","items":{"type":"string"}},"vesselFlagsCode":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"vesselImoNumber":{"type":"string"},"vesselAdditionalOperators":{"type":"array","items":{"type":"object","properties":{"operatorCategory":{"type":"string","enum":["groupBeneficialOwner","operator","registeredOwner","shipManager","technicalManager"]},"operatorName":{"type":"string"},"countryOfControl":{"type":"string"},"countryOfDomicile":{"type":"string"},"countryOfRegistration":{"type":"string"}}}}}}]},{"type":"object","allOf":[{"type":"object","allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}}],"properties":{"company":{"type":"object","description":"The company entity schema must contain the following fields: name, keyTerms\n","properties":{"name":{"type":"string","description":"The companies main name"},"suffix":{"type":"string","description":"Company suffix, e.g. Ltd, PLC or GmbH"},"aliases":{"type":"array","description":"An array of alternative names by which a company is known","items":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"suffix":{"type":"string"},"entityName":{"type":"string"}}}},"dateOfRegistrationArray":{"type":"array","description":"Company registration dates\n","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"companyURLs":{"type":"array","description":"Associated URLs for the company","items":{"type":"string"}},"countryOfRegistrationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"countryOfAffiliationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"formerlySanctionedRegionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"sanctionedRegionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"cessationDateArray":{"type":"array","description":"For non-active companies, the date(s) on which the company ceased trading","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"keyTerms":{"type":"array","description":"Keywords used in entity matching to automatically match this list entity to client profiles that contain one or more of the key terms. Viewing the list entity will then show all linked client profiles","items":{"keyTerms":{"type":"string"}}}}}}}],"properties":{"aircraft":{"type":"object","description":"Aircraft entities are an extension of company entities. As well as the base fields and aircraft-specific fields, all company properties are also included.\n","properties":{"name":{"type":"string","description":"The aircraft's tail number. The prefix of the tail number is used to determine the aircraft's country of origin."}}}}}],"discriminator":{"propertyName":"entityType","mapping":{"listPerson":".\/ListEntityPerson.yaml","listAircraft":".\/ListEntityAircraft.yaml","listLocation":".\/ListEntityLocation.yaml","listOrganisation":".\/ListEntityOrganisation.yaml","listVessel":".\/ListEntityVessel.yaml"}}}}},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}]}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthenticated request"},"403":{"description":"Unauthorised request"},"500":{"description":"Internal Server Error"}}}},"\/pdf\/export\/create\/alert":{"post":{"operationId":"createAlertPDFExport","summary":"Create a PDF Export","description":"Returns a Job ID which can be used to check the status of the export. Once complete the ID can be used to request the full PDF document from the download endpoint\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 189 ms |\n| 90th percentile | 230 ms |\n| 95th percentile | 242 ms |\n| 98th percentile | 267 ms |\n| 99th percentile | 325 ms |\n<!-- operational-characteristics:end -->\n","tags":["PDF Export"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":188.13,"p90":229.51,"p95":241.19,"p98":266.37,"p99":324.86,"sampleSize":4568}},"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","description":"Request body to create an Alert PDF export","required":["alertId","evidenceSortOrder"],"properties":{"options":{"type":"array","description":"Features to include in the PDF output.\n\"coverPage\" - Cover page\n\"toc\" - Table of contents page\n\"markup\" - Markup within documents\n\"fullProfiles\" - Include full profiles\n\"alertComments\" - Alert comments\n\"closureSummary\" - Include closure summary for closed alerts\n\"groupEvidence\" - Group evidence\n\"groupMastersOnly\" - Only show first article in storyline\n","items":{"type":"string","enum":["coverPage","toc","markup","fullProfiles","alertComments","closureSummary","groupEvidence","groupMastersOnly"]}},"comment":{"type":"string","description":"A comment to add to the PDF"},"evidenceIds":{"type":"array","items":{"type":"number","description":"An array of individual evidence ID's to include. When used PDF will only contain these pieces of evidence"}},"evidenceSortOrder":{"type":"string","description":"Dot notation a property on the evidence model followed by the direction of sort","example":"reasons.matchScore:-1"},"configurableBuckets":{"description":"The name of the current bucket to export","type":"array","items":{"type":"string"},"example":["Relevant"]},"alertId":{"type":"number"},"location":{"type":"string","description":"String printed in the footer of each page of the created PDF."},"locale":{"type":"string","description":"2 letter locale code","example":"en","enum":["en","fr","de","it"]},"contentFilters":{"type":"object","description":"For filtering the data within AME tables, will be applied to the generated PDF"},"filter":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string","example":"list-PEP"}},"range":{"type":"object","properties":{"createdTimestamp":{"type":"object","properties":{"gte":{"type":"number","format":"unix timestamp seconds"},"lte":{"type":"number","format":"unix timestamp seconds"}}}}},"type":{"type":"array","items":{"type":"string","example":"list"}},"assessmentOrFilter":{"type":"object","properties":{"unassessed":{"type":"boolean"},"assessed":{"type":"boolean"},"bookmarked":{"type":"boolean"},"codes":{"type":"array","items":{"type":"integer"}}}},"includeCommentCounts":{"type":"boolean"},"realerting":{"type":"string"},"sort":{"type":"string","description":"dot notation of the key followed by colon and direction of sort integer","example":"reasons.matchScore:-1"},"unassessed":{"type":"boolean"}}}}}}}},"responses":{"200":{"description":"An ID of the PDF export","content":{"application\/json":{"schema":{"type":"object","properties":{"job":{"type":"object","properties":{"id":{"type":"number"},"state":{"type":"string"},"user":{"type":"object","properties":{"id":{"type":"number"},"username":{"type":"string"}}},"time":{"type":"object","description":"Dictionary containing state transitions with the EPOCH they occurred at","additionalProperties":{"type":"number"},"example":{"start":1234455678,"in progress":1234455678,"done":1234455678}},"tags":{"type":"array","items":{"type":"string","example":"PDF"}},"namespace":{"type":"string"},"clientKey":{"type":"string"},"transitions":{"description":"Array of state transition history for the PDF generation job","type":"array","items":{"type":"object","properties":{"from":{"type":"number"},"to":{"type":"number"},"description":{"type":"string","example":"job complete"},"fromValue":{"type":"string","example":"in progress"},"toValue":{"type":"string","example":"done"}}}},"metadata":{"type":"object","additionalProperties":true,"description":"Arguments passed to the PDF generation process includes defaults"}}}}}}},"links":{"pdfStatusCheck":{"operationId":"statusPDFExport","parameters":{"job_id":"$response.body#\/job\/id"},"description":"The `id` value returned in the response can be used as the `job_id` parameter in `GET \/pdf\/export\/status\/{job_id}`.\n"},"pdfDownload":{"operationId":"pdfDownload","parameters":{"job_id":"$response.body#\/job\/id"},"description":"The `id` value returned in the response can be used as the `job_id` parameter in `GET \/pdf\/export\/download\/{job_id}`.\n"}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"403":{"description":"Forbidden (e.g. the user does not have the correct permission)","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/pdf\/export\/create\/assessment":{"post":{"summary":"Create a PDF Export","description":"Returns a Job ID which can be used to check the status of the export. Once complete the ID can be used to request the full PDF document from the download endpoint\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 94 ms |\n| 90th percentile | 104 ms |\n| 95th percentile | 109 ms |\n| 98th percentile | 121 ms |\n| 99th percentile | 140 ms |\n<!-- operational-characteristics:end -->\n","operationId":"createAssessmentPDFExport","tags":["PDF Export"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":93.64,"p90":103.48,"p95":108.77,"p98":120.19,"p99":139.57,"sampleSize":77950}},"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","description":"Request body to create a PDF export","required":["assessmentId","evidenceSortOrder"],"properties":{"options":{"type":"array","description":"Features to include in the PDF output.\n\"coverPage\" - Cover page\n\"toc\" - Table of contents page\n\"markup\" - Markup within documents\n\"assessmentSummary\" - Summary of the assessment\n\"closureSummary\" - Include closure summary for closed assessments\n\"groupEvidence\" - Group evidence\n\"groupMastersOnly\" - Only show first article in storyline\n","items":{"type":"string","enum":["coverPage","toc","markup","assessmentSummary","closureSummary","fullProfiles","groupEvidence","groupMastersOnly"]}},"comment":{"type":"string","description":"A comment to add to the PDF"},"evidenceSortOrder":{"type":"string","description":"Dot notation a property on the evidence model followed by the direction of sort","example":"reasons.matchScore:-1"},"configurableBuckets":{"description":"The name of the current bucket to export","type":"array","items":{"type":"string"},"example":["Relevant"]},"assessmentId":{"type":"string"},"evidenceIds":{"type":"array","items":{"type":"number","description":"An array of individual evidence ID's to include. When used PDF will only contain these pieces of evidence"}},"location":{"type":"string","description":"String printed in the footer of each page of the created PDF."},"locale":{"type":"string","description":"2 letter locale code","example":"en","enum":["en","fr","de","it"]},"contentFilters":{"type":"object","description":"For filtering the data within AME tables, will be applied to the generated PDF"},"filter":{"type":"object","properties":{"riskTags":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string","example":"list-PEP"}},"range":{"type":"object","properties":{"createdTimestamp":{"type":"object","properties":{"gte":{"type":"number","format":"unix timestamp seconds"},"lte":{"type":"number","format":"unix timestamp seconds"}}}}},"includeCommentCounts":{"type":"boolean"},"realerting":{"type":"string"},"sort":{"type":"string","description":"Dot notation a property on the evidence model followed by the direction of sort","example":"reasons.matchScore:-1"}}}}}}}},"responses":{"200":{"description":"An ID of the PDF export","content":{"application\/json":{"schema":{"type":"object","properties":{"job":{"type":"object","properties":{"id":{"type":"number"},"state":{"type":"string"},"user":{"type":"object","properties":{"id":{"type":"number"},"username":{"type":"string"}}},"time":{"type":"object","description":"Dictionary containing state transitions with the EPOCH they occurred at","additionalProperties":{"type":"number"},"example":{"start":1234455678,"in progress":1234455678,"done":1234455678}},"tags":{"type":"array","items":{"type":"string","example":"PDF"}},"namespace":{"type":"string"},"clientKey":{"type":"string"},"transitions":{"description":"Array of state transition history for the PDF generation job","type":"array","items":{"type":"object","properties":{"from":{"type":"number"},"to":{"type":"number"},"description":{"type":"string","example":"job complete"},"fromValue":{"type":"string","example":"in progress"},"toValue":{"type":"string","example":"done"}}}},"metadata":{"type":"object","additionalProperties":true,"description":"Arguments passed to the PDF generation process includes defaults"}}}}}}},"links":{"pdfStatusCheck":{"operationId":"statusPDFExport","parameters":{"job_id":"$response.body#\/job\/id"},"description":"The `id` value returned in the response can be used as the `job_id` parameter in `GET \/pdf\/export\/status\/{job_id}`.\n"},"pdfDownload":{"operationId":"pdfDownload","parameters":{"job_id":"$response.body#\/job\/id"},"description":"The `id` value returned in the response can be used as the `job_id` parameter in `GET \/pdf\/export\/download\/{job_id}`.\n"}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"403":{"description":"Forbidden (e.g. the user does not have the correct permission)","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/pdf\/export\/create\/search":{"post":{"operationId":"createSearchPDFExport","summary":"Create a PDF Export","description":"Returns a Job ID which can be used to check the status of the export. Once complete the ID can be used to request the full PDF document from the download endpoint\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nOperational data for this endpoint has not yet been collected.\n<!-- operational-characteristics:end -->\n","tags":["PDF Export"],"x-operational-characteristics":{"description":"Operational characteristics not yet collected from production logs.\n"},"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","description":"Request body to create a PDF export","required":["searchString","locale"],"properties":{"contentFilters":{"type":"object","description":"For filtering the data within AME tables, will be applied to the generated PDF"},"options":{"type":"array","description":"Features to include in the PDF output.\n\"coverPage\" - Cover page\n\"toc\" - Table of contents page\n\"markup\" - Markup within documents\n\"profiles\" - Include profiles\n\"alerts\" - Include alerts\n\"fullProfiles\" - Include full profiles\n","items":{"type":"string","enum":["coverPage","toc","markup","profiles","alerts","fullProfiles"]}},"comment":{"type":"string","description":"A comment to add to the PDF"},"isKeywordSeach":{"type":"boolean"},"searchString":{"type":"string"},"locale":{"type":"string","description":"2 letter locale code","example":"en","enum":["en","fr","de","it"]},"searchFilters":{"oneOf":[{"description":"Entity Search filter","type":"object","required":["entity","keyword"],"properties":{"entity":{"type":"object","properties":{"type":{"type":"string","description":"The target entity type to perform search on","enum":["person","organisation","vessel","aircraft","unknown"]}},"description":"Key \/ array value pairings, where the key matches a key on the underlying entity schema and the array contains the search values e.g 'name:[\"putin\"]' or 'identityNumbers:[1234, 12234]'","additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"number"}]}}]}},"fuzziness":{"type":"string"},"relationships":{"type":"boolean"}}},{"description":"Entity Search filter","type":"object","required":["keyword"],"properties":{"keyword":{"type":"object","properties":{"models":{"type":"array","items":{"type":"string","example":"Source of Wealth"}},"providers":{"type":"array","items":{"type":"string","example":"lexisnexus"}},"sources":{"type":"array","items":{"type":"string"}},"date":{"type":"object","additionalProperties":true}}}}},{"description":"Entity Search filter","type":"object","required":["entity"],"properties":{"entity":{"type":"object","properties":{"profileId":{"type":"string"}}},"fuzziness":{"type":"string"},"relationships":{"type":"boolean"}}}]}}}}}},"responses":{"200":{"description":"An ID of the PDF export","content":{"application\/json":{"schema":{"type":"object","properties":{"job":{"type":"object","properties":{"id":{"type":"number"},"state":{"type":"string"},"user":{"type":"object","properties":{"id":{"type":"number"},"username":{"type":"string"}}},"time":{"type":"object","description":"Dictionary containing state transitions with the EPOCH they occurred at","additionalProperties":{"type":"number"},"example":{"start":1234455678,"in progress":1234455678,"done":1234455678}},"tags":{"type":"array","items":{"type":"string","example":"PDF"}},"namespace":{"type":"string"},"clientKey":{"type":"string"},"transitions":{"description":"Array of state transition history for the PDF generation job","type":"array","items":{"type":"object","properties":{"from":{"type":"number"},"to":{"type":"number"},"description":{"type":"string","example":"job complete"},"fromValue":{"type":"string","example":"in progress"},"toValue":{"type":"string","example":"done"}}}},"metadata":{"type":"object","additionalProperties":true,"description":"Arguments passed to the PDF generation process includes defaults"}}}}}}},"links":{"pdfStatusCheck":{"operationId":"statusPDFExport","parameters":{"job_id":"$response.body#\/job\/id"},"description":"The `id` value returned in the response can be used as the `job_id` parameter in `GET \/pdf\/export\/status\/{job_id}`.\n"},"pdfDownload":{"operationId":"pdfDownload","parameters":{"job_id":"$response.body#\/job\/id"},"description":"The `id` value returned in the response can be used as the `job_id` parameter in `GET \/pdf\/export\/download\/{job_id}`.\n"}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"403":{"description":"Forbidden (e.g. the user does not have the correct permission)","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/pdf\/export\/list":{"get":{"operationId":"listPDFExport","summary":"List PDF exports","description":"Returns a list of previously requested PDF export jobs.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","tags":["PDF Export"],"responses":{"200":{"description":"List of PDF export jobs","content":{"application\/json":{"schema":{"type":"array","items":{"type":"object","required":["id","state","time","filename"],"properties":{"id":{"type":"number"},"state":{"type":"string"},"time":{"type":"object","description":"Dictionary containing state transitions with the EPOCH they occurred at","additionalProperties":{"type":"number"},"example":{"start":1234455678,"in progress":1234455678,"done":1234455678}},"filename":{"type":"string","example":"alert-1234.pdf"}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"403":{"description":"Forbidden (e.g. the user does not have the correct permission)","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/pdf\/export\/status\/{job_id}":{"get":{"operationId":"statusPDFExport","summary":"Check the status of a PDF export job","description":"Returns the status of a given job id\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n*Generated from limited sample size.*\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 8 ms |\n| 90th percentile | 125 ms |\n| 95th percentile | 468 ms |\n| 98th percentile | 927 ms |\n| 99th percentile | 1.1 s |\n<!-- operational-characteristics:end -->\n","tags":["PDF Export"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":8,"p90":124.3,"p95":467.85,"p98":926.6,"p99":1096.8,"sampleSize":38}},"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"number"}}],"responses":{"200":{"description":"An ID of the PDF export","content":{"application\/json":{"schema":{"type":"object","properties":{"pdfId":{"type":"string","format":"uuid"},"state":{"description":"Once the state has reached done the download endpoint can be used to retried the PDF","type":"string","enum":["done","in progress"]}}},"example":{"id":1234,"state":"in progress"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden (e.g. the user does not have the correct permission)"},"404":{"description":"PDF Export Job cannot be found usually indicates the job_id parameter is incorrect","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/pdf\/export\/download\/{job_id}":{"get":{"operationId":"downloadPDFExport","summary":"Download PDF export","description":"Given a job ID, returns the generated PDF (If the job status is 'done'). It is recommended to save a copy of the response as the generated document will be pruned from the system after 24 hours\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n*Generated from limited sample size.*\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 6 ms |\n| 90th percentile | 191 ms |\n| 95th percentile | 377 ms |\n| 98th percentile | 544 ms |\n| 99th percentile | 567 ms |\n<!-- operational-characteristics:end -->\n","tags":["PDF Export"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":6,"p90":191,"p95":376.25,"p98":543.5,"p99":566.25,"sampleSize":36}},"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"number"}}],"responses":{"200":{"description":"Generated PDF","content":{"application\/pdf":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden (e.g. the user does not have the correct permission)"},"404":{"description":"PDF Export Job cannot be found usually indicates the job_id parameter is incorrect","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/excel\/export\/create":{"post":{"operationId":"createExcelExport","summary":"Create an Excel Export","description":"Creates a new Excel export job for client screening results using simplified parameters. Specify the export type, date range, and optional filters. Returns job ID which can be used to check the status and download the completed export. Maximum number of clients per export is 750,000.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n*Generated from limited sample size.*\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 146 ms |\n| 90th percentile | 573 ms |\n| 95th percentile | 693 ms |\n| 98th percentile | 778 ms |\n| 99th percentile | 869 ms |\n<!-- operational-characteristics:end -->\n","tags":["Excel Export"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":146,"p90":573,"p95":692.75,"p98":777.3,"p99":868.65,"sampleSize":46}},"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","description":"Simplified request body for creating an Excel export","required":["exportType","dateRange"],"properties":{"exportType":{"type":"string","description":"The type of export to create, which determines which sheets are included","enum":["ALERTS_CLIENTS_EVIDENCE_WITH_REASONS","CLIENTS_ONLY","CLIENTS_ALERTS","CLIENTS_ALERTS_EVIDENCE"],"example":"CLIENTS_ONLY"},"dateRange":{"type":"string","description":"The time range for the data to include in the export","enum":["LAST_24_HOURS","LAST_WEEK","LAST_MONTH","LAST_6_MONTHS","LAST_YEAR","LAST_2_YEARS"],"example":"LAST_24_HOURS"},"filters":{"type":"object","description":"Optional filters to narrow down the export results","properties":{"nameOrId":{"type":"string","description":"Filter by client name or ID (supports partial matching)","minLength":1,"maxLength":1000,"example":"some-client-id-123"},"segment":{"type":"string","description":"Filter by client segment","minLength":1,"maxLength":1000,"example":"HIGH_RISK"},"entityType":{"type":"array","description":"Filter by entity types","items":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"example":["PERSON","ORGANISATION"],"uniqueItems":true}}}}}}}},"responses":{"200":{"description":"Excel export job created successfully","content":{"application\/json":{"schema":{"type":"object","description":"Response containing only the job ID of the created Excel export job","required":["id"],"properties":{"id":{"type":"number","description":"Unique numeric identifier for the export job","example":110}}}}},"links":{"excelStatusCheck":{"operationId":"getExcelExportStatus","parameters":{"jobId":"$response.body#\/id"},"description":"The `id` value returned in the response can be used as the `jobId` parameter in `GET \/excel\/export\/status\/{jobId}`.\n"},"excelDownload":{"operationId":"downloadExcelExport","parameters":{"jobId":"$response.body#\/id"},"description":"The `id` value returned in the response can be used as the `jobId` parameter in `GET \/excel\/export\/download\/{jobId}`.\n"}}},"400":{"description":"Bad Request - Invalid request parameters","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"401":{"description":"Unauthorized - Authentication required","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/excel\/export\/status\/{jobId}":{"get":{"operationId":"getExcelExportStatus","summary":"Get Excel Export Status","description":"Retrieves the current status of an Excel export job.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n*Generated from limited sample size.*\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 22 ms |\n| 90th percentile | 77 ms |\n| 95th percentile | 77 ms |\n| 98th percentile | 78 ms |\n| 99th percentile | 79 ms |\n<!-- operational-characteristics:end -->\n","tags":["Excel Export"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":22,"p90":77,"p95":77,"p98":78,"p99":78.99,"sampleSize":102}},"parameters":[{"name":"jobId","in":"path","required":true,"description":"The unique identifier of the export job","schema":{"type":"number","example":110}}],"responses":{"200":{"description":"Export status retrieved successfully","content":{"application\/json":{"schema":{"type":"object","description":"Response containing the essential status information of an Excel export job","required":["id","state"],"properties":{"id":{"type":"number","description":"Unique numeric identifier for the export job","example":110},"state":{"type":"string","description":"Current state of the export job","enum":["queued","running","completed","errored"],"example":"completed"}}}}},"links":{"excelDownload":{"operationId":"downloadExcelExport","parameters":{"jobId":"$response.body#\/id"},"description":"The `id` value returned in the response can be used as the `jobId` parameter in `GET \/excel\/export\/download\/{jobId}`.\n"}}},"400":{"description":"Bad Request - Invalid export ID","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"401":{"description":"Unauthorized - Authentication required","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"404":{"description":"Not Found - Export job not found","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/excel\/export\/download\/{jobId}":{"get":{"operationId":"downloadExcelExport","summary":"Download Excel Export","description":"Downloads the completed Excel export file as a ZIP file. Each compressed file will be an Excel workbook - each containing worksheet(s) of up to 500,000 rows each.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n*Generated from limited sample size.*\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 30 ms |\n| 90th percentile | 152 ms |\n| 95th percentile | 300 ms |\n| 98th percentile | 1.3 s |\n| 99th percentile | 1.7 s |\n<!-- operational-characteristics:end -->\n","tags":["Excel Export"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":29.5,"p90":151.3,"p95":299.95,"p98":1348.18,"p99":1697.59,"sampleSize":20}},"parameters":[{"name":"jobId","in":"path","required":true,"description":"The unique identifier of the export job","schema":{"type":"number","example":110}}],"responses":{"200":{"description":"Excel export file downloaded successfully","content":{"application\/octet-stream":{"schema":{"type":"string","format":"binary","description":"Excel export file in the appropriate format"}}}},"400":{"description":"Bad Request - Invalid export ID","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"401":{"description":"Unauthorized - Authentication required","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"404":{"description":"Not Found - Export job not found or not completed","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/assessment":{"get":{"summary":"Get assessments","description":"Returns a paged list of assessments\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"assessmentGet","tags":["Assessment"],"parameters":[{"in":"query","name":"pageSize","required":false,"schema":{"type":"integer"}},{"in":"query","name":"page","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns the assessment objects with dig-basic tags removed\n","content":{"application\/json":{"schema":{"type":"object","allOf":[{"type":"object","required":["hasMore","total","data"],"properties":{"incompleteResultSet":{"type":"boolean","description":"if set to true indicates that the server did not include all name matches when the name parameter was included","example":true},"hasMore":{"type":"boolean","description":"a convenience boolean to determine whether there is more data to page through","example":true},"total":{"type":"number","description":"the total number of results available to page through","example":1035},"data":{"type":"array","description":"an array of assessments","items":{"type":"object","allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Human friendly unique identifier for this assessment","example":"AS-26"},"assessmentRange":{"type":"object","description":"The date range the assessment ran against","required":["gte","lte"],"properties":{"gte":{"type":"number","description":"unix timestamp (lower bound)","example":1539954158521},"lte":{"type":"number","description":"unix timestamp (upper bound)"}}},"precision":{"type":"string","description":"assessment search precision","example":"torch"},"options":{"type":"object","example":{"languages":[]},"description":"The options used when the assessment was created"},"security":{"type":"object","description":"The security label applied to this assessment as per the Ripjar Security Model"},"searchType":{"type":"number","description":"the policy ID to use when determining which policies apply to this assessment","example":10002},"entities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"John Smith"},"entityType":{"type":"string","enum":["searchperson","searchorganisation","searchvessel","searchaircraft","searchunknown"],"example":"searchperson"},"aliases":{"type":"array","items":{"type":"string"},"description":"Alternate names for the entity"},"id":{"type":"string","description":"Unique identifier for this entity under assessment","example":"assessment:3f9cbec5-a322-4b3c-9275-4d06e8737624"},"result":{"type":"object","properties":{"id":{"type":"number","example":25514},"state":{"type":"number","format":"int64","description":"Numerical representation of the internal alert state (e.g. opened, closed, etc).","example":2},"status":{"type":"number","description":"A 3 digit number made up of internal alert state (1 digit) and the alert status as configured by your system administrator (2 digits).","example":200},"reason":{"type":"number","description":"A number which represents the closure reason as configured by your system administrator.","example":1},"timestamp":{"type":"number","description":"last updated timestamp for the internal alert"},"comment":{"type":"object","properties":{"value":{"type":"string","description":"comment text"},"user":{"type":"object","properties":{"email":{"type":"string","example":"test@ripjar.com"},"externalId":{"type":"string","example":"test@ripjar.com"},"cn":{"type":"string","example":"test@ripjar.com"},"id":{"type":"number","example":10006}}}}},"history":{"type":"array","description":"The assignment history of the assessment","items":{"type":"object","properties":{"assignedUsers":{"example":[{"username":"John Smith","email":"john.smith@ripjar.com","externalId":"john.smith@ripjar.com","mobile":"01234567890","roles":["ROLE_1"],"cn":"john.smith@ripjar.com","clientKey":"lowercasekey","customerExcludedApps":["app"],"security":{},"lastLogin":1596188918065,"username_lowercase":"john smith","lineNumber":4,"lastModified":1595437138430,"id":10003,"dateCreated":1595437138459}],"oneOf":[{"type":"array","description":"IDs of users assigned to the result, returned when results enrichment is disabled","items":{"type":"number"},"example":[1]},{"type":"array","description":"Objects representing users assigned to the result, returned when results enrichment is enabled","items":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}},"components":{"schemas":{"AssignedUserEnriched":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}}}}}]},"timestamp":{"type":"integer","description":"The timestamp for when the assessment was assigned"},"state":{"type":"integer","description":"The state code"},"status":{"type":"integer","description":"The status code"}}}},"assignedUsers":{"type":"array","items":{"type":"object","description":"User objects for any user accounts currently assigned to the assessment","properties":{"email":{"type":"string","example":"test@ripjar.com"},"externalId":{"type":"string","example":"test@ripjar.com"},"cn":{"type":"string","example":"test@ripjar.com"},"id":{"type":"number","example":10006}}}}}}}}}}}],"properties":{"createdBy":{"type":"object","description":null,"properties":{"username":{"type":"string","description":"the username for this user","example":"admin"},"id":{"type":"number","description":"unique identifier for this user","example":10001}}},"clientKey":{"type":"string","description":"the customer ID","example":"lowercasekey"},"namespace":{"type":"string","description":"system namespace","example":"torch"},"label":{"type":"string","description":"the name which was searched","example":"John Smith"},"created":{"type":"number","description":"created at (unix timestamp)","example":1603113059520},"updated":{"type":"number","description":"last updated at (unix timestamp)","example":1603113059520},"irsVersion":{"type":"number","description":"the revision the identity resolution service was at when the assessment was created","example":225670},"state":{"type":"object","required":["state"],"properties":{"state":{"type":"string","description":"Top-level state of the assessment","enum":["IN_PROGRESS","COMPLETED_NO_HITS","COMPLETED_WITH_HITS","ERRORED","CLOSED"]}}},"policyId":{"type":"number","description":"the id for the matched policy","example":10001},"tags":{"type":"array","description":"Metadata related to the assessment","example":["context-assessment"],"items":{"type":"string"}},"groupContext":{"type":"object","required":["isPrimary","groupId"],"properties":{"isPrimary":{"type":"boolean","description":"if this assessment is the primary one of the group","example":false},"groupId":{"type":"string","description":"id of the group","example":"03b9a256-9524-4ed8-9d23-84a213793b7b"},"relationship":{"type":"object","properties":{"type":{"type":"string","description":"type of relationship between assessed entity and the primary assessment","example":"FRIEND"}}}}}}}}}}],"properties":{"data":{"type":"array","description":"an array of assessments","items":{"type":"object","allOf":[{"type":"object","allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Human friendly unique identifier for this assessment","example":"AS-26"},"assessmentRange":{"type":"object","description":"The date range the assessment ran against","required":["gte","lte"],"properties":{"gte":{"type":"number","description":"unix timestamp (lower bound)","example":1539954158521},"lte":{"type":"number","description":"unix timestamp (upper bound)"}}},"precision":{"type":"string","description":"assessment search precision","example":"torch"},"options":{"type":"object","example":{"languages":[]},"description":"The options used when the assessment was created"},"security":{"type":"object","description":"The security label applied to this assessment as per the Ripjar Security Model"},"searchType":{"type":"number","description":"the policy ID to use when determining which policies apply to this assessment","example":10002},"entities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"John Smith"},"entityType":{"type":"string","enum":["searchperson","searchorganisation","searchvessel","searchaircraft","searchunknown"],"example":"searchperson"},"aliases":{"type":"array","items":{"type":"string"},"description":"Alternate names for the entity"},"id":{"type":"string","description":"Unique identifier for this entity under assessment","example":"assessment:3f9cbec5-a322-4b3c-9275-4d06e8737624"},"result":{"type":"object","properties":{"id":{"type":"number","example":25514},"state":{"type":"number","format":"int64","description":"Numerical representation of the internal alert state (e.g. opened, closed, etc).","example":2},"status":{"type":"number","description":"A 3 digit number made up of internal alert state (1 digit) and the alert status as configured by your system administrator (2 digits).","example":200},"reason":{"type":"number","description":"A number which represents the closure reason as configured by your system administrator.","example":1},"timestamp":{"type":"number","description":"last updated timestamp for the internal alert"},"comment":{"type":"object","properties":{"value":{"type":"string","description":"comment text"},"user":{"type":"object","properties":{"email":{"type":"string","example":"test@ripjar.com"},"externalId":{"type":"string","example":"test@ripjar.com"},"cn":{"type":"string","example":"test@ripjar.com"},"id":{"type":"number","example":10006}}}}},"history":{"type":"array","description":"The assignment history of the assessment","items":{"type":"object","properties":{"assignedUsers":{"example":[{"username":"John Smith","email":"john.smith@ripjar.com","externalId":"john.smith@ripjar.com","mobile":"01234567890","roles":["ROLE_1"],"cn":"john.smith@ripjar.com","clientKey":"lowercasekey","customerExcludedApps":["app"],"security":{},"lastLogin":1596188918065,"username_lowercase":"john smith","lineNumber":4,"lastModified":1595437138430,"id":10003,"dateCreated":1595437138459}],"oneOf":[{"type":"array","description":"IDs of users assigned to the result, returned when results enrichment is disabled","items":{"type":"number"},"example":[1]},{"type":"array","description":"Objects representing users assigned to the result, returned when results enrichment is enabled","items":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}},"components":{"schemas":{"AssignedUserEnriched":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}}}}}]},"timestamp":{"type":"integer","description":"The timestamp for when the assessment was assigned"},"state":{"type":"integer","description":"The state code"},"status":{"type":"integer","description":"The status code"}}}},"assignedUsers":{"type":"array","items":{"type":"object","description":"User objects for any user accounts currently assigned to the assessment","properties":{"email":{"type":"string","example":"test@ripjar.com"},"externalId":{"type":"string","example":"test@ripjar.com"},"cn":{"type":"string","example":"test@ripjar.com"},"id":{"type":"number","example":10006}}}}}}}}}}}],"properties":{"createdBy":{"type":"object","description":null,"properties":{"username":{"type":"string","description":"the username for this user","example":"admin"},"id":{"type":"number","description":"unique identifier for this user","example":10001}}},"clientKey":{"type":"string","description":"the customer ID","example":"lowercasekey"},"namespace":{"type":"string","description":"system namespace","example":"torch"},"label":{"type":"string","description":"the name which was searched","example":"John Smith"},"created":{"type":"number","description":"created at (unix timestamp)","example":1603113059520},"updated":{"type":"number","description":"last updated at (unix timestamp)","example":1603113059520},"irsVersion":{"type":"number","description":"the revision the identity resolution service was at when the assessment was created","example":225670},"state":{"type":"object","required":["state"],"properties":{"state":{"type":"string","description":"Top-level state of the assessment","enum":["IN_PROGRESS","COMPLETED_NO_HITS","COMPLETED_WITH_HITS","ERRORED","CLOSED"]}}},"policyId":{"type":"number","description":"the id for the matched policy","example":10001},"tags":{"type":"array","description":"Metadata related to the assessment","example":["context-assessment"],"items":{"type":"string"}},"groupContext":{"type":"object","required":["isPrimary","groupId"],"properties":{"isPrimary":{"type":"boolean","description":"if this assessment is the primary one of the group","example":false},"groupId":{"type":"string","description":"id of the group","example":"03b9a256-9524-4ed8-9d23-84a213793b7b"},"relationship":{"type":"object","properties":{"type":{"type":"string","description":"type of relationship between assessed entity and the primary assessment","example":"FRIEND"}}}}}}}],"properties":{"closureDate":{"type":"number","description":"assessment closure date (unix timestamp)","example":1603113059521}}}}}}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthenticated request"},"403":{"description":"Forbidden (e.g. the user does not have the ListSearch permission)"},"404":{"description":"Not found"},"500":{"description":"Internal server error"}}},"post":{"summary":"Create an assessment","description":"This creates a new Assessment for a new entity, returning an assessment ID\nthat can be used to request the status and detail of the assessment.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 325 ms |\n| 90th percentile | 417 ms |\n| 95th percentile | 484 ms |\n| 98th percentile | 561 ms |\n| 99th percentile | 651 ms |\n<!-- operational-characteristics:end -->\n","operationId":"assessmentCreate","tags":["Assessment"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":324.86,"p90":416.28,"p95":483.02,"p98":560.44,"p99":650.23,"sampleSize":50464}},"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["entity","options"],"properties":{"entity":{"type":"object","required":["name","entityType"],"properties":{"aliases":{"type":"array","items":{"type":"string"},"description":"Alternate names for the entity"},"associatedCities":{"type":"array","items":{"type":"string"},"description":"Associated cities if assessing unknown entity type"},"associatedCountryCodes":{"type":"array","description":"Country codes if assessing unknown entity type","items":{"type":"string"}},"dateOfBirth":{"type":"string","format":"date","description":"Date of birth if assessing a person"},"dateOfIncorporation":{"type":"string","format":"date","description":"Date of incorporation if assessing an organisation"},"domicileCodes":{"type":"array","description":"Domicile codes if assessing a person","items":{"type":"string"}},"domiciles":{"type":"array","description":"Domiciles if assessing a person","items":{"type":"string"}},"entityType":{"type":"string","enum":["searchperson","searchorganisation","searchvessel","searchaircraft","searchunknown"]},"externalId":{"type":"string","description":"External identifier for this entity under assessment"},"freeTextItems":{"type":"array","description":"free-text key-value pairs for the entity","items":{"type":"object","required":["fieldId","value"],"properties":{"fieldId":{"type":"string","description":"The free-text field id (or key)"},"value":{"type":"string","description":"The free-text field value"}}}},"gender":{"type":"string","description":"Gender if assessing a person","enum":["MALE","FEMALE"]},"identityNumbers":{"type":"array","description":"Identity numbers for the entity","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","description":"The identity number type"},"value":{"type":"string","description":"The identity number value"}}}},"incorporationCountry":{"type":"string","description":"Country of incorporation if assessing an organisation"},"incorporationCountryCode":{"type":"string","description":"Country code for country of incorporation if assessing an organisation"},"name":{"type":"string","description":"The canonical name of an entity"},"nationalities":{"type":"array","description":"Nationalities if assessing a person","items":{"type":"string"}},"nationalityCodes":{"type":"array","items":{"type":"string"},"description":"Nationality codes if assessing a person"},"screeningReqID":{"type":"string","description":"The screening request ID"},"vesselCallSigns":{"type":"array","description":"Call signs if assessing a vessel","items":{"type":"string"}},"vesselFlags":{"type":"array","description":"Vessel flags if assessing a vessel","items":{"type":"string"}},"vesselFlagsCode":{"type":"array","description":"Vessel flag codes if assessing a vessel","items":{"type":"string"}}}},"options":{"type":"object","description":"Important options to control the assessment","required":["searchType","assessmentRange","security"],"properties":{"searchType":{"type":"number","description":"The id of the search type the assessment will be run against"},"precision":{"type":"string","description":"Which matching strategy is used to connect the input to other entities in the system. Deprecated as searchType contains policy id that has the precision defined in it.","deprecated":true},"assessmentRange":{"type":"object","description":"The date range for the assessment to run against","required":["gte","lte"],"properties":{"gte":{"type":"number","description":"Match to artefacts greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to artefacts less than this unix timestamp (milliseconds)"}}},"languages":{"type":"array","items":{"type":"string"},"description":"Filter over languages of news articles during assessment. If left empty no filtering will occur"}}},"security":{"type":"object","description":"Security object for the assessment and anything derived from it"}}},"examples":{"Person":{"value":{"entity":{"entityType":"searchperson","name":"Bobbly Tables","aliases":["Bob Tables","Robert Tables"],"gender":"MALE","dateOfBirth":"1995-05-04","nationalityCodes":["US","GB"],"domicileCodes":["US","GB"],"associatedCities":["London","New York"],"externalId":"Reference ID","nationalities":["United States of America","United Kingdom"],"domiciles":["United States of America","United Kingdom"]},"options":{"searchType":1,"assessmentRange":{"gte":1539505329390,"lte":1602663729390},"security":{}}}},"Organisation":{"value":{"entity":{"entityType":"searchorganisation","name":"Apple","externalId":"AAPL","dateOfIncorporation":"1977-01-03","incorporationCountryCode":"GB","aliases":["Apple Inc."],"associatedCities":["Cupertino","San Francisco","London"],"incorporationCountry":"United Kingdom"},"options":{"searchType":1,"assessmentRange":{"gte":1539505329390,"lte":1602663729390},"security":{}}}},"Vessel":{"value":{"entity":{"entityType":"searchvessel","name":"Melville","externalId":"Melv","vesselCallSigns":["WECB"],"vesselFlagsCode":["AU"],"aliases":["HMAS Melville"],"associatedCities":["Sydney","Melbourne"],"vesselFlags":["Australia"]},"options":{"searchType":1,"assessmentRange":{"gte":1539505329390,"lte":1602663729390},"security":{}}}},"Aircraft":{"value":{"entity":{"entityType":"searchaircraft","name":"Apollo 11","externalId":"ap11","associatedCountryCodes":["GB","US"],"aliases":["AC1"]},"options":{"searchType":1,"assessmentRange":{"gte":1539505329390,"lte":1602663729390},"security":{}}}},"Unknown":{"value":{"entity":{"entityType":"searchunknown","name":"Bobbly Tables","aliases":["Bob Tables","Robert Tables"],"associatedCountryCodes":["GB","US"],"associatedCities":["London","New York"]},"options":{"searchType":1,"assessmentRange":{"gte":1539505329390,"lte":1602663729390},"security":{}}}}}}}},"responses":{"201":{"description":"Assessment accepted","content":{"application\/json":{"schema":{"type":"object","allOf":[{"type":"object","allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Human friendly unique identifier for this assessment","example":"AS-26"},"assessmentRange":{"type":"object","description":"The date range the assessment ran against","required":["gte","lte"],"properties":{"gte":{"type":"number","description":"unix timestamp (lower bound)","example":1539954158521},"lte":{"type":"number","description":"unix timestamp (upper bound)"}}},"precision":{"type":"string","description":"assessment search precision","example":"torch"},"options":{"type":"object","example":{"languages":[]},"description":"The options used when the assessment was created"},"security":{"type":"object","description":"The security label applied to this assessment as per the Ripjar Security Model"},"searchType":{"type":"number","description":"the policy ID to use when determining which policies apply to this assessment","example":10002},"entities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"John Smith"},"entityType":{"type":"string","enum":["searchperson","searchorganisation","searchvessel","searchaircraft","searchunknown"],"example":"searchperson"},"aliases":{"type":"array","items":{"type":"string"},"description":"Alternate names for the entity"},"id":{"type":"string","description":"Unique identifier for this entity under assessment","example":"assessment:3f9cbec5-a322-4b3c-9275-4d06e8737624"},"result":{"type":"object","properties":{"id":{"type":"number","example":25514},"state":{"type":"number","format":"int64","description":"Numerical representation of the internal alert state (e.g. opened, closed, etc).","example":2},"status":{"type":"number","description":"A 3 digit number made up of internal alert state (1 digit) and the alert status as configured by your system administrator (2 digits).","example":200},"reason":{"type":"number","description":"A number which represents the closure reason as configured by your system administrator.","example":1},"timestamp":{"type":"number","description":"last updated timestamp for the internal alert"},"comment":{"type":"object","properties":{"value":{"type":"string","description":"comment text"},"user":{"type":"object","properties":{"email":{"type":"string","example":"test@ripjar.com"},"externalId":{"type":"string","example":"test@ripjar.com"},"cn":{"type":"string","example":"test@ripjar.com"},"id":{"type":"number","example":10006}}}}},"history":{"type":"array","description":"The assignment history of the assessment","items":{"type":"object","properties":{"assignedUsers":{"example":[{"username":"John Smith","email":"john.smith@ripjar.com","externalId":"john.smith@ripjar.com","mobile":"01234567890","roles":["ROLE_1"],"cn":"john.smith@ripjar.com","clientKey":"lowercasekey","customerExcludedApps":["app"],"security":{},"lastLogin":1596188918065,"username_lowercase":"john smith","lineNumber":4,"lastModified":1595437138430,"id":10003,"dateCreated":1595437138459}],"oneOf":[{"type":"array","description":"IDs of users assigned to the result, returned when results enrichment is disabled","items":{"type":"number"},"example":[1]},{"type":"array","description":"Objects representing users assigned to the result, returned when results enrichment is enabled","items":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}},"components":{"schemas":{"AssignedUserEnriched":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}}}}}]},"timestamp":{"type":"integer","description":"The timestamp for when the assessment was assigned"},"state":{"type":"integer","description":"The state code"},"status":{"type":"integer","description":"The status code"}}}},"assignedUsers":{"type":"array","items":{"type":"object","description":"User objects for any user accounts currently assigned to the assessment","properties":{"email":{"type":"string","example":"test@ripjar.com"},"externalId":{"type":"string","example":"test@ripjar.com"},"cn":{"type":"string","example":"test@ripjar.com"},"id":{"type":"number","example":10006}}}}}}}}}}}],"properties":{"createdBy":{"type":"object","description":null,"properties":{"username":{"type":"string","description":"the username for this user","example":"admin"},"id":{"type":"number","description":"unique identifier for this user","example":10001}}},"clientKey":{"type":"string","description":"the customer ID","example":"lowercasekey"},"namespace":{"type":"string","description":"system namespace","example":"torch"},"label":{"type":"string","description":"the name which was searched","example":"John Smith"},"created":{"type":"number","description":"created at (unix timestamp)","example":1603113059520},"updated":{"type":"number","description":"last updated at (unix timestamp)","example":1603113059520},"irsVersion":{"type":"number","description":"the revision the identity resolution service was at when the assessment was created","example":225670},"state":{"type":"object","required":["state"],"properties":{"state":{"type":"string","description":"Top-level state of the assessment","enum":["IN_PROGRESS","COMPLETED_NO_HITS","COMPLETED_WITH_HITS","ERRORED","CLOSED"]}}},"policyId":{"type":"number","description":"the id for the matched policy","example":10001},"tags":{"type":"array","description":"Metadata related to the assessment","example":["context-assessment"],"items":{"type":"string"}},"groupContext":{"type":"object","required":["isPrimary","groupId"],"properties":{"isPrimary":{"type":"boolean","description":"if this assessment is the primary one of the group","example":false},"groupId":{"type":"string","description":"id of the group","example":"03b9a256-9524-4ed8-9d23-84a213793b7b"},"relationship":{"type":"object","properties":{"type":{"type":"string","description":"type of relationship between assessed entity and the primary assessment","example":"FRIEND"}}}}}}}],"properties":{"closureDate":{"type":"number","description":"assessment closure date (unix timestamp)","example":1603113059521}}}}}},"400":{"description":"Your request was invalid and an assessment could not be created","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}},"examples":{"badInput":{"summary":"Bad Input Format","value":{"code":"BAD_INPUT_FORMAT","message":"entity.entityType must be one of: 'searchperson', 'searchorganisation'"}}}}}},"401":{"description":"Unauthenticated request"},"403":{"description":"The authenticated user cannot create assessments"},"500":{"description":"An unexpected error occurred creating the assessment","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}},"examples":{"unexpectedError":{"summary":"Unexpected Error","value":{"code":"ERROR_SUBMITTING_ASSESSMENT","message":"An error occurred submitting the assessment"}}}}}}}},"delete":{"summary":"Bulk delete assessments","description":"\"Request to delete multiple assessments using filters\"\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"assessmentBulkDelete","tags":["Assessment"],"parameters":[{"name":"atSystemHigh","in":"query","description":"Defaults to false if not set","schema":{"type":"boolean"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"anyOf":[{"description":"Delete by filters","type":"object","allOf":[{"type":"object","allOf":[{"not":{"required":["createdBy","createdByExternalIds"]}},{"not":{"required":["assignee","assigneeExternalIds"]}}],"properties":{"createdBy":{"description":"Filter by created user\/s internal ID\/s. Cannot be used in conjunction with createdByExternalIds.","oneOf":[{"type":"integer","description":"Filter by created user"},{"type":"array","description":"Filter by created users","minItems":1,"items":{"type":"integer"}}]},"createdByExternalIds":{"description":"Filter by created user\/s external ID\/s. Cannot be used in conjunction with createdBy.","oneOf":[{"type":"string","description":"Filter by created user"},{"type":"array","description":"Filter by created users","minItems":1,"items":{"type":"string"}}]},"status":{"description":"Filter by status code\/s","oneOf":[{"type":"integer","description":"Filter by status code"},{"type":"array","description":"Filter by status codes","minItems":1,"items":{"type":"integer"}}]},"target":{"description":"Filter by targets","type":"array","minItems":1,"items":{"type":"string"}},"resultStatus":{"description":"Filter by result status codes","type":"array","minItems":1,"items":{"type":"number"}},"assignee":{"description":"Filter by assignees internal IDs. Cannot be used in conjunction with assigneeExternalIds.","type":"array","minItems":1,"items":{"type":"integer"}},"assigneeExternalIds":{"description":"Filter by assignees external IDs. Cannot be used in conjunction with assignee.","type":"array","minItems":1,"items":{"type":"string"}},"alertTags":{"description":"Filter by alert tags","type":"array","minItems":1,"items":{"type":"string"}}}},{"properties":{"skip":{"type":"integer"},"limit":{"type":"integer"},"sort":{"type":"object","anyOf":[{"SortCreated":{"type":"object","description":"Sort by creation date","properties":{"created":{"type":"integer","enum":[1,-1]}}}},{"SortUpdated":{"type":"object","description":"Sort by last updated date","properties":{"updated":{"type":"integer","enum":[1,-1]}}}}]}}}]},{"description":"Delete by assessment ids","allOf":[{"type":"object","description":"Array of ids to delete","properties":{"ids":{"type":"array","example":["AS-50","AS-51","AS-75"],"items":{"type":"string","minLength":1},"minItems":1}}},{"properties":{"skip":{"type":"integer"},"limit":{"type":"integer"},"sort":{"type":"object","anyOf":[{"SortCreated":{"type":"object","description":"Sort by creation date","properties":{"created":{"type":"integer","enum":[1,-1]}}}},{"SortUpdated":{"type":"object","description":"Sort by last updated date","properties":{"updated":{"type":"integer","enum":[1,-1]}}}}]}}}]}]},"examples":{"filters":{"value":{"filter":{"createdBy":[100,200],"createdByExternalIds":["john.smith@ripjar.com"],"status":1,"assignee":[100]},"skip":1,"limit":2}},"ids":{"value":{"ids":["AS-51","AS-52","AS-70"]}}}}}},"responses":{"200":{"description":"Assessment(s) deleted","content":{"application\/json":{"schema":{"description":"Delete by filters","type":"object","properties":{"success":{"type":"array","items":{"type":"object","properties":{"name":{"description":"Name of deleted items","type":"string","example":"entities"},"total":{"description":"Total deleted items","type":"integer"}}}},"warnings":{"description":"Non fatal errors","type":"array","items":{"type":"object","properties":{"id":{"description":"Assessment id relating to the warning","type":"string","example":"AS-60"},"value":{"description":"Warning value text","type":"string","example":"id does not exist"}}}}}},"example":{"success":[{"name":"entities","total":7},{"name":"activities","total":1},{"name":"attachments","total":1},{"name":"assessments","total":1}],"warnings":[]}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthenticated request"},"403":{"description":"The authenticated user cannot delete assessments"},"404":{"description":"Assessment(s) not found"},"500":{"description":"An unexpected error occurred when deleting assessment"}}}},"\/assessment\/search":{"post":{"summary":"Search assessments","description":"Returns a paged list of assessments that match the given filters, sorted by the given sort criteria.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"assessmentSearch","tags":["Assessment"],"parameters":[{"in":"query","name":"pageSize","required":false,"schema":{"type":"integer"}},{"in":"query","name":"page","required":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"page":{"type":"number","example":1,"default":1},"pageSize":{"type":"number","minimum":1,"maximum":1000,"default":20,"example":10},"sort":{"type":"object","properties":{"created":{"type":"number","enum":[-1,1]},"updated":{"type":"number","enum":[-1,1]},"closureDate":{"type":"number","enum":[-1,1]}},"example":{"created":1}},"filter":{"type":"object","allOf":[{"not":{"required":["assignee","assigneeExternalIds"]}},{"not":{"required":["createdBy","createdByExternalIds"]}}],"properties":{"previousAssignees":{"type":"array","items":{"type":"object","allOf":[{"not":{"required":["includes","includesExternalIds"]}},{"not":{"required":["excludes","excludesExternalIds"]}}],"properties":{"includes":{"type":"array","items":{"type":"number"},"description":"array of internal user IDs. Cannot be used in conjunction with includesExternalIds."},"includesExternalIds":{"type":"array","items":{"type":"string"},"description":"array of external user IDs. Cannot be used in conjunction with includes."},"excludes":{"type":"array","items":{"type":"number"},"description":"array of internal user IDs. Cannot be used in conjunction with excludesExternalIds."},"excludesExternalIds":{"type":"array","items":{"type":"string"},"description":"array of external user IDs. Cannot be used in conjunction with excludes."}}}},"assignee":{"type":"array","description":"return assessments currently assigned to users with these internal IDs. Cannot be used in conjunction with assigneeExternalIds.","items":{"type":"number"}},"assigneeExternalIds":{"type":"array","description":"return assessments currently assigned to users with these external IDs. Cannot be used in conjunction with assignee.","items":{"type":"string"}},"types":{"type":"array","items":{"type":"string","enum":["searchperson","searchorganisation","searchvessel","searchaircraft","searchunknown"]}},"status":{"type":"array","items":{"description":"statuses are configurable to your organisation and vary per Labyrinth Screening install","type":"number"}},"state":{"type":"array","items":{"description":"the state of the assessment (-1 = ERRORED, 0 = IN_PROGRESS, 1 = NULL, 2 = CLOSED)","type":"number","enum":[-1,0,1,2]}},"createdBy":{"type":"array","description":"array of internal user IDs of the users who created the assessments to include in the results. Cannot be used in conjunction with createdByExternalIds.","items":{"type":"number"}},"createdByExternalIds":{"type":"array","description":"array of external user IDs of the users who created the assessments to include in the results. Cannot be used in conjunction with createdBy.","items":{"type":"string"}},"name":{"type":"string","description":"Search by name"},"entityIds":{"type":"array","description":"Array of assessed entity IDs (without the \"assessment:\" prefix)","items":{"type":"string"}},"tags":{"type":"array","description":"Array of tags; at least one tag must match for a result to be returned","items":{"type":"string"}},"dateRange":{"type":"object","properties":{"created":{"description":"Timestamp range for when the assessment was created","type":"object","properties":{"gte":{"type":"number","example":1590973346512,"description":"cannot be used in conjunction with gt"},"lte":{"type":"number","description":"cannot be used in conjunction with lt","example":1590973346512},"gt":{"type":"number","description":"cannot be used in conjunction with gte","example":1590973346512},"lt":{"type":"number","description":"cannot be used in conjunction with lte","example":1590973346512}}},"updated":{"description":"Timestamp range for when the assessment was updated","type":"object","properties":{"gte":{"type":"number","example":1590973346512,"description":"cannot be used in conjunction with gt"},"lte":{"type":"number","description":"cannot be used in conjunction with lt","example":1590973346512},"gt":{"type":"number","description":"cannot be used in conjunction with gte","example":1590973346512},"lt":{"type":"number","description":"cannot be used in conjunction with lte","example":1590973346512}}},"closureDate":{"description":"Timestamp range for when the assessment was closed","type":"object","properties":{"gte":{"type":"number","example":1590973346512,"description":"cannot be used in conjunction with gt"},"lte":{"type":"number","description":"cannot be used in conjunction with lt","example":1590973346512},"gt":{"type":"number","description":"cannot be used in conjunction with gte","example":1590973346512},"lt":{"type":"number","description":"cannot be used in conjunction with lte","example":1590973346512}}}}}}}},"components":{"dateRangeProperties":{"gte":{"type":"number","example":1590973346512,"description":"cannot be used in conjunction with gt"},"lte":{"type":"number","description":"cannot be used in conjunction with lt","example":1590973346512},"gt":{"type":"number","description":"cannot be used in conjunction with gte","example":1590973346512},"lt":{"type":"number","description":"cannot be used in conjunction with lte","example":1590973346512}}}},"example":{"page":1,"pageSize":10,"sort":{"created":1},"filter":{"assignee":[10006],"createdByExternalIds":["john.smith@ripjar.com"],"state":[1,0],"name":"John","tags":["template-10007"]}}}}},"responses":{"200":{"description":"Returns the assessment objects with dig-basic tags removed\n","content":{"application\/json":{"schema":{"type":"object","required":["hasMore","total","data"],"properties":{"incompleteResultSet":{"type":"boolean","description":"if set to true indicates that the server did not include all name matches when the name parameter was included","example":true},"hasMore":{"type":"boolean","description":"a convenience boolean to determine whether there is more data to page through","example":true},"total":{"type":"number","description":"the total number of results available to page through","example":1035},"data":{"type":"array","description":"an array of assessments","items":{"type":"object","allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Human friendly unique identifier for this assessment","example":"AS-26"},"assessmentRange":{"type":"object","description":"The date range the assessment ran against","required":["gte","lte"],"properties":{"gte":{"type":"number","description":"unix timestamp (lower bound)","example":1539954158521},"lte":{"type":"number","description":"unix timestamp (upper bound)"}}},"precision":{"type":"string","description":"assessment search precision","example":"torch"},"options":{"type":"object","example":{"languages":[]},"description":"The options used when the assessment was created"},"security":{"type":"object","description":"The security label applied to this assessment as per the Ripjar Security Model"},"searchType":{"type":"number","description":"the policy ID to use when determining which policies apply to this assessment","example":10002},"entities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"John Smith"},"entityType":{"type":"string","enum":["searchperson","searchorganisation","searchvessel","searchaircraft","searchunknown"],"example":"searchperson"},"aliases":{"type":"array","items":{"type":"string"},"description":"Alternate names for the entity"},"id":{"type":"string","description":"Unique identifier for this entity under assessment","example":"assessment:3f9cbec5-a322-4b3c-9275-4d06e8737624"},"result":{"type":"object","properties":{"id":{"type":"number","example":25514},"state":{"type":"number","format":"int64","description":"Numerical representation of the internal alert state (e.g. opened, closed, etc).","example":2},"status":{"type":"number","description":"A 3 digit number made up of internal alert state (1 digit) and the alert status as configured by your system administrator (2 digits).","example":200},"reason":{"type":"number","description":"A number which represents the closure reason as configured by your system administrator.","example":1},"timestamp":{"type":"number","description":"last updated timestamp for the internal alert"},"comment":{"type":"object","properties":{"value":{"type":"string","description":"comment text"},"user":{"type":"object","properties":{"email":{"type":"string","example":"test@ripjar.com"},"externalId":{"type":"string","example":"test@ripjar.com"},"cn":{"type":"string","example":"test@ripjar.com"},"id":{"type":"number","example":10006}}}}},"history":{"type":"array","description":"The assignment history of the assessment","items":{"type":"object","properties":{"assignedUsers":{"example":[{"username":"John Smith","email":"john.smith@ripjar.com","externalId":"john.smith@ripjar.com","mobile":"01234567890","roles":["ROLE_1"],"cn":"john.smith@ripjar.com","clientKey":"lowercasekey","customerExcludedApps":["app"],"security":{},"lastLogin":1596188918065,"username_lowercase":"john smith","lineNumber":4,"lastModified":1595437138430,"id":10003,"dateCreated":1595437138459}],"oneOf":[{"type":"array","description":"IDs of users assigned to the result, returned when results enrichment is disabled","items":{"type":"number"},"example":[1]},{"type":"array","description":"Objects representing users assigned to the result, returned when results enrichment is enabled","items":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}},"components":{"schemas":{"AssignedUserEnriched":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}}}}}]},"timestamp":{"type":"integer","description":"The timestamp for when the assessment was assigned"},"state":{"type":"integer","description":"The state code"},"status":{"type":"integer","description":"The status code"}}}},"assignedUsers":{"type":"array","items":{"type":"object","description":"User objects for any user accounts currently assigned to the assessment","properties":{"email":{"type":"string","example":"test@ripjar.com"},"externalId":{"type":"string","example":"test@ripjar.com"},"cn":{"type":"string","example":"test@ripjar.com"},"id":{"type":"number","example":10006}}}}}}}}}}}],"properties":{"createdBy":{"type":"object","description":null,"properties":{"username":{"type":"string","description":"the username for this user","example":"admin"},"id":{"type":"number","description":"unique identifier for this user","example":10001}}},"clientKey":{"type":"string","description":"the customer ID","example":"lowercasekey"},"namespace":{"type":"string","description":"system namespace","example":"torch"},"label":{"type":"string","description":"the name which was searched","example":"John Smith"},"created":{"type":"number","description":"created at (unix timestamp)","example":1603113059520},"updated":{"type":"number","description":"last updated at (unix timestamp)","example":1603113059520},"irsVersion":{"type":"number","description":"the revision the identity resolution service was at when the assessment was created","example":225670},"state":{"type":"object","required":["state"],"properties":{"state":{"type":"string","description":"Top-level state of the assessment","enum":["IN_PROGRESS","COMPLETED_NO_HITS","COMPLETED_WITH_HITS","ERRORED","CLOSED"]}}},"policyId":{"type":"number","description":"the id for the matched policy","example":10001},"tags":{"type":"array","description":"Metadata related to the assessment","example":["context-assessment"],"items":{"type":"string"}},"groupContext":{"type":"object","required":["isPrimary","groupId"],"properties":{"isPrimary":{"type":"boolean","description":"if this assessment is the primary one of the group","example":false},"groupId":{"type":"string","description":"id of the group","example":"03b9a256-9524-4ed8-9d23-84a213793b7b"},"relationship":{"type":"object","properties":{"type":{"type":"string","description":"type of relationship between assessed entity and the primary assessment","example":"FRIEND"}}}}}}}}}}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthenticated request"},"403":{"description":"Forbidden (e.g. the user does not have the ListSearch permission)"},"404":{"description":"Not found"},"500":{"description":"Internal server error"}}}},"\/assessment\/synchronous":{"post":{"summary":"Create an assessment synchronously","description":"This creates a new Assessment for a new entity, blocking until the assessment\nhas completed, and returning the summary form of the assessment.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes, and a global concurrent request limit of 5 simultaneous requests per customer.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 1.3 s |\n| 90th percentile | 2.4 s |\n| 95th percentile | 2.4 s |\n| 98th percentile | 3.5 s |\n| 99th percentile | 9.0 s |\n<!-- operational-characteristics:end -->\n","operationId":"assessmentCreateSync","tags":["Assessment"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":1300.49,"p90":2355.08,"p95":2355.08,"p98":3498.62,"p99":8955.12,"sampleSize":1552460}},"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["entity","options"],"properties":{"entity":{"type":"object","required":["name","entityType"],"properties":{"aliases":{"type":"array","items":{"type":"string"},"description":"Alternate names for the entity"},"associatedCities":{"type":"array","items":{"type":"string"},"description":"Associated cities if assessing unknown entity type"},"associatedCountryCodes":{"type":"array","description":"Country codes if assessing unknown entity type","items":{"type":"string"}},"dateOfBirth":{"type":"string","format":"date","description":"Date of birth if assessing a person"},"dateOfIncorporation":{"type":"string","format":"date","description":"Date of incorporation if assessing an organisation"},"domicileCodes":{"type":"array","description":"Domicile codes if assessing a person","items":{"type":"string"}},"domiciles":{"type":"array","description":"Domiciles if assessing a person","items":{"type":"string"}},"entityType":{"type":"string","enum":["searchperson","searchorganisation","searchvessel","searchaircraft","searchunknown"]},"externalId":{"type":"string","description":"External identifier for this entity under assessment"},"freeTextItems":{"type":"array","description":"free-text key-value pairs for the entity","items":{"type":"object","required":["fieldId","value"],"properties":{"fieldId":{"type":"string","description":"The free-text field id (or key)"},"value":{"type":"string","description":"The free-text field value"}}}},"gender":{"type":"string","description":"Gender if assessing a person","enum":["MALE","FEMALE"]},"identityNumbers":{"type":"array","description":"Identity numbers for the entity","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","description":"The identity number type"},"value":{"type":"string","description":"The identity number value"}}}},"incorporationCountry":{"type":"string","description":"Country of incorporation if assessing an organisation"},"incorporationCountryCode":{"type":"string","description":"Country code for country of incorporation if assessing an organisation"},"name":{"type":"string","description":"The canonical name of an entity"},"nationalities":{"type":"array","description":"Nationalities if assessing a person","items":{"type":"string"}},"nationalityCodes":{"type":"array","items":{"type":"string"},"description":"Nationality codes if assessing a person"},"screeningReqID":{"type":"string","description":"The screening request ID"},"vesselCallSigns":{"type":"array","description":"Call signs if assessing a vessel","items":{"type":"string"}},"vesselFlags":{"type":"array","description":"Vessel flags if assessing a vessel","items":{"type":"string"}},"vesselFlagsCode":{"type":"array","description":"Vessel flag codes if assessing a vessel","items":{"type":"string"}}}},"options":{"type":"object","description":"Important options to control the assessment","required":["searchType","assessmentRange","security"],"properties":{"searchType":{"type":"number","description":"The id of the search type the assessment will be run against"},"precision":{"type":"string","description":"Which matching strategy is used to connect the input to other entities in the system. Deprecated as searchType contains policy id that has the precision defined in it.","deprecated":true},"assessmentRange":{"type":"object","description":"The date range for the assessment to run against","required":["gte","lte"],"properties":{"gte":{"type":"number","description":"Match to artefacts greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to artefacts less than this unix timestamp (milliseconds)"}}},"languages":{"type":"array","items":{"type":"string"},"description":"Filter over languages of news articles during assessment. If left empty no filtering will occur"}}},"security":{"type":"object","description":"Security object for the assessment and anything derived from it"}}},"examples":{"Person":{"value":{"entity":{"entityType":"searchperson","name":"Bobbly Tables","aliases":["Bob Tables","Robert Tables"],"gender":"MALE","dateOfBirth":"1995-05-04","nationalityCodes":["US","GB"],"domicileCodes":["US","GB"],"associatedCities":["London","New York"],"externalId":"Reference ID","nationalities":["United States of America","United Kingdom"],"domiciles":["United States of America","United Kingdom"]},"options":{"searchType":1,"assessmentRange":{"gte":1539505329390,"lte":1602663729390},"security":{}}}},"Organisation":{"value":{"entity":{"entityType":"searchorganisation","name":"Apple","externalId":"AAPL","dateOfIncorporation":"1977-01-03","incorporationCountryCode":"GB","aliases":["Apple Inc."],"associatedCities":["Cupertino","San Francisco","London"],"incorporationCountry":"United Kingdom"},"options":{"searchType":1,"assessmentRange":{"gte":1539505329390,"lte":1602663729390},"security":{}}}},"Vessel":{"value":{"entity":{"entityType":"searchvessel","name":"Melville","externalId":"Melv","vesselCallSigns":["WECB"],"vesselFlagsCode":["AU"],"aliases":["HMAS Melville"],"associatedCities":["Sydney","Melbourne"],"vesselFlags":["Australia"]},"options":{"searchType":1,"assessmentRange":{"gte":1539505329390,"lte":1602663729390},"security":{}}}},"Aircraft":{"value":{"entity":{"entityType":"searchaircraft","name":"Apollo 11","externalId":"ap11","associatedCountryCodes":["GB","US"],"aliases":["AC1"]},"options":{"searchType":1,"assessmentRange":{"gte":1539505329390,"lte":1602663729390},"security":{}}}},"Unknown":{"value":{"entity":{"entityType":"searchunknown","name":"Bobbly Tables","aliases":["Bob Tables","Robert Tables"],"associatedCountryCodes":["GB","US"],"associatedCities":["London","New York"]},"options":{"searchType":1,"assessmentRange":{"gte":1539505329390,"lte":1602663729390},"security":{}}}}}}}},"responses":{"201":{"description":"Assessment completed","content":{"application\/json":{"schema":{"type":"object","allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Human friendly unique identifier for this assessment","example":"AS-26"},"assessmentRange":{"type":"object","description":"The date range the assessment ran against","required":["gte","lte"],"properties":{"gte":{"type":"number","description":"unix timestamp (lower bound)","example":1539954158521},"lte":{"type":"number","description":"unix timestamp (upper bound)"}}},"precision":{"type":"string","description":"assessment search precision","example":"torch"},"options":{"type":"object","example":{"languages":[]},"description":"The options used when the assessment was created"},"security":{"type":"object","description":"The security label applied to this assessment as per the Ripjar Security Model"},"searchType":{"type":"number","description":"the policy ID to use when determining which policies apply to this assessment","example":10002},"entities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"John Smith"},"entityType":{"type":"string","enum":["searchperson","searchorganisation","searchvessel","searchaircraft","searchunknown"],"example":"searchperson"},"aliases":{"type":"array","items":{"type":"string"},"description":"Alternate names for the entity"},"id":{"type":"string","description":"Unique identifier for this entity under assessment","example":"assessment:3f9cbec5-a322-4b3c-9275-4d06e8737624"},"result":{"type":"object","properties":{"id":{"type":"number","example":25514},"state":{"type":"number","format":"int64","description":"Numerical representation of the internal alert state (e.g. opened, closed, etc).","example":2},"status":{"type":"number","description":"A 3 digit number made up of internal alert state (1 digit) and the alert status as configured by your system administrator (2 digits).","example":200},"reason":{"type":"number","description":"A number which represents the closure reason as configured by your system administrator.","example":1},"timestamp":{"type":"number","description":"last updated timestamp for the internal alert"},"comment":{"type":"object","properties":{"value":{"type":"string","description":"comment text"},"user":{"type":"object","properties":{"email":{"type":"string","example":"test@ripjar.com"},"externalId":{"type":"string","example":"test@ripjar.com"},"cn":{"type":"string","example":"test@ripjar.com"},"id":{"type":"number","example":10006}}}}},"history":{"type":"array","description":"The assignment history of the assessment","items":{"type":"object","properties":{"assignedUsers":{"example":[{"username":"John Smith","email":"john.smith@ripjar.com","externalId":"john.smith@ripjar.com","mobile":"01234567890","roles":["ROLE_1"],"cn":"john.smith@ripjar.com","clientKey":"lowercasekey","customerExcludedApps":["app"],"security":{},"lastLogin":1596188918065,"username_lowercase":"john smith","lineNumber":4,"lastModified":1595437138430,"id":10003,"dateCreated":1595437138459}],"oneOf":[{"type":"array","description":"IDs of users assigned to the result, returned when results enrichment is disabled","items":{"type":"number"},"example":[1]},{"type":"array","description":"Objects representing users assigned to the result, returned when results enrichment is enabled","items":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}},"components":{"schemas":{"AssignedUserEnriched":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}}}}}]},"timestamp":{"type":"integer","description":"The timestamp for when the assessment was assigned"},"state":{"type":"integer","description":"The state code"},"status":{"type":"integer","description":"The status code"}}}},"assignedUsers":{"type":"array","items":{"type":"object","description":"User objects for any user accounts currently assigned to the assessment","properties":{"email":{"type":"string","example":"test@ripjar.com"},"externalId":{"type":"string","example":"test@ripjar.com"},"cn":{"type":"string","example":"test@ripjar.com"},"id":{"type":"number","example":10006}}}}}}}}}}}],"properties":{"createdBy":{"type":"object","description":null,"properties":{"username":{"type":"string","description":"the username for this user","example":"admin"},"id":{"type":"number","description":"unique identifier for this user","example":10001}}},"clientKey":{"type":"string","description":"the customer ID","example":"lowercasekey"},"namespace":{"type":"string","description":"system namespace","example":"torch"},"label":{"type":"string","description":"the name which was searched","example":"John Smith"},"created":{"type":"number","description":"created at (unix timestamp)","example":1603113059520},"updated":{"type":"number","description":"last updated at (unix timestamp)","example":1603113059520},"irsVersion":{"type":"number","description":"the revision the identity resolution service was at when the assessment was created","example":225670},"state":{"type":"object","required":["state"],"properties":{"state":{"type":"string","description":"Top-level state of the assessment","enum":["IN_PROGRESS","COMPLETED_NO_HITS","COMPLETED_WITH_HITS","ERRORED","CLOSED"]}}},"policyId":{"type":"number","description":"the id for the matched policy","example":10001},"tags":{"type":"array","description":"Metadata related to the assessment","example":["context-assessment"],"items":{"type":"string"}},"groupContext":{"type":"object","required":["isPrimary","groupId"],"properties":{"isPrimary":{"type":"boolean","description":"if this assessment is the primary one of the group","example":false},"groupId":{"type":"string","description":"id of the group","example":"03b9a256-9524-4ed8-9d23-84a213793b7b"},"relationship":{"type":"object","properties":{"type":{"type":"string","description":"type of relationship between assessed entity and the primary assessment","example":"FRIEND"}}}}}}}}}},"400":{"description":"Your request was invalid and an assessment could not be created","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}},"examples":{"badInput":{"summary":"Bad Input Format","value":{"code":"BAD_INPUT_FORMAT","message":"entity.entityType must be one of: 'searchperson', 'searchorganisation'"}}}}}},"401":{"description":"Unauthenticated request"},"403":{"description":"The authenticated user cannot create assessments"},"500":{"description":"An unexpected error occurred creating the assessment","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}},"examples":{"unexpectedError":{"summary":"Unexpected Error","value":{"code":"ERROR_SUBMITTING_ASSESSMENT","message":"An error occurred submitting the assessment"}}}}}}}}},"\/assessment\/{assessment_id}":{"get":{"summary":"Retrieve an assessment","description":"The details of the assessment and summary of any results\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"assessmentSingleGet","tags":["Assessment"],"parameters":[{"name":"assessment_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Assessment detail retrieved","content":{"application\/json":{"schema":{"type":"object","allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Human friendly unique identifier for this assessment","example":"AS-26"},"assessmentRange":{"type":"object","description":"The date range the assessment ran against","required":["gte","lte"],"properties":{"gte":{"type":"number","description":"unix timestamp (lower bound)","example":1539954158521},"lte":{"type":"number","description":"unix timestamp (upper bound)"}}},"precision":{"type":"string","description":"assessment search precision","example":"torch"},"options":{"type":"object","example":{"languages":[]},"description":"The options used when the assessment was created"},"security":{"type":"object","description":"The security label applied to this assessment as per the Ripjar Security Model"},"searchType":{"type":"number","description":"the policy ID to use when determining which policies apply to this assessment","example":10002},"entities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"John Smith"},"entityType":{"type":"string","enum":["searchperson","searchorganisation","searchvessel","searchaircraft","searchunknown"],"example":"searchperson"},"aliases":{"type":"array","items":{"type":"string"},"description":"Alternate names for the entity"},"id":{"type":"string","description":"Unique identifier for this entity under assessment","example":"assessment:3f9cbec5-a322-4b3c-9275-4d06e8737624"},"result":{"type":"object","properties":{"id":{"type":"number","example":25514},"state":{"type":"number","format":"int64","description":"Numerical representation of the internal alert state (e.g. opened, closed, etc).","example":2},"status":{"type":"number","description":"A 3 digit number made up of internal alert state (1 digit) and the alert status as configured by your system administrator (2 digits).","example":200},"reason":{"type":"number","description":"A number which represents the closure reason as configured by your system administrator.","example":1},"timestamp":{"type":"number","description":"last updated timestamp for the internal alert"},"comment":{"type":"object","properties":{"value":{"type":"string","description":"comment text"},"user":{"type":"object","properties":{"email":{"type":"string","example":"test@ripjar.com"},"externalId":{"type":"string","example":"test@ripjar.com"},"cn":{"type":"string","example":"test@ripjar.com"},"id":{"type":"number","example":10006}}}}},"history":{"type":"array","description":"The assignment history of the assessment","items":{"type":"object","properties":{"assignedUsers":{"example":[{"username":"John Smith","email":"john.smith@ripjar.com","externalId":"john.smith@ripjar.com","mobile":"01234567890","roles":["ROLE_1"],"cn":"john.smith@ripjar.com","clientKey":"lowercasekey","customerExcludedApps":["app"],"security":{},"lastLogin":1596188918065,"username_lowercase":"john smith","lineNumber":4,"lastModified":1595437138430,"id":10003,"dateCreated":1595437138459}],"oneOf":[{"type":"array","description":"IDs of users assigned to the result, returned when results enrichment is disabled","items":{"type":"number"},"example":[1]},{"type":"array","description":"Objects representing users assigned to the result, returned when results enrichment is enabled","items":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}},"components":{"schemas":{"AssignedUserEnriched":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}}}}}]},"timestamp":{"type":"integer","description":"The timestamp for when the assessment was assigned"},"state":{"type":"integer","description":"The state code"},"status":{"type":"integer","description":"The status code"}}}},"assignedUsers":{"type":"array","items":{"type":"object","description":"User objects for any user accounts currently assigned to the assessment","properties":{"email":{"type":"string","example":"test@ripjar.com"},"externalId":{"type":"string","example":"test@ripjar.com"},"cn":{"type":"string","example":"test@ripjar.com"},"id":{"type":"number","example":10006}}}}}}}}}}}],"properties":{"createdBy":{"type":"object","description":null,"properties":{"username":{"type":"string","description":"the username for this user","example":"admin"},"id":{"type":"number","description":"unique identifier for this user","example":10001}}},"clientKey":{"type":"string","description":"the customer ID","example":"lowercasekey"},"namespace":{"type":"string","description":"system namespace","example":"torch"},"label":{"type":"string","description":"the name which was searched","example":"John Smith"},"created":{"type":"number","description":"created at (unix timestamp)","example":1603113059520},"updated":{"type":"number","description":"last updated at (unix timestamp)","example":1603113059520},"irsVersion":{"type":"number","description":"the revision the identity resolution service was at when the assessment was created","example":225670},"state":{"type":"object","required":["state"],"properties":{"state":{"type":"string","description":"Top-level state of the assessment","enum":["IN_PROGRESS","COMPLETED_NO_HITS","COMPLETED_WITH_HITS","ERRORED","CLOSED"]}}},"policyId":{"type":"number","description":"the id for the matched policy","example":10001},"tags":{"type":"array","description":"Metadata related to the assessment","example":["context-assessment"],"items":{"type":"string"}},"groupContext":{"type":"object","required":["isPrimary","groupId"],"properties":{"isPrimary":{"type":"boolean","description":"if this assessment is the primary one of the group","example":false},"groupId":{"type":"string","description":"id of the group","example":"03b9a256-9524-4ed8-9d23-84a213793b7b"},"relationship":{"type":"object","properties":{"type":{"type":"string","description":"type of relationship between assessed entity and the primary assessment","example":"FRIEND"}}}}}}}}}},"401":{"description":"Unauthenticated request"},"403":{"description":"The authenticated user cannot view assessments"},"404":{"description":"Assessment with that ID not found"},"500":{"description":"An unexpected error occurred creating the assessment","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}},"examples":{"unexpectedError":{"summary":"Unexpected Error","value":{"code":"ERROR_GETTING_ASSESSMENT","message":"An error occurred retrieving the assessment"}}}}}}}},"delete":{"summary":"Delete an assessment","description":"Request to delete the assessment with specified id\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"AssessmentDelete","tags":["Assessment"],"parameters":[{"name":"assessment_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"atSystemHigh","in":"query","description":"Defaults to false if not set","schema":{"type":"boolean"}}],"responses":{"204":{"description":"Assessment deleted"},"400":{"description":"Invalid request"},"401":{"description":"Unauthenticated request"},"403":{"description":"The authenticated user cannot delete assessments"},"404":{"description":"Assessment with id not found"},"500":{"description":"An unexpected error occurred when fetching the assessments"}}}},"\/assessment\/{assessment_id}\/close":{"post":{"tags":["Assessment"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":294.17,"p90":754.4,"p95":1366.48,"p98":2355.08,"p99":3016.06,"sampleSize":77934}},"operationId":"assessmentClose","summary":"Close an assessment","description":"An endpoint for closing assessments\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 295 ms |\n| 90th percentile | 755 ms |\n| 95th percentile | 1.4 s |\n| 98th percentile | 2.4 s |\n| 99th percentile | 3.0 s |\n<!-- operational-characteristics:end -->\n","parameters":[{"name":"assessment_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An object with information for closing the assessment","content":{"application\/json":{"schema":{"type":"object","required":["status","reason"],"properties":{"comment":{"type":"string"},"status":{"type":"integer"},"reason":{"type":"integer"}}}}}},"responses":{"200":{"description":"A response for successfully closed assessment","content":{"application\/json":{"schema":{"description":"Response received when closing an assessment","type":"object","properties":{"allOf":[{"type":"object","allOf":[{"type":"object","allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Human friendly unique identifier for this assessment","example":"AS-26"},"assessmentRange":{"type":"object","description":"The date range the assessment ran against","required":["gte","lte"],"properties":{"gte":{"type":"number","description":"unix timestamp (lower bound)","example":1539954158521},"lte":{"type":"number","description":"unix timestamp (upper bound)"}}},"precision":{"type":"string","description":"assessment search precision","example":"torch"},"options":{"type":"object","example":{"languages":[]},"description":"The options used when the assessment was created"},"security":{"type":"object","description":"The security label applied to this assessment as per the Ripjar Security Model"},"searchType":{"type":"number","description":"the policy ID to use when determining which policies apply to this assessment","example":10002},"entities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"John Smith"},"entityType":{"type":"string","enum":["searchperson","searchorganisation","searchvessel","searchaircraft","searchunknown"],"example":"searchperson"},"aliases":{"type":"array","items":{"type":"string"},"description":"Alternate names for the entity"},"id":{"type":"string","description":"Unique identifier for this entity under assessment","example":"assessment:3f9cbec5-a322-4b3c-9275-4d06e8737624"},"result":{"type":"object","properties":{"id":{"type":"number","example":25514},"state":{"type":"number","format":"int64","description":"Numerical representation of the internal alert state (e.g. opened, closed, etc).","example":2},"status":{"type":"number","description":"A 3 digit number made up of internal alert state (1 digit) and the alert status as configured by your system administrator (2 digits).","example":200},"reason":{"type":"number","description":"A number which represents the closure reason as configured by your system administrator.","example":1},"timestamp":{"type":"number","description":"last updated timestamp for the internal alert"},"comment":{"type":"object","properties":{"value":{"type":"string","description":"comment text"},"user":{"type":"object","properties":{"email":{"type":"string","example":"test@ripjar.com"},"externalId":{"type":"string","example":"test@ripjar.com"},"cn":{"type":"string","example":"test@ripjar.com"},"id":{"type":"number","example":10006}}}}},"history":{"type":"array","description":"The assignment history of the assessment","items":{"type":"object","properties":{"assignedUsers":{"example":[{"username":"John Smith","email":"john.smith@ripjar.com","externalId":"john.smith@ripjar.com","mobile":"01234567890","roles":["ROLE_1"],"cn":"john.smith@ripjar.com","clientKey":"lowercasekey","customerExcludedApps":["app"],"security":{},"lastLogin":1596188918065,"username_lowercase":"john smith","lineNumber":4,"lastModified":1595437138430,"id":10003,"dateCreated":1595437138459}],"oneOf":[{"type":"array","description":"IDs of users assigned to the result, returned when results enrichment is disabled","items":{"type":"number"},"example":[1]},{"type":"array","description":"Objects representing users assigned to the result, returned when results enrichment is enabled","items":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}},"components":{"schemas":{"AssignedUserEnriched":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}}}}}]},"timestamp":{"type":"integer","description":"The timestamp for when the assessment was assigned"},"state":{"type":"integer","description":"The state code"},"status":{"type":"integer","description":"The status code"}}}},"assignedUsers":{"type":"array","items":{"type":"object","description":"User objects for any user accounts currently assigned to the assessment","properties":{"email":{"type":"string","example":"test@ripjar.com"},"externalId":{"type":"string","example":"test@ripjar.com"},"cn":{"type":"string","example":"test@ripjar.com"},"id":{"type":"number","example":10006}}}}}}}}}}}],"properties":{"createdBy":{"type":"object","description":null,"properties":{"username":{"type":"string","description":"the username for this user","example":"admin"},"id":{"type":"number","description":"unique identifier for this user","example":10001}}},"clientKey":{"type":"string","description":"the customer ID","example":"lowercasekey"},"namespace":{"type":"string","description":"system namespace","example":"torch"},"label":{"type":"string","description":"the name which was searched","example":"John Smith"},"created":{"type":"number","description":"created at (unix timestamp)","example":1603113059520},"updated":{"type":"number","description":"last updated at (unix timestamp)","example":1603113059520},"irsVersion":{"type":"number","description":"the revision the identity resolution service was at when the assessment was created","example":225670},"state":{"type":"object","required":["state"],"properties":{"state":{"type":"string","description":"Top-level state of the assessment","enum":["IN_PROGRESS","COMPLETED_NO_HITS","COMPLETED_WITH_HITS","ERRORED","CLOSED"]}}},"policyId":{"type":"number","description":"the id for the matched policy","example":10001},"tags":{"type":"array","description":"Metadata related to the assessment","example":["context-assessment"],"items":{"type":"string"}},"groupContext":{"type":"object","required":["isPrimary","groupId"],"properties":{"isPrimary":{"type":"boolean","description":"if this assessment is the primary one of the group","example":false},"groupId":{"type":"string","description":"id of the group","example":"03b9a256-9524-4ed8-9d23-84a213793b7b"},"relationship":{"type":"object","properties":{"type":{"type":"string","description":"type of relationship between assessed entity and the primary assessment","example":"FRIEND"}}}}}}}],"properties":{"closureDate":{"type":"number","description":"assessment closure date (unix timestamp)","example":1603113059521}}},{"properties":{"createdBy":{"description":"Information about the user who created the assessment","type":"object","properties":{"id":{"description":"The user's ID","type":"number","example":17725},"username":{"description":"The user's username","type":"string","example":"johnDoe"}}}}}]}}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthenticated request"},"403":{"description":"Forbidden (e.g. the user does not have the ListSearch permission)"},"404":{"description":"Not found\n- For example, when the reason or status do not exist, or the or assessment cannot be found.\n"},"412":{"description":"Precondition failed\n- For example when the assessment has not finished or has already been closed.\n"},"422":{"description":"Unprocessable entity"},"500":{"description":"An unexpected error occurred while closing the assessment","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}},"examples":{"unexpectedError":{"summary":"Cannot close search","value":{"code":"CLOSE_ASSESSMENT_ERROR","message":"Internal Server Error: Request failed with status code 500"}}}}}}}}},"\/assessment\/{assessment_id}\/state":{"get":{"summary":"Get the high-level state of the assessment","description":"Retrieve the state of the given assessment\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"assessmentState","tags":["Assessment"],"parameters":[{"name":"assessment_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Assessment State","content":{"application\/json":{"schema":{"type":"object","required":["state"],"properties":{"state":{"type":"string","description":"Top-level state of the assessment","enum":["IN_PROGRESS","COMPLETED_NO_HITS","COMPLETED_WITH_HITS","ERRORED","CLOSED"]}}}}}},"401":{"description":"Unauthenticated request"},"403":{"description":"The authenticated user cannot view assessments"},"404":{"description":"Assessment with that ID not found"},"500":{"description":"An unexpected error occurred creating the assessment","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}},"examples":{"unexpectedError":{"summary":"Unexpected Error","value":{"code":"ERROR_GETTING_STATUS","message":"An error occurred retrieving the assessment status"}}}}}}}}},"\/assessment\/{assessment_id}\/status":{"put":{"summary":"Update the status of an assessment","description":"Update the status of an assessment\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"assessmentUpdateStatus","tags":["Assessment"],"parameters":[{"name":"assessment_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An object describing the new status","content":{"application\/json":{"schema":{"type":"object","properties":{"status":{"type":"number","description":"A 3 digit number made up of internal alert state (1 digit) and the alert status as configured by your system administrator (2 digits).","example":101}}}}}},"responses":{"200":{"description":"The updated assessment object","content":{"application\/json":{"schema":{"type":"object","allOf":[{"type":"object","allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Human friendly unique identifier for this assessment","example":"AS-26"},"assessmentRange":{"type":"object","description":"The date range the assessment ran against","required":["gte","lte"],"properties":{"gte":{"type":"number","description":"unix timestamp (lower bound)","example":1539954158521},"lte":{"type":"number","description":"unix timestamp (upper bound)"}}},"precision":{"type":"string","description":"assessment search precision","example":"torch"},"options":{"type":"object","example":{"languages":[]},"description":"The options used when the assessment was created"},"security":{"type":"object","description":"The security label applied to this assessment as per the Ripjar Security Model"},"searchType":{"type":"number","description":"the policy ID to use when determining which policies apply to this assessment","example":10002},"entities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"John Smith"},"entityType":{"type":"string","enum":["searchperson","searchorganisation","searchvessel","searchaircraft","searchunknown"],"example":"searchperson"},"aliases":{"type":"array","items":{"type":"string"},"description":"Alternate names for the entity"},"id":{"type":"string","description":"Unique identifier for this entity under assessment","example":"assessment:3f9cbec5-a322-4b3c-9275-4d06e8737624"},"result":{"type":"object","properties":{"id":{"type":"number","example":25514},"state":{"type":"number","format":"int64","description":"Numerical representation of the internal alert state (e.g. opened, closed, etc).","example":2},"status":{"type":"number","description":"A 3 digit number made up of internal alert state (1 digit) and the alert status as configured by your system administrator (2 digits).","example":200},"reason":{"type":"number","description":"A number which represents the closure reason as configured by your system administrator.","example":1},"timestamp":{"type":"number","description":"last updated timestamp for the internal alert"},"comment":{"type":"object","properties":{"value":{"type":"string","description":"comment text"},"user":{"type":"object","properties":{"email":{"type":"string","example":"test@ripjar.com"},"externalId":{"type":"string","example":"test@ripjar.com"},"cn":{"type":"string","example":"test@ripjar.com"},"id":{"type":"number","example":10006}}}}},"history":{"type":"array","description":"The assignment history of the assessment","items":{"type":"object","properties":{"assignedUsers":{"example":[{"username":"John Smith","email":"john.smith@ripjar.com","externalId":"john.smith@ripjar.com","mobile":"01234567890","roles":["ROLE_1"],"cn":"john.smith@ripjar.com","clientKey":"lowercasekey","customerExcludedApps":["app"],"security":{},"lastLogin":1596188918065,"username_lowercase":"john smith","lineNumber":4,"lastModified":1595437138430,"id":10003,"dateCreated":1595437138459}],"oneOf":[{"type":"array","description":"IDs of users assigned to the result, returned when results enrichment is disabled","items":{"type":"number"},"example":[1]},{"type":"array","description":"Objects representing users assigned to the result, returned when results enrichment is enabled","items":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}},"components":{"schemas":{"AssignedUserEnriched":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}}}}}]},"timestamp":{"type":"integer","description":"The timestamp for when the assessment was assigned"},"state":{"type":"integer","description":"The state code"},"status":{"type":"integer","description":"The status code"}}}},"assignedUsers":{"type":"array","items":{"type":"object","description":"User objects for any user accounts currently assigned to the assessment","properties":{"email":{"type":"string","example":"test@ripjar.com"},"externalId":{"type":"string","example":"test@ripjar.com"},"cn":{"type":"string","example":"test@ripjar.com"},"id":{"type":"number","example":10006}}}}}}}}}}}],"properties":{"createdBy":{"type":"object","description":null,"properties":{"username":{"type":"string","description":"the username for this user","example":"admin"},"id":{"type":"number","description":"unique identifier for this user","example":10001}}},"clientKey":{"type":"string","description":"the customer ID","example":"lowercasekey"},"namespace":{"type":"string","description":"system namespace","example":"torch"},"label":{"type":"string","description":"the name which was searched","example":"John Smith"},"created":{"type":"number","description":"created at (unix timestamp)","example":1603113059520},"updated":{"type":"number","description":"last updated at (unix timestamp)","example":1603113059520},"irsVersion":{"type":"number","description":"the revision the identity resolution service was at when the assessment was created","example":225670},"state":{"type":"object","required":["state"],"properties":{"state":{"type":"string","description":"Top-level state of the assessment","enum":["IN_PROGRESS","COMPLETED_NO_HITS","COMPLETED_WITH_HITS","ERRORED","CLOSED"]}}},"policyId":{"type":"number","description":"the id for the matched policy","example":10001},"tags":{"type":"array","description":"Metadata related to the assessment","example":["context-assessment"],"items":{"type":"string"}},"groupContext":{"type":"object","required":["isPrimary","groupId"],"properties":{"isPrimary":{"type":"boolean","description":"if this assessment is the primary one of the group","example":false},"groupId":{"type":"string","description":"id of the group","example":"03b9a256-9524-4ed8-9d23-84a213793b7b"},"relationship":{"type":"object","properties":{"type":{"type":"string","description":"type of relationship between assessed entity and the primary assessment","example":"FRIEND"}}}}}}}],"properties":{"closureDate":{"type":"number","description":"assessment closure date (unix timestamp)","example":1603113059521}}}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found\n- For example, the system configuration does not contain the status in the request or the assessment cannot be found.\n"},"422":{"description":"Unprocessable Entity\n- For example, the status in the request is not valid to transition to from the current status.\n"},"500":{"description":"An unexpected error occurred creating the assessment","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}},"examples":{"unexpectedError":{"summary":"Unexpected Error","value":{"code":"ERROR_GETTING_STATUS","message":"An error occurred retrieving the assessment status"}}}}}}}}},"\/assessment\/{assessment_id}\/assign":{"post":{"summary":"Assign and change the status of the assessment","description":"Assign and change the status of the assessment\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"assessmentAssign","tags":["Assessment"],"parameters":[{"name":"assessment_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An object describing the new status and assigned users delta","content":{"application\/json":{"schema":{"type":"object","properties":{"users":{"type":"object","oneOf":[{"required":["add","remove"]},{"required":["addExternalIds","remove"]},{"required":["add","removeExternalIds"]},{"required":["addExternalIds","removeExternalIds"]}],"description":"an object describing the assignee delta. if re-assigning, you must provide both as assessments can currently only have 1 assignee.","properties":{"add":{"type":"array","description":"internal user id to add. Cannot be used in conjunction with addExternalIds.","items":{"type":"number","example":10006}},"addExternalIds":{"type":"array","description":"external user id to add. Cannot be used in conjunction with add.","items":{"type":"string","example":"john.smith@ripjar.com"}},"remove":{"type":"array","description":"internal user id to remove. Cannot be used in conjunction with removeExternalIds.","items":{"type":"number","example":80006}},"removeExternalIds":{"type":"array","description":"external user id to remove. Cannot be used in conjunction with remove.","items":{"type":"string","example":"will.smith@ripjar.com"}}}},"status":{"type":"number","description":"A 3 digit number made up of internal alert state (1 digit) and the alert status as configured by your system administrator (2 digits).","example":102}}}}}},"responses":{"200":{"description":"Returns the updated assessment object. The updated assignees are found in the entities object.\n","content":{"application\/json":{"schema":{"type":"object","allOf":[{"type":"object","allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Human friendly unique identifier for this assessment","example":"AS-26"},"assessmentRange":{"type":"object","description":"The date range the assessment ran against","required":["gte","lte"],"properties":{"gte":{"type":"number","description":"unix timestamp (lower bound)","example":1539954158521},"lte":{"type":"number","description":"unix timestamp (upper bound)"}}},"precision":{"type":"string","description":"assessment search precision","example":"torch"},"options":{"type":"object","example":{"languages":[]},"description":"The options used when the assessment was created"},"security":{"type":"object","description":"The security label applied to this assessment as per the Ripjar Security Model"},"searchType":{"type":"number","description":"the policy ID to use when determining which policies apply to this assessment","example":10002},"entities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"John Smith"},"entityType":{"type":"string","enum":["searchperson","searchorganisation","searchvessel","searchaircraft","searchunknown"],"example":"searchperson"},"aliases":{"type":"array","items":{"type":"string"},"description":"Alternate names for the entity"},"id":{"type":"string","description":"Unique identifier for this entity under assessment","example":"assessment:3f9cbec5-a322-4b3c-9275-4d06e8737624"},"result":{"type":"object","properties":{"id":{"type":"number","example":25514},"state":{"type":"number","format":"int64","description":"Numerical representation of the internal alert state (e.g. opened, closed, etc).","example":2},"status":{"type":"number","description":"A 3 digit number made up of internal alert state (1 digit) and the alert status as configured by your system administrator (2 digits).","example":200},"reason":{"type":"number","description":"A number which represents the closure reason as configured by your system administrator.","example":1},"timestamp":{"type":"number","description":"last updated timestamp for the internal alert"},"comment":{"type":"object","properties":{"value":{"type":"string","description":"comment text"},"user":{"type":"object","properties":{"email":{"type":"string","example":"test@ripjar.com"},"externalId":{"type":"string","example":"test@ripjar.com"},"cn":{"type":"string","example":"test@ripjar.com"},"id":{"type":"number","example":10006}}}}},"history":{"type":"array","description":"The assignment history of the assessment","items":{"type":"object","properties":{"assignedUsers":{"example":[{"username":"John Smith","email":"john.smith@ripjar.com","externalId":"john.smith@ripjar.com","mobile":"01234567890","roles":["ROLE_1"],"cn":"john.smith@ripjar.com","clientKey":"lowercasekey","customerExcludedApps":["app"],"security":{},"lastLogin":1596188918065,"username_lowercase":"john smith","lineNumber":4,"lastModified":1595437138430,"id":10003,"dateCreated":1595437138459}],"oneOf":[{"type":"array","description":"IDs of users assigned to the result, returned when results enrichment is disabled","items":{"type":"number"},"example":[1]},{"type":"array","description":"Objects representing users assigned to the result, returned when results enrichment is enabled","items":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}},"components":{"schemas":{"AssignedUserEnriched":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}}}}}]},"timestamp":{"type":"integer","description":"The timestamp for when the assessment was assigned"},"state":{"type":"integer","description":"The state code"},"status":{"type":"integer","description":"The status code"}}}},"assignedUsers":{"type":"array","items":{"type":"object","description":"User objects for any user accounts currently assigned to the assessment","properties":{"email":{"type":"string","example":"test@ripjar.com"},"externalId":{"type":"string","example":"test@ripjar.com"},"cn":{"type":"string","example":"test@ripjar.com"},"id":{"type":"number","example":10006}}}}}}}}}}}],"properties":{"createdBy":{"type":"object","description":null,"properties":{"username":{"type":"string","description":"the username for this user","example":"admin"},"id":{"type":"number","description":"unique identifier for this user","example":10001}}},"clientKey":{"type":"string","description":"the customer ID","example":"lowercasekey"},"namespace":{"type":"string","description":"system namespace","example":"torch"},"label":{"type":"string","description":"the name which was searched","example":"John Smith"},"created":{"type":"number","description":"created at (unix timestamp)","example":1603113059520},"updated":{"type":"number","description":"last updated at (unix timestamp)","example":1603113059520},"irsVersion":{"type":"number","description":"the revision the identity resolution service was at when the assessment was created","example":225670},"state":{"type":"object","required":["state"],"properties":{"state":{"type":"string","description":"Top-level state of the assessment","enum":["IN_PROGRESS","COMPLETED_NO_HITS","COMPLETED_WITH_HITS","ERRORED","CLOSED"]}}},"policyId":{"type":"number","description":"the id for the matched policy","example":10001},"tags":{"type":"array","description":"Metadata related to the assessment","example":["context-assessment"],"items":{"type":"string"}},"groupContext":{"type":"object","required":["isPrimary","groupId"],"properties":{"isPrimary":{"type":"boolean","description":"if this assessment is the primary one of the group","example":false},"groupId":{"type":"string","description":"id of the group","example":"03b9a256-9524-4ed8-9d23-84a213793b7b"},"relationship":{"type":"object","properties":{"type":{"type":"string","description":"type of relationship between assessed entity and the primary assessment","example":"FRIEND"}}}}}}}],"properties":{"closureDate":{"type":"number","description":"assessment closure date (unix timestamp)","example":1603113059521}}}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthenticated request"},"403":{"description":"Forbidden (e.g. the user does not have the ListSearch permission)"},"404":{"description":"Not found"},"412":{"description":"Precondition failed"},"422":{"description":"Unprocessable entity"},"500":{"description":"Internal server error"}}}},"\/assessment\/{assessment_id}\/bulk-assess":{"post":{"summary":"Bulk assess a number of pieces of evidence","description":"Bulk assess a number of pieces of evidence. They are assessed as Relevant\/Not Relevant depending on the assessment codes passed in.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"assessmentBulkAssess","tags":["Assessment"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":298,"p90":484.3,"p95":520.15,"p98":541.66,"p99":548.83,"sampleSize":4}},"parameters":[{"name":"assessment_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["assessmentCodes","evidence"],"properties":{"assessmentCodes":{"type":"array","description":"array of assessment codes","items":{"type":"number"},"example":[10001]},"evidence":{"type":"array","description":"array of evidence IDs. invalid evidence IDs are not updated.","items":{"type":"number"},"example":[1]},"comment":{"type":"string","description":"an optional comment to accompany the assessment"}}}}}},"responses":{"200":{"description":"Returns an array of updated (partial) evidence items\n","content":{"application\/json":{"schema":{"type":"array","description":"an array of updated (partial) evidence items","items":{"type":"object","properties":{"id":{"type":"number","description":"evidence ID","example":161325},"matchScore":{"type":"number","description":"the confidence that the match between the assessed entity and the one found in the evidence piece is correct","example":0.7002781604436024},"totalRisk":{"type":"number","description":"the sum of all risk for the evidence. each match reason contributes to the total risk.","example":100},"matchDate":{"type":"number","description":"the unix timestamp when the evidence was created","example":1603295488656},"isGroupMaster":{"type":"boolean","description":"indicates whether the evidence item is the master version","example":true},"tags":{"type":"array","description":"Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and\u2014when custom categories apply\u2014entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property.\n","items":{"type":"string"},"example":["policy-20037","risk-Financial Crime","userTag-Fin Crime-active"]},"riskTags":{"type":"array","description":"Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags).\n","items":{"type":"string"},"example":["PEP-active","cc42-active"]}}}}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthenticated request"},"403":{"description":"Forbidden (e.g. the user does not have the EvidenceAssess permission)"},"404":{"description":"Not found"},"412":{"description":"Precondition failed - the assessment must not be in progress to perform assessments"},"422":{"description":"Unprocessable entity"},"500":{"description":"Internal server error"}}}},"\/assessment\/{assessment_id}\/evidence\/{evidence_id}":{"get":{"summary":"Retrieve the full content of evidence","description":"Retrieve the full content of evidence, including list profiles and article content and metadata\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"assessmentEvidenceFullGet","tags":["Assessment"],"parameters":[{"name":"assessment_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"evidence_id","in":"path","required":true,"schema":{"type":"number"}},{"in":"query","name":"documentFields","description":"Return specific fields from the supporting evidence document. By default core.content.value and entity are returned.","examples":{"all":{"value":{"all":true},"summary":"Return all document fields"},"exclude_core":{"value":{"core":false},"summary":"Return all fields except core"}},"required":false,"schema":{"type":"object"},"allowReserved":true,"style":"deepObject"}],"responses":{"200":{"description":"The full evidence object including the supporting document","content":{"application\/json":{"schema":{"oneOf":[{"allOf":[{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"number","description":"evidence ID","example":161325},"matchScore":{"type":"number","description":"the confidence that the match between the assessed entity and the one found in the evidence piece is correct","example":0.7002781604436024},"totalRisk":{"type":"number","description":"the sum of all risk for the evidence. each match reason contributes to the total risk.","example":100},"matchDate":{"type":"number","description":"the unix timestamp when the evidence was created","example":1603295488656},"isGroupMaster":{"type":"boolean","description":"indicates whether the evidence item is the master version","example":true},"tags":{"type":"array","description":"Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and\u2014when custom categories apply\u2014entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property.\n","items":{"type":"string"},"example":["policy-20037","risk-Financial Crime","userTag-Fin Crime-active"]},"riskTags":{"type":"array","description":"Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags).\n","items":{"type":"string"},"example":["PEP-active","cc42-active"]}}}],"properties":{"type":{"type":"string","enum":["risk"]},"isBookmarked":{"type":"boolean","description":"indicates whether the evidence is bookmarked by the user","example":true},"assessment":{"type":"object","properties":{"codes":{"type":"array","items":{"type":"number"},"description":"array of assessment codes. assessment codes are configured by your system administrator.","example":[10001]},"timestamp":{"type":"number","description":"unix timestamp which indicates when the evidence was assessed","example":1603295488656,"user":{"type":"object","properties":{"id":{"type":"integer","example":10006},"email":{"type":"string","example":"kyc.admin@ripjar.com"},"externalId":{"type":"string","example":"kyc.admin@ripjar.com"},"cn":{"type":"string","example":"kyc.admin@ripjar.com"}}}}}}}},{"type":"object"}]},{"allOf":[{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"number","description":"evidence ID","example":161325},"matchScore":{"type":"number","description":"the confidence that the match between the assessed entity and the one found in the evidence piece is correct","example":0.7002781604436024},"totalRisk":{"type":"number","description":"the sum of all risk for the evidence. each match reason contributes to the total risk.","example":100},"matchDate":{"type":"number","description":"the unix timestamp when the evidence was created","example":1603295488656},"isGroupMaster":{"type":"boolean","description":"indicates whether the evidence item is the master version","example":true},"tags":{"type":"array","description":"Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and\u2014when custom categories apply\u2014entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property.\n","items":{"type":"string"},"example":["policy-20037","risk-Financial Crime","userTag-Fin Crime-active"]},"riskTags":{"type":"array","description":"Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags).\n","items":{"type":"string"},"example":["PEP-active","cc42-active"]}}}],"properties":{"type":{"type":"string","enum":["list"]},"name":{"type":"string","description":"the name of watchlist entity"},"lists":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"the name of the watchlist","example":"FCA (UK) Final Notices"},"description":{"type":"string","description":"a description of the watchlist","example":"Publishing notices is important to ensure the transparency of Financial Conduct Authority (FCA) decision-making; it informs the public and helps maximise the deterrent effect of enforcement action.\\r\\nWe publish certain information about Enforcement action once a statutory notice is issued.\\r\\n\\r\\n\u2022Warning Notices are issued when we propose to take action\\r\\n\u2022Decision Notices are issued when we decide to take action\\r\\n\u2022Final Notices are issued when we take action."},"active":{"type":"boolean","description":"whether the watchlist entity is active on the list","example":true},"id":{"type":"string","description":"the watchlist ID","example":"dj:list:1423"},"listActive":{"type":"boolean","description":"whether the list is active","example":true},"sinceRange":{"type":"object","description":"indicates when the entity was added to the watchlist","properties":{"granularity":{"type":"string","enum":["day","month","year"],"example":"day"},"start":{"type":"string","format":"date-time","example":"2005-11-24T00:00:00.000Z"},"end":{"type":"string","format":"date-time","example":"2005-11-24T23:59:59.999Z"}}},"toRange":{"type":"object","description":"indicates when the entity was removed from the watchlist","properties":{"granularity":{"type":"string","enum":["day","month","year"],"example":"day"},"start":{"type":"string","format":"date-time","example":"2009-11-02T00:00:00.000Z"},"end":{"type":"string","format":"date-time","example":"2009-11-02T23:59:59.999Z"}}},"hierarchy":{"type":"array","description":"describes the hierarchy of the watchlist","items":{"type":"object","properties":{"name":{"type":"string","example":"FCA (UK) Final Notices"},"id":{"type":"string","example":"dj:list:1423"},"parent":{"type":"string","example":"dj:mid:4"}}}},"tags":{"type":"array","items":{"type":"string"}}}}},"assessment":{"type":"object","properties":{"codes":{"type":"array","items":{"type":"number"},"description":"array of assessment codes. assessment codes are configured by your system administrator.","example":[10001]},"timestamp":{"type":"number","description":"unix timestamp which indicates when the evidence was assessed","example":1603295488656,"user":{"type":"object","properties":{"id":{"type":"integer","example":10006},"email":{"type":"string","example":"kyc.admin@ripjar.com"},"externalId":{"type":"string","example":"kyc.admin@ripjar.com"},"cn":{"type":"string","example":"kyc.admin@ripjar.com"}}}}}},"isBookmarked":{"type":"boolean","description":"indicates whether the evidence is bookmarked by the user","example":true}}},{"type":"object"}]}]}}}},"401":{"description":"Unauthenticated request"},"403":{"description":"The authenticated user cannot view assessments"},"404":{"description":"Assessment with that ID not found"},"412":{"description":"Precondition failed"},"422":{"description":"Unprocessable entity"},"500":{"description":"An unexpected error occurred creating the assessment","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}},"examples":{"unexpectedError":{"summary":"Unexpected Error","value":{"code":"ERROR_GETTING_STATUS","message":"An error occurred retrieving the assessment status"}}}}}}}},"post":{"summary":"Retrieve the full content of evidence","description":"Retrieve the full content of evidence, including list profiles and article content and metadata\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"assessmentEvidenceFullPost","tags":["Assessment"],"parameters":[{"name":"assessment_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"evidence_id","in":"path","required":true,"schema":{"type":"number"}}],"responses":{"200":{"description":"The full evidence object including the supporting document","content":{"application\/json":{"schema":{"oneOf":[{"allOf":[{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"number","description":"evidence ID","example":161325},"matchScore":{"type":"number","description":"the confidence that the match between the assessed entity and the one found in the evidence piece is correct","example":0.7002781604436024},"totalRisk":{"type":"number","description":"the sum of all risk for the evidence. each match reason contributes to the total risk.","example":100},"matchDate":{"type":"number","description":"the unix timestamp when the evidence was created","example":1603295488656},"isGroupMaster":{"type":"boolean","description":"indicates whether the evidence item is the master version","example":true},"tags":{"type":"array","description":"Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and\u2014when custom categories apply\u2014entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property.\n","items":{"type":"string"},"example":["policy-20037","risk-Financial Crime","userTag-Fin Crime-active"]},"riskTags":{"type":"array","description":"Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags).\n","items":{"type":"string"},"example":["PEP-active","cc42-active"]}}}],"properties":{"type":{"type":"string","enum":["risk"]},"isBookmarked":{"type":"boolean","description":"indicates whether the evidence is bookmarked by the user","example":true},"assessment":{"type":"object","properties":{"codes":{"type":"array","items":{"type":"number"},"description":"array of assessment codes. assessment codes are configured by your system administrator.","example":[10001]},"timestamp":{"type":"number","description":"unix timestamp which indicates when the evidence was assessed","example":1603295488656,"user":{"type":"object","properties":{"id":{"type":"integer","example":10006},"email":{"type":"string","example":"kyc.admin@ripjar.com"},"externalId":{"type":"string","example":"kyc.admin@ripjar.com"},"cn":{"type":"string","example":"kyc.admin@ripjar.com"}}}}}}}},{"type":"object"}]},{"allOf":[{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"number","description":"evidence ID","example":161325},"matchScore":{"type":"number","description":"the confidence that the match between the assessed entity and the one found in the evidence piece is correct","example":0.7002781604436024},"totalRisk":{"type":"number","description":"the sum of all risk for the evidence. each match reason contributes to the total risk.","example":100},"matchDate":{"type":"number","description":"the unix timestamp when the evidence was created","example":1603295488656},"isGroupMaster":{"type":"boolean","description":"indicates whether the evidence item is the master version","example":true},"tags":{"type":"array","description":"Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and\u2014when custom categories apply\u2014entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property.\n","items":{"type":"string"},"example":["policy-20037","risk-Financial Crime","userTag-Fin Crime-active"]},"riskTags":{"type":"array","description":"Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags).\n","items":{"type":"string"},"example":["PEP-active","cc42-active"]}}}],"properties":{"type":{"type":"string","enum":["list"]},"name":{"type":"string","description":"the name of watchlist entity"},"lists":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"the name of the watchlist","example":"FCA (UK) Final Notices"},"description":{"type":"string","description":"a description of the watchlist","example":"Publishing notices is important to ensure the transparency of Financial Conduct Authority (FCA) decision-making; it informs the public and helps maximise the deterrent effect of enforcement action.\\r\\nWe publish certain information about Enforcement action once a statutory notice is issued.\\r\\n\\r\\n\u2022Warning Notices are issued when we propose to take action\\r\\n\u2022Decision Notices are issued when we decide to take action\\r\\n\u2022Final Notices are issued when we take action."},"active":{"type":"boolean","description":"whether the watchlist entity is active on the list","example":true},"id":{"type":"string","description":"the watchlist ID","example":"dj:list:1423"},"listActive":{"type":"boolean","description":"whether the list is active","example":true},"sinceRange":{"type":"object","description":"indicates when the entity was added to the watchlist","properties":{"granularity":{"type":"string","enum":["day","month","year"],"example":"day"},"start":{"type":"string","format":"date-time","example":"2005-11-24T00:00:00.000Z"},"end":{"type":"string","format":"date-time","example":"2005-11-24T23:59:59.999Z"}}},"toRange":{"type":"object","description":"indicates when the entity was removed from the watchlist","properties":{"granularity":{"type":"string","enum":["day","month","year"],"example":"day"},"start":{"type":"string","format":"date-time","example":"2009-11-02T00:00:00.000Z"},"end":{"type":"string","format":"date-time","example":"2009-11-02T23:59:59.999Z"}}},"hierarchy":{"type":"array","description":"describes the hierarchy of the watchlist","items":{"type":"object","properties":{"name":{"type":"string","example":"FCA (UK) Final Notices"},"id":{"type":"string","example":"dj:list:1423"},"parent":{"type":"string","example":"dj:mid:4"}}}},"tags":{"type":"array","items":{"type":"string"}}}}},"assessment":{"type":"object","properties":{"codes":{"type":"array","items":{"type":"number"},"description":"array of assessment codes. assessment codes are configured by your system administrator.","example":[10001]},"timestamp":{"type":"number","description":"unix timestamp which indicates when the evidence was assessed","example":1603295488656,"user":{"type":"object","properties":{"id":{"type":"integer","example":10006},"email":{"type":"string","example":"kyc.admin@ripjar.com"},"externalId":{"type":"string","example":"kyc.admin@ripjar.com"},"cn":{"type":"string","example":"kyc.admin@ripjar.com"}}}}}},"isBookmarked":{"type":"boolean","description":"indicates whether the evidence is bookmarked by the user","example":true}}},{"type":"object"}]}]}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthenticated request"},"403":{"description":"The authenticated user cannot view assessments"},"404":{"description":"Assessment with that ID not found"},"412":{"description":"Precondition failed"},"422":{"description":"Unprocessable entity"},"500":{"description":"An unexpected error occurred creating the assessment","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}},"examples":{"unexpectedError":{"summary":"Unexpected Error","value":{"code":"ERROR_GETTING_STATUS","message":"An error occurred retrieving the assessment status"}}}}}}}}},"\/assessment\/{assessment_id}\/evidence":{"post":{"summary":"Search evidence summaries for an assessment","description":"Returns a paged list of evidence that match the given filters and sorted by the given sort criteria.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 63 ms |\n| 90th percentile | 109 ms |\n| 95th percentile | 163 ms |\n| 98th percentile | 561 ms |\n| 99th percentile | 651 ms |\n<!-- operational-characteristics:end -->\n","operationId":"assessmentEvidenceSearchPost","tags":["Assessment"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":62.71,"p90":108.77,"p95":162.05,"p98":560.44,"p99":650.23,"sampleSize":693962}},"parameters":[{"in":"query","name":"pageSize","required":false,"schema":{"type":"integer"}},{"in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"in":"query","name":"convert_timestamps","required":false,"schema":{"type":"string","enum":["true","false"],"description":"convert timestamps to ISO-8601 date formatted strings"}},{"name":"assessment_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"page":{"type":"number","example":1,"default":1},"pageSize":{"type":"number","minimum":1,"maximum":1000,"default":20,"example":10},"sort":{"type":"object","properties":{"matchScore":{"type":"number","enum":[-1,1]},"matchDate":{"type":"number","enum":[-1,1]},"totalRisk":{"type":"number","enum":[-1,1]}}},"filter":{"type":"object","example":{"qualification":"not_assessed","bookmarked":false,"type":"list"},"properties":{"dateRange":{"type":"object","properties":{"publication":{"type":"object","description":"filter on the publication date","required":["gte","lte"],"properties":{"gte":{"type":"number","description":"unix timestamp (lower bound)","example":1539954158521},"lte":{"type":"number","description":"unix timestamp (upper bound)","example":1603112558521}}}}},"type":{"type":"string","description":"the type of evidence","enum":["risk","list"],"example":"risk"},"assessmentCodes":{"type":"array","description":"an array of assessment codes. assessment codes are defined by your system administrator.","items":{"type":"number"},"example":[10001]},"tags":{"type":"array","items":{"type":"string"},"example":["riskType-onList"]},"qualification":{"type":"string","description":"filter by evidence qualification. can be used XOR with assessmentCodes.","enum":["not_assessed","relevant","not_relevant","assessed"],"example":"not_assessed"},"bookmarked":{"type":"boolean","description":"filter by bookmarked evidence only","example":false},"isGroupMaster":{"type":"boolean","description":"filter to only include evidence which are mastered","example":false}}}}}}}},"responses":{"200":{"description":"Returns risk and list evidence\n","content":{"application\/json":{"schema":{"type":"object","required":["hasMore","total","data"],"properties":{"hasMore":{"type":"boolean","description":"a convenience boolean to determine whether there is more data to page through","example":true},"total":{"type":"number","description":"the total number of results available to page through","example":1035},"data":{"type":"array","description":"an array of risk or list evidence items","items":{"anyOf":[{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"number","description":"evidence ID","example":161325},"matchScore":{"type":"number","description":"the confidence that the match between the assessed entity and the one found in the evidence piece is correct","example":0.7002781604436024},"totalRisk":{"type":"number","description":"the sum of all risk for the evidence. each match reason contributes to the total risk.","example":100},"matchDate":{"type":"number","description":"the unix timestamp when the evidence was created","example":1603295488656},"isGroupMaster":{"type":"boolean","description":"indicates whether the evidence item is the master version","example":true},"tags":{"type":"array","description":"Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and\u2014when custom categories apply\u2014entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property.\n","items":{"type":"string"},"example":["policy-20037","risk-Financial Crime","userTag-Fin Crime-active"]},"riskTags":{"type":"array","description":"Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags).\n","items":{"type":"string"},"example":["PEP-active","cc42-active"]}}}],"properties":{"type":{"type":"string","enum":["risk"]},"isBookmarked":{"type":"boolean","description":"indicates whether the evidence is bookmarked by the user","example":true},"assessment":{"type":"object","properties":{"codes":{"type":"array","items":{"type":"number"},"description":"array of assessment codes. assessment codes are configured by your system administrator.","example":[10001]},"timestamp":{"type":"number","description":"unix timestamp which indicates when the evidence was assessed","example":1603295488656,"user":{"type":"object","properties":{"id":{"type":"integer","example":10006},"email":{"type":"string","example":"kyc.admin@ripjar.com"},"externalId":{"type":"string","example":"kyc.admin@ripjar.com"},"cn":{"type":"string","example":"kyc.admin@ripjar.com"}}}}}}}},{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"number","description":"evidence ID","example":161325},"matchScore":{"type":"number","description":"the confidence that the match between the assessed entity and the one found in the evidence piece is correct","example":0.7002781604436024},"totalRisk":{"type":"number","description":"the sum of all risk for the evidence. each match reason contributes to the total risk.","example":100},"matchDate":{"type":"number","description":"the unix timestamp when the evidence was created","example":1603295488656},"isGroupMaster":{"type":"boolean","description":"indicates whether the evidence item is the master version","example":true},"tags":{"type":"array","description":"Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and\u2014when custom categories apply\u2014entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property.\n","items":{"type":"string"},"example":["policy-20037","risk-Financial Crime","userTag-Fin Crime-active"]},"riskTags":{"type":"array","description":"Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags).\n","items":{"type":"string"},"example":["PEP-active","cc42-active"]}}}],"properties":{"type":{"type":"string","enum":["list"]},"name":{"type":"string","description":"the name of watchlist entity"},"lists":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"the name of the watchlist","example":"FCA (UK) Final Notices"},"description":{"type":"string","description":"a description of the watchlist","example":"Publishing notices is important to ensure the transparency of Financial Conduct Authority (FCA) decision-making; it informs the public and helps maximise the deterrent effect of enforcement action.\\r\\nWe publish certain information about Enforcement action once a statutory notice is issued.\\r\\n\\r\\n\u2022Warning Notices are issued when we propose to take action\\r\\n\u2022Decision Notices are issued when we decide to take action\\r\\n\u2022Final Notices are issued when we take action."},"active":{"type":"boolean","description":"whether the watchlist entity is active on the list","example":true},"id":{"type":"string","description":"the watchlist ID","example":"dj:list:1423"},"listActive":{"type":"boolean","description":"whether the list is active","example":true},"sinceRange":{"type":"object","description":"indicates when the entity was added to the watchlist","properties":{"granularity":{"type":"string","enum":["day","month","year"],"example":"day"},"start":{"type":"string","format":"date-time","example":"2005-11-24T00:00:00.000Z"},"end":{"type":"string","format":"date-time","example":"2005-11-24T23:59:59.999Z"}}},"toRange":{"type":"object","description":"indicates when the entity was removed from the watchlist","properties":{"granularity":{"type":"string","enum":["day","month","year"],"example":"day"},"start":{"type":"string","format":"date-time","example":"2009-11-02T00:00:00.000Z"},"end":{"type":"string","format":"date-time","example":"2009-11-02T23:59:59.999Z"}}},"hierarchy":{"type":"array","description":"describes the hierarchy of the watchlist","items":{"type":"object","properties":{"name":{"type":"string","example":"FCA (UK) Final Notices"},"id":{"type":"string","example":"dj:list:1423"},"parent":{"type":"string","example":"dj:mid:4"}}}},"tags":{"type":"array","items":{"type":"string"}}}}},"assessment":{"type":"object","properties":{"codes":{"type":"array","items":{"type":"number"},"description":"array of assessment codes. assessment codes are configured by your system administrator.","example":[10001]},"timestamp":{"type":"number","description":"unix timestamp which indicates when the evidence was assessed","example":1603295488656,"user":{"type":"object","properties":{"id":{"type":"integer","example":10006},"email":{"type":"string","example":"kyc.admin@ripjar.com"},"externalId":{"type":"string","example":"kyc.admin@ripjar.com"},"cn":{"type":"string","example":"kyc.admin@ripjar.com"}}}}}},"isBookmarked":{"type":"boolean","description":"indicates whether the evidence is bookmarked by the user","example":true}}}]}}}}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthenticated request"},"403":{"description":"Forbidden (e.g. the user does not have the ViewSearch permission)"},"404":{"description":"Not found"},"412":{"description":"Precondition failed - the assessment must not be in progress to view results"},"500":{"description":"Internal server error"}}},"get":{"summary":"Search evidence summaries for an assessment","description":"Returns a paged list of evidence that match the given filters and sorted by the given sort criteria.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"assessmentEvidenceSearchGet","tags":["Assessment"],"parameters":[{"in":"query","name":"pageSize","required":false,"schema":{"type":"integer"}},{"in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"in":"query","name":"convert_timestamps","required":false,"schema":{"type":"string","enum":["true","false"],"description":"convert timestamps to ISO-8601 date formatted strings"}},{"name":"assessment_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns risk and list evidence\n","content":{"application\/json":{"schema":{"type":"object","required":["hasMore","total","data"],"properties":{"hasMore":{"type":"boolean","description":"a convenience boolean to determine whether there is more data to page through","example":true},"total":{"type":"number","description":"the total number of results available to page through","example":1035},"data":{"type":"array","description":"an array of risk or list evidence items","items":{"anyOf":[{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"number","description":"evidence ID","example":161325},"matchScore":{"type":"number","description":"the confidence that the match between the assessed entity and the one found in the evidence piece is correct","example":0.7002781604436024},"totalRisk":{"type":"number","description":"the sum of all risk for the evidence. each match reason contributes to the total risk.","example":100},"matchDate":{"type":"number","description":"the unix timestamp when the evidence was created","example":1603295488656},"isGroupMaster":{"type":"boolean","description":"indicates whether the evidence item is the master version","example":true},"tags":{"type":"array","description":"Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and\u2014when custom categories apply\u2014entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property.\n","items":{"type":"string"},"example":["policy-20037","risk-Financial Crime","userTag-Fin Crime-active"]},"riskTags":{"type":"array","description":"Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags).\n","items":{"type":"string"},"example":["PEP-active","cc42-active"]}}}],"properties":{"type":{"type":"string","enum":["risk"]},"isBookmarked":{"type":"boolean","description":"indicates whether the evidence is bookmarked by the user","example":true},"assessment":{"type":"object","properties":{"codes":{"type":"array","items":{"type":"number"},"description":"array of assessment codes. assessment codes are configured by your system administrator.","example":[10001]},"timestamp":{"type":"number","description":"unix timestamp which indicates when the evidence was assessed","example":1603295488656,"user":{"type":"object","properties":{"id":{"type":"integer","example":10006},"email":{"type":"string","example":"kyc.admin@ripjar.com"},"externalId":{"type":"string","example":"kyc.admin@ripjar.com"},"cn":{"type":"string","example":"kyc.admin@ripjar.com"}}}}}}}},{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"number","description":"evidence ID","example":161325},"matchScore":{"type":"number","description":"the confidence that the match between the assessed entity and the one found in the evidence piece is correct","example":0.7002781604436024},"totalRisk":{"type":"number","description":"the sum of all risk for the evidence. each match reason contributes to the total risk.","example":100},"matchDate":{"type":"number","description":"the unix timestamp when the evidence was created","example":1603295488656},"isGroupMaster":{"type":"boolean","description":"indicates whether the evidence item is the master version","example":true},"tags":{"type":"array","description":"Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and\u2014when custom categories apply\u2014entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property.\n","items":{"type":"string"},"example":["policy-20037","risk-Financial Crime","userTag-Fin Crime-active"]},"riskTags":{"type":"array","description":"Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags).\n","items":{"type":"string"},"example":["PEP-active","cc42-active"]}}}],"properties":{"type":{"type":"string","enum":["list"]},"name":{"type":"string","description":"the name of watchlist entity"},"lists":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"the name of the watchlist","example":"FCA (UK) Final Notices"},"description":{"type":"string","description":"a description of the watchlist","example":"Publishing notices is important to ensure the transparency of Financial Conduct Authority (FCA) decision-making; it informs the public and helps maximise the deterrent effect of enforcement action.\\r\\nWe publish certain information about Enforcement action once a statutory notice is issued.\\r\\n\\r\\n\u2022Warning Notices are issued when we propose to take action\\r\\n\u2022Decision Notices are issued when we decide to take action\\r\\n\u2022Final Notices are issued when we take action."},"active":{"type":"boolean","description":"whether the watchlist entity is active on the list","example":true},"id":{"type":"string","description":"the watchlist ID","example":"dj:list:1423"},"listActive":{"type":"boolean","description":"whether the list is active","example":true},"sinceRange":{"type":"object","description":"indicates when the entity was added to the watchlist","properties":{"granularity":{"type":"string","enum":["day","month","year"],"example":"day"},"start":{"type":"string","format":"date-time","example":"2005-11-24T00:00:00.000Z"},"end":{"type":"string","format":"date-time","example":"2005-11-24T23:59:59.999Z"}}},"toRange":{"type":"object","description":"indicates when the entity was removed from the watchlist","properties":{"granularity":{"type":"string","enum":["day","month","year"],"example":"day"},"start":{"type":"string","format":"date-time","example":"2009-11-02T00:00:00.000Z"},"end":{"type":"string","format":"date-time","example":"2009-11-02T23:59:59.999Z"}}},"hierarchy":{"type":"array","description":"describes the hierarchy of the watchlist","items":{"type":"object","properties":{"name":{"type":"string","example":"FCA (UK) Final Notices"},"id":{"type":"string","example":"dj:list:1423"},"parent":{"type":"string","example":"dj:mid:4"}}}},"tags":{"type":"array","items":{"type":"string"}}}}},"assessment":{"type":"object","properties":{"codes":{"type":"array","items":{"type":"number"},"description":"array of assessment codes. assessment codes are configured by your system administrator.","example":[10001]},"timestamp":{"type":"number","description":"unix timestamp which indicates when the evidence was assessed","example":1603295488656,"user":{"type":"object","properties":{"id":{"type":"integer","example":10006},"email":{"type":"string","example":"kyc.admin@ripjar.com"},"externalId":{"type":"string","example":"kyc.admin@ripjar.com"},"cn":{"type":"string","example":"kyc.admin@ripjar.com"}}}}}},"isBookmarked":{"type":"boolean","description":"indicates whether the evidence is bookmarked by the user","example":true}}}]}}}}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthenticated request"},"403":{"description":"Forbidden (e.g. the user does not have the ViewSearch permission)"},"404":{"description":"Not found"},"412":{"description":"Precondition failed - the assessment must not be in progress to view results"},"500":{"description":"Internal server error"}}}},"\/assessment\/{assessment_id}\/evidence\/{evidence_id}\/assess":{"post":{"summary":"Assess an item of evidence in an assessment","description":"Marks an evidence item as Relevant\/Not Relevant based on the assessment code passed in.  Returns the assessed evidence item & activity.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"assessmentEvidenceAssess","tags":["Assessment"],"parameters":[{"name":"assessment_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"evidence_id","in":"path","required":true,"schema":{"type":"number"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"assessmentCodes":{"type":"array","required":true,"items":{"type":"number"}},"example":[10001],"comment":{"type":"string","required":false}}}}}},"responses":{"200":{"description":"Returns the assessed evidence item and activity entry\n","content":{"application\/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"type":{"type":"string"},"matchScore":{"type":"number"},"totalRisk":{"type":"number"},"matchDate":{"oneOf":[{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"},{"type":"integer","description":"Timestamp expressed as the number of milliseconds past the epoch (1970-01-01 00:00:00 UTC)"}]},"isBookmarked":{"type":"boolean","description":"indicates whether the evidence is bookmarked by the user","example":true},"assessment":{"type":"object","properties":{"codes":{"type":"array","items":{"type":"number"},"description":"array of assessment codes. assessment codes are configured by your system administrator.","example":[10001]},"timestamp":{"type":"number","description":"unix timestamp which indicates when the evidence was assessed","example":1603295488656,"user":{"type":"object","properties":{"id":{"type":"integer","example":10006},"email":{"type":"string","example":"kyc.admin@ripjar.com"},"externalId":{"type":"string","example":"kyc.admin@ripjar.com"},"cn":{"type":"string","example":"kyc.admin@ripjar.com"}}}}}},"isGroupMaster":{"type":"boolean"},"tags":{"type":"array","items":{"type":"string"}}}}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthenticated request"},"403":{"description":"Forbidden (e.g. the user does not have the EvidenceAssess permission)"},"404":{"description":"Not found"},"412":{"description":"Precondition failed - the assessment must not be in progress to view results"},"422":{"description":"Unprocessable entity"},"500":{"description":"Internal server error"}}}},"\/assessment\/{assessment_id}\/evidence\/{evidence_id}\/bookmark":{"post":{"summary":"Bookmark an item of evidence in an assessment","description":"Bookmark an item of evidence in an assessment\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"assessmentEvidenceBookmark","tags":["Assessment"],"parameters":[{"name":"assessment_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"evidence_id","in":"path","required":true,"schema":{"type":"number"}}],"responses":{"200":{"description":"Returns the bookmarked evidence item and activity entry\n","content":{"application\/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"number","description":"evidence ID","example":161325},"matchScore":{"type":"number","description":"the confidence that the match between the assessed entity and the one found in the evidence piece is correct","example":0.7002781604436024},"totalRisk":{"type":"number","description":"the sum of all risk for the evidence. each match reason contributes to the total risk.","example":100},"matchDate":{"type":"number","description":"the unix timestamp when the evidence was created","example":1603295488656},"isGroupMaster":{"type":"boolean","description":"indicates whether the evidence item is the master version","example":true},"tags":{"type":"array","description":"Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and\u2014when custom categories apply\u2014entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property.\n","items":{"type":"string"},"example":["policy-20037","risk-Financial Crime","userTag-Fin Crime-active"]},"riskTags":{"type":"array","description":"Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags).\n","items":{"type":"string"},"example":["PEP-active","cc42-active"]}}}],"properties":{"isBookmarked":{"type":"boolean","description":"indicates whether the evidence is bookmarked by the user","example":true}}}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthenticated request"},"403":{"description":"Forbidden"},"404":{"description":"Not found"},"500":{"description":"Internal server error"}}},"delete":{"summary":"Delete bookmark evidence in an assessment","description":"Delete bookmark evidence in an assessment\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"assessmentEvidenceBookmarkDelete","tags":["Assessment"],"parameters":[{"name":"assessment_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"evidence_id","in":"path","required":true,"schema":{"type":"number"}}],"responses":{"200":{"description":"Returns the deleted evidence item and activity entry\n","content":{"application\/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"number","description":"evidence ID","example":161325},"matchScore":{"type":"number","description":"the confidence that the match between the assessed entity and the one found in the evidence piece is correct","example":0.7002781604436024},"totalRisk":{"type":"number","description":"the sum of all risk for the evidence. each match reason contributes to the total risk.","example":100},"matchDate":{"type":"number","description":"the unix timestamp when the evidence was created","example":1603295488656},"isGroupMaster":{"type":"boolean","description":"indicates whether the evidence item is the master version","example":true},"tags":{"type":"array","description":"Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and\u2014when custom categories apply\u2014entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property.\n","items":{"type":"string"},"example":["policy-20037","risk-Financial Crime","userTag-Fin Crime-active"]},"riskTags":{"type":"array","description":"Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags).\n","items":{"type":"string"},"example":["PEP-active","cc42-active"]}}}],"properties":{"isBookmarked":{"type":"boolean","description":"indicates whether the evidence is bookmarked by the user","example":true}}}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthenticated request"},"403":{"description":"Forbidden"},"404":{"description":"Not found"},"500":{"description":"Internal server error"}}}},"\/assessment\/export\/jsonl":{"post":{"summary":"Fetch assessments in JSON-L format","description":"Request to export assessments in the system as JSON-L format.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes, and a global concurrent request limit of 5 simultaneous requests per customer.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 66 ms |\n| 90th percentile | 561 ms |\n| 95th percentile | 755 ms |\n| 98th percentile | 1.1 s |\n| 99th percentile | 1.3 s |\n<!-- operational-characteristics:end -->\n\nEach assessment includes `riskTags` and `tags` (including `userTag-{pillLabel}-active|inactive`\nfor custom categories when enabled). Enriched `results` entries expose the same fields per linked alert.\n\nPlease note, at scale some queries to this endpoint may slowdown. Please test your particular access pattern at the scale you are running at.\n","operationId":"assessmentExport","tags":["Assessment Export"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":65.94,"p90":560.44,"p95":754.4,"p98":1066.89,"p99":1300.49,"sampleSize":610091}},"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"assessmentFilter":{"type":"object","description":"The collection of filters","anyOf":[{"properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"type":"array","items":{"oneOf":[{"type":"object","allOf":[{"not":{"required":["createdBy","createdByExternalIds"]}}],"properties":{"status":{"type":"array","items":{"type":"integer","example":1},"description":"The status of the assessment"},"precision":{"type":"array","items":{"type":"string","example":"torch_normal"},"description":"The precision setting of the search to be applied as part of the assessment. Deprecated as precision is now defined in the policy.\n","deprecated":true},"created":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590989346512},"gt":{"type":"number","example":1590989346512},"lt":{"type":"number","example":1590989346512}},"description":"Timestamp range for when the assessment was created"},"updated":{"description":"Timestamp range for when the assessment was last updated","type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590989346512},"gt":{"type":"number","example":1590989346512},"lt":{"type":"number","example":1590989346512}}},"closureDate":{"description":"Timestamp range for when the assessment was closed","type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590989346512},"gt":{"type":"number","example":1590989346512},"lt":{"type":"number","example":1590989346512}}},"id":{"description":"Array of assessments IDs","type":"array","items":{"type":"string"},"example":["AS-3","AS-100","AS-201"]},"createdBy":{"description":"Internal IDs of users who created the assessments. Cannot be used in conjunction with createdByExternalIds.","type":"array","items":{"type":"integer","example":990}},"createdByExternalIds":{"description":"External IDs of users who created the assessments. Cannot be used in conjunction with createdBy.","type":"array","items":{"type":"string","example":"john.smith@ripjar.com"}},"policyId":{"description":"ID of the policy associated with this assessment","type":"array","items":{"type":"integer","example":10002}},"previousAssignees":{"type":"array","items":{"type":"object","allOf":[{"not":{"required":["includes","includesExternalIds"]}},{"not":{"required":["excludes","excludesExternalIds"]}}],"properties":{"includes":{"description":"array of internal user IDs. Cannot be used in conjunction with includesExternalIds.","type":"array","items":{"type":"number","example":990}},"includesExternalIds":{"description":"array of external user IDs. Cannot be used in conjunction with includes.","type":"array","items":{"type":"string","example":"john.smith@ripjar.com"}},"excludes":{"description":"array of internal user IDs. Cannot be used in conjunction with excludesExternalIds.","type":"array","items":{"type":"number","example":990}},"excludesExternalIds":{"description":"array of external user IDs. Cannot be used in conjunction with excludes.","type":"array","items":{"type":"string","example":"john.smith@ripjar.com"}}}}}}},{"type":"object","description":"recursive filter","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filter"}}}]}}}},{"type":"object","properties":{"skip":{"type":"integer","default":0,"description":"The number of records to skip."},"limit":{"type":"integer","default":100,"description":"The number of records to return. Setting this to zero (0) returns all records."},"sort":{"type":"string","description":"Field to sort by and sort order","enum":["created:1","created:-1","updated:1","updated:-1","closureDate:1","closureDate:-1"]}}}]},"enrich":{"type":"object","description":"Instructions to enrich specific parts to the results","properties":{"results":{"type":"boolean","description":"enrich the results property (the objects produced as a result of the assessment) with extra fields"}}}}},"example":{"assessmentFilter":{"filters":[{"status":[1],"created":{"gte":0},"updated":{"lte":1590989346512},"policyId":[10002]},{"operator":"OR","filters":[{"id":["AS-3","AS-100","AS-201"]},{"createdBy":[990]}]}],"operator":"AND","skip":0,"limit":0,"sort":"created:1"},"enrich":{"results":true}}}}},"responses":{"200":{"description":"Assessments retrieved","content":{"application\/jsonld":{"schema":{"oneOf":[{"description":"Line-delimited JSON assessment objects","type":"object","properties":{"createdBy":{"type":"number","example":10002,"description":"ID of the user who created the assessment"},"clientKey":{"type":"string","example":"lowercasekey","description":"The system client key that owns the assessment"},"policyId":{"type":"number","example":10002,"description":"Represents the policy for generating the assessment"},"assessmentRange":{"type":"object","description":"The time frame in which the assessment has been conducted","properties":{"gte":{"type":"number","example":1588078084933,"description":"The lower bound of the range (greater than or equal to)"},"lte":{"type":"number","example":1590670084934,"description":"The upper bound of the range (less than or equal to)"}}},"label":{"type":"string","example":"john doe","description":"The name of the assessed entity"},"targets":{"type":"array","description":"Contains information regarding the clients (EOIs) that matched the assessed entity\n","items":{"type":"object","properties":{"id":{"type":"string","example":"2f4aab0d-deee-4460-a3df-82e0cf817fe9"},"eoiId":{"type":"string","example":"assessment:2f4aab0d-deee-4460-a3df-82e0cf817fe9"},"_revision":{"type":"number","example":1251}}}},"results":{"type":"array","description":"The objects produced as a result of the assessment","items":{"type":"object","properties":{"id":{"type":"number"},"status":{"type":"number"},"assignedUsers":{"example":[{"username":"John Smith","email":"john.smith@ripjar.com","externalId":"john.smith@ripjar.com","mobile":"01234567890","roles":["ROLE_1"],"cn":"john.smith@ripjar.com","clientKey":"lowercasekey","customerExcludedApps":["app"],"security":{},"lastLogin":1596188918065,"username_lowercase":"john smith","lineNumber":4,"lastModified":1595437138430,"id":10003,"dateCreated":1595437138459}],"oneOf":[{"type":"array","description":"IDs of users assigned to the result, returned when results enrichment is disabled","items":{"type":"number"},"example":[1]},{"type":"array","description":"Objects representing users assigned to the result, returned when results enrichment is enabled","items":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}},"components":{"schemas":{"AssignedUserEnriched":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"externalId":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"security":{"type":"object"},"lastLogin":{"type":"number","example":1596188918065},"username_lowercase":{"type":"string","example":"john smith"},"lineNumber":{"type":"number","example":4},"lastModified":{"type":"number","example":1595437138430},"id":{"type":"number","example":1},"dateCreated":{"type":"number","example":1595437138459}}}}}}]},"state":{"type":"number","description":"(Only present if results enrichment is enabled) The state of the result"},"score":{"type":"number","description":"(Only present if results enrichment is enabled) The score assigned to the result"},"time":{"type":"object","description":"(Only present if results enrichment is enabled)","properties":{"created":{"description":"The time the result was created in ms epoch","type":"number"},"lastUpdated":{"description":"The time the result was last updated in ms epoch","type":"number"}}},"tags":{"description":"(Only present if results enrichment is enabled) Tags associated with the result, including `userTag-{pillLabel}-active|inactive` for custom categories when exported.\n","allOf":[{"type":"array","description":"Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and\u2014when custom categories apply\u2014entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property.\n","items":{"type":"string"},"example":["policy-20037","risk-Financial Crime","userTag-Fin Crime-active"]}]},"riskTags":{"description":"(Only present if results enrichment is enabled) Risk tags for the result, including custom category stamps (`cc{id}` with optional `-active` \/ `-inactive` suffix).\n","allOf":[{"type":"array","description":"Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags).\n","items":{"type":"string"},"example":["PEP-active","cc42-active"]}]}}}},"created":{"type":"number","example":1590670084934,"description":"Unix Epoch timestamp for when the assessment was created"},"updated":{"type":"number","example":1590670087032,"description":"Unix Epoch timestamp for when the assessment was updated"},"precision":{"type":"string","example":"torch_fuzzy","description":"The matching strategy used to connect the input to other entities in the system\n"},"options":{"type":"object","example":{"languages":[]},"description":"The options used when the assessment was created"},"security":{"type":"object","description":"Security settings attributed to the assessment"},"namespace":{"type":"string","example":"torch","description":"The system namespace"},"status":{"type":"number","example":1,"description":"The assessment's status"},"id":{"type":"string","example":"AS-132","description":"The assessment's ID"},"tags":{"type":"array","description":"Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and\u2014when custom categories apply\u2014entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property.\n","items":{"type":"string"},"example":["policy-20037","risk-Financial Crime","userTag-Fin Crime-active"]},"riskTags":{"type":"array","description":"Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags).\n","items":{"type":"string"},"example":["PEP-active","cc42-active"]},"groupContext":{"type":"object","required":["isPrimary","groupId"],"properties":{"isPrimary":{"type":"boolean","description":"if this assessment is the primary one of the group","example":false},"groupId":{"type":"string","description":"id of the group","example":"03b9a256-9524-4ed8-9d23-84a213793b7b"},"relationship":{"type":"object","properties":{"type":{"type":"string","description":"type of relationship between assessed entity and the primary assessment","example":"FRIEND"}}}}}}},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}]}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthenticated request"},"403":{"description":"The authenticated user cannot view assessments"},"500":{"description":"An unexpected error occurred when fetching the assessments","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}},"examples":{"unexpectedError":{"summary":"Unexpected Error","value":{"code":"ERROR_GETTING_ASSESSMENT","message":"An error occurred retrieving the assessments"}}}}}}}}},"\/assessment\/evidence\/export\/jsonl":{"post":{"summary":"Export evidence in JSON-L format","description":"Streaming filtered export of evidence in jsonl format. If the assessment is closed the matches enrichment will not be populated.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes, and a global concurrent request limit of 5 simultaneous requests per customer.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 920 ms |\n| 90th percentile | 5.2 s |\n| 95th percentile | 1:08 (min) |\n| 98th percentile | 1:15 (min) |\n| 99th percentile | 1:18 (min) |\n<!-- operational-characteristics:end -->\n\nEach evidence row includes `riskTags` (`cc{id}` custom category stamps) and `tags` with matching\n`userTag-{pillLabel}-active|inactive` entries derived from that row's `riskTags` only.\n\nPlease note, at scale some queries to this endpoint may slowdown. Please test your particular access pattern at the scale you are running at.\n","operationId":"assessmentEvidenceExport","tags":["Assessment Export"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":919.64,"p90":5197.19,"p95":68037.59,"p98":75111.66,"p99":78919.91,"sampleSize":231137}},"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"evidenceFilter":{"description":"nested filters","oneOf":[{"type":"object","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"alertId":{"type":"array","items":{"type":"integer"},"description":"the alert id of the evidence"},"assessmentId":{"type":"array","items":{"type":"string"},"description":"the assessment ids e.g 'AS-101'"},"alertType":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"assessment.codes":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"totalRisk":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to fields greater or equal to this value"},"gt":{"type":"number","description":"Match to fields greater than this value"},"lte":{"type":"number","description":"Match to fields less or equal to this value"},"lt":{"type":"number","description":"Match to fields less than this value"}}},"type":{"description":"the type of alert","enum":["list","risk"]},"createdTimestamp":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}},"assessment.timestamp":{"description":"filter the results based on the evidence assessment timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters","type":"object","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"alertId":{"type":"array","items":{"type":"integer"},"description":"the alert id of the evidence"},"assessmentId":{"type":"array","items":{"type":"string"},"description":"the assessment ids e.g 'AS-101'"},"alertType":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"assessment.codes":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"totalRisk":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to fields greater or equal to this value"},"gt":{"type":"number","description":"Match to fields greater than this value"},"lte":{"type":"number","description":"Match to fields less or equal to this value"},"lt":{"type":"number","description":"Match to fields less than this value"}}},"type":{"description":"the type of alert","enum":["list","risk"]},"createdTimestamp":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}},"assessment.timestamp":{"description":"filter the results based on the evidence assessment timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters"}}}]}}}}}}]}}}},{"type":"object","properties":{"skip":{"type":"integer","default":0,"description":"The number of records to skip."},"limit":{"type":"integer","default":100,"description":"The number of records to return. Setting this to zero (0) returns all records."},"sort":{"type":"string","description":"field to sort by and sort order","enum":["alertId:1","alertId:-1","createdTimestamp:1","createdTimestamp:-1","target:1","target:-1","totalRisk:1","totalRisk:-1"]}}}]},"enrich":{"type":"object","description":"Instructions to enrich specific parts to the results","properties":{"assessments":{"type":"boolean","description":"enrich results with evidence assessment details","default":false},"comments":{"type":"boolean","description":"enrich results with comment details","default":false},"matches":{"type":"boolean","description":"enrich results with identity matches details. If using on a closed assessment, this matches field will not be populated.","default":false},"lists":{"type":"boolean","description":"enrich results with list entity details","default":false}}},"projections":{"type":"object","description":"set of fields to return or not return","properties":{"assessments":{"type":"object","description":"set of evidence assessment fields to return or not return"},"evidence":{"type":"object","description":"set of evidence fields to return or not return"},"comments":{"type":"object","description":"set of comments fields to return or not return"},"lists":{"example":{"name":true,"significantProfiles":true,"lists":true},"type":"object","properties":{"activeStatus":{"type":"boolean"},"additionalNames":{"type":"boolean"},"additionalNamesAliasVariant":{"type":"boolean"},"additionalNamesArabicArabicNormalised":{"type":"boolean"},"additionalNamesDiacriticVariants":{"type":"boolean"},"additionalNamesHomophones":{"type":"boolean"},"additionalNamesLatinArabicNormalised":{"type":"boolean"},"additionalNamesLevenshteinVariants":{"type":"boolean"},"additionalNamesSubtractionVariants":{"type":"boolean"},"additionalNamesTlevVariants":{"type":"boolean"},"additionalNamesTransliterationVariants":{"type":"boolean"},"additionalNamesVariants":{"type":"boolean"},"addresses":{"type":"boolean"},"aliases":{"type":"boolean"},"ameDetails":{"type":"boolean"},"arabicArabicNormalisedName":{"type":"boolean"},"birthPlace":{"type":"boolean"},"birthPlaceCity":{"type":"boolean"},"birthPlaceCountry":{"type":"boolean"},"birthPlaceCountryCode":{"type":"boolean"},"callSignsPrefixCodes":{"type":"boolean"},"callSignsPrefixes":{"type":"boolean"},"callSignsVariants":{"type":"boolean"},"categories":{"type":"boolean"},"citizenship":{"type":"boolean"},"citizenshipCode":{"type":"boolean"},"coreName":{"type":"boolean"},"coreNameAliasVariants":{"type":"boolean"},"coreNameDiacriticVariants":{"type":"boolean"},"coreNameHomophones":{"type":"boolean"},"coreNameVariants":{"type":"boolean"},"countryOfReportedAllegation":{"type":"boolean"},"countryOfReportedAllegationCode":{"type":"boolean"},"dateOfBirthRange":{"type":"boolean"},"dateOfBirthRanges":{"type":"boolean"},"deceased":{"type":"boolean"},"deceasedDateRange":{"type":"boolean"},"deceasedDateRanges":{"type":"boolean"},"descriptions":{"type":"boolean"},"enhancedRiskCountry":{"type":"boolean"},"enhancedRiskCountryCode":{"type":"boolean"},"entityType":{"type":"boolean","default":true},"firstSeen":{"type":"boolean"},"firstSignificantSeen":{"type":"boolean"},"forename":{"type":"boolean"},"formerlySanctionedRegionCode":{"type":"boolean"},"gender":{"type":"boolean"},"hash":{"type":"boolean"},"id":{"type":"boolean","default":true},"identityNumbers":{"type":"boolean"},"imageKeys":{"type":"boolean"},"images":{"type":"boolean"},"initialisedNameVariants":{"type":"boolean"},"initialisedNames":{"type":"boolean"},"internal":{"type":"boolean"},"isSignificantProfile":{"type":"boolean"},"jurisdiction":{"type":"boolean"},"jurisdictionCode":{"type":"boolean"},"keyTerms":{"type":"boolean"},"lastModifiedDateRange":{"type":"boolean"},"lastSeen":{"type":"boolean"},"lastSignificantSeen":{"type":"boolean"},"lastSignificantUpdate":{"type":"boolean"},"latinArabicNormalisedName":{"type":"boolean"},"levSubtractionVariants":{"type":"boolean"},"levenshteinVariants":{"type":"boolean"},"listId":{"type":"boolean"},"lists":{"type":"boolean","default":true},"metadata":{"type":"boolean","default":true},"middlename":{"type":"boolean"},"name":{"type":"boolean","default":true},"nameOrigin":{"type":"boolean"},"ngrams":{"type":"boolean"},"normalisedName":{"type":"boolean"},"originalScriptName":{"type":"boolean"},"otherRoles":{"type":"boolean"},"previousRoles":{"type":"boolean"},"profileNotes":{"type":"boolean"},"residentOf":{"type":"boolean"},"residentOfCode":{"type":"boolean"},"roles":{"type":"boolean"},"sanctionedRegionCode":{"type":"boolean"},"script":{"type":"boolean"},"security":{"type":"boolean"},"significantDocuments":{"type":"boolean"},"significantProfiles":{"type":"boolean"},"singleStringName":{"type":"boolean"},"sources":{"type":"boolean"},"stateOwnershipDetails":{"type":"boolean"},"suffix":{"type":"boolean"},"surname":{"type":"boolean"},"systemEvent":{"type":"boolean"},"titleHonorific":{"type":"boolean"},"tlevVariants":{"type":"boolean"},"transliterationVariants":{"type":"boolean"},"cessationDateRange":{"type":"boolean"},"cessationDateRanges":{"type":"boolean"},"companyUrls":{"type":"boolean"},"countryOfAffiliation":{"type":"boolean"},"countryOfAffiliationCode":{"type":"boolean"},"countryOfRegistration":{"type":"boolean"},"countryOfRegistrationCode":{"type":"boolean"},"dateOfRegistrationRange":{"type":"boolean"},"dateOfRegistrationRanges":{"type":"boolean"},"formerlySanctionedRegion":{"type":"boolean"},"sanctionedRegion":{"type":"boolean"},"vesselAdditionalOperators":{"type":"boolean"},"vesselCallSigns":{"type":"boolean"},"vesselCustomers":{"type":"boolean"},"vesselFlags":{"type":"boolean"},"vesselFlagsCode":{"type":"boolean"},"vesselGrts":{"type":"boolean"},"vesselImoNumber":{"type":"boolean"},"vesselOwners":{"type":"boolean"},"vesselTonnages":{"type":"boolean"},"vesselTypes":{"type":"boolean"},"cities":{"type":"boolean"},"countryCode":{"type":"boolean"},"locationType":{"type":"boolean"}}}}}},"components":{"schemas":{"EvidenceFilter":{"description":"nested filters","oneOf":[{"type":"object","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"alertId":{"type":"array","items":{"type":"integer"},"description":"the alert id of the evidence"},"assessmentId":{"type":"array","items":{"type":"string"},"description":"the assessment ids e.g 'AS-101'"},"alertType":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"assessment.codes":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"totalRisk":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to fields greater or equal to this value"},"gt":{"type":"number","description":"Match to fields greater than this value"},"lte":{"type":"number","description":"Match to fields less or equal to this value"},"lt":{"type":"number","description":"Match to fields less than this value"}}},"type":{"description":"the type of alert","enum":["list","risk"]},"createdTimestamp":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}},"assessment.timestamp":{"description":"filter the results based on the evidence assessment timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters","type":"object","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"alertId":{"type":"array","items":{"type":"integer"},"description":"the alert id of the evidence"},"assessmentId":{"type":"array","items":{"type":"string"},"description":"the assessment ids e.g 'AS-101'"},"alertType":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"assessment.codes":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"totalRisk":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to fields greater or equal to this value"},"gt":{"type":"number","description":"Match to fields greater than this value"},"lte":{"type":"number","description":"Match to fields less or equal to this value"},"lt":{"type":"number","description":"Match to fields less than this value"}}},"type":{"description":"the type of alert","enum":["list","risk"]},"createdTimestamp":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}},"assessment.timestamp":{"description":"filter the results based on the evidence assessment timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters"}}}]}}}}}}]}}}},{"type":"object","properties":{"skip":{"type":"integer","default":0,"description":"The number of records to skip."},"limit":{"type":"integer","default":100,"description":"The number of records to return. Setting this to zero (0) returns all records."},"sort":{"type":"string","description":"field to sort by and sort order","enum":["alertId:1","alertId:-1","createdTimestamp:1","createdTimestamp:-1","target:1","target:-1","totalRisk:1","totalRisk:-1"]}}}]},"Filters":{"type":"object","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"alertId":{"type":"array","items":{"type":"integer"},"description":"the alert id of the evidence"},"assessmentId":{"type":"array","items":{"type":"string"},"description":"the assessment ids e.g 'AS-101'"},"alertType":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"assessment.codes":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"totalRisk":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to fields greater or equal to this value"},"gt":{"type":"number","description":"Match to fields greater than this value"},"lte":{"type":"number","description":"Match to fields less or equal to this value"},"lt":{"type":"number","description":"Match to fields less than this value"}}},"type":{"description":"the type of alert","enum":["list","risk"]},"createdTimestamp":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}},"assessment.timestamp":{"description":"filter the results based on the evidence assessment timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters","type":"object","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"alertId":{"type":"array","items":{"type":"integer"},"description":"the alert id of the evidence"},"assessmentId":{"type":"array","items":{"type":"string"},"description":"the assessment ids e.g 'AS-101'"},"alertType":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"assessment.codes":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"totalRisk":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to fields greater or equal to this value"},"gt":{"type":"number","description":"Match to fields greater than this value"},"lte":{"type":"number","description":"Match to fields less or equal to this value"},"lt":{"type":"number","description":"Match to fields less than this value"}}},"type":{"description":"the type of alert","enum":["list","risk"]},"createdTimestamp":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}},"assessment.timestamp":{"description":"filter the results based on the evidence assessment timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters"}}}]}}}}}}]}}}},"NestedFilters":{"type":"object","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"alertId":{"type":"array","items":{"type":"integer"},"description":"the alert id of the evidence"},"assessmentId":{"type":"array","items":{"type":"string"},"description":"the assessment ids e.g 'AS-101'"},"alertType":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"assessment.codes":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"totalRisk":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to fields greater or equal to this value"},"gt":{"type":"number","description":"Match to fields greater than this value"},"lte":{"type":"number","description":"Match to fields less or equal to this value"},"lt":{"type":"number","description":"Match to fields less than this value"}}},"type":{"description":"the type of alert","enum":["list","risk"]},"createdTimestamp":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}},"assessment.timestamp":{"description":"filter the results based on the evidence assessment timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters"}}}]}}}},"EvidenceFilterKeyValues":{"type":"object","properties":{"alertId":{"type":"array","items":{"type":"integer"},"description":"the alert id of the evidence"},"assessmentId":{"type":"array","items":{"type":"string"},"description":"the assessment ids e.g 'AS-101'"},"alertType":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"assessment.codes":{"type":"array","items":{"type":"integer"},"description":"the alert type of the evidence"},"totalRisk":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to fields greater or equal to this value"},"gt":{"type":"number","description":"Match to fields greater than this value"},"lte":{"type":"number","description":"Match to fields less or equal to this value"},"lt":{"type":"number","description":"Match to fields less than this value"}}},"type":{"description":"the type of alert","enum":["list","risk"]},"createdTimestamp":{"description":"filter the results based on the evidence created timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}},"assessment.timestamp":{"description":"filter the results based on the evidence assessment timestamp","type":"object","properties":{"gte":{"type":"number","description":"Match to evidence greater or equal to than this unix timestamp (milliseconds)"},"gt":{"type":"number","description":"Match to evidence greater than this unix timestamp (milliseconds)"},"lte":{"type":"number","description":"Match to evidence less or equal to than this unix timestamp (milliseconds)"},"lt":{"type":"number","description":"Match to evidence less than this unix timestamp (milliseconds)"}}}}}}}},"example":{"evidenceFilter":{"filters":[{"alertId":[10001],"assessmentId":["AS-101"],"totalRisk":{"gte":0,"lte":100},"assessment.timestamp":{"gte":0,"lte":1590973346512}},{"operator":"AND","filters":[{"createdTimestamp":{"gt":0}},{"createdTimestamp":{"lt":1590973346512}}]}],"operator":"OR","skip":0,"limit":0,"sort":"alertId:1"},"enrich":{"assessments":true,"comments":true,"matches":true,"lists":true},"projections":{"assessments":{},"evidence":{},"comments":{},"policies":{},"lists":{}}}}}},"responses":{"200":{"description":"Evidence items returned in line-delimited JSON format","content":{"application\/jsonld":{"schema":{"oneOf":[{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}},{"description":"Line-delimited JSON evidence objects","type":"object","properties":{"searchResultAssessmentId":{"type":"string","description":"ID of the assessment this evidence is associated with","example":"AS-1"},"alertId":{"type":"number","description":"ID of associated alert","example":18793},"alertType":{"type":"number","description":"ID of policy that resulted in the associated alert","example":10001},"clientKey":{"type":"string","description":"User\\'s client key","example":"lowercasekey"},"createdTimestamp":{"type":"number","description":"Time evidence was created as an Epoch timestamp","example":1592889012822},"data":{"type":"object","description":"Additional metadata","example":{"irs_version":83894,"vos_version":17448},"properties":{"irs_version":{"type":"number"},"vos_version":{"type":"number"}}},"id":{"type":"number","description":"The evidence item\\'s ID","example":39824},"isGroupMaster":{"type":"boolean","description":"Determines whether the evidence item is a master item","example":true},"matchTypes":{"type":"array","items":{"type":"string","enum":["NAME","ADDRESS","LOCATION"]}},"namespace":{"type":"string","description":"The system\\'s namespace","example":"torch"},"reasons":{"type":"array","items":{"type":"object","properties":{"data":{"type":"object","properties":{"match":{"type":"object","properties":{"active":{"type":"boolean"},"allPoliciesEvaluated":{"type":"boolean"},"cellId":{"type":"string"},"entity":{"description":"The entity of interest sent for matching, either a client or a list depending on if the Alert is breached due to client load or profile load","oneOf":[{"discriminator":{"propertyName":"entityType","mapping":{"PERSON":".\/PersonClient.yaml","ORGANISATION":".\/OrganisationClient.yaml","VESSEL":".\/VesselClient.yaml","AIRCRAFT":".\/AircraftClient.yaml"}},"anyOf":[{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"description":"Entity specifier for a person. Must provide at least one of the following:\n\n  * name (recommended)\n  * firstName and surname (with optional middleName)\n\nIf all three are provided, the system will use \"name\". Our recommendation is\nfor you to provide a single, whole, name string which we will then analyse.\n\n**Note**: Name structure is a cultural artefact. We strongly recommend using\nthe full name field as we handle many cross-cultural aspects. If you do wish\nto separate out the name then we consider \"firstName\" to be the given name of\nan individual, and \"surname\" to be a \"family\" name.\n","properties":{"entityType":{"const":"PERSON"},"gender":{"type":"string"},"titles":{"type":"array","items":{"type":"string"}},"surname":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"suffixes":{"type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"titles":{"type":"array","items":{"type":"string"}},"surname":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"suffixes":{"type":"array","items":{"type":"string"}},"nameType":{"type":"string"}}}},"dateOfBirth":{"oneOf":[{"type":"string"},{"type":"integer"}]},"birthPlaceCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"deceasedOn":{"oneOf":[{"type":"string"},{"type":"integer"}]},"nationalityCodes":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"domicileCodes":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"occupation":{"type":"string"}}},{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"properties":{"entityType":{"const":"ORGANISATION"},"companyName":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"aliases":{"type":"array","items":{"type":"object","properties":{"companyName":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"nameType":{"type":"string"}}}},"dateOfIncorporation":{"oneOf":[{"type":"string"},{"type":"integer"}]},"incorporationCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"required":["companyName"]},{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"description":"An entity specifier for a maritime vessel. Must provide AT LEAST ONE of:\nname, aliases, vesselCallSigns or vesselImoNumber\n","required":["vesselName"],"properties":{"entityType":{"const":"VESSEL"},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"nameType":{"type":"string"}}}},"vesselName":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"vesselCallSigns":{"type":"array","items":{"type":"string"}},"vesselTypes":{"type":"array","items":{"type":"string"}},"vesselTonnages":{"type":"array","items":{"type":"number"}},"vesselOwners":{"type":"array","items":{"type":"string"}},"vesselCustomers":{"type":"array","items":{"type":"string"}},"vesselGrts":{"type":"array","items":{"type":"number"}},"vesselFlags":{"type":"array","items":{"type":"string"}},"vesselFlagsCode":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"vesselImoNumber":{"type":"string"},"countryOfRegistrationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}}},{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"properties":{"entityType":{"const":"AIRCRAFT"},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"nameType":{"type":"string"}}}},"aircraftManufactureDate":{"oneOf":[{"type":"string"},{"type":"integer"}]},"aircraftModel":{"type":"string"},"aircraftName":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"aircraftOperator":{"type":"string"},"countryOfAffiliationCode":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}}}}]},{"description":"The list entity associated with this evidence. Present if the evidence is of type 'list' and the 'lists' enrichment is enabled","oneOf":[{"type":"object","allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}}],"properties":{"person":{"type":"object","description":"The person entity schema must contain the following fileds; firstName, middleName, surname, name\n","properties":{"name":{"type":"string","description":"Full name of the person. Can be used as well as, or instead of, fields for individual name parts"},"firstName":{"type":"string","description":"Given name of the person"},"surname":{"type":"string","description":"Family name of the person"},"aliases":{"type":"array","description":"An aray of alternative names by which a person is known. Fields in each name are as for the main name fields with some additions","items":{"type":"object","properties":{"type":{"type":"string"},"firstName":{"type":"string"},"surname":{"type":"string"},"middleName":{"type":"string"},"titleHonorific":{"type":"string"},"maidenName":{"type":"string"}}}},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER"],"description":"Known gender type of the person, must be in capitals"},"deceased":{"type":"boolean","description":"Is the person deceased?"},"birthPlace":{"type":"string","description":"The name of the persons birthplace. Populated automatically from birthPlaceCountryCode"},"birthPlaceCity":{"type":"string","description":"The persons city of birth"},"dateOfBirthArray":{"type":"array","description":"Possible values for the persons date of birth. This is an array to allow for the uncertanty in reported dates","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"images":{"type":"array","description":"URLs pointing to the images of, or related to, the person","items":{"type":"string"}},"birthPlaceCountryCode":{"type":"string","description":"The country code of the persons birth"},"citizenshipCode":{"type":"array","description":"Country codes of the countries for which the person has citizenship. May be more than one","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"residentOfCode":{"type":"array","description":"Country codes of the countries for which the person is domiciled. May be more than one","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"countryOfReportedAllegationCode":{"type":"array","description":"Country codes of the countries in which alleged misconduct took place. May be more than one","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"middleName":{"type":"string","description":"Middle name of the person"},"roles":{"type":"array","description":"Current jobs or roles of the person","items":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"categoryId":{"type":"string"},"since":{"type":"string","description":"Date in the form yyyy-mm-dd"}}}},"previousRoles":{"type":"array","description":"Past jobs or roles of the person","items":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"categoryId":{"type":"string"},"since":{"type":"string","description":"Date in the form yyyy-mm-dd"},"to":{"type":"string","description":"Date in the form yyyy-mm-dd"}}}},"jurisdictionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"deceasedDateArray":{"type":"array","description":"If the person is deceased (deceased=true), possible values for the persons date of death. This is an array to allow for uncertainty in reported cases"},"suffix":{"type":"string","description":"An honorific that comes after the person's name, rather than before"}}}}},{"type":"object","allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}}],"properties":{"company":{"type":"object","description":"The company entity schema must contain the following fields: name, keyTerms\n","properties":{"name":{"type":"string","description":"The companies main name"},"suffix":{"type":"string","description":"Company suffix, e.g. Ltd, PLC or GmbH"},"aliases":{"type":"array","description":"An array of alternative names by which a company is known","items":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"suffix":{"type":"string"},"entityName":{"type":"string"}}}},"dateOfRegistrationArray":{"type":"array","description":"Company registration dates\n","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"companyURLs":{"type":"array","description":"Associated URLs for the company","items":{"type":"string"}},"countryOfRegistrationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"countryOfAffiliationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"formerlySanctionedRegionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"sanctionedRegionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"cessationDateArray":{"type":"array","description":"For non-active companies, the date(s) on which the company ceased trading","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"keyTerms":{"type":"array","description":"Keywords used in entity matching to automatically match this list entity to client profiles that contain one or more of the key terms. Viewing the list entity will then show all linked client profiles","items":{"keyTerms":{"type":"string"}}}}}}},{"type":"object","allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}}],"properties":{"location":{"type":"object","description":"Location entities are an extension of entities. All of the base fields are included in addition to the fields defined below. \nLocations can be used to represent high risk countries, and can match with location fields on clients or other entities of \ninterest in order to highlight links between the entities and these countries.\n","properties":{"name":{"type":"string","description":"Name of the location"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"The country code of the location","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"locationType":{"type":"string","description":"This must be country"},"cities":{"type":"array","description":"A list of names of cities associated with this location","items":{"type":"string"}}}},"subType":{"type":"string","enum":["country","city","region","sub-region","free-trade-zone","airport","port"],"description":"The sub-type of a location entity"}}},{"allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}},{"type":"object","properties":{"entityType":{"type":"string","enum":["listVessel"]},"vesselCallSigns":{"type":"array","items":{"type":"string"}},"vesselTypes":{"type":"array","items":{"type":"string"}},"vesselTonnages":{"type":"array","items":{"type":"integer"}},"vesselOwners":{"type":"array","items":{"type":"string"}},"vesselCustomers":{"type":"array","items":{"type":"string"}},"vesselGrts":{"type":"array","items":{"type":"integer"}},"vesselFlags":{"type":"array","items":{"type":"string"}},"vesselFlagsCode":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"vesselImoNumber":{"type":"string"},"vesselAdditionalOperators":{"type":"array","items":{"type":"object","properties":{"operatorCategory":{"type":"string","enum":["groupBeneficialOwner","operator","registeredOwner","shipManager","technicalManager"]},"operatorName":{"type":"string"},"countryOfControl":{"type":"string"},"countryOfDomicile":{"type":"string"},"countryOfRegistration":{"type":"string"}}}}}}]},{"type":"object","allOf":[{"type":"object","allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}}],"properties":{"company":{"type":"object","description":"The company entity schema must contain the following fields: name, keyTerms\n","properties":{"name":{"type":"string","description":"The companies main name"},"suffix":{"type":"string","description":"Company suffix, e.g. Ltd, PLC or GmbH"},"aliases":{"type":"array","description":"An array of alternative names by which a company is known","items":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"suffix":{"type":"string"},"entityName":{"type":"string"}}}},"dateOfRegistrationArray":{"type":"array","description":"Company registration dates\n","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"companyURLs":{"type":"array","description":"Associated URLs for the company","items":{"type":"string"}},"countryOfRegistrationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"countryOfAffiliationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"formerlySanctionedRegionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"sanctionedRegionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"cessationDateArray":{"type":"array","description":"For non-active companies, the date(s) on which the company ceased trading","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"keyTerms":{"type":"array","description":"Keywords used in entity matching to automatically match this list entity to client profiles that contain one or more of the key terms. Viewing the list entity will then show all linked client profiles","items":{"keyTerms":{"type":"string"}}}}}}}],"properties":{"aircraft":{"type":"object","description":"Aircraft entities are an extension of company entities. As well as the base fields and aircraft-specific fields, all company properties are also included.\n","properties":{"name":{"type":"string","description":"The aircraft's tail number. The prefix of the tail number is used to determine the aircraft's country of origin."}}}}}],"discriminator":{"propertyName":"entityType","mapping":{"listPerson":".\/ListEntityPerson.yaml","listAircraft":".\/ListEntityAircraft.yaml","listLocation":".\/ListEntityLocation.yaml","listOrganisation":".\/ListEntityOrganisation.yaml","listVessel":".\/ListEntityVessel.yaml"}}}]},"irs_version":{"type":"integer"},"isNew":{"type":"boolean"},"lineNumber":{"type":"integer"},"matchedData":{"description":"Entity that matches the sent entity of interest, trimmed down to only properties required for matching","anyOf":[{"additionalProperties":false,"properties":{"activeStatus":{"type":"string"},"addresses":{"items":{"additionalProperties":false,"properties":{"addressType":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"line":{"type":"string"},"poBox":{"type":"string"},"postcode":{"type":"string"},"province":{"type":"string"}},"type":"object"},"type":"array"},"aliases":{"items":{"additionalProperties":false,"properties":{"firstName":{"type":"string"},"maidenName":{"type":"string"},"middleName":{"type":"string"},"name":{"type":"string"},"suffix":{"type":"string"},"surname":{"type":"string"},"titleHonorific":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"},"associatedCities":{"items":{"type":"string"},"type":"array"},"associatedCountryCodes":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"citizenshipCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"clientKey":{"type":"string"},"dateOfBirthArray":{"items":{"anyOf":[{"type":"string"},{"items":[{"anyOf":[{"type":"number"},{"format":"date-time","type":"string"},{"type":"null"}]},{"anyOf":[{"type":"number"},{"format":"date-time","type":"string"},{"type":"null"}]},{"enum":["year","month","day","range"],"type":"string"}],"maxItems":"3","minItems":"3","type":"array"}]},"type":"array"},"dateOfDeceasedArray":{"items":{"anyOf":[{"type":"string"},{"items":[{"anyOf":[{"type":"number"},{"format":"date-time","type":"string"},{"type":"null"}]},{"anyOf":[{"type":"number"},{"format":"date-time","type":"string"},{"type":"null"}]},{"enum":["year","month","day","range"],"type":"string"}],"maxItems":"3","minItems":"3","type":"array"}]},"type":"array"},"deceased":{"type":"boolean"},"firstName":{"type":"string"},"formerlySanctionedRegionCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"gender":{"enum":["MALE","FEMALE","OTHER"],"type":"string"},"identityNumbers":{"items":{"additionalProperties":false,"properties":{"type":{"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"lastModifiedDate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"lastReviewed":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"},{"type":"string"}]},"lastSignificantUpdate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"lists":{"items":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"additionalFields":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"description":{"type":"string"},"hierarchy":{"items":{"additionalProperties":false,"properties":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"id":{"type":"string"},"jurisdiction":{"type":"string"},"jurisdictionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"listActive":{"type":"boolean"},"name":{"type":"string"},"provider":{"type":"string"},"since":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"sinceRange":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"source":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"to":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"toRange":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"}},"required":["id","name","description","active","listActive","hierarchy"],"type":"object"},"type":"array"},"loadOptions":{"additionalProperties":false,"properties":{"suppressNotification":{"type":"boolean"}},"type":"object"},"middleName":{"type":"string"},"name":{"type":"string"},"profileId":{"type":"string"},"residentOfCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"sanctionedRegionCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"significantDocuments":{"items":{"additionalProperties":false,"properties":{"additionalProperties":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"articleId":{"type":"string"},"dates":{"additionalProperties":false,"properties":{"arrivalDch":{"format":"date-time","type":"string"},"published":{"format":"date-time","type":"string"}},"required":["published","arrivalDch"],"type":"object"},"enTitle":{"type":"string"},"groupId":{"type":"string"},"language":{"type":"string"},"models":{"items":{"additionalProperties":false,"properties":{"confidence":{"type":"number"},"model":{"type":"string"},"name":{"type":"string"}},"required":["name","model","confidence"],"type":"object"},"type":"array"},"properties":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"provider":{"type":"string"},"source":{"type":"string"},"storyline":{"type":"string"},"title":{"type":"string"}},"required":["articleId","title","groupId","provider","source","dates"],"type":"object"},"type":"array"},"status":{"type":"string"},"suffix":{"type":"string"},"surname":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"titleHonorific":{"type":"string"},"type":{"const":"person","type":"string"}},"required":["profileId","type"],"type":"object"},{"additionalProperties":false,"properties":{"activeStatus":{"type":"string"},"addresses":{"items":{"additionalProperties":false,"properties":{"addressType":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"line":{"type":"string"},"poBox":{"type":"string"},"postcode":{"type":"string"},"province":{"type":"string"}},"type":"object"},"type":"array"},"aliases":{"items":{"additionalProperties":false,"properties":{"name":{"type":"string"},"suffix":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"},"associatedCities":{"items":{"type":"string"},"type":"array"},"associatedCountryCodes":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"clientKey":{"type":"string"},"countryOfAffiliationCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"countryOfRegistrationCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"dateOfCessationArray":{"items":{"anyOf":[{"type":"string"},{"items":[{"anyOf":[{"type":"number"},{"format":"date-time","type":"string"},{"type":"null"}]},{"anyOf":[{"type":"number"},{"format":"date-time","type":"string"},{"type":"null"}]},{"enum":["year","month","day","range"],"type":"string"}],"maxItems":"3","minItems":"3","type":"array"}]},"type":"array"},"dateOfRegistrationArray":{"items":{"anyOf":[{"type":"string"},{"items":[{"anyOf":[{"type":"number"},{"format":"date-time","type":"string"},{"type":"null"}]},{"anyOf":[{"type":"number"},{"format":"date-time","type":"string"},{"type":"null"}]},{"enum":["year","month","day","range"],"type":"string"}],"maxItems":"3","minItems":"3","type":"array"}]},"type":"array"},"formerlySanctionedRegionCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"identityNumbers":{"items":{"additionalProperties":false,"properties":{"type":{"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"lastModifiedDate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"lastReviewed":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"},{"type":"string"}]},"lastSignificantUpdate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"lists":{"items":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"additionalFields":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"description":{"type":"string"},"hierarchy":{"items":{"additionalProperties":false,"properties":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"id":{"type":"string"},"jurisdiction":{"type":"string"},"jurisdictionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"listActive":{"type":"boolean"},"name":{"type":"string"},"provider":{"type":"string"},"since":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"sinceRange":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"source":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"to":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"toRange":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"}},"required":["id","name","description","active","listActive","hierarchy"],"type":"object"},"type":"array"},"loadOptions":{"additionalProperties":false,"properties":{"suppressNotification":{"type":"boolean"}},"type":"object"},"name":{"type":"string"},"profileId":{"type":"string"},"sanctionedRegionCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"significantDocuments":{"items":{"additionalProperties":false,"properties":{"additionalProperties":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"articleId":{"type":"string"},"dates":{"additionalProperties":false,"properties":{"arrivalDch":{"format":"date-time","type":"string"},"published":{"format":"date-time","type":"string"}},"required":["published","arrivalDch"],"type":"object"},"enTitle":{"type":"string"},"groupId":{"type":"string"},"language":{"type":"string"},"models":{"items":{"additionalProperties":false,"properties":{"confidence":{"type":"number"},"model":{"type":"string"},"name":{"type":"string"}},"required":["name","model","confidence"],"type":"object"},"type":"array"},"properties":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"provider":{"type":"string"},"source":{"type":"string"},"storyline":{"type":"string"},"title":{"type":"string"}},"required":["articleId","title","groupId","provider","source","dates"],"type":"object"},"type":"array"},"status":{"type":"string"},"suffix":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"type":{"const":"organisation","type":"string"}},"required":["profileId","type"],"type":"object"},{"additionalProperties":false,"properties":{"activeStatus":{"type":"string"},"addresses":{"items":{"additionalProperties":false,"properties":{"addressType":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"line":{"type":"string"},"poBox":{"type":"string"},"postcode":{"type":"string"},"province":{"type":"string"}},"type":"object"},"type":"array"},"aliases":{"items":{"additionalProperties":false,"properties":{"name":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"},"associatedCities":{"items":{"type":"string"},"type":"array"},"associatedCountryCodes":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"clientKey":{"type":"string"},"countryOfAffiliationCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"countryOfRegistrationCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"formerlySanctionedRegionCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"identityNumbers":{"items":{"additionalProperties":false,"properties":{"type":{"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"lastModifiedDate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"lastReviewed":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"},{"type":"string"}]},"lastSignificantUpdate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"lists":{"items":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"additionalFields":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"description":{"type":"string"},"hierarchy":{"items":{"additionalProperties":false,"properties":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"id":{"type":"string"},"jurisdiction":{"type":"string"},"jurisdictionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"listActive":{"type":"boolean"},"name":{"type":"string"},"provider":{"type":"string"},"since":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"sinceRange":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"source":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"to":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"toRange":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"}},"required":["id","name","description","active","listActive","hierarchy"],"type":"object"},"type":"array"},"loadOptions":{"additionalProperties":false,"properties":{"suppressNotification":{"type":"boolean"}},"type":"object"},"name":{"type":"string"},"profileId":{"type":"string"},"sanctionedRegionCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"significantDocuments":{"items":{"additionalProperties":false,"properties":{"additionalProperties":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"articleId":{"type":"string"},"dates":{"additionalProperties":false,"properties":{"arrivalDch":{"format":"date-time","type":"string"},"published":{"format":"date-time","type":"string"}},"required":["published","arrivalDch"],"type":"object"},"enTitle":{"type":"string"},"groupId":{"type":"string"},"language":{"type":"string"},"models":{"items":{"additionalProperties":false,"properties":{"confidence":{"type":"number"},"model":{"type":"string"},"name":{"type":"string"}},"required":["name","model","confidence"],"type":"object"},"type":"array"},"properties":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"provider":{"type":"string"},"source":{"type":"string"},"storyline":{"type":"string"},"title":{"type":"string"}},"required":["articleId","title","groupId","provider","source","dates"],"type":"object"},"type":"array"},"status":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"type":{"const":"vessel","type":"string"},"vesselCallSigns":{"items":{"type":"string"},"type":"array"},"vesselFlagsCode":{"items":{"type":"string"},"type":"array"},"vesselGrts":{"items":{"type":"string"},"type":"array"},"vesselImoNumber":{"type":"string"},"vesselOwners":{"items":{"type":"string"},"type":"array"},"vesselTonnages":{"items":{"type":"string"},"type":"array"},"vesselTypes":{"items":{"type":"string"},"type":"array"}},"required":["profileId","type"],"type":"object"},{"additionalProperties":false,"properties":{"activeStatus":{"type":"string"},"addresses":{"items":{"additionalProperties":false,"properties":{"addressType":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"line":{"type":"string"},"poBox":{"type":"string"},"postcode":{"type":"string"},"province":{"type":"string"}},"type":"object"},"type":"array"},"aliases":{"items":{"additionalProperties":false,"properties":{"name":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"},"associatedCities":{"items":{"type":"string"},"type":"array"},"associatedCountryCodes":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"clientKey":{"type":"string"},"countryOfAffiliationCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"countryOfRegistrationCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"formerlySanctionedRegionCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"identityNumbers":{"items":{"additionalProperties":false,"properties":{"type":{"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"lastModifiedDate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"lastReviewed":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"},{"type":"string"}]},"lastSignificantUpdate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"lists":{"items":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"additionalFields":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"description":{"type":"string"},"hierarchy":{"items":{"additionalProperties":false,"properties":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"id":{"type":"string"},"jurisdiction":{"type":"string"},"jurisdictionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"listActive":{"type":"boolean"},"name":{"type":"string"},"provider":{"type":"string"},"since":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"sinceRange":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"source":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"to":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"toRange":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"}},"required":["id","name","description","active","listActive","hierarchy"],"type":"object"},"type":"array"},"loadOptions":{"additionalProperties":false,"properties":{"suppressNotification":{"type":"boolean"}},"type":"object"},"name":{"type":"string"},"profileId":{"type":"string"},"sanctionedRegionCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"significantDocuments":{"items":{"additionalProperties":false,"properties":{"additionalProperties":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"articleId":{"type":"string"},"dates":{"additionalProperties":false,"properties":{"arrivalDch":{"format":"date-time","type":"string"},"published":{"format":"date-time","type":"string"}},"required":["published","arrivalDch"],"type":"object"},"enTitle":{"type":"string"},"groupId":{"type":"string"},"language":{"type":"string"},"models":{"items":{"additionalProperties":false,"properties":{"confidence":{"type":"number"},"model":{"type":"string"},"name":{"type":"string"}},"required":["name","model","confidence"],"type":"object"},"type":"array"},"properties":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"provider":{"type":"string"},"source":{"type":"string"},"storyline":{"type":"string"},"title":{"type":"string"}},"required":["articleId","title","groupId","provider","source","dates"],"type":"object"},"type":"array"},"status":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"type":{"const":"aircraft","type":"string"}},"required":["profileId","type"],"type":"object"},{"additionalProperties":false,"properties":{"activeStatus":{"type":"string"},"addresses":{"items":{"additionalProperties":false,"properties":{"addressType":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"line":{"type":"string"},"poBox":{"type":"string"},"postcode":{"type":"string"},"province":{"type":"string"}},"type":"object"},"type":"array"},"aliases":{"items":{"additionalProperties":false,"properties":{"name":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"},"associatedCities":{"items":{"type":"string"},"type":"array"},"associatedCountryCodes":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"cities":{"items":{"type":"string"},"type":"array"},"clientKey":{"type":"string"},"formerlySanctionedRegionCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"identityNumbers":{"items":{"additionalProperties":false,"properties":{"type":{"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"lastModifiedDate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"lastReviewed":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"},{"type":"string"}]},"lastSignificantUpdate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"lists":{"items":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"additionalFields":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"description":{"type":"string"},"hierarchy":{"items":{"additionalProperties":false,"properties":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"id":{"type":"string"},"jurisdiction":{"type":"string"},"jurisdictionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"listActive":{"type":"boolean"},"name":{"type":"string"},"provider":{"type":"string"},"since":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"sinceRange":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"source":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"to":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"toRange":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"}},"required":["id","name","description","active","listActive","hierarchy"],"type":"object"},"type":"array"},"loadOptions":{"additionalProperties":false,"properties":{"suppressNotification":{"type":"boolean"}},"type":"object"},"name":{"type":"string"},"profileId":{"type":"string"},"sanctionedRegionCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"significantDocuments":{"items":{"additionalProperties":false,"properties":{"additionalProperties":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"articleId":{"type":"string"},"dates":{"additionalProperties":false,"properties":{"arrivalDch":{"format":"date-time","type":"string"},"published":{"format":"date-time","type":"string"}},"required":["published","arrivalDch"],"type":"object"},"enTitle":{"type":"string"},"groupId":{"type":"string"},"language":{"type":"string"},"models":{"items":{"additionalProperties":false,"properties":{"confidence":{"type":"number"},"model":{"type":"string"},"name":{"type":"string"}},"required":["name","model","confidence"],"type":"object"},"type":"array"},"properties":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"provider":{"type":"string"},"source":{"type":"string"},"storyline":{"type":"string"},"title":{"type":"string"}},"required":["articleId","title","groupId","provider","source","dates"],"type":"object"},"type":"array"},"status":{"type":"string"},"subType":{"type":"string","enum":["country","city","region","sub-region","free-trade-zone","airport","port"],"description":"The sub-type of a location entity"},"tags":{"items":{"type":"string"},"type":"array"},"type":{"const":"location","type":"string"}},"required":["profileId","subType","type"],"type":"object"},{"additionalProperties":false,"properties":{"activeStatus":{"type":"string"},"addresses":{"items":{"additionalProperties":false,"properties":{"addressType":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"line":{"type":"string"},"poBox":{"type":"string"},"postcode":{"type":"string"},"province":{"type":"string"}},"type":"object"},"type":"array"},"aliases":{"anyOf":[{"items":{"additionalProperties":false,"properties":{"name":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"},{"items":{"additionalProperties":false,"properties":{"firstName":{"type":"string"},"maidenName":{"type":"string"},"middleName":{"type":"string"},"name":{"type":"string"},"suffix":{"type":"string"},"surname":{"type":"string"},"titleHonorific":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"},{"items":{"additionalProperties":false,"properties":{"name":{"type":"string"},"suffix":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"}]},"associatedCities":{"items":{"type":"string"},"type":"array"},"associatedCountryCodes":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"clientKey":{"type":"string"},"formerlySanctionedRegionCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"identityNumbers":{"items":{"additionalProperties":false,"properties":{"type":{"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"lastModifiedDate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"lastReviewed":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"},{"type":"string"}]},"lastSignificantUpdate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"lists":{"items":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"additionalFields":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"description":{"type":"string"},"hierarchy":{"items":{"additionalProperties":false,"properties":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"id":{"type":"string"},"jurisdiction":{"type":"string"},"jurisdictionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"listActive":{"type":"boolean"},"name":{"type":"string"},"provider":{"type":"string"},"since":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"sinceRange":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"source":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"to":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"},"toRange":{"additionalProperties":false,"properties":{"end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]},"granularity":{"enum":["year","month","day","range"],"type":"string"},"start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"number"}]}},"required":["start","end","granularity"],"type":"object"}},"required":["id","name","description","active","listActive","hierarchy"],"type":"object"},"type":"array"},"loadOptions":{"additionalProperties":false,"properties":{"suppressNotification":{"type":"boolean"}},"type":"object"},"name":{"type":"string"},"profileId":{"type":"string"},"sanctionedRegionCode":{"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"type":"array"},"significantDocuments":{"items":{"additionalProperties":false,"properties":{"additionalProperties":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"articleId":{"type":"string"},"dates":{"additionalProperties":false,"properties":{"arrivalDch":{"format":"date-time","type":"string"},"published":{"format":"date-time","type":"string"}},"required":["published","arrivalDch"],"type":"object"},"enTitle":{"type":"string"},"groupId":{"type":"string"},"language":{"type":"string"},"models":{"items":{"additionalProperties":false,"properties":{"confidence":{"type":"number"},"model":{"type":"string"},"name":{"type":"string"}},"required":["name","model","confidence"],"type":"object"},"type":"array"},"properties":{"items":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"provider":{"type":"string"},"source":{"type":"string"},"storyline":{"type":"string"},"title":{"type":"string"}},"required":["articleId","title","groupId","provider","source","dates"],"type":"object"},"type":"array"},"status":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"type":{"const":"unknown","type":"string"}},"required":["profileId","type"],"type":"object"}]},"notificationPolicyCombiner":{"type":"object"},"notificationPolicyResults":{"type":"array","items":{"type":"object","properties":{"className":{"type":"string"},"description":{"type":"string"},"evaluated":{"type":"boolean"},"executionTime":{"type":"number"},"name":{"type":"string"},"params":{"type":"object","properties":{"active_if_new":{"type":"boolean"},"data_source":{"type":"string"},"delta":{"type":"integer"},"diff_record_query":{"type":"object","properties":{"$or":{"type":"array","items":{"type":"object","properties":{"lists.hierarchy.id":{"type":"object","properties":{"$in":{"type":"array","items":{"type":"string"}}}},"tags":{"type":"object","properties":{"$regex":{"type":"string"}}}}}}}},"diff_rules":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"id_field":{"type":"string"},"new_field":{"type":"null"},"reverse":{"type":"boolean"},"type":{"type":"string"}}}},"inclusive":{"type":"boolean"},"operator":{"type":"string"},"threshold":{"type":"integer"}}},"reason":{"type":"string"},"value":{"type":"boolean"},"version":{"type":"string"}}}},"reasons":{"type":"array","items":{"type":"object","properties":{"is_consistent":{"type":"boolean"},"is_match":{"type":"boolean"},"is_property_matcher_mandatory":{"type":"boolean"},"mandatory_group":{"type":"integer"},"match_score":{"type":"integer"},"matching_details":{"type":"array","items":{"type":"object","properties":{"data_source":{"type":"string"},"field":{"type":"string"},"field_label":{"type":"string"},"id":{"type":"string"},"special_score":{"type":"integer"},"value":{"type":"string"}}}},"property_matcher_id":{"type":"integer"},"property_matcher_name":{"type":"string"},"result_reason":{"type":"string"},"weight":{"type":"integer"}}}},"score":{"type":"number"},"individualMatchScore":{"type":"number"},"suppressed":{"type":"boolean"},"uuid":{"type":"string"}}},"policy":{"type":"object","properties":{"_id":{"type":"string"},"active":{"type":"boolean"},"cells":{"type":"array","items":{"type":"object","properties":{"cellId":{"type":"string"},"dataMatchingGroup":{"type":"integer"},"isStructured":{"type":"boolean"},"cellType":{"type":"string","enum":["NAME","ADDRESS","LOCATION"]},"notificationPolicyConfig":{"type":"array","items":{"type":"object","properties":{"class_name":{"type":"string"},"name":{"type":"string"},"params":{"type":"object","properties":{"data_source":{"type":"string"},"delta":{"type":"integer"},"diff_record_query":{"type":"object","properties":{"$or":{"type":"array","items":{"type":"object","properties":{"lists.hierarchy.id":{"type":"object","properties":{"$in":{"type":"array","items":{"type":"string"}}}},"tags":{"type":"object","properties":{"$regex":{"type":"string"}}}}}}}},"diff_rules":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"id_field":{"type":"string"},"type":{"type":"string"}}}},"inclusive":{"type":"boolean"},"operator":{"type":"string"},"threshold":{"type":"integer"}}}}}},"score":{"type":"integer"},"strategyKey":{"type":"string"},"tagQuery1":{"type":"object","properties":{"allTags":{"type":"array","items":{"type":"string"}},"anyTags":{"type":"array","items":{"type":"string"}},"noneTags":{"type":"array","items":{"type":"string"}}}},"tagQuery2":{"type":"object","properties":{"allTags":{"type":"array","items":{"type":"string"}},"anyTags":{"type":"array","items":{"type":"string"}},"noneTags":{"type":"array","items":{"type":"string"}}}}}}},"clientKey":{"type":"string"},"created":{"type":"number"},"dataSource1":{"type":"string"},"dataSource2":{"type":"string"},"default":{"type":"boolean"},"disabled":{"type":"boolean"},"entityGroups":{"type":"array","items":{"type":"integer"}},"id":{"type":"integer"},"lastUpdated":{"type":"number"},"matchOnlyFromDataSource2":{"type":"boolean"},"name":{"type":"string"},"systemGenerated":{"type":"boolean"},"threshold":{"type":"integer"},"type":{"type":"string"},"withExisting":{"type":"boolean"}}}}},"impact":{"type":"integer"},"matchScore":{"type":"number"},"individualMatchScore":{"type":"number"},"reasonType":{"type":"string"}}}},"tags":{"type":"array","description":"Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and\u2014when custom categories apply\u2014entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property.\n","items":{"type":"string"},"example":["policy-20037","risk-Financial Crime","userTag-Fin Crime-active"]},"riskTags":{"type":"array","description":"Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags).\n","items":{"type":"string"},"example":["PEP-active","cc42-active"]},"target":{"type":"string","description":"A representation of the target entity for which this evidence was raised\n","example":"eoi:329164"},"totalRisk":{"type":"number","description":"The total risk contribution the evidence had to the associated alert","example":200},"type":{"type":"string","description":"The evidence type","example":"risk"},"assessment":{"type":"object","description":"Contains data related to the evidence\\'s assessment","example":{"codes":[10001],"user":{"email":"bobby.tables@ripjar.com","username":"Bobby Tables","id":"123","cn":"example","roles":["ROLE1","ROLE2"]},"timestamp":1594050360827},"properties":{"codes":{"type":"array","description":"The assessment codes raised against the evidence","items":{"description":"Depending on configuration","oneOf":[{"type":"number"},{"type":"object","properties":{"code":{"type":"number"},"description":{"type":"string"}},"example":{"code":10001,"description":"There is high confidence that the evidence references a client which has been correctly associated with risk"}}]}},"user":{"type":"object","description":"An object representing a user in the system.","required":["username","email","cn"],"properties":{"excludedApps":{"type":"array","items":{"type":"string"},"description":"A list of the applications that this user is excluded from accessing. Not used in Labyrinth Screening."},"username":{"type":"string","description":"The name of the user. This is the value displayed when the user is referenced in the UI."},"email":{"type":"string","description":"The email address of the user. Can be used as part of basic authentication."},"mobile":{"type":"string","description":"The mobile\/cell phone number of the user."},"roles":{"type":"array","items":{"type":"string"},"description":"A list of the user roles that this user has.\nLabyrinth Screening makes use of defined user roles to control the actions a user may perform and to tailor the interface to the needs of particular users.\nEach role is made up of a set of permissions which provide fine grained control over the actions a user can perform. Roles can be configured to match the business roles required by the users of the Screening system.\nThese permissions used by the Screening system are described in the Ripjar Security Implementation document.\nWhen users are loaded into the system, each user account should include the list of roles they are allowed to perform.\n"},"password":{"type":"string","description":"The user's password, used for basic authentication or to retrieve a bearer auth (JWT) token. Not available in API responses. Required when creating or updating users.\n"},"cn":{"type":"string","description":"The user's canonical name. Used to lookup user accounts when performing certificate-based authentication."},"externalId":{"type":"string","description":"The user's ID external to the system. Typically maps to a username or ID in an external user entitlement system."},"security":{"type":"object","description":"The security attributes for this user.\nA user's security attributes govern the data items in the system (such as clients, alerts and assessments) that the user has visibility of. These are distinct from the user's roles, which govern the operations a user can carry out in the system.\nThe security schema contains a set of generic attributes that the user can be assigned. The meaning of these attributes varies depending on the security policy installed on the system.\nBy default, the security policy will compare the list of strings (also known as tags) in dataRolesN fields of the user to the list of strings in the orTagsN field in the security attributes of the data item. If the user has any of the tags that appear on the data item, they can view that item.\nIf the data item has multiple orTags fields, for example orTags1 and orTags2, the user must has at least one of the tags in each of the corresponding dataRoles fields, i.e. there is an AND logic between each attribute.\n","properties":{"dataRoles1":{"type":"array","items":{"type":"string"}},"dataRoles2":{"type":"array","items":{"type":"string"}},"dataRoles3":{"type":"array","items":{"type":"string"}},"compositeDataRoles1":{"type":"array","items":{"type":"object"}}}}}},"timestamp":{"type":"number","description":"When the assessment was performed, in epoch time","example":1594050360827},"assessments":{"type":"array","description":"Details of each assessment currently applied to the evidence","items":{"properties":{"relevant":{"type":"boolean","example":true},"description":{"type":"string","example":"There is high confidence that the evidence references a client which has been correctly associated with risk"},"list":{"type":"boolean","example":true},"active":{"type":"boolean","example":true},"id":{"type":"string","example":"10001"},"risk":{"type":"boolean","example":true}}}}}},"matches":{"type":"array","description":"Contains data describing the matches between entities and the alerting client in the evidence\n","items":{"type":"object","properties":{"active":{"type":"boolean","example":true},"activate_state":{"type":"number","example":11974},"active_from":{"type":"number","example":1590674133787},"blacklisted":{"type":"boolean","example":false},"reason":{"type":"object","properties":{"property_match_combiner_name":{"type":"string","example":"Person News Combiner"},"is_match":{"type":"boolean","example":true},"result_reason":{"type":"string","example":"All properties were consistent"},"match_score":{"type":"number","example":0.6711888086280882},"property_match_results":{"type":"array","example":[{"property_matcher_id":1,"is_consistent":true,"is_match":true,"result_reason":"entity_types exactly match","match_score":1,"property_matcher_name":"Entity Type","is_property_matcher_mandatory":true,"weight":0}],"items":{"type":"object","description":"Each object represents a match reason"}}}},"security":{"type":"object"},"data_source":{"type":"string"},"id":{"type":"string"}}}},"comments":{"type":"array","items":{"type":"object","properties":{"namespace":{"type":"string","description":"The namespace the comment belongs to","example":"torch"},"target":{"type":"string","description":"The ID of the resource the comment belongs to","example":"document-56350b74-3981-4734-8076-62163bca2255"},"security":{"type":"object","description":"The comment's security block","example":{}},"body":{"type":"string","description":"The comment's content","example":"Hello, world"},"context":{"type":"string","description":"The alert the comment belongs to","example":"alert-10001"},"user":{"type":"object","description":"An object representing a user in the system.","required":["username","email","cn"],"properties":{"excludedApps":{"type":"array","items":{"type":"string"},"description":"A list of the applications that this user is excluded from accessing. Not used in Labyrinth Screening."},"username":{"type":"string","description":"The name of the user. This is the value displayed when the user is referenced in the UI."},"email":{"type":"string","description":"The email address of the user. Can be used as part of basic authentication."},"mobile":{"type":"string","description":"The mobile\/cell phone number of the user."},"roles":{"type":"array","items":{"type":"string"},"description":"A list of the user roles that this user has.\nLabyrinth Screening makes use of defined user roles to control the actions a user may perform and to tailor the interface to the needs of particular users.\nEach role is made up of a set of permissions which provide fine grained control over the actions a user can perform. Roles can be configured to match the business roles required by the users of the Screening system.\nThese permissions used by the Screening system are described in the Ripjar Security Implementation document.\nWhen users are loaded into the system, each user account should include the list of roles they are allowed to perform.\n"},"password":{"type":"string","description":"The user's password, used for basic authentication or to retrieve a bearer auth (JWT) token. Not available in API responses. Required when creating or updating users.\n"},"cn":{"type":"string","description":"The user's canonical name. Used to lookup user accounts when performing certificate-based authentication."},"externalId":{"type":"string","description":"The user's ID external to the system. Typically maps to a username or ID in an external user entitlement system."},"security":{"type":"object","description":"The security attributes for this user.\nA user's security attributes govern the data items in the system (such as clients, alerts and assessments) that the user has visibility of. These are distinct from the user's roles, which govern the operations a user can carry out in the system.\nThe security schema contains a set of generic attributes that the user can be assigned. The meaning of these attributes varies depending on the security policy installed on the system.\nBy default, the security policy will compare the list of strings (also known as tags) in dataRolesN fields of the user to the list of strings in the orTagsN field in the security attributes of the data item. If the user has any of the tags that appear on the data item, they can view that item.\nIf the data item has multiple orTags fields, for example orTags1 and orTags2, the user must has at least one of the tags in each of the corresponding dataRoles fields, i.e. there is an AND logic between each attribute.\n","properties":{"dataRoles1":{"type":"array","items":{"type":"string"}},"dataRoles2":{"type":"array","items":{"type":"string"}},"dataRoles3":{"type":"array","items":{"type":"string"}},"compositeDataRoles1":{"type":"array","items":{"type":"object"}}}}}},"clientKey":{"type":"string","description":"The client key of the comment","example":"lowercasekey"},"commentId":{"type":"number","description":"The ID of the comment","example":10001},"createdTimestamp":{"type":"number","description":"The time the comment was created, in epoch time","example":1602680554666}}}},"listEntity":{"description":"The list entity associated with this evidence. Present if the evidence is of type 'list' and the 'lists' enrichment is enabled","oneOf":[{"type":"object","allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}}],"properties":{"person":{"type":"object","description":"The person entity schema must contain the following fileds; firstName, middleName, surname, name\n","properties":{"name":{"type":"string","description":"Full name of the person. Can be used as well as, or instead of, fields for individual name parts"},"firstName":{"type":"string","description":"Given name of the person"},"surname":{"type":"string","description":"Family name of the person"},"aliases":{"type":"array","description":"An aray of alternative names by which a person is known. Fields in each name are as for the main name fields with some additions","items":{"type":"object","properties":{"type":{"type":"string"},"firstName":{"type":"string"},"surname":{"type":"string"},"middleName":{"type":"string"},"titleHonorific":{"type":"string"},"maidenName":{"type":"string"}}}},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER"],"description":"Known gender type of the person, must be in capitals"},"deceased":{"type":"boolean","description":"Is the person deceased?"},"birthPlace":{"type":"string","description":"The name of the persons birthplace. Populated automatically from birthPlaceCountryCode"},"birthPlaceCity":{"type":"string","description":"The persons city of birth"},"dateOfBirthArray":{"type":"array","description":"Possible values for the persons date of birth. This is an array to allow for the uncertanty in reported dates","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"images":{"type":"array","description":"URLs pointing to the images of, or related to, the person","items":{"type":"string"}},"birthPlaceCountryCode":{"type":"string","description":"The country code of the persons birth"},"citizenshipCode":{"type":"array","description":"Country codes of the countries for which the person has citizenship. May be more than one","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"residentOfCode":{"type":"array","description":"Country codes of the countries for which the person is domiciled. May be more than one","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"countryOfReportedAllegationCode":{"type":"array","description":"Country codes of the countries in which alleged misconduct took place. May be more than one","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"middleName":{"type":"string","description":"Middle name of the person"},"roles":{"type":"array","description":"Current jobs or roles of the person","items":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"categoryId":{"type":"string"},"since":{"type":"string","description":"Date in the form yyyy-mm-dd"}}}},"previousRoles":{"type":"array","description":"Past jobs or roles of the person","items":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"categoryId":{"type":"string"},"since":{"type":"string","description":"Date in the form yyyy-mm-dd"},"to":{"type":"string","description":"Date in the form yyyy-mm-dd"}}}},"jurisdictionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"deceasedDateArray":{"type":"array","description":"If the person is deceased (deceased=true), possible values for the persons date of death. This is an array to allow for uncertainty in reported cases"},"suffix":{"type":"string","description":"An honorific that comes after the person's name, rather than before"}}}}},{"type":"object","allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}}],"properties":{"company":{"type":"object","description":"The company entity schema must contain the following fields: name, keyTerms\n","properties":{"name":{"type":"string","description":"The companies main name"},"suffix":{"type":"string","description":"Company suffix, e.g. Ltd, PLC or GmbH"},"aliases":{"type":"array","description":"An array of alternative names by which a company is known","items":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"suffix":{"type":"string"},"entityName":{"type":"string"}}}},"dateOfRegistrationArray":{"type":"array","description":"Company registration dates\n","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"companyURLs":{"type":"array","description":"Associated URLs for the company","items":{"type":"string"}},"countryOfRegistrationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"countryOfAffiliationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"formerlySanctionedRegionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"sanctionedRegionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"cessationDateArray":{"type":"array","description":"For non-active companies, the date(s) on which the company ceased trading","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"keyTerms":{"type":"array","description":"Keywords used in entity matching to automatically match this list entity to client profiles that contain one or more of the key terms. Viewing the list entity will then show all linked client profiles","items":{"keyTerms":{"type":"string"}}}}}}},{"type":"object","allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}}],"properties":{"location":{"type":"object","description":"Location entities are an extension of entities. All of the base fields are included in addition to the fields defined below. \nLocations can be used to represent high risk countries, and can match with location fields on clients or other entities of \ninterest in order to highlight links between the entities and these countries.\n","properties":{"name":{"type":"string","description":"Name of the location"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"The country code of the location","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"locationType":{"type":"string","description":"This must be country"},"cities":{"type":"array","description":"A list of names of cities associated with this location","items":{"type":"string"}}}},"subType":{"type":"string","enum":["country","city","region","sub-region","free-trade-zone","airport","port"],"description":"The sub-type of a location entity"}}},{"allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}},{"type":"object","properties":{"entityType":{"type":"string","enum":["listVessel"]},"vesselCallSigns":{"type":"array","items":{"type":"string"}},"vesselTypes":{"type":"array","items":{"type":"string"}},"vesselTonnages":{"type":"array","items":{"type":"integer"}},"vesselOwners":{"type":"array","items":{"type":"string"}},"vesselCustomers":{"type":"array","items":{"type":"string"}},"vesselGrts":{"type":"array","items":{"type":"integer"}},"vesselFlags":{"type":"array","items":{"type":"string"}},"vesselFlagsCode":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"vesselImoNumber":{"type":"string"},"vesselAdditionalOperators":{"type":"array","items":{"type":"object","properties":{"operatorCategory":{"type":"string","enum":["groupBeneficialOwner","operator","registeredOwner","shipManager","technicalManager"]},"operatorName":{"type":"string"},"countryOfControl":{"type":"string"},"countryOfDomicile":{"type":"string"},"countryOfRegistration":{"type":"string"}}}}}}]},{"type":"object","allOf":[{"type":"object","allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}}],"properties":{"company":{"type":"object","description":"The company entity schema must contain the following fields: name, keyTerms\n","properties":{"name":{"type":"string","description":"The companies main name"},"suffix":{"type":"string","description":"Company suffix, e.g. Ltd, PLC or GmbH"},"aliases":{"type":"array","description":"An array of alternative names by which a company is known","items":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"suffix":{"type":"string"},"entityName":{"type":"string"}}}},"dateOfRegistrationArray":{"type":"array","description":"Company registration dates\n","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"companyURLs":{"type":"array","description":"Associated URLs for the company","items":{"type":"string"}},"countryOfRegistrationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"countryOfAffiliationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"formerlySanctionedRegionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"sanctionedRegionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"cessationDateArray":{"type":"array","description":"For non-active companies, the date(s) on which the company ceased trading","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"keyTerms":{"type":"array","description":"Keywords used in entity matching to automatically match this list entity to client profiles that contain one or more of the key terms. Viewing the list entity will then show all linked client profiles","items":{"keyTerms":{"type":"string"}}}}}}}],"properties":{"aircraft":{"type":"object","description":"Aircraft entities are an extension of company entities. As well as the base fields and aircraft-specific fields, all company properties are also included.\n","properties":{"name":{"type":"string","description":"The aircraft's tail number. The prefix of the tail number is used to determine the aircraft's country of origin."}}}}}],"discriminator":{"propertyName":"entityType","mapping":{"listPerson":".\/ListEntityPerson.yaml","listAircraft":".\/ListEntityAircraft.yaml","listLocation":".\/ListEntityLocation.yaml","listOrganisation":".\/ListEntityOrganisation.yaml","listVessel":".\/ListEntityVessel.yaml"}}}}}]}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthenticated request"},"403":{"description":"Unauthorised request"},"500":{"description":"Internal server error"}}}},"\/assessment\/activity\/export\/jsonl":{"post":{"summary":"Export assessment activity in JSON-L format","description":"Request to export assessment activities in the system as JSON-L format\n\nPlease note, at scale some queries to this endpoint may slowdown. Please test your particular access pattern at the scale you are running at.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes, and a global concurrent request limit of 5 simultaneous requests per customer.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 21 ms |\n| 90th percentile | 24 ms |\n| 95th percentile | 24 ms |\n| 98th percentile | 28 ms |\n| 99th percentile | 30 ms |\n<!-- operational-characteristics:end -->\n","operationId":"assessmentActivityExport","tags":["Assessment Export"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":20.46,"p90":23.9,"p95":23.9,"p98":27.88,"p99":29.34,"sampleSize":73975}},"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["activityFilter"],"properties":{"activityFilter":{"allOf":[{"type":"object","required":["filters"],"properties":{"filters":{"type":"array","items":{"oneOf":[{"type":"object","allOf":[{"not":{"required":["createdBy","createdByExternalIds"]}}],"properties":{"alertIds":{"type":"array","items":{"type":"number","example":10001}},"activityTypes":{"type":"array","items":{"type":"string","example":"alertOpened","enum":["alertOpened","alertReopened","alertClosed","newEvidence","alertAssigned","alertViewed","alertStatusChanged","commentCreated","commentDeleted","commentEdited","evidenceAssessed","evidenceBulkAssessed"]}},"activityDate":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590989346512},"gt":{"type":"number","example":1590989346512},"lt":{"type":"number","example":1590989346512}}},"createdBy":{"description":"Internal IDs of users who performed the activity. Cannot be used in conjunction with createdByExternalIds.","type":"array","items":{"type":"number","example":990}},"createdByExternalIds":{"description":"External IDs of users who performed the activity. Cannot be used in conjunction with createdBy.","type":"array","items":{"type":"string","example":"john.smith@ripjar.com"}},"activityIds":{"type":"array","items":{"type":"number","example":12}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters","type":"object","required":["filters"],"properties":{"filters":{"type":"array","items":{"oneOf":[{"type":"object","allOf":[{"not":{"required":["createdBy","createdByExternalIds"]}}],"properties":{"alertIds":{"type":"array","items":{"type":"number","example":10001}},"activityTypes":{"type":"array","items":{"type":"string","example":"alertOpened","enum":["alertOpened","alertReopened","alertClosed","newEvidence","alertAssigned","alertViewed","alertStatusChanged","commentCreated","commentDeleted","commentEdited","evidenceAssessed","evidenceBulkAssessed"]}},"activityDate":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590989346512},"gt":{"type":"number","example":1590989346512},"lt":{"type":"number","example":1590989346512}}},"createdBy":{"description":"Internal IDs of users who performed the activity. Cannot be used in conjunction with createdByExternalIds.","type":"array","items":{"type":"number","example":990}},"createdByExternalIds":{"description":"External IDs of users who performed the activity. Cannot be used in conjunction with createdBy.","type":"array","items":{"type":"string","example":"john.smith@ripjar.com"}},"activityIds":{"type":"array","items":{"type":"number","example":12}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters"}}}]}}}}}}]}}}},{"type":"object","properties":{"skip":{"type":"integer","default":0,"description":"The number of records to skip."},"limit":{"type":"integer","default":100,"description":"The number of records to return. Setting this to zero (0) returns all records."},"sort":{"type":"string","example":"createdAt:-1","enum":["createdAt:-1","createdAt:1"]}}}]}},"components":{"schemas":{"ActivityFilter":{"allOf":[{"type":"object","required":["filters"],"properties":{"filters":{"type":"array","items":{"oneOf":[{"type":"object","allOf":[{"not":{"required":["createdBy","createdByExternalIds"]}}],"properties":{"alertIds":{"type":"array","items":{"type":"number","example":10001}},"activityTypes":{"type":"array","items":{"type":"string","example":"alertOpened","enum":["alertOpened","alertReopened","alertClosed","newEvidence","alertAssigned","alertViewed","alertStatusChanged","commentCreated","commentDeleted","commentEdited","evidenceAssessed","evidenceBulkAssessed"]}},"activityDate":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590989346512},"gt":{"type":"number","example":1590989346512},"lt":{"type":"number","example":1590989346512}}},"createdBy":{"description":"Internal IDs of users who performed the activity. Cannot be used in conjunction with createdByExternalIds.","type":"array","items":{"type":"number","example":990}},"createdByExternalIds":{"description":"External IDs of users who performed the activity. Cannot be used in conjunction with createdBy.","type":"array","items":{"type":"string","example":"john.smith@ripjar.com"}},"activityIds":{"type":"array","items":{"type":"number","example":12}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters","type":"object","required":["filters"],"properties":{"filters":{"type":"array","items":{"oneOf":[{"type":"object","allOf":[{"not":{"required":["createdBy","createdByExternalIds"]}}],"properties":{"alertIds":{"type":"array","items":{"type":"number","example":10001}},"activityTypes":{"type":"array","items":{"type":"string","example":"alertOpened","enum":["alertOpened","alertReopened","alertClosed","newEvidence","alertAssigned","alertViewed","alertStatusChanged","commentCreated","commentDeleted","commentEdited","evidenceAssessed","evidenceBulkAssessed"]}},"activityDate":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590989346512},"gt":{"type":"number","example":1590989346512},"lt":{"type":"number","example":1590989346512}}},"createdBy":{"description":"Internal IDs of users who performed the activity. Cannot be used in conjunction with createdByExternalIds.","type":"array","items":{"type":"number","example":990}},"createdByExternalIds":{"description":"External IDs of users who performed the activity. Cannot be used in conjunction with createdBy.","type":"array","items":{"type":"string","example":"john.smith@ripjar.com"}},"activityIds":{"type":"array","items":{"type":"number","example":12}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters"}}}]}}}}}}]}}}},{"type":"object","properties":{"skip":{"type":"integer","default":0,"description":"The number of records to skip."},"limit":{"type":"integer","default":100,"description":"The number of records to return. Setting this to zero (0) returns all records."},"sort":{"type":"string","example":"createdAt:-1","enum":["createdAt:-1","createdAt:1"]}}}]},"Filters":{"type":"object","required":["filters"],"properties":{"filters":{"type":"array","items":{"oneOf":[{"type":"object","allOf":[{"not":{"required":["createdBy","createdByExternalIds"]}}],"properties":{"alertIds":{"type":"array","items":{"type":"number","example":10001}},"activityTypes":{"type":"array","items":{"type":"string","example":"alertOpened","enum":["alertOpened","alertReopened","alertClosed","newEvidence","alertAssigned","alertViewed","alertStatusChanged","commentCreated","commentDeleted","commentEdited","evidenceAssessed","evidenceBulkAssessed"]}},"activityDate":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590989346512},"gt":{"type":"number","example":1590989346512},"lt":{"type":"number","example":1590989346512}}},"createdBy":{"description":"Internal IDs of users who performed the activity. Cannot be used in conjunction with createdByExternalIds.","type":"array","items":{"type":"number","example":990}},"createdByExternalIds":{"description":"External IDs of users who performed the activity. Cannot be used in conjunction with createdBy.","type":"array","items":{"type":"string","example":"john.smith@ripjar.com"}},"activityIds":{"type":"array","items":{"type":"number","example":12}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters","type":"object","required":["filters"],"properties":{"filters":{"type":"array","items":{"oneOf":[{"type":"object","allOf":[{"not":{"required":["createdBy","createdByExternalIds"]}}],"properties":{"alertIds":{"type":"array","items":{"type":"number","example":10001}},"activityTypes":{"type":"array","items":{"type":"string","example":"alertOpened","enum":["alertOpened","alertReopened","alertClosed","newEvidence","alertAssigned","alertViewed","alertStatusChanged","commentCreated","commentDeleted","commentEdited","evidenceAssessed","evidenceBulkAssessed"]}},"activityDate":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590989346512},"gt":{"type":"number","example":1590989346512},"lt":{"type":"number","example":1590989346512}}},"createdBy":{"description":"Internal IDs of users who performed the activity. Cannot be used in conjunction with createdByExternalIds.","type":"array","items":{"type":"number","example":990}},"createdByExternalIds":{"description":"External IDs of users who performed the activity. Cannot be used in conjunction with createdBy.","type":"array","items":{"type":"string","example":"john.smith@ripjar.com"}},"activityIds":{"type":"array","items":{"type":"number","example":12}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters"}}}]}}}}}}]}}}},"NestedFilters":{"type":"object","required":["filters"],"properties":{"filters":{"type":"array","items":{"oneOf":[{"type":"object","allOf":[{"not":{"required":["createdBy","createdByExternalIds"]}}],"properties":{"alertIds":{"type":"array","items":{"type":"number","example":10001}},"activityTypes":{"type":"array","items":{"type":"string","example":"alertOpened","enum":["alertOpened","alertReopened","alertClosed","newEvidence","alertAssigned","alertViewed","alertStatusChanged","commentCreated","commentDeleted","commentEdited","evidenceAssessed","evidenceBulkAssessed"]}},"activityDate":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590989346512},"gt":{"type":"number","example":1590989346512},"lt":{"type":"number","example":1590989346512}}},"createdBy":{"description":"Internal IDs of users who performed the activity. Cannot be used in conjunction with createdByExternalIds.","type":"array","items":{"type":"number","example":990}},"createdByExternalIds":{"description":"External IDs of users who performed the activity. Cannot be used in conjunction with createdBy.","type":"array","items":{"type":"string","example":"john.smith@ripjar.com"}},"activityIds":{"type":"array","items":{"type":"number","example":12}}}},{"type":"object","description":"recursive filters","properties":{"operator":{"type":"string","description":"high level boolean operator (default \"AND\")","enum":["AND","OR"]},"filters":{"description":"recursive filters"}}}]}}}},"ActivityFilterKeyValues":{"type":"object","allOf":[{"not":{"required":["createdBy","createdByExternalIds"]}}],"properties":{"alertIds":{"type":"array","items":{"type":"number","example":10001}},"activityTypes":{"type":"array","items":{"type":"string","example":"alertOpened","enum":["alertOpened","alertReopened","alertClosed","newEvidence","alertAssigned","alertViewed","alertStatusChanged","commentCreated","commentDeleted","commentEdited","evidenceAssessed","evidenceBulkAssessed"]}},"activityDate":{"type":"object","properties":{"gte":{"type":"number","example":1590973346512},"lte":{"type":"number","example":1590989346512},"gt":{"type":"number","example":1590989346512},"lt":{"type":"number","example":1590989346512}}},"createdBy":{"description":"Internal IDs of users who performed the activity. Cannot be used in conjunction with createdByExternalIds.","type":"array","items":{"type":"number","example":990}},"createdByExternalIds":{"description":"External IDs of users who performed the activity. Cannot be used in conjunction with createdBy.","type":"array","items":{"type":"string","example":"john.smith@ripjar.com"}},"activityIds":{"type":"array","items":{"type":"number","example":12}}}}}}},"example":{"activityFilter":{"alertIds":[10001],"filters":[{"operator":"OR","filters":[{"activityTypes":["alertOpened"]},{"activityDate":{"gte":0,"lte":1602666851},"createdBy":[990],"activityIds":[12]}]}],"operator":"OR","skip":0,"limit":0,"sort":"createdAt:-1"}}}}},"responses":{"200":{"description":"Assessment activities returned in JSON-L format","content":{"application\/json":{"schema":{"oneOf":[{"type":"object","description":"Line-delimited JSON assessment activity objects","properties":{"searchResultAssessmentId":{"type":"string","description":"ID of the assessment this activity is associated with","example":"AS-1"},"id":{"type":"number","description":"The activity\\'s ID","example":10001},"createdAt":{"type":"number","description":"Time the activity was created as an Epoch timestamp","example":1590668036303},"type":{"type":"string","description":"The type of the activity","example":"alertReopened","enum":["alertOpened","alertReopened","alertClosed","newEvidence","alertAssigned","alertViewed","alertStatusChanged","commentCreated","commentDeleted","commentEdited","evidenceAssessed","evidenceBulkAssessed"]},"description":{"type":"string","description":"Description of the activity","example":"Evidence added to alert 10001"},"data":{"type":"object","description":"Data relevant to the particular type of activity"},"security":{"type":"object","description":"The activity\\'s security object","example":{}},"target":{"type":"string","description":"The target object that encapsulates the activity","example":"alert-10001"},"namespace":{"type":"string","description":"The system namespace in which the activity occurred","example":"torch"},"createdBy":{"type":"object","description":"An object representing a user in the system.","required":["username","email","cn"],"properties":{"excludedApps":{"type":"array","items":{"type":"string"},"description":"A list of the applications that this user is excluded from accessing. Not used in Labyrinth Screening."},"username":{"type":"string","description":"The name of the user. This is the value displayed when the user is referenced in the UI."},"email":{"type":"string","description":"The email address of the user. Can be used as part of basic authentication."},"mobile":{"type":"string","description":"The mobile\/cell phone number of the user."},"roles":{"type":"array","items":{"type":"string"},"description":"A list of the user roles that this user has.\nLabyrinth Screening makes use of defined user roles to control the actions a user may perform and to tailor the interface to the needs of particular users.\nEach role is made up of a set of permissions which provide fine grained control over the actions a user can perform. Roles can be configured to match the business roles required by the users of the Screening system.\nThese permissions used by the Screening system are described in the Ripjar Security Implementation document.\nWhen users are loaded into the system, each user account should include the list of roles they are allowed to perform.\n"},"password":{"type":"string","description":"The user's password, used for basic authentication or to retrieve a bearer auth (JWT) token. Not available in API responses. Required when creating or updating users.\n"},"cn":{"type":"string","description":"The user's canonical name. Used to lookup user accounts when performing certificate-based authentication."},"externalId":{"type":"string","description":"The user's ID external to the system. Typically maps to a username or ID in an external user entitlement system."},"security":{"type":"object","description":"The security attributes for this user.\nA user's security attributes govern the data items in the system (such as clients, alerts and assessments) that the user has visibility of. These are distinct from the user's roles, which govern the operations a user can carry out in the system.\nThe security schema contains a set of generic attributes that the user can be assigned. The meaning of these attributes varies depending on the security policy installed on the system.\nBy default, the security policy will compare the list of strings (also known as tags) in dataRolesN fields of the user to the list of strings in the orTagsN field in the security attributes of the data item. If the user has any of the tags that appear on the data item, they can view that item.\nIf the data item has multiple orTags fields, for example orTags1 and orTags2, the user must has at least one of the tags in each of the corresponding dataRoles fields, i.e. there is an AND logic between each attribute.\n","properties":{"dataRoles1":{"type":"array","items":{"type":"string"}},"dataRoles2":{"type":"array","items":{"type":"string"}},"dataRoles3":{"type":"array","items":{"type":"string"}},"compositeDataRoles1":{"type":"array","items":{"type":"object"}}}}}},"clientKey":{"type":"string","description":"The client key the activity is owned by","example":"lowercasekey"}}},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}]}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthenticated request"},"403":{"description":"The authenticated user is not permitted to export assessment activities"},"500":{"description":"An unexpected error occurred when exporting assessment activities","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/attachment\/alert\/{alertId}":{"post":{"summary":"Upload an attachment","description":"This endpoint allows to upload attachments to alerts\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"attachmentPost","tags":["Attachment"],"parameters":[{"name":"alertId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart\/form-data":{"schema":{"type":"object","properties":{"attachment":{"type":"string","format":"binary"}}},"encoding":{"attachment":{"contentType":"application\/pdf, application\/vnd.ms-excel, application\/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application\/msword, application\/vnd.openxmlformats-officedocument.wordprocessingml.document, text\/plain, image\/jpeg, image\/png, application\/vnd.ms-outlook, text\/csv"}}}}},"responses":{"201":{"description":"Attachment uploaded","content":{"application\/json":{"schema":{"type":"object","properties":{"datumId":{"type":"string","example":"24d3lea2-o0e6-4825-8339-eafe3eed5e48","description":"Date of attachment creation"},"filename":{"type":"string","example":"attachment.pdf","description":"Name of the attached file"},"target":{"type":"string","example":"alert-1002","description":"Field with target type and target id"},"createdBy":{"type":"string","example":"10173","description":"Internal IDs of users who performed the activity. Cannot be used in conjunction with createdByExternalIds."},"clientKey":{"type":"string","example":"joyce123","description":"The client key the activity is owned by"},"created":{"type":"number","example":1764946009344,"description":"Activity timestamp"},"downloadCount":{"type":"number","example":0,"description":"How many times the attachment has been downloaded"},"MIMEType":{"type":"string","example":"application\/pdf","description":"Identifier that indicates the format of a file or data"},"namespace":{"type":"string","example":"torch","description":"The namespace the attachment belongs to"},"uploadSuccessful":{"type":"boolean","example":true,"description":"if attachment file has been uploaded successfully"},"id":{"type":"number","example":13,"description":"Id of upload creation"}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthenticated request"},"403":{"description":"Forbidden"},"404":{"description":"Not found"},"413":{"description":"File upload unsuccessful as the file was too large"},"500":{"description":"An unexpected error occurred uploading the attachment","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}},"examples":{"unexpectedError":{"summary":"Unexpected Error","value":{"code":"ERROR_UPLOADING_ATTACHMENT","message":"An error occurred uploading attachment"}}}}}}}}},"\/client\/delete":{"post":{"summary":"Delete client records","operationId":"deleteClientRecords","description":"Provide a list of client ids to be deleted.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes, and a global concurrent request limit of 5 simultaneous requests per customer.\n","tags":["Client Delete"],"parameters":[{"name":"formData","required":true,"in":"header","schema":{"type":"file","description":"CSV file containing a single column: Client ID\n\nContaining a list of client ids to mark for deletion.\n"}}],"responses":{"200":{"description":"The delete client request was successfully submitted. The response body contains details of the newly-create client load job's ID and status.","content":{"application\/json":{"schema":{"type":"object","description":"The status of the client delete job.","properties":{"id":{"type":"integer","description":"The unique identifier id for your deletion request"},"type":{"type":"string","description":"the job type."},"state":{"type":"string","description":"The state your deletion request is in","enum":["queued","running","completed","errored"]},"clientKey":{"type":"string","description":"Client key for multi-tenant systems"},"metadata":{"type":"object"},"user":{"type":"object"},"time":{"type":"object"},"namespace":{"type":"string"},"tags":{"type":"array"}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden (e.g. the user does not have the correct permission)"},"404":{"description":"Not Found - the specificed client delete job does not exist."},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/client\/delete\/{jobId}\/errors":{"get":{"summary":"Client delete job errors","operationId":"clientDeleteJobErrors","description":"Retreive the errors associated with a given client delete job. Results are returned in pages, defined using the `from` and `to` query parameters.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","tags":["Client Delete"],"parameters":[{"name":"jobId","in":"path","required":true,"schema":{"type":"number"},"description":"The ID of the client delete job."},{"name":"skip","in":"query","required":false,"schema":{"type":"number"},"description":"Number of jobs to skip ahead."},{"name":"limit","in":"query","required":false,"schema":{"type":"number","default":20}}],"responses":{"200":{"description":"The details of any errors or warnings associated with the client delete job.","content":{"application\/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"errors":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string"},"code":{"type":"integer","description":"An error code indicating the nature of the error:\n* 1 : Invalid client relationship\n* 2 : Invalid JSON\n* 3 : Missing attribute\n* 4 : Failed to stage the client\n* 5 : Invalid attribute specified on the client\n* 6 : Invalid data format (JSON\/CSV)\n* 7 : Client failed during assessment\n* 100  : Unexpected exception\n"},"details":{"type":"object","properties":{"clientId":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"missingClientId":{"type":"string"},"lineNumber":{"type":"integer","example":1},"additionalInformation":{"type":"string","example":"Missing required 'objectType' attribute"},"lineContent":{"type":"string","example":"{\"profileId\":\"another-id-007\",\"name\":\"John Smith\",...}"}}}}}}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden (e.g. the user does not have the correct permission)"},"404":{"description":"Not Found - the specificed client delete job does not exist."},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/client\/delete\/filter":{"post":{"summary":"Client delete filter","operationId":"clientDeleteReportFilter","description":"Retrieve the Client Delete jobs created by all users.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes, and a global concurrent request limit of 5 simultaneous requests per customer.\n","tags":["Client Delete"],"responses":{"200":{"description":"The response to indicate the request was successful. Returns an array of jobs.","content":{"application\/json":{"schema":{"type":"array","description":"The current state of the delete jobs the user has requested.","items":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier id for your deletion request"},"state":{"type":"string","description":"The state your deletion request is in","enum":["queued","running","completed","errored"]},"metadata":{"type":"object"},"time":{"type":"object"}}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden (e.g. the user does not have the correct permission)"},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/client\/import":{"get":{"operationId":"clientImportList","summary":"List all import jobs","description":"This endpoint lists all client import jobs\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","tags":["Client Import"],"responses":{"200":{"description":"A response containing information about all submitted client import jobs","content":{"application\/json":{"schema":{"description":"The status of all client import jobs","type":"array","items":{"type":"object","description":"The status of a client import job.","properties":{"id":{"type":"integer","description":"Unique identifier for the job"},"timeCreated":{"type":"integer","description":"Unix timestamp for when the content was created"},"timeStaged":{"type":"integer","description":"Unix timestamp for when the content was staged"},"state":{"type":"string","description":"State of the job","enum":["STAGING","STAGED","IMPORTED","COMPLETE","ERRORED"]},"itemsFailed":{"type":"integer","description":"Number of items that failed"},"itemsUploaded":{"type":"integer","description":"Number of items that were uploaded"},"relationshipsUploaded":{"type":"integer","description":"Number of relationships that were uploaded"},"itemsStaged":{"type":"integer","description":"Number of items that were staged"},"itemsFailedStaging":{"type":"integer","description":"Number of items that failed staging"},"relationshipsAdded":{"type":"integer","description":"Number of relationships that were added"},"relationshipsFailed":{"type":"integer","description":"Number of relationships that failed"},"itemsImported":{"type":"integer","description":"Number of items that were imported"},"itemsFailedImporting":{"type":"integer","description":"Number of items that failed importing"},"itemsForAssessment":{"type":"integer","description":"Number of items for assessment"},"itemsAssessed":{"type":"integer","description":"Number of items assessed"},"itemsFailedAssessment":{"type":"integer","description":"Number of items that failed assessment"},"name":{"type":"string","description":"Name of the job"},"removeInvalidRelationships":{"type":"boolean","description":"Whether to remove invalid relationships"},"validate":{"type":"boolean","description":"Whether to validate"},"clientKey":{"type":"string","description":"Client key for multi-tenant systems"},"lastUpdated":{"type":"integer","description":"Unix timestamp for when the job was last updated"},"validationWarnings":{"type":"integer","description":"Number of validation warnings"}}}},"example":[{"id":52,"timeCreated":1692273794423,"timeStaged":1692273794726,"state":"COMPLETE","itemsFailed":1,"itemsUploaded":1,"relationshipsUploaded":0,"itemsStaged":0,"itemsFailedStaging":1,"relationshipsAdded":0,"relationshipsFailed":0,"itemsImported":0,"itemsFailedImporting":0,"itemsForAssessment":0,"itemsAssessed":0,"itemsFailedAssessment":0,"name":"Bulk Client Job","removeInvalidRelationships":true,"validate":true,"clientKey":"lowercasekey","lastUpdated":1692273796030,"validationWarnings":0},{"id":86,"timeCreated":1692296462489,"timeStaged":1692296462919,"state":"COMPLETE","itemsFailed":0,"itemsUploaded":40,"relationshipsUploaded":0,"itemsStaged":40,"itemsFailedStaging":0,"relationshipsAdded":0,"relationshipsFailed":0,"itemsImported":40,"itemsFailedImporting":0,"itemsForAssessment":40,"itemsAssessed":40,"itemsFailedAssessment":0,"name":"Example","removeInvalidRelationships":true,"validate":true,"clientKey":"lowercasekey","lastUpdated":1692296470953,"validationWarnings":0}]}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden (e.g. the user does not have the correct permission)"},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}},"post":{"summary":"Bulk import client records","description":"Labyrinth Screening supports ongoing monitoring of entities (referred to as \"clients\") against risks. The Client Import API supports the loading and updating of clients that should be monitored.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes, and a global concurrent request limit of 5 simultaneous requests per customer.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 127 ms |\n| 90th percentile | 208 ms |\n| 95th percentile | 267 ms |\n| 98th percentile | 310 ms |\n| 99th percentile | 377 ms |\n<!-- operational-characteristics:end -->\n\nThe client import process is asynchronous. Clients are loaded in batches, referred to as \"jobs\". Once loaded, the job goes through several stages of processing until all the clients are loaded.\n\nThe API provides access to the status of any submitted client import job, including any errors that have occurred during processing. (see the endpoints `\/client\/import\/{job_id}\/status` and `\/client\/import\/{job_id}\/errors`)\n\nClient records can be submitted as line-delimited JSON (`application\/octet-stream`) or as an Excel macro-enabled workbook (`.xlsm`, `application\/vnd.ms-excel.sheet.macroenabled.12`).\n","operationId":"clientBulkImport","tags":["Client Import"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":126.33,"p90":207.8,"p95":266.37,"p98":309.14,"p99":376.98,"sampleSize":4184238}},"parameters":[{"name":"removeInvalidRelationships","in":"query","required":false,"schema":{"type":"boolean","default":true},"description":"This flag controls how the system handles cases where a client that is referenced in a relationship is not found in the client import job and is not already loaded.\n\nIf the flag is set to `true`, the relationship will be ignored and not loaded. If the flag is set to `false`, the relationship will be loaded, allowing the missing referenced client to be loaded as part of a subsequence client load job.\n"},{"name":"batch","in":"query","required":false,"schema":{"type":"boolean","default":true},"description":"Indicates that the clients in this client import job should be handled as a single batch and immediately loaded together.\n\nIf this value is set to `false`, the system will not load the clients in this job immediately and will instead wait until there are more clients to load in requests where this parameter is set to `false`, or until a certain amount of time has passed. This allows the system to batch smaller client load jobs internally and process them as part of a larger internal batch, which is more efficiently.\n\nIMPORTANT: Loading large numbers of smaller client load jobs without this value set to `false` is not recommended as it can lead to overheads that can impact system performance.\n"}],"requestBody":{"required":true,"description":"The set of client records to be imported in a new bulk client import job.\n\nSubmit as line-delimited JSON (`application\/octet-stream`), where each line contains a complete JSON record that adheres to the client import schema, or as an Excel macro-enabled workbook (`.xlsm`) using `application\/vnd.ms-excel.sheet.macroenabled.12`.\n","content":{"application\/octet-stream":{"schema":{"description":"The line-delimited JSON records within the client import request body represent either clients or relationships between clients.\nIMPORTANT: All relationship records must appear after all client records.\n","discriminator":{"propertyName":"objectType","mapping":{"client":".\/ClientImportJobRecordClient.yaml","relationship":"..\/..\/..\/..\/common\/schemas\/client\/ClientRelationship.yaml"}},"oneOf":[{"description":"A client record for import, including optional hash and assessmentRequired fields.","allOf":[{"type":"object","properties":{"hash":{"type":"string","description":"An optional hash of the client record. The hash is generated by the client and can be used to reconcile the version of the client stored in the system with versions mastered in the source system. When supplied during import, the hash can later be validated using the `\/entity\/validate-data` endpoint.\n"},"assessmentRequired":{"type":"boolean","default":false,"description":"When a client is loaded or updated, the assessmentRequired property of the client record can be set to true to request a full screening or re-screening of the Client against the risk data currently in the system at time of loading.\nIf this flag is not set, the client will be loaded or updated, but alerts will only be generated against the client as Risk Profiles and Internal Lists are loaded or updated in the system.\nIf the flag is set, the Client is screened against all existing Risk Profiles and List Entities and Alerts may be generated if any matches meet the alerting criteria in the Alert Policies.\n"}}}],"discriminator":{"propertyName":"entityType","mapping":{"PERSON":"..\/..\/..\/..\/common\/schemas\/client\/PersonClient.yaml","ORGANISATION":"..\/..\/..\/..\/common\/schemas\/client\/OrganisationClient.yaml","VESSEL":"..\/..\/..\/..\/common\/schemas\/client\/VesselClient.yaml","AIRCRAFT":"..\/..\/..\/..\/common\/schemas\/client\/AircraftClient.yaml","UNKNOWN":"..\/..\/..\/..\/common\/schemas\/client\/UnknownClient.yaml"}},"oneOf":[{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"description":"Entity specifier for a person. Must provide at least one of the following:\n\n  * name (recommended)\n  * firstName and surname (with optional middleName)\n\nIf all three are provided, the system will use \"name\". Our recommendation is\nfor you to provide a single, whole, name string which we will then analyse.\n\n**Note**: Name structure is a cultural artefact. We strongly recommend using\nthe full name field as we handle many cross-cultural aspects. If you do wish\nto separate out the name then we consider \"firstName\" to be the given name of\nan individual, and \"surname\" to be a \"family\" name.\n","properties":{"entityType":{"const":"PERSON"},"gender":{"type":"string"},"titles":{"type":"array","items":{"type":"string"}},"surname":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"suffixes":{"type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"titles":{"type":"array","items":{"type":"string"}},"surname":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"suffixes":{"type":"array","items":{"type":"string"}},"nameType":{"type":"string"}}}},"dateOfBirth":{"oneOf":[{"type":"string"},{"type":"integer"}]},"birthPlaceCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"deceasedOn":{"oneOf":[{"type":"string"},{"type":"integer"}]},"nationalityCodes":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"domicileCodes":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"occupation":{"type":"string"}}},{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"properties":{"entityType":{"const":"ORGANISATION"},"companyName":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"aliases":{"type":"array","items":{"type":"object","properties":{"companyName":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"nameType":{"type":"string"}}}},"dateOfIncorporation":{"oneOf":[{"type":"string"},{"type":"integer"}]},"incorporationCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"required":["companyName"]},{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"description":"An entity specifier for a maritime vessel. Must provide AT LEAST ONE of:\nname, aliases, vesselCallSigns or vesselImoNumber\n","required":["vesselName"],"properties":{"entityType":{"const":"VESSEL"},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"nameType":{"type":"string"}}}},"vesselName":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"vesselCallSigns":{"type":"array","items":{"type":"string"}},"vesselTypes":{"type":"array","items":{"type":"string"}},"vesselTonnages":{"type":"array","items":{"type":"number"}},"vesselOwners":{"type":"array","items":{"type":"string"}},"vesselCustomers":{"type":"array","items":{"type":"string"}},"vesselGrts":{"type":"array","items":{"type":"number"}},"vesselFlags":{"type":"array","items":{"type":"string"}},"vesselFlagsCode":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"vesselImoNumber":{"type":"string"},"countryOfRegistrationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}}},{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"properties":{"entityType":{"const":"AIRCRAFT"},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"nameType":{"type":"string"}}}},"aircraftManufactureDate":{"oneOf":[{"type":"string"},{"type":"integer"}]},"aircraftModel":{"type":"string"},"aircraftName":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"aircraftOperator":{"type":"string"},"countryOfAffiliationCode":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}}}},{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"description":"Entity specifier for a client whose type is not known or not one of the supported entity types.\n","properties":{"entityType":{"const":"UNKNOWN"}}}]},{"type":"object","required":["objectType","clientId","from","to","relationshipType","directed"],"properties":{"objectType":{"type":"string","enum":["relationship"]},"clientId":{"type":"string","description":"The ID of the client record that is the owner of the relationship. Typically this is the same as the client ID in the from field."},"from":{"type":"string","description":"The ID of the client the relationship is from."},"to":{"type":"string","description":"The ID of the client the relationship is to."},"directed":{"type":"boolean","description":"Flag indicating whether the relationship is directional."},"relationshipType":{"type":"string","description":"The type of relationship being expressed.","enum":["AGENT\/REPRESENTATIVE","ASSET","ASSOCIATE","ASSOCIATEDSPECIALINTERESTPERSON","AUNT","BROTHER","BROTHER-IN-LAW","BUSINESSASSOCIATE","CHILD","COLLEAGUE","COUSIN","DAUGHTER","DAUGHTER-IN-LAW","EMPLOYEE","EMPLOYER","FAMILYMEMBER","FATHER","FATHER-IN-LAW","FINANCIALADVISER","FRIEND","GRANDDAUGHTER","GRANDFATHER","GRANDMOTHER","GRANDSON","HUSBAND","LEGALADVISER","MOTHER","MOTHER-IN-LAW","NEPHEW","NIECE","OTHER","PARENTCOMPANY","POLITICALADVISER","SAME-SEXSPOUSE","SENIOROFFICIAL","SHAREHOLDER\/OWNER","SISTER","SISTER-IN-LAW","SON","SON-IN-LAW","STEP-DAUGHTER","STEP-SON","STEPFATHER","STEPMOTHER","SUBSIDIARY","UNCLE","UNMARRIEDPARTNER","WIFE"]},"detailedRelationshipType":{"type":"string","description":"Freeform string that can be used to capture a more detailed form of the relationship type. Often used alongside the OTHER relationshipType."},"startDate":{"type":"number","description":"The date the relationship began"},"endDate":{"type":"number","description":"The date the relationship ended"},"tags":{"type":"array","description":"An array of tags that are used for grouping relationships.","items":{"type":"string"}}}}]},"examples":{"PersonClientMinimal":{"value":{"objectType":"client","assessmentRequired":true,"status":"ACTIVE","entityType":"PERSON","name":"John Smith","clientId":"example-client-person-minimal","dateOfBirth":-543888000000}},"PersonClientExpanded":{"value":{"objectType":"client","status":"ACTIVE","entityType":"PERSON","assessmentRequired":true,"businessDivisions":["Testing Division"],"clientId":"example-client-person-expanded","gender":"MALE","surname":"Doe","forename":"John","occupation":"Electrician","nationalityCodes":["US"],"aliases":[{"surname":"Doe","forename":"Jonathan","middlename":"Michael","nameType":"variant"}],"dateOfBirth":-543888000000,"birthPlaceCountryCode":"US","domicileCodes":["US"]}},"OrganisationClientMinimal":{"value":{"objectType":"client","status":"ACTIVE","entityType":"ORGANISATION","assessmentRequired":true,"clientId":"example-client-org-minimal","companyName":"Example Org Ltd"}},"OrganisationClientExpanded":{"value":{"objectType":"client","status":"ACTIVE","entityType":"ORGANISATION","assessmentRequired":true,"clientId":"example-client-org-expanded","companyName":"Example Org Ltd","dateOfIncorporation":1713948157000,"incorporationCountryCode":"US","aliases":[{"nameType":"also known as","companyName":"EO Trading Inc"}]}},"Relationship":{"value":{"objectType":"relationship","clientId":"example-client-person-minimal","from":"example-client-person-minimal","to":"example-client-org-minimal","relationshipType":"EMPLOYEE","detailedRelationshipType":"Director","directed":true}}}},"application\/vnd.ms-excel.sheet.macroenabled.12":{"schema":{"type":"string","format":"binary","description":"Excel macro-enabled workbook (.xlsm) containing client records to import."}}}},"responses":{"200":{"description":"The client import job was successfully submitted. The response body contains details of the newly-created client import job's ID and status.","content":{"application\/json":{"schema":{"type":"object","description":"The status of a client import job.","properties":{"id":{"type":"integer","description":"Unique identifier for the job"},"timeCreated":{"type":"integer","description":"Unix timestamp for when the content was created"},"timeStaged":{"type":"integer","description":"Unix timestamp for when the content was staged"},"state":{"type":"string","description":"State of the job","enum":["STAGING","STAGED","IMPORTED","COMPLETE","ERRORED"]},"itemsFailed":{"type":"integer","description":"Number of items that failed"},"itemsUploaded":{"type":"integer","description":"Number of items that were uploaded"},"relationshipsUploaded":{"type":"integer","description":"Number of relationships that were uploaded"},"itemsStaged":{"type":"integer","description":"Number of items that were staged"},"itemsFailedStaging":{"type":"integer","description":"Number of items that failed staging"},"relationshipsAdded":{"type":"integer","description":"Number of relationships that were added"},"relationshipsFailed":{"type":"integer","description":"Number of relationships that failed"},"itemsImported":{"type":"integer","description":"Number of items that were imported"},"itemsFailedImporting":{"type":"integer","description":"Number of items that failed importing"},"itemsForAssessment":{"type":"integer","description":"Number of items for assessment"},"itemsAssessed":{"type":"integer","description":"Number of items assessed"},"itemsFailedAssessment":{"type":"integer","description":"Number of items that failed assessment"},"name":{"type":"string","description":"Name of the job"},"removeInvalidRelationships":{"type":"boolean","description":"Whether to remove invalid relationships"},"validate":{"type":"boolean","description":"Whether to validate"},"clientKey":{"type":"string","description":"Client key for multi-tenant systems"},"lastUpdated":{"type":"integer","description":"Unix timestamp for when the job was last updated"},"validationWarnings":{"type":"integer","description":"Number of validation warnings"}}},"example":{"id":52,"timeCreated":1692273794423,"timeStaged":1692273794726,"state":"COMPLETE","itemsFailed":1,"itemsUploaded":1,"relationshipsUploaded":0,"itemsStaged":0,"itemsFailedStaging":1,"relationshipsAdded":0,"relationshipsFailed":0,"itemsImported":0,"itemsFailedImporting":0,"itemsForAssessment":0,"itemsAssessed":0,"itemsFailedAssessment":0,"name":"Bulk Client Job","removeInvalidRelationships":true,"validate":true,"clientKey":"lowercasekey","lastUpdated":1692273796030,"validationWarnings":0}}}},"400":{"description":"Bad request (e.g. the content-type is incorrect)","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"403":{"description":"Forbidden (e.g. the user does not have the correct permission)","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/client\/import\/synchronous":{"post":{"operationId":"clientImportSyncronous","summary":"Import a single client synchronously","description":"Import or update **one** client record and block until screening has completed, then return\nthe current alerts for that client.\n\nUnlike `POST \/client\/import`, which accepts a bulk upload and returns immediately with a\njob identifier, this endpoint holds the HTTP connection open until the import job reaches\n`COMPLETE` and assessment counters have caught up. The client is processed through the\nstandard client import pipeline using high-priority routing.\n\n### Request body\n\nSubmit a **single client JSON object** (not line-delimited JSON). The schema is the same as\na client record in the bulk import API. Set `assessmentRequired: true` when a full\nscreening against current risk data is required.\n\n### Response body\n\nThe response contains an `openAlerts` array with the alerts in **OPENED** state\nclient, and `monitoringAlerts` array with the alerts in **MONITORING** state for the imported client sorted by creation time descending.\n\n**Important:** this list includes **all alerts currently associated with the client**, not\nonly alerts created or updated by this import request.\n\nWhen no alerts exist for the client, the response is `{ \"openAlerts\": [], \"monitoringAlerts\": [] }`.\n\n### Typical latencies\n\nEnd-to-end latency depends on platform load, client complexity, and whether alerting is\ntriggered. Measurements below are round-trip times for `POST \/client\/import\/synchronous` with\n**one client per request** and `assessmentRequired: true`.\n\n#### Development environment conditions\n\n| Percentile | Latency |\n| :--------- | :------ |\n| Median     | 6.8 s   |\n| Mean       | 6.9 s   |\n| 90th       | 8.6 s   |\n| 95th       | 8.8 s   |\n| 98th       | 8.8 s   |\n\n**Caveat:** these measurements were taken in the **Development** environment. Production-like\nlatency metrics will be collected later based on real usage, as this is a new endpoint.\n\nA long response time does **not** indicate failure. Successful imports return **`200 OK`**\nregardless of duration.\n\n### Throughput limitations and usage guidance\n\nThis endpoint is intended for **interactive, low-volume** client updates (for example, a user\nsaving a single client in a UI). It is **not** a substitute for bulk client loading.\n\n| Guidance | Detail |\n| :------- | :----- |\n| Volume   | **One client per request.** Use `POST \/client\/import` for bulk or batch uploads. |\n| Rate limit | **90 requests** per 15 minutes time window (`periodicRateLimit`). Exceeding this limit returns **`429 Too Many Requests`**. |\n| Concurrency | **6 concurrent requests** maximum per tenant (`concurrentRateLimit`). Additional in-flight requests receive **`429 Too Many Requests`** until an existing request completes. |\n| Connection | The server holds the connection until processing completes. Do not treat a slow response as an error if the HTTP status is `200`. |\n| Disconnect | If the client closes the connection early, the import job may continue in the background; the client will not receive the response body. |\n\n`RateLimit` and `RateLimit-Policy` response headers report remaining quota for both policies.\nPlan client applications to stay within **90 requests** and **6 concurrent** calls; higher\nparallelism increases latency even when limits are not exceeded.\n\nFor large data loads use `POST \/client\/import` and poll `\/client\/import\/{job_id}\/status` instead.\n","tags":["Client Import"],"parameters":[{"name":"jobname","in":"query","required":false,"schema":{"type":"string"},"description":"Optional label for the created import job (defaults to \"Sync Client Import\")."}],"requestBody":{"required":true,"description":"A single client record to import or update.","content":{"application\/json":{"schema":{"description":"A client record for import, including optional hash and assessmentRequired fields.","allOf":[{"type":"object","properties":{"hash":{"type":"string","description":"An optional hash of the client record. The hash is generated by the client and can be used to reconcile the version of the client stored in the system with versions mastered in the source system. When supplied during import, the hash can later be validated using the `\/entity\/validate-data` endpoint.\n"},"assessmentRequired":{"type":"boolean","default":false,"description":"When a client is loaded or updated, the assessmentRequired property of the client record can be set to true to request a full screening or re-screening of the Client against the risk data currently in the system at time of loading.\nIf this flag is not set, the client will be loaded or updated, but alerts will only be generated against the client as Risk Profiles and Internal Lists are loaded or updated in the system.\nIf the flag is set, the Client is screened against all existing Risk Profiles and List Entities and Alerts may be generated if any matches meet the alerting criteria in the Alert Policies.\n"}}}],"discriminator":{"propertyName":"entityType","mapping":{"PERSON":"..\/..\/..\/..\/common\/schemas\/client\/PersonClient.yaml","ORGANISATION":"..\/..\/..\/..\/common\/schemas\/client\/OrganisationClient.yaml","VESSEL":"..\/..\/..\/..\/common\/schemas\/client\/VesselClient.yaml","AIRCRAFT":"..\/..\/..\/..\/common\/schemas\/client\/AircraftClient.yaml","UNKNOWN":"..\/..\/..\/..\/common\/schemas\/client\/UnknownClient.yaml"}},"oneOf":[{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"description":"Entity specifier for a person. Must provide at least one of the following:\n\n  * name (recommended)\n  * firstName and surname (with optional middleName)\n\nIf all three are provided, the system will use \"name\". Our recommendation is\nfor you to provide a single, whole, name string which we will then analyse.\n\n**Note**: Name structure is a cultural artefact. We strongly recommend using\nthe full name field as we handle many cross-cultural aspects. If you do wish\nto separate out the name then we consider \"firstName\" to be the given name of\nan individual, and \"surname\" to be a \"family\" name.\n","properties":{"entityType":{"const":"PERSON"},"gender":{"type":"string"},"titles":{"type":"array","items":{"type":"string"}},"surname":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"suffixes":{"type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"titles":{"type":"array","items":{"type":"string"}},"surname":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"suffixes":{"type":"array","items":{"type":"string"}},"nameType":{"type":"string"}}}},"dateOfBirth":{"oneOf":[{"type":"string"},{"type":"integer"}]},"birthPlaceCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"deceasedOn":{"oneOf":[{"type":"string"},{"type":"integer"}]},"nationalityCodes":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"domicileCodes":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"occupation":{"type":"string"}}},{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"properties":{"entityType":{"const":"ORGANISATION"},"companyName":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"aliases":{"type":"array","items":{"type":"object","properties":{"companyName":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"nameType":{"type":"string"}}}},"dateOfIncorporation":{"oneOf":[{"type":"string"},{"type":"integer"}]},"incorporationCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"required":["companyName"]},{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"description":"An entity specifier for a maritime vessel. Must provide AT LEAST ONE of:\nname, aliases, vesselCallSigns or vesselImoNumber\n","required":["vesselName"],"properties":{"entityType":{"const":"VESSEL"},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"nameType":{"type":"string"}}}},"vesselName":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"vesselCallSigns":{"type":"array","items":{"type":"string"}},"vesselTypes":{"type":"array","items":{"type":"string"}},"vesselTonnages":{"type":"array","items":{"type":"number"}},"vesselOwners":{"type":"array","items":{"type":"string"}},"vesselCustomers":{"type":"array","items":{"type":"string"}},"vesselGrts":{"type":"array","items":{"type":"number"}},"vesselFlags":{"type":"array","items":{"type":"string"}},"vesselFlagsCode":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"vesselImoNumber":{"type":"string"},"countryOfRegistrationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}}},{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"properties":{"entityType":{"const":"AIRCRAFT"},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"nameType":{"type":"string"}}}},"aircraftManufactureDate":{"oneOf":[{"type":"string"},{"type":"integer"}]},"aircraftModel":{"type":"string"},"aircraftName":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"aircraftOperator":{"type":"string"},"countryOfAffiliationCode":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}}}},{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"description":"Entity specifier for a client whose type is not known or not one of the supported entity types.\n","properties":{"entityType":{"const":"UNKNOWN"}}}]},"examples":{"PersonClientMinimal":{"value":{"objectType":"client","assessmentRequired":true,"status":"ACTIVE","entityType":"PERSON","name":"John Smith","clientId":"example-client-person-minimal","dateOfBirth":-543888000000}},"PersonClientExpanded":{"value":{"objectType":"client","status":"ACTIVE","entityType":"PERSON","assessmentRequired":true,"businessDivisions":["Testing Division"],"clientId":"example-client-person-expanded","gender":"MALE","surname":"Doe","forename":"John","occupation":"Electrician","nationalityCodes":["US"],"aliases":[{"surname":"Doe","forename":"Jonathan","middlename":"Michael","nameType":"variant"}],"dateOfBirth":-543888000000,"birthPlaceCountryCode":"US","domicileCodes":["US"]}},"OrganisationClientMinimal":{"value":{"objectType":"client","status":"ACTIVE","entityType":"ORGANISATION","assessmentRequired":true,"clientId":"example-client-org-minimal","companyName":"Example Org Ltd"}}}}}},"responses":{"200":{"description":"The client was imported and screening completed. The response contains all current\nalerts for the client (see schema description).\n","headers":{"RateLimit":{"description":"Current usage information of the concurrent rate limit, \nstandard RateLimit headers in accordance with the 8th draft of the IETF rate limit header specification\nhttps:\/\/datatracker.ietf.org\/doc\/html\/draft-ietf-httpapi-ratelimit-headers-08\n\n**Examples:**\n- Concurrent rate limit: `\"concurrentRateLimit\"; r=99; t=2836`\n- Periodic rate limit: `\"periodicRateLimit\"; r=9999998; t=3595`\n","schema":{"type":"string"},"examples":{"concurrentRateLimit":{"value":"\"concurrentRateLimit\"; r=99; t=2836","summary":"Concurrent rate limit"},"periodicRateLimit":{"value":"\"periodicRateLimit\"; r=9999998; t=3595","summary":"Periodic rate limit"}}},"RateLimit-Policy":{"description":"Screening has 2 Rate limiting policies\n\n- Periodic request limit, a limit of x requests within a given time bucket\n  - Identified with the policy name of 'periodicRateLimit'\n  - Applies globally to all API requests\n  \n- Concurrent request limit, a limit of x concurrently running requests\n  - Identified with the policy name of 'concurrentRateLimit'\n  - Applies to a subset of potentially long running requests\n  - Only counts against actively running requests\n\nHeader policy implements the following spec \nhttps:\/\/datatracker.ietf.org\/doc\/html\/draft-ietf-httpapi-ratelimit-headers-08\n\n**Examples:**\n- Concurrent rate limit policy: `\"concurrentRateLimit\"; q=1000000; w=3600; pk=:MmRhYjNjNTRmMzdm:`\n- Periodic rate limit policy: `\"periodicRateLimit\"; q=10000000; w=3600; pk=:Yjc2YzM2NWE5MTg4:`\n\nPlease contact support if these rate limit quotas are inappropriate for your usage.\n","schema":{"type":"string"},"examples":{"concurrentRateLimitPolicy":{"value":"\"concurrentRateLimit\"; q=1000000; w=3600; pk=:MmRhYjNjNTRmMzdm:","summary":"Concurrent rate limit policy"},"periodicRateLimitPolicy":{"value":"\"periodicRateLimit\"; q=10000000; w=3600; pk=:Yjc2YzM2NWE5MTg4:","summary":"Periodic rate limit policy"}}}},"content":{"application\/json":{"schema":{"type":"object","description":"Synchronous client import result returned after the import pipeline has completed.\n\nThe `openAlerts` array contains alerts in **OPENED** state for the imported client, and\n`monitoringAlerts` contains alerts in **MONITORING** state. Both arrays are sorted by\ncreation time descending. This includes **all current alerts for the client**, not only\nalerts created or updated by this request. Use alert timestamps and job history if you\nneed to distinguish alerts raised by a specific import.\n","required":["openAlerts","monitoringAlerts"],"properties":{"openAlerts":{"type":"array","description":"Alerts in OPENED state for the imported client, as returned by the alert service filter\nfor the client target (`eoi:{clientId}`). Ordered by `time.created` descending.\nMay be empty when no open alerts exist for the client.\n","items":{"type":"object","description":"Alert object returned for the imported client. Fields mirror the alert service filter\nresponse for synchronous client import.\n","properties":{"id":{"type":"integer","description":"Unique identifier for the alert","example":11533},"target":{"type":"string","description":"The target object (client) that encapsulates the activity","example":"eoi:test-client-Donald-6"},"name":{"type":"string","description":"Display name of the alert subject (typically the client name)","example":"Donald Trump"},"description":{"type":"string","description":"Brief description of the alert","example":"alert for Donald Trump"},"namespace":{"type":"string","description":"Internal namespace for the alert record","example":"torch"},"clientKey":{"type":"string","description":"Tenant client key that owns the alert","example":"delphia726"},"type":{"type":"integer","description":"Alert policy type identifier","example":10507},"mode":{"type":"string","description":"Alert scoring mode","example":"sum"},"state":{"type":"integer","description":"A number representing the overall state of the alert.\n0 = Monitoring\n1 = Open\n2 = Closed\n3 = Reopened\n","enum":[0,1,2,3]},"score":{"type":"integer","description":"Score of the alert, based on the evidence accrued","example":100},"sortKey":{"type":"integer","description":"Internal sort key used when ordering alerts","example":100},"docCount":{"type":"integer","description":"Total number of evidence items in the alert","example":1},"threshold":{"type":"integer","description":"Threshold value that was breached when the alert opened","example":0},"assignedUsers":{"type":"array","description":"IDs of users assigned to the result, returned when results enrichment is disabled","items":{"type":"number"},"example":[1]},"assignedGroups":{"type":"array","description":"Group IDs the alert has been assigned to, where appropriate","items":{"type":"number"},"example":[]},"tags":{"type":"array","description":"Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and\u2014when custom categories apply\u2014entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property.\n","items":{"type":"string"},"example":["policy-20037","risk-Financial Crime","userTag-Fin Crime-active"]},"riskTags":{"type":"array","description":"Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags).\n","items":{"type":"string"},"example":["PEP-active","cc42-active"]},"listEntityIds":{"type":"array","description":"IDs of list entities or risk profiles that have generated evidence within the alert\n","items":{"type":"string","example":"listEntity:list_entity-urn:ripjar:ruh-kif-heb-qog"}},"policyVersions":{"type":"array","description":"Policy versions applied when the alert was raised","items":{"type":"integer"},"example":[1]},"currentStatus":{"type":"object","description":"Current workflow status of the alert (distinct from `state`)","properties":{"status":{"type":"integer","description":"Numeric status code","example":100},"timestamp":{"type":"integer","description":"Epoch timestamp in milliseconds when the status was set","example":1781252307365}}},"time":{"type":"object","description":"Relevant alert timestamps (epoch milliseconds)","properties":{"created":{"type":"integer","description":"When the alert was created","example":1781252307365},"lastUpdated":{"type":"integer","description":"When the alert last received updated information","example":1781252307446},"breached":{"type":"integer","description":"When the alert transitioned from monitoring to opened","example":1781252307446},"lastEvidence":{"type":"integer","description":"When the last piece of evidence was added to the alert","example":1781252307446}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}}}}},"monitoringAlerts":{"type":"array","description":"Alerts in MONITORING state for the imported client, as returned by the alert service filter\nfor the client target (`eoi:{clientId}`). Ordered by `time.created` descending.\nMay be empty when no monitoring alerts exist for the client.\n","items":{"type":"object","description":"Alert object returned for the imported client. Fields mirror the alert service filter\nresponse for synchronous client import.\n","properties":{"id":{"type":"integer","description":"Unique identifier for the alert","example":11533},"target":{"type":"string","description":"The target object (client) that encapsulates the activity","example":"eoi:test-client-Donald-6"},"name":{"type":"string","description":"Display name of the alert subject (typically the client name)","example":"Donald Trump"},"description":{"type":"string","description":"Brief description of the alert","example":"alert for Donald Trump"},"namespace":{"type":"string","description":"Internal namespace for the alert record","example":"torch"},"clientKey":{"type":"string","description":"Tenant client key that owns the alert","example":"delphia726"},"type":{"type":"integer","description":"Alert policy type identifier","example":10507},"mode":{"type":"string","description":"Alert scoring mode","example":"sum"},"state":{"type":"integer","description":"A number representing the overall state of the alert.\n0 = Monitoring\n1 = Open\n2 = Closed\n3 = Reopened\n","enum":[0,1,2,3]},"score":{"type":"integer","description":"Score of the alert, based on the evidence accrued","example":100},"sortKey":{"type":"integer","description":"Internal sort key used when ordering alerts","example":100},"docCount":{"type":"integer","description":"Total number of evidence items in the alert","example":1},"threshold":{"type":"integer","description":"Threshold value that was breached when the alert opened","example":0},"assignedUsers":{"type":"array","description":"IDs of users assigned to the result, returned when results enrichment is disabled","items":{"type":"number"},"example":[1]},"assignedGroups":{"type":"array","description":"Group IDs the alert has been assigned to, where appropriate","items":{"type":"number"},"example":[]},"tags":{"type":"array","description":"Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and\u2014when custom categories apply\u2014entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property.\n","items":{"type":"string"},"example":["policy-20037","risk-Financial Crime","userTag-Fin Crime-active"]},"riskTags":{"type":"array","description":"Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags).\n","items":{"type":"string"},"example":["PEP-active","cc42-active"]},"listEntityIds":{"type":"array","description":"IDs of list entities or risk profiles that have generated evidence within the alert\n","items":{"type":"string","example":"listEntity:list_entity-urn:ripjar:ruh-kif-heb-qog"}},"policyVersions":{"type":"array","description":"Policy versions applied when the alert was raised","items":{"type":"integer"},"example":[1]},"currentStatus":{"type":"object","description":"Current workflow status of the alert (distinct from `state`)","properties":{"status":{"type":"integer","description":"Numeric status code","example":100},"timestamp":{"type":"integer","description":"Epoch timestamp in milliseconds when the status was set","example":1781252307365}}},"time":{"type":"object","description":"Relevant alert timestamps (epoch milliseconds)","properties":{"created":{"type":"integer","description":"When the alert was created","example":1781252307365},"lastUpdated":{"type":"integer","description":"When the alert last received updated information","example":1781252307446},"breached":{"type":"integer","description":"When the alert transitioned from monitoring to opened","example":1781252307446},"lastEvidence":{"type":"integer","description":"When the last piece of evidence was added to the alert","example":1781252307446}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}}}}}}},"examples":{"NoAlerts":{"summary":"No alerts for client","value":{"openAlerts":[],"monitoringAlerts":[]}},"WithAlerts":{"summary":"Client with existing alerts","value":{"openAlerts":[{"assignedUsers":[],"assignedGroups":[],"tags":["context-alerting","policy-10507","segment-testing1","businessDivision-Testing Division1"],"listEntityIds":["listEntity:list_entity-urn:ripjar:ruh-kif-heb-qog"],"state":1,"score":100,"sortKey":100,"docCount":1,"currentStatus":{"status":100,"timestamp":1781252307365},"time":{"created":1781252307365,"lastUpdated":1781252307446,"breached":1781252307446,"lastEvidence":1781252307446},"namespace":"torch","clientKey":"delphia726","type":10507,"target":"eoi:test-client-Donald-6","name":"Donald Trump","description":"alert for Donald Trump","security":{},"mode":"sum","id":11533,"policyVersions":[1],"riskTags":["PEP-active","SIP-active","NEWS-active"],"threshold":0}],"monitoringAlerts":[]}}}}}},"400":{"description":"Bad request (for example, missing `clientId`, invalid JSON body, or validation failure).\n","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"}}}}}},"403":{"description":"Forbidden (for example, the user does not have the BulkCreateClient permission)","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"}}}}}},"429":{"description":"Rate limit exceeded. The request has been rejected because the rate limit has been exceeded.\n\nSee the response headers below for details:\n- `RateLimit` - Current usage information\n- `RateLimit-Policy` - The applicable rate limit policy\n\nPlease contact support if these rate limit quotas are inappropriate for your usage.\n","headers":{"RateLimit":{"description":"Current usage information of the concurrent rate limit, \nstandard RateLimit headers in accordance with the 8th draft of the IETF rate limit header specification\nhttps:\/\/datatracker.ietf.org\/doc\/html\/draft-ietf-httpapi-ratelimit-headers-08\n\n**Examples:**\n- Concurrent rate limit: `\"concurrentRateLimit\"; r=99; t=2836`\n- Periodic rate limit: `\"periodicRateLimit\"; r=9999998; t=3595`\n","schema":{"type":"string"},"examples":{"concurrentRateLimit":{"value":"\"concurrentRateLimit\"; r=99; t=2836","summary":"Concurrent rate limit"},"periodicRateLimit":{"value":"\"periodicRateLimit\"; r=9999998; t=3595","summary":"Periodic rate limit"}}},"RateLimit-Policy":{"description":"Screening has 2 Rate limiting policies\n\n- Periodic request limit, a limit of x requests within a given time bucket\n  - Identified with the policy name of 'periodicRateLimit'\n  - Applies globally to all API requests\n  \n- Concurrent request limit, a limit of x concurrently running requests\n  - Identified with the policy name of 'concurrentRateLimit'\n  - Applies to a subset of potentially long running requests\n  - Only counts against actively running requests\n\nHeader policy implements the following spec \nhttps:\/\/datatracker.ietf.org\/doc\/html\/draft-ietf-httpapi-ratelimit-headers-08\n\n**Examples:**\n- Concurrent rate limit policy: `\"concurrentRateLimit\"; q=1000000; w=3600; pk=:MmRhYjNjNTRmMzdm:`\n- Periodic rate limit policy: `\"periodicRateLimit\"; q=10000000; w=3600; pk=:Yjc2YzM2NWE5MTg4:`\n\nPlease contact support if these rate limit quotas are inappropriate for your usage.\n","schema":{"type":"string"},"examples":{"concurrentRateLimitPolicy":{"value":"\"concurrentRateLimit\"; q=1000000; w=3600; pk=:MmRhYjNjNTRmMzdm:","summary":"Concurrent rate limit policy"},"periodicRateLimitPolicy":{"value":"\"periodicRateLimit\"; q=10000000; w=3600; pk=:Yjc2YzM2NWE5MTg4:","summary":"Periodic rate limit policy"}}},"Retry-After":{"description":"Indicates when the limit resets, only applies to 'Periodic rate limit' policy","schema":{"type":"integer"}}},"content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}},"example":{"code":"RATE_LIMIT_EXCEEDED","message":"Rate limit exceeded","status":429}}}},"500":{"description":"Internal server error, or the import job entered an `ERRORED` state during processing.\n","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"}}}}}}}}},"\/client\/import\/reload":{"post":{"operationId":"clientReload","summary":"Reload clients","description":"Reloads all clients in the system\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes, and a global concurrent request limit of 5 simultaneous requests per customer.\n","tags":["Client Import"],"responses":{"200":{"description":"A successful client reload operation","content":{"application\/json":{"schema":{"type":"object","properties":{"createdJobs":{"description":"The unique identifiers of the created jobs","type":"array","items":{"type":"number"}},"reloadedClients":{"description":"The total number of clients reloaded","type":"number"}}},"example":{"createdJobs":[87,88,89,90,91,92],"reloadedClients":100088}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden (e.g. the user does not have the correct permission)"},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/client\/import\/search":{"get":{"operationId":"clientImportSearch","summary":"Search client import jobs","description":"An endpoint used to search client import jobs\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","tags":["Client Import"],"parameters":[{"name":"id","description":"The ID of a client job to search for. This parameter can be specified multiple times to retrieve multiple import jobs.","in":"query","required":false,"schema":{"type":"integer"}},{"name":"jobname","description":"The partial name of a job to search for. Strings will be matched from the beginning of the job name. For example, searching for \"Bulk Client\" will return \"Bulk Client Job\", but not \"Job for Bulk Clients Load\"","in":"query","required":false,"schema":{"type":"string"}},{"name":"sort","description":"The sort order of the results.","in":"query","required":false,"schema":{"type":"integer","default":-1,"enum":[1,-1]}},{"name":"limit","description":"The maximum number of results to retrieve.","in":"query","required":false,"schema":{"type":"integer"}},{"name":"skip","description":"The number of entries to skip before retrieving results.","in":"query","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"The results of the searched job","content":{"application\/json":{"schema":{"description":"The status of all client import jobs","type":"array","items":{"type":"object","description":"The status of a client import job.","properties":{"id":{"type":"integer","description":"Unique identifier for the job"},"timeCreated":{"type":"integer","description":"Unix timestamp for when the content was created"},"timeStaged":{"type":"integer","description":"Unix timestamp for when the content was staged"},"state":{"type":"string","description":"State of the job","enum":["STAGING","STAGED","IMPORTED","COMPLETE","ERRORED"]},"itemsFailed":{"type":"integer","description":"Number of items that failed"},"itemsUploaded":{"type":"integer","description":"Number of items that were uploaded"},"relationshipsUploaded":{"type":"integer","description":"Number of relationships that were uploaded"},"itemsStaged":{"type":"integer","description":"Number of items that were staged"},"itemsFailedStaging":{"type":"integer","description":"Number of items that failed staging"},"relationshipsAdded":{"type":"integer","description":"Number of relationships that were added"},"relationshipsFailed":{"type":"integer","description":"Number of relationships that failed"},"itemsImported":{"type":"integer","description":"Number of items that were imported"},"itemsFailedImporting":{"type":"integer","description":"Number of items that failed importing"},"itemsForAssessment":{"type":"integer","description":"Number of items for assessment"},"itemsAssessed":{"type":"integer","description":"Number of items assessed"},"itemsFailedAssessment":{"type":"integer","description":"Number of items that failed assessment"},"name":{"type":"string","description":"Name of the job"},"removeInvalidRelationships":{"type":"boolean","description":"Whether to remove invalid relationships"},"validate":{"type":"boolean","description":"Whether to validate"},"clientKey":{"type":"string","description":"Client key for multi-tenant systems"},"lastUpdated":{"type":"integer","description":"Unix timestamp for when the job was last updated"},"validationWarnings":{"type":"integer","description":"Number of validation warnings"}}}}}}},"400":{"description":"Bad request (e.g. the skip parameter is not a number)"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden (e.g. the user does not have the correct permission)"},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/client\/import\/{job_id}":{"get":{"operationId":"clientImportJobGet","summary":"Get a job by ID","description":"This endpoint fetches a client import job by ID\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","tags":["Client Import"],"parameters":[{"in":"path","name":"job_id","required":true,"description":"ID of the job to fetch","schema":{"type":"integer"}}],"responses":{"200":{"description":"Job retrieved successfully","content":{"application\/json":{"schema":{"type":"object","description":"The status of a client import job.","properties":{"id":{"type":"integer","description":"Unique identifier for the job"},"timeCreated":{"type":"integer","description":"Unix timestamp for when the content was created"},"timeStaged":{"type":"integer","description":"Unix timestamp for when the content was staged"},"state":{"type":"string","description":"State of the job","enum":["STAGING","STAGED","IMPORTED","COMPLETE","ERRORED"]},"itemsFailed":{"type":"integer","description":"Number of items that failed"},"itemsUploaded":{"type":"integer","description":"Number of items that were uploaded"},"relationshipsUploaded":{"type":"integer","description":"Number of relationships that were uploaded"},"itemsStaged":{"type":"integer","description":"Number of items that were staged"},"itemsFailedStaging":{"type":"integer","description":"Number of items that failed staging"},"relationshipsAdded":{"type":"integer","description":"Number of relationships that were added"},"relationshipsFailed":{"type":"integer","description":"Number of relationships that failed"},"itemsImported":{"type":"integer","description":"Number of items that were imported"},"itemsFailedImporting":{"type":"integer","description":"Number of items that failed importing"},"itemsForAssessment":{"type":"integer","description":"Number of items for assessment"},"itemsAssessed":{"type":"integer","description":"Number of items assessed"},"itemsFailedAssessment":{"type":"integer","description":"Number of items that failed assessment"},"name":{"type":"string","description":"Name of the job"},"removeInvalidRelationships":{"type":"boolean","description":"Whether to remove invalid relationships"},"validate":{"type":"boolean","description":"Whether to validate"},"clientKey":{"type":"string","description":"Client key for multi-tenant systems"},"lastUpdated":{"type":"integer","description":"Unix timestamp for when the job was last updated"},"validationWarnings":{"type":"integer","description":"Number of validation warnings"}}}}}},"404":{"description":"Job not found"},"default":{"description":"Unexpected error","content":{"application\/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}}},"\/client\/import\/{job_id}\/report":{"get":{"operationId":"clientImportJobReport","tags":["Client Import"],"summary":"Get a report for a client import job","description":"Fetches a client import job report based on the given ID and optional parameters, detailing errors for that job\"\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","parameters":[{"name":"job_id","in":"path","description":"Client import job ID","required":true,"schema":{"type":"integer"}},{"name":"from","in":"query","description":"Starting point for pagination","required":false,"schema":{"type":"integer","default":0}},{"name":"size","in":"query","description":"Size for pagination","required":false,"schema":{"type":"integer","default":100}},{"name":"Accept","in":"header","description":"Expected output format (application\/json or text\/csv)","required":false,"schema":{"type":"string","enum":["text\/csv"]}}],"responses":{"200":{"description":"Successful operation","content":{"application\/json":{"schema":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string"},"code":{"type":"integer","description":"An error code indicating the nature of the error:\n* 1 : Invalid client relationship\n* 2 : Invalid JSON\n* 3 : Missing attribute\n* 4 : Failed to stage the client\n* 5 : Invalid attribute specified on the client\n* 6 : Invalid data format (JSON\/CSV)\n* 7 : Client failed during assessment\n* 100  : Unexpected exception\n"},"details":{"type":"object","properties":{"clientId":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"missingClientId":{"type":"string"},"lineNumber":{"type":"integer","example":1},"additionalInformation":{"type":"string","example":"Missing required 'objectType' attribute"},"lineContent":{"type":"string","example":"{\"profileId\":\"another-id-007\",\"name\":\"John Smith\",...}"}}}}}}},"text\/csv":{"schema":{"type":"string"}}},"headers":{"Content-Disposition":{"schema":{"type":"string"},"description":"File attachment header, indicating the filename and attachment nature of the file."}}},"400":{"description":"Bad request"},"500":{"description":"Internal server error"}}}},"\/client\/import\/{job_id}\/report\/stream":{"get":{"operationId":"clientImportReportStream","tags":["Client Import"],"summary":"Stream a report for a client import job","description":"Streams a client import job report based on the given ID and optional parameters, detailing errors for that job\"\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","parameters":[{"name":"job_id","in":"path","description":"Client import job ID","required":true,"schema":{"type":"integer"}},{"name":"Accept","in":"header","description":"Expected output format (application\/json or text\/csv)","required":false,"schema":{"type":"string","enum":["text\/csv"]}}],"responses":{"200":{"description":"Successful operation","content":{"application\/json":{"schema":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string"},"code":{"type":"integer","description":"An error code indicating the nature of the error:\n* 1 : Invalid client relationship\n* 2 : Invalid JSON\n* 3 : Missing attribute\n* 4 : Failed to stage the client\n* 5 : Invalid attribute specified on the client\n* 6 : Invalid data format (JSON\/CSV)\n* 7 : Client failed during assessment\n* 100  : Unexpected exception\n"},"details":{"type":"object","properties":{"clientId":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"missingClientId":{"type":"string"},"lineNumber":{"type":"integer","example":1},"additionalInformation":{"type":"string","example":"Missing required 'objectType' attribute"},"lineContent":{"type":"string","example":"{\"profileId\":\"another-id-007\",\"name\":\"John Smith\",...}"}}}}}}},"text\/csv":{"schema":{"type":"string"}}},"headers":{"Content-Disposition":{"schema":{"type":"string"},"description":"File attachment header, indicating the filename and attachment nature of the file."}}},"400":{"description":"Bad request"},"500":{"description":"Internal server error"}}}},"\/client\/import\/{job_id}\/status":{"get":{"summary":"Client import job status","description":"Retrieve the status of a given client import job.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"clientImportJobStatus","tags":["Client Import"],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"number"},"description":"The ID of the client import job."}],"responses":{"200":{"description":"The status of the client import job.","content":{"application\/json":{"schema":{"type":"object","description":"The status of a client import job.","properties":{"id":{"type":"integer","description":"Unique identifier for the job"},"timeCreated":{"type":"integer","description":"Unix timestamp for when the content was created"},"timeStaged":{"type":"integer","description":"Unix timestamp for when the content was staged"},"state":{"type":"string","description":"State of the job","enum":["STAGING","STAGED","IMPORTED","COMPLETE","ERRORED"]},"itemsFailed":{"type":"integer","description":"Number of items that failed"},"itemsUploaded":{"type":"integer","description":"Number of items that were uploaded"},"relationshipsUploaded":{"type":"integer","description":"Number of relationships that were uploaded"},"itemsStaged":{"type":"integer","description":"Number of items that were staged"},"itemsFailedStaging":{"type":"integer","description":"Number of items that failed staging"},"relationshipsAdded":{"type":"integer","description":"Number of relationships that were added"},"relationshipsFailed":{"type":"integer","description":"Number of relationships that failed"},"itemsImported":{"type":"integer","description":"Number of items that were imported"},"itemsFailedImporting":{"type":"integer","description":"Number of items that failed importing"},"itemsForAssessment":{"type":"integer","description":"Number of items for assessment"},"itemsAssessed":{"type":"integer","description":"Number of items assessed"},"itemsFailedAssessment":{"type":"integer","description":"Number of items that failed assessment"},"name":{"type":"string","description":"Name of the job"},"removeInvalidRelationships":{"type":"boolean","description":"Whether to remove invalid relationships"},"validate":{"type":"boolean","description":"Whether to validate"},"clientKey":{"type":"string","description":"Client key for multi-tenant systems"},"lastUpdated":{"type":"integer","description":"Unix timestamp for when the job was last updated"},"validationWarnings":{"type":"integer","description":"Number of validation warnings"}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"403":{"description":"Forbidden (e.g. the user does not have the correct permission)","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"404":{"description":"Not Found - the specified client import job does not exist.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/client\/import\/{job_id}\/errors":{"get":{"summary":"Client import job errors","description":"Retrieve the errors associated with a given client import job. Results are returned in pages, defined using the `from` and `to` query parameters.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"clientImportJobErrors","tags":["Client Import"],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"number"},"description":"The ID of the client import job."},{"name":"from","in":"query","required":false,"schema":{"type":"number","default":0},"description":"The index of the error to start from."},{"name":"to","in":"query","required":false,"schema":{"type":"number","default":100},"description":"The index of the error to end with."}],"responses":{"200":{"description":"The details of any errors or warnings associated with the client import job.","content":{"application\/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"errors":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string"},"code":{"type":"integer","description":"An error code indicating the nature of the error:\n* 1 : Invalid client relationship\n* 2 : Invalid JSON\n* 3 : Missing attribute\n* 4 : Failed to stage the client\n* 5 : Invalid attribute specified on the client\n* 6 : Invalid data format (JSON\/CSV)\n* 7 : Client failed during assessment\n* 100  : Unexpected exception\n"},"details":{"type":"object","properties":{"clientId":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"missingClientId":{"type":"string"},"lineNumber":{"type":"integer","example":1},"additionalInformation":{"type":"string","example":"Missing required 'objectType' attribute"},"lineContent":{"type":"string","example":"{\"profileId\":\"another-id-007\",\"name\":\"John Smith\",...}"}}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"403":{"description":"Forbidden (e.g. the user does not have the correct permission)","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"404":{"description":"Not Found - the specified client import job does not exist.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/client\/import\/{job_id}\/errors\/stream":{"get":{"summary":"Client import job errors stream","description":"Retrieve the errors associated with a given client import job as a stream.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"clientImportJobErrorsStream","tags":["Client Import"],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"number"},"description":"The ID of the client import job."}],"responses":{"200":{"description":"The details of any errors or warnings associated with the client import job as a stream of line-delimited json records. Each line is a single JSON record that conforms to the schema.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string"},"code":{"type":"integer","description":"An error code indicating the nature of the error:\n* 1 : Invalid client relationship\n* 2 : Invalid JSON\n* 3 : Missing attribute\n* 4 : Failed to stage the client\n* 5 : Invalid attribute specified on the client\n* 6 : Invalid data format (JSON\/CSV)\n* 7 : Client failed during assessment\n* 100  : Unexpected exception\n"},"details":{"type":"object","properties":{"clientId":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"missingClientId":{"type":"string"},"lineNumber":{"type":"integer","example":1},"additionalInformation":{"type":"string","example":"Missing required 'objectType' attribute"},"lineContent":{"type":"string","example":"{\"profileId\":\"another-id-007\",\"name\":\"John Smith\",...}"}}}}},"examples":{"AssessmentError":{"value":{"type":"ERROR","code":7,"message":"<Error message>","details":{"clientId":"example-client"}}},"DuplicateClient":{"value":{"type":"ERROR","message":"Duplicate Client","code":4,"details":{"clientId":"example-client"}}},"InvalidClient":{"value":{"type":"ERROR","message":"Invalid attribute specified on the client","code":5,"details":{"clientId":"example-client"}}},"InvalidRelationship":{"value":{"type":"WARNING","message":"Invalid client relationship","code":1,"details":{"clientId":"1","from":"1","to":"100","missingClientId":"100"}}},"MalformedRelationship":{"value":{"type":"ERROR","code":2,"message":"SyntaxError: Unexpected token ,","details":{"lineNumber":7,"additionalInformation":"{ clientId }"}}},"UnexpectedError":{"value":{"type":"ERROR","code":500,"message":"Internal Server Error","details":{"clientId":"example-client","additionalInformation":"Error invoking EOI service: Service unavailable"}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"403":{"description":"Forbidden (e.g. the user does not have the correct permission)","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"404":{"description":"Not Found - the specified client import job does not exist.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/disposition":{"post":{"operationId":"dispositionCreate","tags":["Disposition"],"summary":"Create a historical disposition","description":"Request to create a historical disposition in the system ### Rate Limits\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","security":[{"basicAuth":[]}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["matchedProfiles","sourceSystemId"],"properties":{"clientId":{"type":"string","description":"Optional client identifier (can be added later)"},"sourceSystemId":{"type":"string","description":"External identifier linking decisions to client record (e.g., assessment ID, onboarding case ID)"},"mediaFlag":{"type":"integer","minimum":1,"description":"Optional assessment code ID to apply to media-only evidences.\nMust be a valid assessment code from configuration.\nIf provided with a relevant code (relevant: true), media processing is skipped.\nOnly non-relevant codes are applied to media-only evidences.\nAvailable codes:\n- 10001: Relevant - high confidence evidence references a client correctly associated with risk (relevant: true)\n- 10002: Not relevant - document is not about the client or a related entity (relevant: false)\n- 10003: Not relevant - document is not about risk (relevant: false)\n- 10004: Not relevant - risk in document does not relate to the client (relevant: false)\n- 10005: Not relevant - this type of document is not useful (relevant: false)\n- 10006: Not relevant - the matched record could never be the client (relevant: false, breakEntityLink: true)\n- 10007: Not relevant - the matched record does not contain any risk (relevant: false)\n- 10008: Not relevant - the matched record is unlikely to be the client (relevant: false)\n","example":10002},"matchedProfiles":{"type":"array","minItems":1,"items":{"type":"object","required":["profileSource","profileId","outcome","adjudicationDate","adjudicatedBy"],"properties":{"profileSource":{"type":"string","enum":["DJID","RPID","HRNID","INTID","LXID","KHID","RZLTID","WCHID"],"description":"Identifier domain (e.g., DJID, RPID, HRNID, INTID, LXID, KHID, RZLTID, WCHID)","example":"DJID"},"profileId":{"type":"string","description":"Profile identifier within the source domain","example":"DJ-12345"},"outcome":{"type":"array","uniqueItems":true,"minItems":1,"items":{"type":"integer","minimum":1},"description":"Array of unique assessment code IDs from configuration. \nCode 10001 (Relevant) cannot be combined with any other code in the same array.\nValidated against active configuration at runtime.\nAvailable codes:\n- 10001: Relevant - high confidence evidence references a client correctly associated with risk (relevant: true)\n- 10002: Not relevant - document is not about the client or a related entity (relevant: false)\n- 10003: Not relevant - document is not about risk (relevant: false)\n- 10004: Not relevant - risk in document does not relate to the client (relevant: false)\n- 10005: Not relevant - this type of document is not useful (relevant: false)\n- 10006: Not relevant - the matched record could never be the client (relevant: false, breakEntityLink: true)\n- 10007: Not relevant - the matched record does not contain any risk (relevant: false)\n- 10008: Not relevant - the matched record is unlikely to be the client (relevant: false)\n","example":[10002]},"adjudicationDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date when adjudication was made (YYYY-MM-DD format, converted to timestamp on storage)","example":"2024-01-15"},"adjudicatedBy":{"type":"string","description":"Identity of the individual who made the decision","example":"analyst@company.com"},"ttl":{"type":"integer","minimum":1,"description":"Days until this match expires for auto-disposition purposes","example":365},"comment":{"type":"string","maxLength":1000,"description":"Free-text comment or notes about the adjudication decision","example":"Verified against official government records"}}},"description":"Array of matched profiles with adjudication outcomes"}}},"example":{"clientId":"client-id-42","sourceSystemId":"ASSESSMENT-12345","mediaFlag":10002,"matchedProfiles":[{"profileSource":"DJID","profileId":"DJ-001","outcome":[10002],"adjudicationDate":"2024-01-15","adjudicatedBy":"analyst@company.com","comment":"Name similarity only, different DOB confirmed"},{"profileSource":"RPID","profileId":"RP-002","outcome":[10001],"adjudicationDate":"2024-01-15","adjudicatedBy":"compliance.team@company.com","ttl":365}]}}}},"responses":{"201":{"description":"Historical disposition created successfully","content":{"application\/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Unique internal identifier","example":1},"clientId":{"type":"string","description":"Optional client identifier","example":"CLIENT-001"},"sourceSystemId":{"type":"string","description":"External source system identifier","example":"ASSESSMENT-12345"},"mediaFlag":{"type":"integer","description":"Assessment code ID applied to media-only evidences","example":10002},"matchedProfiles":{"type":"array","items":{"type":"object","required":["profileSource","profileId","outcome","adjudicationDate","adjudicatedBy"],"properties":{"profileSource":{"type":"string","enum":["DJID","RPID","HRNID","INTID","LXID","KHID","RZLTID","WCHID"],"description":"Identifier domain (e.g., DJID, RPID, HRNID, INTID, LXID, KHID, RZLTID, WCHID)","example":"DJID"},"profileId":{"type":"string","description":"Profile identifier within the source domain","example":"DJ-12345"},"outcome":{"type":"array","uniqueItems":true,"minItems":1,"items":{"type":"integer","minimum":1},"description":"Array of unique assessment code IDs applied to evidence","example":[10002]},"adjudicationDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date when adjudication was made (YYYY-MM-DD format, converted to timestamp on storage)","example":"2024-01-15"},"adjudicatedBy":{"type":"string","description":"Identity of the individual who made the decision","example":"analyst@company.com"},"ttl":{"type":"integer","minimum":1,"description":"Days until this match expires for auto-disposition purposes","example":365},"comment":{"type":"string","maxLength":1000,"description":"Free-text comment or notes about the adjudication decision","example":"Verified against official government records"}}},"description":"Resolved matched profiles (duplicates removed)"},"createdAt":{"type":"integer","description":"Timestamp when record was created (epoch ms)","example":1705276800000},"updatedAt":{"type":"integer","description":"Timestamp when record was last updated (epoch ms)","example":1705363200000}}}}}},"400":{"description":"Bad request - validation failed","content":{"application\/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"statusCode":{"type":"integer","description":"HTTP status code"}}}}}},"401":{"description":"Not authorized to use this endpoint"},"403":{"description":"Forbidden - insufficient permissions"},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"statusCode":{"type":"integer","description":"HTTP status code"}}}}}}}},"get":{"operationId":"dispositionList","tags":["Disposition"],"summary":"Get historical dispositions","description":"Request to get historical dispositions by filters ### Rate Limits\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","security":[{"basicAuth":[]}],"parameters":[{"in":"query","name":"clientId","schema":{"type":"string"},"required":false,"description":"Client identifier used to scope historical dispositions"},{"in":"query","name":"sourceSystemId","schema":{"type":"string"},"required":false,"description":"Source system identifier associated with historical dispositions"},{"in":"query","name":"profileId","schema":{"type":"string"},"required":false,"description":"Profile identifier to filter historical dispositions"},{"in":"query","name":"skip","schema":{"type":"integer","default":0},"required":false,"description":"Number of items to skip from the beginning"},{"in":"query","name":"limit","schema":{"type":"integer","default":30},"required":false,"description":"Maximum number of items to return"}],"responses":{"200":{"description":"Historical dispositions retrieved successfully","content":{"application\/json":{"schema":{"type":"object","description":"List response with pagination metadata","properties":{"total":{"type":"integer","description":"Total number of elements available for the given filter","example":42},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Unique internal identifier","example":1},"clientId":{"type":"string","description":"Optional client identifier","example":"CLIENT-001"},"sourceSystemId":{"type":"string","description":"External source system identifier","example":"ASSESSMENT-12345"},"mediaFlag":{"type":"integer","description":"Assessment code ID applied to media-only evidences","example":10002},"matchedProfiles":{"type":"array","items":{"type":"object","required":["profileSource","profileId","outcome","adjudicationDate","adjudicatedBy"],"properties":{"profileSource":{"type":"string","enum":["DJID","RPID","HRNID","INTID","LXID","KHID","RZLTID","WCHID"],"description":"Identifier domain (e.g., DJID, RPID, HRNID, INTID, LXID, KHID, RZLTID, WCHID)","example":"DJID"},"profileId":{"type":"string","description":"Profile identifier within the source domain","example":"DJ-12345"},"outcome":{"type":"array","uniqueItems":true,"minItems":1,"items":{"type":"integer","minimum":1},"description":"Array of unique assessment code IDs applied to evidence","example":[10002]},"adjudicationDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date when adjudication was made (YYYY-MM-DD format, converted to timestamp on storage)","example":"2024-01-15"},"adjudicatedBy":{"type":"string","description":"Identity of the individual who made the decision","example":"analyst@company.com"},"ttl":{"type":"integer","minimum":1,"description":"Days until this match expires for auto-disposition purposes","example":365},"comment":{"type":"string","maxLength":1000,"description":"Free-text comment or notes about the adjudication decision","example":"Verified against official government records"}}},"description":"Resolved matched profiles (duplicates removed)"},"createdAt":{"type":"integer","description":"Timestamp when record was created (epoch ms)","example":1705276800000},"updatedAt":{"type":"integer","description":"Timestamp when record was last updated (epoch ms)","example":1705363200000}}}}}}}}},"400":{"description":"Bad request - validation failed","content":{"application\/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"statusCode":{"type":"integer","description":"HTTP status code"}}}}}},"401":{"description":"Not authorized to use this endpoint"},"403":{"description":"Forbidden - insufficient permissions"},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"statusCode":{"type":"integer","description":"HTTP status code"}}}}}}}}},"\/disposition\/{disposition_id}":{"get":{"operationId":"dispositionGetById","tags":["Disposition"],"summary":"Get a historical disposition","description":"Request to get a historical disposition identified by id ### Rate Limits\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","security":[{"basicAuth":[]}],"parameters":[{"name":"disposition_id","in":"path","description":"Identifier of the historical disposition","required":true,"schema":{"type":"integer"},"example":42}],"responses":{"200":{"description":"Historical disposition retrieved successfully","content":{"application\/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Unique internal identifier","example":1},"clientId":{"type":"string","description":"Optional client identifier","example":"CLIENT-001"},"sourceSystemId":{"type":"string","description":"External source system identifier","example":"ASSESSMENT-12345"},"mediaFlag":{"type":"integer","description":"Assessment code ID applied to media-only evidences","example":10002},"matchedProfiles":{"type":"array","items":{"type":"object","required":["profileSource","profileId","outcome","adjudicationDate","adjudicatedBy"],"properties":{"profileSource":{"type":"string","enum":["DJID","RPID","HRNID","INTID","LXID","KHID","RZLTID","WCHID"],"description":"Identifier domain (e.g., DJID, RPID, HRNID, INTID, LXID, KHID, RZLTID, WCHID)","example":"DJID"},"profileId":{"type":"string","description":"Profile identifier within the source domain","example":"DJ-12345"},"outcome":{"type":"array","uniqueItems":true,"minItems":1,"items":{"type":"integer","minimum":1},"description":"Array of unique assessment code IDs applied to evidence","example":[10002]},"adjudicationDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date when adjudication was made (YYYY-MM-DD format, converted to timestamp on storage)","example":"2024-01-15"},"adjudicatedBy":{"type":"string","description":"Identity of the individual who made the decision","example":"analyst@company.com"},"ttl":{"type":"integer","minimum":1,"description":"Days until this match expires for auto-disposition purposes","example":365},"comment":{"type":"string","maxLength":1000,"description":"Free-text comment or notes about the adjudication decision","example":"Verified against official government records"}}},"description":"Resolved matched profiles (duplicates removed)"},"createdAt":{"type":"integer","description":"Timestamp when record was created (epoch ms)","example":1705276800000},"updatedAt":{"type":"integer","description":"Timestamp when record was last updated (epoch ms)","example":1705363200000}}}}}},"400":{"description":"Bad request - validation failed","content":{"application\/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"statusCode":{"type":"integer","description":"HTTP status code"}}}}}},"401":{"description":"Not authorized to use this endpoint"},"403":{"description":"Forbidden - insufficient permissions"},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"statusCode":{"type":"integer","description":"HTTP status code"}}}}}}}},"patch":{"operationId":"dispositionUpdate","tags":["Disposition"],"summary":"Update a historical disposition","description":"Request to update a historical disposition in the system ### Rate Limits\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","security":[{"basicAuth":[]}],"parameters":[{"name":"disposition_id","in":"path","description":"Identifier of the historical disposition","required":true,"schema":{"type":"integer","minimum":1},"example":42}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","description":"Partial update payload for an existing historical disposition","additionalProperties":false,"properties":{"clientId":{"type":"string","description":"Client identifier associated with the historical disposition","example":"CLIENT-42"},"mediaFlag":{"type":"integer","nullable":true,"minimum":1,"description":"Assessment code ID applied to media-only evidences (null to clear).\nAvailable codes:\n- 10001: Relevant - high confidence evidence references a client correctly associated with risk (relevant: true)\n- 10002: Not relevant - document is not about the client or a related entity (relevant: false)\n- 10003: Not relevant - document is not about risk (relevant: false)\n- 10004: Not relevant - risk in document does not relate to the client (relevant: false)\n- 10005: Not relevant - this type of document is not useful (relevant: false)\n- 10006: Not relevant - the matched record could never be the client (relevant: false, breakEntityLink: true)\n- 10007: Not relevant - the matched record does not contain any risk (relevant: false)\n- 10008: Not relevant - the matched record is unlikely to be the client (relevant: false)\n","example":10002},"sourceSystemId":{"type":"string","description":"External identifier linking decisions to client record (e.g., assessment ID)","example":"ASSESSMENT-42"}}},"example":{"sourceSystemId":"source-system-id-42","clientId":"client-id-42","mediaFlag":10002}}}},"responses":{"200":{"description":"Historical disposition updated successfully","content":{"application\/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Unique internal identifier","example":1},"clientId":{"type":"string","description":"Optional client identifier","example":"CLIENT-001"},"sourceSystemId":{"type":"string","description":"External source system identifier","example":"ASSESSMENT-12345"},"mediaFlag":{"type":"integer","description":"Assessment code ID applied to media-only evidences","example":10002},"matchedProfiles":{"type":"array","items":{"type":"object","required":["profileSource","profileId","outcome","adjudicationDate","adjudicatedBy"],"properties":{"profileSource":{"type":"string","enum":["DJID","RPID","HRNID","INTID","LXID","KHID","RZLTID","WCHID"],"description":"Identifier domain (e.g., DJID, RPID, HRNID, INTID, LXID, KHID, RZLTID, WCHID)","example":"DJID"},"profileId":{"type":"string","description":"Profile identifier within the source domain","example":"DJ-12345"},"outcome":{"type":"array","uniqueItems":true,"minItems":1,"items":{"type":"integer","minimum":1},"description":"Array of unique assessment code IDs applied to evidence","example":[10002]},"adjudicationDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date when adjudication was made (YYYY-MM-DD format, converted to timestamp on storage)","example":"2024-01-15"},"adjudicatedBy":{"type":"string","description":"Identity of the individual who made the decision","example":"analyst@company.com"},"ttl":{"type":"integer","minimum":1,"description":"Days until this match expires for auto-disposition purposes","example":365},"comment":{"type":"string","maxLength":1000,"description":"Free-text comment or notes about the adjudication decision","example":"Verified against official government records"}}},"description":"Resolved matched profiles (duplicates removed)"},"createdAt":{"type":"integer","description":"Timestamp when record was created (epoch ms)","example":1705276800000},"updatedAt":{"type":"integer","description":"Timestamp when record was last updated (epoch ms)","example":1705363200000}}}}}},"400":{"description":"Bad request - validation failed","content":{"application\/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"statusCode":{"type":"integer","description":"HTTP status code"}}}}}},"401":{"description":"Not authorized to use this endpoint"},"403":{"description":"Forbidden - insufficient permissions"},"404":{"description":"Historical disposition not found for the given disposition_id","content":{"application\/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"statusCode":{"type":"integer","description":"HTTP status code"}}}}}},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"statusCode":{"type":"integer","description":"HTTP status code"}}}}}}}},"delete":{"operationId":"dispositionDelete","tags":["Disposition"],"summary":"Delete a historical disposition","description":"Deletes an existing historical disposition identified by id ### Rate Limits\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","security":[{"basicAuth":[]}],"parameters":[{"name":"disposition_id","in":"path","description":"Identifier of the historical disposition","required":true,"schema":{"type":"integer"},"example":42}],"responses":{"204":{"description":"Historical disposition deleted successfully"},"400":{"description":"Bad request - validation failed","content":{"application\/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"statusCode":{"type":"integer","description":"HTTP status code"}}}}}},"401":{"description":"Not authorized to use this endpoint"},"403":{"description":"Forbidden - insufficient permissions"},"404":{"description":"Historical disposition not found for the given disposition_id","content":{"application\/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"statusCode":{"type":"integer","description":"HTTP status code"}}}}}},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"statusCode":{"type":"integer","description":"HTTP status code"}}}}}}}}},"\/disposition\/bulk":{"post":{"operationId":"dispositionBulkDelete","tags":["Disposition"],"summary":"Bulk delete historical dispositions","description":"Bulk delete historical dispositions by list of disposition IDs ### Rate Limits\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","security":[{"basicAuth":[]}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","minItems":1,"maxItems":1000,"items":{"type":"integer","minimum":1},"description":"Array of disposition IDs to delete","example":[41,42]}}},"example":{"items":[41,42]}}}},"responses":{"200":{"description":"Bulk delete completed (may include partial failures)","content":{"application\/json":{"schema":{"type":"object","properties":{"success":{"type":"integer","description":"Number of successful delete operations","example":1},"failed":{"type":"integer","description":"Number of failed delete operations","example":1},"results":{"type":"array","items":{"oneOf":[{"type":"object","required":["dispositionId","success"],"properties":{"dispositionId":{"type":"integer","description":"Unique disposition identifier","example":41},"success":{"const":true,"description":"Always true when the delete succeeded for this item","example":true}}},{"type":"object","required":["dispositionId","success","error"],"properties":{"dispositionId":{"type":"integer","description":"Unique disposition identifier","example":42},"success":{"const":false,"description":"Always false when the delete failed for this item","example":false},"error":{"type":"string","description":"Error message for this failed delete","example":"Disposition with id 42 not found"}}}]},"description":"Detailed results for each item in the request"}},"example":{"success":1,"failed":1,"results":[{"dispositionId":41,"success":true},{"dispositionId":42,"success":false,"error":"Disposition with id 42 not found"}]}}}}},"400":{"description":"Bad request - validation failed","content":{"application\/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"statusCode":{"type":"integer","description":"HTTP status code"}}}}}},"401":{"description":"Not authorized to use this endpoint"},"403":{"description":"Forbidden - insufficient permissions"},"500":{"description":"Internal server error","content":{"application\/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"statusCode":{"type":"integer","description":"HTTP status code"}}}}}}}}},"\/entity\/client-count":{"get":{"summary":"Fetch the number of clients in the system","description":"Returns the total number of clients in the system including counts of active and inactive clients.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes, and a global concurrent request limit of 5 simultaneous requests per customer.\n","operationId":"entityClientCount","tags":["Entity"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":8,"p90":12.8,"p95":13.4,"p98":13.76,"p99":13.88,"sampleSize":3}},"parameters":[{"in":"query","name":"ignoreSecurity","required":false,"description":"Whether or not to ignore security and either return the full count in LS or return the visible count for the authenticated user. If `false`, the counts represent the number of entities that are visible to the authenticated calling user based on the user's security settings. If `true`, the counts returned are the totals for all entities in the system, ignoring the authenticated user's security settings.\n","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Counts retrieved successfully","content":{"application\/json":{"schema":{"type":"object","description":"Counts of the number of client entities in the system. The counts will either be for the entities visible to the calling user, or all entities depending on the value of the `ignoreSecurity` flag in the request.","properties":{"count":{"type":"number","description":"The number of client entities in the system."},"active":{"type":"number","description":"The number of counted entities with Active status."},"inactive":{"type":"number","description":"The number of counted entities with Inactive status."}}}}}},"401":{"description":"Unauthenticated request","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"403":{"description":"Forbidden request","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"500":{"description":"An unexpected error occurred when fetching the client counts.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}},"examples":{"unexpectedError":{"summary":"Unexpected Error","value":{"code":"500","message":"An error occurred getting the clients counts."}}}}}}}}},"\/entity\/client-query":{"post":{"summary":"Queries the clients in LS and streams response","description":"Returns clients filtered by the query specified in the request. For example, requesting all Active clients will return the list of active clients that the calling user has permission to see.\nClient records are streamed as line-delimited JSON records conforming to the schema.\nThe records returned are restricted by the calling user's security settings, so that the user will not see restricted information that is outside their own permissions.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes, and a global concurrent request limit of 5 simultaneous requests per customer.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 5.5 s |\n| 90th percentile | 6.7 s |\n| 95th percentile | 7.3 s |\n| 98th percentile | 8.5 s |\n| 99th percentile | 9.4 s |\n<!-- operational-characteristics:end -->\n\nPlease note, at scale some queries to this endpoint may slowdown. Please test your particular access pattern at the scale you are running at.\n","operationId":"entityClientQuery","tags":["Entity"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":5460.74,"p90":6655.51,"p95":7347.59,"p98":8522.95,"p99":9409.2,"sampleSize":10962}},"requestBody":{"required":false,"content":{"application\/json":{"schema":{"type":"object","properties":{"queryFields":{"type":"object","description":"Any field that a client can have can be filtered against. Below is a subset of common fields that will most likely be used for filtering.\n","properties":{"name":{"type":"string","description":"The full name of the individual"},"surname":{"type":"string","description":"The family name of the individual"},"firstName":{"type":"string","description":"The primary given name of the individual"},"middleName":{"type":"string","description":"All other parts of the legal name not covered in first and surname fields"},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER"]},"citizenshipCode":{"description":"A list of country codes reflecting known citizenships of the individual.\n","type":"array","minLength":1,"items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"residentOfCode":{"description":"ISO ALPHA 2 country code for the primary country of residence for the individual\n","type":"string"},"type":{"type":"string","enum":["person","organisation","aircraft","vessel"]},"vesselCallSigns":{"description":"Array of known call signs for the vessel\n","type":"array","minLength":1,"items":{"type":"string"}},"vesselFlagsCode":{"description":"Array of ISO Alpha 2 country codes for flags under which the vessel may sail.\n","type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"vesselImoNumber":{"description":"The IMO number of the vessel if known.\n","type":"string"}}}}}}}},"responses":{"200":{"description":"Clients finished streaming","content":{"application\/octet-stream":{"schema":{"discriminator":{"propertyName":"entityType","mapping":{"PERSON":".\/PersonClient.yaml","ORGANISATION":".\/OrganisationClient.yaml","VESSEL":".\/VesselClient.yaml","AIRCRAFT":".\/AircraftClient.yaml"}},"anyOf":[{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"description":"Entity specifier for a person. Must provide at least one of the following:\n\n  * name (recommended)\n  * firstName and surname (with optional middleName)\n\nIf all three are provided, the system will use \"name\". Our recommendation is\nfor you to provide a single, whole, name string which we will then analyse.\n\n**Note**: Name structure is a cultural artefact. We strongly recommend using\nthe full name field as we handle many cross-cultural aspects. If you do wish\nto separate out the name then we consider \"firstName\" to be the given name of\nan individual, and \"surname\" to be a \"family\" name.\n","properties":{"entityType":{"const":"PERSON"},"gender":{"type":"string"},"titles":{"type":"array","items":{"type":"string"}},"surname":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"suffixes":{"type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"titles":{"type":"array","items":{"type":"string"}},"surname":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"suffixes":{"type":"array","items":{"type":"string"}},"nameType":{"type":"string"}}}},"dateOfBirth":{"oneOf":[{"type":"string"},{"type":"integer"}]},"birthPlaceCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"deceasedOn":{"oneOf":[{"type":"string"},{"type":"integer"}]},"nationalityCodes":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"domicileCodes":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"occupation":{"type":"string"}}},{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"properties":{"entityType":{"const":"ORGANISATION"},"companyName":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"aliases":{"type":"array","items":{"type":"object","properties":{"companyName":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"nameType":{"type":"string"}}}},"dateOfIncorporation":{"oneOf":[{"type":"string"},{"type":"integer"}]},"incorporationCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"required":["companyName"]},{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"description":"An entity specifier for a maritime vessel. Must provide AT LEAST ONE of:\nname, aliases, vesselCallSigns or vesselImoNumber\n","required":["vesselName"],"properties":{"entityType":{"const":"VESSEL"},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"nameType":{"type":"string"}}}},"vesselName":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"vesselCallSigns":{"type":"array","items":{"type":"string"}},"vesselTypes":{"type":"array","items":{"type":"string"}},"vesselTonnages":{"type":"array","items":{"type":"number"}},"vesselOwners":{"type":"array","items":{"type":"string"}},"vesselCustomers":{"type":"array","items":{"type":"string"}},"vesselGrts":{"type":"array","items":{"type":"number"}},"vesselFlags":{"type":"array","items":{"type":"string"}},"vesselFlagsCode":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"vesselImoNumber":{"type":"string"},"countryOfRegistrationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}}},{"type":"object","allOf":[{"type":"object","required":["objectType","entityType","clientId"],"properties":{"objectType":{"type":"string","enum":["client"]},"clientId":{"type":"string"},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"]},"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"freeTextItems":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"]}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"security":{"type":"object","description":"The security attributes applied to this data item.\nLabyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system's security policy.\nSystems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item.\n","properties":{"enabled":{"type":"boolean","default":false},"orTags1":{"type":"array","items":{"type":"string"}},"orTags2":{"type":"array","items":{"type":"string"}},"orTags3":{"type":"array","items":{"type":"string"}},"andTags1":{"type":"array","items":{"type":"string"}},"andTags2":{"type":"array","items":{"type":"string"}},"andTags3":{"type":"array","items":{"type":"string"}},"notTags1":{"type":"array","items":{"type":"string"}},"notTags2":{"type":"array","items":{"type":"string"}},"notTags3":{"type":"array","items":{"type":"string"}},"compositeTags1":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}},"compositeTags2":{"type":"array","items":{"type":"object","description":"an object containing a set of security tags that should be considered together when making access control decisions"}}}},"lastReviewed":{"type":"string"},"fixedAlertSpans":{"type":"boolean","description":"A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval.","default":false},"fixedAlertSpanPeriod":{"type":"string","description":"The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year).","default":"1d"},"fixedAlertSpanStartDate":{"default":"the time the client is loaded","description":"The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The  fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value.\n","type":"string","format":"date","example":"2023-12-25"},"alertingTimezone":{"type":"integer","description":"The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180.\n","default":0},"periodicReviewPeriod":{"type":"string"},"periodicReviewStartDate":{"type":"integer"},"identityNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]}},"bookingCenter":{"type":"string"},"segment":{"type":"string"},"businessRelationshipNumbers":{"type":"array","items":{"type":"string"}},"businessRelationship":{"type":"array","items":{"type":"string"}},"riskScore":{"type":"number"},"riskDescription":{"type":"string"},"employeeContactDetails":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"industries":{"type":"array","items":{"type":"string"}},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}],"properties":{"entityType":{"const":"AIRCRAFT"},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"nameType":{"type":"string"}}}},"aircraftManufactureDate":{"oneOf":[{"type":"string"},{"type":"integer"}]},"aircraftModel":{"type":"string"},"aircraftName":{"type":"string","maxLength":460,"minLength":1,"description":"The full name of the client. This is a key field used in identity matching.\nThe name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.\nNames cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.\n"},"aircraftOperator":{"type":"string"},"countryOfAffiliationCode":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}}}}]}}}},"401":{"description":"Unauthenticated request","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"403":{"description":"Forbidden request","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"500":{"description":"An unexpected error occurred when fetching the client counts.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}},"examples":{"unexpectedError":{"summary":"Unexpected Error","value":{"code":"500","message":"An error occurred streaming the clients."}}}}}}}}},"\/entity\/risk-profile-query":{"post":{"summary":"Query full profile details for a list of profile IDs","description":"Returns the most recent version of profile records for up to 200 profile IDs in a single request.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n*Generated from limited sample size.*\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 79 ms |\n| 90th percentile | 709 ms |\n| 95th percentile | 1.1 s |\n| 98th percentile | 2.2 s |\n| 99th percentile | 2.8 s |\n<!-- operational-characteristics:end -->\n\nThe response is JSON Lines (`application\/x-ndjson`) \u2014 one JSON object per line, in the same order as the requested `ids`. Each line is either a successful profile entry or an inline error entry (e.g. `NOT_FOUND`, `BAD_ID`); the request as a whole never fails because of an individual lookup miss.\nExample source of IDs for this query: `POST \/search\/{strategy}` returns `results[].profileId`, which can be passed as `ids` here.\n\nDuplicate `ids` are rejected with HTTP `400`.\n\nWith `relationships=true`, profiles include `relationships` (`relationshipType`, `profileId`, and `name` only when known). Default is `relationships=false` (no relationship data).\n\nRipjar profiles do not return relationships here; when `sourceProfileIds` is present, use an appropriate id from that array for follow-up requests (e.g. linked watchlist profile).\n\nBy default deleted profiles are returned. Pass `retrieveDeleted=false` to return them as `NOT_FOUND` instead.\n","operationId":"entityRiskProfileQuery","tags":["Entity"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":79,"p90":708.5,"p95":1053.35,"p98":2171.64,"p99":2756.07,"sampleSize":60}},"parameters":[{"in":"query","name":"relationships","required":false,"schema":{"type":"boolean","default":false},"description":"When `true`, include each profile's `relationships` (`relationshipType`, `profileId`, optional `name`).\n"},{"in":"query","name":"retrieveDeleted","required":false,"schema":{"type":"boolean","default":true},"description":"When `false`, deleted profiles are returned as inline `NOT_FOUND` entries instead of being included in the response.\n"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["ids"],"properties":{"ids":{"type":"array","description":"List of profile IDs to retrieve (1\u2013200 entries, non-empty strings, all distinct).\n","minItems":1,"maxItems":200,"uniqueItems":true,"items":{"type":"string","minLength":1,"example":"listEntity:1234"}}}},"examples":{"basicRequest":{"summary":"Three Ripjar profile IDs","value":{"ids":["listEntity:list_entity-urn:ripjar:kat-rek-kod-kig","listEntity:list_entity-urn:ripjar:wid-sav-yiv-ciq","listEntity:list_entity-urn:ripjar:kiz-pil-nor-tas"]}}}}}},"responses":{"200":{"description":"One JSON Lines entry per requested ID, in request order. Each line is independently parseable. May contain a mix of successful profiles and inline error entries.\n\nThe **examples** are single lines (one object each); a real response concatenates many such lines separated by newlines.\n","content":{"application\/x-ndjson":{"schema":{"description":"A single line of the JSON Lines response. Either a successful profile entry or an inline error entry. Discriminated by the presence of a `profile` or `error` field.\n","oneOf":[{"type":"object","required":["id","profile"],"properties":{"id":{"type":"string","description":"The profile ID as supplied in the request.","example":"listEntity:1234"},"profile":{"type":"object","description":"A profile record returned by risk-profile-query. Internal fields and `metadata` are stripped from the response.\n","required":["id"],"properties":{"id":{"type":"string","description":"The profile ID.","example":"listEntity:1234"},"name":{"type":"string","description":"Display name of the profile."},"entityType":{"type":"string","description":"Entity type (e.g. `listPerson`, `listOrganisation`, `listLocation`, `listVessel`, `listAircraft`)."},"sourceProfileIds":{"type":"array","items":{"type":"string"},"description":"Optional. Same values as `metadata.sourceProfileIds` on the source record, copied to the profile root because `metadata` is not returned. Clients choose which id (if any) to use in follow-up requests.\n","example":["listEntity:list_entity-urn:ripjar:kat-rek-kod-kig","listEntity:list_entity-urn:ripjar:wid-sav-yiv-ciq","listEntity:list_entity-urn:ripjar:kiz-pil-nor-tas"]},"relationships":{"type":"array","description":"Present only when the request was made with `relationships=true`.","items":{"type":"object","description":"Relationship type, related profile id, and optional display name for the related profile.\n","required":["relationshipType","profileId"],"properties":{"relationshipType":{"type":"string","nullable":true,"description":"Type of the relationship (e.g. `spouse`, `affiliate`)."},"profileId":{"type":"string","nullable":true,"description":"ID of the related profile (the side of the edge that is not the anchor profile).","example":"listEntity:5678"},"name":{"type":"string","description":"Display name of the related profile when available."}}}}},"additionalProperties":true}}},{"type":"object","description":"Inline error entry for a profile that could not be returned. The response will still contain a line for this ID, in the same position as the request.\n","required":["id","error"],"properties":{"id":{"type":"string","description":"The profile ID as supplied in the request.","example":"listEntity:9999"},"error":{"type":"string","description":"Machine-readable error code identifying why this profile could not be returned.\n","enum":["NOT_FOUND","BAD_ID"]},"message":{"type":"string","description":"Human-readable detail when supplied (e.g. invalid id format for `BAD_ID`)."}}}]},"examples":{"successWithRelationships":{"summary":"Success line when relationships=true","description":"Includes two relationships \u2014 one without `name`, one with `name`.\n","value":{"id":"listEntity:1234","profile":{"id":"listEntity:1234","name":"Alice Example","entityType":"listPerson","relationships":[{"relationshipType":"affiliate","profileId":"listEntity:8888"},{"relationshipType":"spouse","profileId":"listEntity:5678","name":"Bob Example"}]}}},"successWithSourceProfileIds":{"summary":"Success line with optional sourceProfileIds","value":{"id":"listEntity:list_entity-urn:ripjar:kat-rek-kod-kig","profile":{"id":"listEntity:list_entity-urn:ripjar:kat-rek-kod-kig","name":"Example adverse media entity","entityType":"listPerson","sourceProfileIds":["listEntity:list_entity-urn:ripjar:kat-rek-kod-kig","listEntity:list_entity-urn:ripjar:wid-sav-yiv-ciq","listEntity:list_entity-urn:ripjar:kiz-pil-nor-tas"]}}},"inlineNotFound":{"summary":"Inline NOT_FOUND","value":{"id":"listEntity:9999","error":"NOT_FOUND"}},"inlineBadId":{"summary":"Inline BAD_ID","value":{"id":"not-a-profile","error":"BAD_ID","message":"Id \"not-a-profile\" is not a profile id (must start with \"listEntity:\")"}}}}}},"400":{"description":"Bad request (e.g. invalid body, duplicate `ids`, or more than 200 ids).\n","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"401":{"description":"Unauthenticated request.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"500":{"description":"An unexpected error occurred while fetching the requested profiles. The request did not produce any inline result entries.\n","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/entity\/client-export":{"post":{"summary":"Exports the clients in LS and streams response, optionally filtered by Last Modified Date only","description":"Unlike \/entity\/client-query, this endpoint optionally filters by Last Modified Date only. If Last Modified Date is provided it will return all clients that have been modified since the Last Modified Date. If no Last Modified Date is provided it will return all clients. Unlike \/entity\/client-query, this endpoint does not filter by any other fields.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes, and a global concurrent request limit of 5 simultaneous requests per customer.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n*Generated from limited sample size.*\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 1.2 s |\n| 90th percentile | 1:36 (min) |\n| 95th percentile | 1:36 (min) |\n| 98th percentile | 1:36 (min) |\n| 99th percentile | 3:02 (min) |\n<!-- operational-characteristics:end -->\n","operationId":"clientExport","tags":["Entity"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":1177.92,"p90":96184.08,"p95":96184.08,"p98":96184.08,"p99":182949.49,"sampleSize":266}},"requestBody":{"required":false,"content":{"application\/json":{"schema":{"type":"object","properties":{"lastModifiedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}}}},"responses":{"200":{"description":"Clients retrieved","content":{"application\/jsonld":{"schema":{"description":"Line-delimited JSON client objects","type":"object","properties":{"addresses":{"oneOf":[{"type":"array","description":"Addresses associated with the client (array)","items":{"type":"object","additionalProperties":true}}]},"aircraftManufactureDate":{"oneOf":[{"type":"string","example":"2018-03-15","description":"Aircraft manufacture date in ISO 8601 format (YYYY-MM-DD)"},{"type":"number","example":1521072000000,"description":"Aircraft manufacture date as Unix timestamp (milliseconds since epoch)"}]},"aircraftModel":{"type":"string","example":"737-800","description":"Model of the aircraft (string)"},"aircraftName":{"type":"string","example":"Boeing 737","description":"Name of the aircraft for aircraft clients (string)"},"aircraftOperator":{"type":"string","example":"Airline Inc","description":"Operator of the aircraft (string)"},"alertingTimezone":{"oneOf":[{"type":"number","example":0,"description":"Timezone offset for alerting (number)"}]},"aliases":{"oneOf":[{"type":"array","description":"Alternative names for the client (array)","items":{"type":"object","properties":{"name":{"type":"string","example":"Johnny Doe","description":"Full alias name"},"nameType":{"type":"string","example":"nickname","description":"Type of alias (e.g., primary, variant, nickname, abbreviation)"}},"required":["name","nameType"],"additionalProperties":false}}]},"associatedCities":{"type":"array","items":{"type":"string"},"example":["London","New York"],"description":"Cities associated with the client (always returned as array of strings - single strings are converted to single-item arrays)"},"associatedCountryCodes":{"type":"array","items":{"type":"string"},"example":["US","CA"],"description":"Associated country codes (always returned as array of strings - single strings are converted to single-item arrays, accepts any string value)"},"birthPlaceCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"bookingCenter":{"oneOf":[{"type":"string","example":"LONDON","description":"Booking center associated with the client (string)"}]},"businessDivisions":{"type":"array","items":{"type":"string"},"example":["Technology","Finance"],"description":"Business divisions the client belongs to (always returned as array of strings - single strings are converted to single-item arrays)"},"clientId":{"type":"string","example":"12345","description":"Unique identifier for the client"},"companyName":{"type":"string","example":"Acme Corp","description":"Company name for organization clients (string)"},"countryOfAffiliationCode":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"example":["GB"],"description":"ISO 3166-1 alpha-2 country of affiliation codes (always returned as array of 2-character country codes - single strings are converted to single-item arrays)"},"countryOfRegistrationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"dateOfBirth":{"oneOf":[{"type":"string","example":"1952-10-07","description":"Date of birth in ISO 8601 format (YYYY-MM-DD)"},{"type":"number","example":631152000000,"description":"Date of birth as Unix timestamp (milliseconds since epoch)"}]},"dateOfIncorporation":{"oneOf":[{"type":"string","example":"2020-01-01","description":"Date of incorporation in ISO 8601 format (YYYY-MM-DD)"},{"type":"number","example":1577836800000,"description":"Date of incorporation as Unix timestamp (milliseconds since epoch)"}]},"deceasedOn":{"oneOf":[{"type":"string","example":"2023-01-01","description":"Date of death in ISO 8601 format (YYYY-MM-DD)"},{"type":"number","example":1672531200000,"description":"Date of death as Unix timestamp (milliseconds since epoch)"}]},"domicileCodes":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"example":["GB","US"],"description":"ISO 3166-1 alpha-2 domicile codes (always returned as array of 2-character country codes - single strings are converted to single-item arrays)"},"employeeContactDetails":{"oneOf":[{"type":"object","description":"Employee contact details (object)","properties":{"email":{"type":"string","format":"email","example":"jane@example.com","description":"Contact email address"},"name":{"type":"string","example":"Jane Smith","description":"Contact person name"},"phoneNumber":{"type":"string","example":"+1234567890","description":"Contact phone number"}}}]},"entityType":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","AIRCRAFT","UNKNOWN"],"example":"PERSON","description":"The type of entity this client represents (strictly valid enum only)"},"fixedAlertSpanPeriod":{"oneOf":[{"type":"string","pattern":"^[0-9]+[ymdh]$","example":"2d","description":"Period for fixed alert spans (format: [0-9]+[ymdh])"}]},"fixedAlertSpanStartDate":{"oneOf":[{"type":"string","example":"2024-01-01","description":"Fixed alert span start date in ISO 8601 format (YYYY-MM-DD)"},{"type":"number","example":1640995200000,"description":"Fixed alert span start date as Unix timestamp (milliseconds since epoch)"}]},"fixedAlertSpans":{"oneOf":[{"type":"boolean","example":false,"description":"Whether fixed alert spans are enabled (boolean)"},{"type":"string","enum":["true","false","yes","0","1"],"example":"false","description":"Whether fixed alert spans are enabled (limited string values: true, false, yes, 0, 1)"}]},"forename":{"type":"string","example":"John","description":"First name of the client (string)"},"freeTextItems":{"oneOf":[{"type":"array","description":"Free text items associated with the client (array of objects with flexible structure)","items":{"type":"object","additionalProperties":true,"properties":{"fieldId":{"type":"string","example":"notes","description":"Identifier for the field (commonly used property)"},"value":{"type":"string","example":"Additional client information","description":"Value of the field (commonly used property)"}},"example":{"fieldId":"notes","value":"Additional client information"}}}]},"gender":{"oneOf":[{"type":"string","example":"MALE","description":"Gender of the client (string)"}]},"identityNumbers":{"oneOf":[{"type":"array","description":"Identity numbers associated with the client (array of objects with flexible structure)","items":{"type":"object","additionalProperties":true,"properties":{"type":{"type":"string","example":"passport_no","description":"Type of identity document (must be a configured identity type)"},"value":{"type":"string","example":"123456789","description":"Identity number value"}},"required":["type","value"]},"example":[{"type":"passport_no","value":"123456789"},{"type":"swift_code","value":"DEUTDEFF500"}]}]},"incorporationCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"industries":{"type":"array","items":{"type":"string"},"example":["Banking","Technology"],"description":"Industries the client operates in (always returned as array of strings - single strings are converted to single-item arrays)"},"lastReviewed":{"oneOf":[{"type":"number","example":1640995200000,"description":"Unix timestamp of last review (number)"}]},"lastScreenedDate":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"},"middlename":{"oneOf":[{"type":"string","example":"Michael","description":"Middle name of the client (string)"}]},"monitorEndDate":{"oneOf":[{"type":"string","example":"2025-12-31","description":"Monitoring end date in ISO 8601 format (YYYY-MM-DD)"},{"type":"number","example":1672531200000,"description":"Monitoring end date as Unix timestamp (milliseconds since epoch)"}]},"name":{"type":"string","example":"John Doe","description":"Full name of the client (strictly string only)"},"nationalityCodes":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"example":["GB","US"],"description":"ISO 3166-1 alpha-2 nationality codes (always returned as array of 2-character country codes - single strings are converted to single-item arrays)"},"objectType":{"type":"string","example":"client","description":"The type of object, always 'client' for client exports"},"occupation":{"oneOf":[{"type":"string","example":"Software Engineer","description":"Occupation of the client (string)"}]},"periodicReviewPeriod":{"oneOf":[{"type":"string","pattern":"^[0-9]+[ymdh]$","example":"1y","description":"Period for periodic reviews (format: [0-9]+[ymdh])"}]},"periodicReviewStartDate":{"oneOf":[{"type":"string","example":"2024-01-01","description":"Periodic review start date in ISO 8601 format (YYYY-MM-DD)"},{"type":"number","example":1640995200000,"description":"Periodic review start date as Unix timestamp (milliseconds since epoch)"}]},"riskScore":{"oneOf":[{"type":"number","example":75,"description":"Risk score assigned to the client (number)"}]},"segment":{"oneOf":[{"type":"string","example":"HIGH_NET_WORTH","description":"Client segment classification (string)"}]},"status":{"type":"string","enum":["ACTIVE","INACTIVE"],"example":"ACTIVE","description":"Current status of the client"},"surname":{"oneOf":[{"type":"string","example":"Doe","description":"Last name of the client (string)"}]},"suffixes":{"type":"array","items":{"type":"string"},"example":["Jr","Sr"],"description":"Suffixes associated with the client (always returned as array of strings - single strings are converted to single-item arrays)"},"titles":{"type":"array","items":{"type":"string"},"example":["Mr","Dr"],"description":"Titles associated with the client (always returned as array of strings - single strings are converted to single-item arrays)"},"vesselCallSigns":{"type":"array","items":{"type":"string"},"example":["GB1234","US5678"],"description":"Vessel call signs (always returned as array of strings - single strings are converted to single-item arrays)"},"vesselFlagsCode":{"type":"array","items":{"type":"string"},"example":["GB","US"],"description":"Vessel flag country codes (always returned as array of strings - single strings are converted to single-item arrays)"},"vesselGrts":{"type":"array","items":{"type":"integer"},"example":[123456789,987654321],"description":"Vessel GRT (Gross Register Tonnage) numbers (always returned as array of integers - single integers are converted to single-item arrays)"},"vesselImoNumber":{"type":"string","example":"1234567","description":"International Maritime Organization number (string)"},"vesselName":{"type":"string","example":"Ocean Explorer","description":"Name of the vessel for vessel clients (string)"},"vesselOwners":{"type":"array","items":{"type":"string"},"example":["Ocean Shipping Ltd","Maritime Corp"],"description":"Vessel owners (always returned as array of strings - single strings are converted to single-item arrays)"},"vesselTonnages":{"type":"array","items":{"type":"integer"},"example":[50000,75000],"description":"Vessel tonnages (always returned as array of integers - single integers are converted to single-item arrays)"}}}}}},"401":{"description":"Unauthenticated request","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"403":{"description":"Forbidden request","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"429":{"description":"Rate limit exceeded","content":{"application\/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Too many requests, please try again later","description":"Rate limit error message"},"retryAfter":{"type":"integer","example":60,"description":"Number of seconds to wait before retrying"}},"required":["error","retryAfter"]}}}},"500":{"description":"An unexpected error occurred when fetching the client counts.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}},"examples":{"unexpectedError":{"summary":"Unexpected Error","value":{"code":"500","message":"An error occurred streaming the clients."}}}}}}}}},"\/entity":{"delete":{"summary":"Delete multiple clients","description":"Delete all of the clients specified in the request body. This is a hard delete that deletes the client along with all of their alerts and associated information.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"entityMultipleDelete","tags":["Entity"],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"array","description":"A list of the IDs of the clients to delete.","properties":{"ids":{"type":"array","description":"List of client ids","minItems":1,"items":{"type":"string"}}}}}}},"responses":{"200":{"description":"Clients deleted successfully","content":{"application\/json":{"schema":{"description":"Entity deletion response","type":"object","properties":{"message":{"type":"string","example":"Successfully deleted 2 entities."},"warnings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the entity that produced the warning"},"description":{"type":"string","example":"Entity does not exist"}}}},"alerts":{"description":"Alert deletion details","type":"object","properties":{"alerts":{"description":"Total number of alerts deleted","type":"number"},"evidence":{"description":"Total number of alert evidence items deleted","type":"number"},"reasons":{"description":"Total number alert reasons deleted","type":"number"},"annotations":{"description":"Total number of alert annotations deleted","type":"number"},"activity":{"description":"Total number of alert activities deleted","type":"number"},"attachments":{"description":"Total number of alert attachments deleted","type":"number"},"blacklistedEvidence":{"description":"Total number of alert black listed evidence items deleted","type":"number"}}},"activity":{"description":"Total number of activity items deleted","type":"number"},"assessmentStore":{"description":"Total number of assessment store items deleted","type":"number"},"jobErrors":{"description":"Total number of job errors deleted","type":"number"},"vos":{"description":"VOS deletion details","type":"object","properties":{"totalDeletedFromMongo":{"description":"Total items deleted from mongo","type":"number"},"totalDeletedFromSearch":{"description:":"Total items deleted from elastic search","type":"number"}}},"blacklist":{"description":"Total blacklist items deleted","type":"number"},"irs":{"description":"Total irs items deleted","type":"number"},"periodicReview":{"description":"Total periodic review items deleted","type":"number"},"uploadedClients":{"description":"Total uploaded client items deleted","type":"number"},"activityCreated":{"description":"Total activity created items deleted","type":"number"}}},"example":{"message":"Successfully deleted 1 entities.","warnings":[{"id":"571","description":"Entity does not exist"}],"alerts":{"alerts":0,"evidence":0,"reasons":0,"comments":0,"annotations":0,"activity":0,"attachments":0,"blacklistedEvidence":0},"activity":0,"assessmentStore":0,"jobErrors":0,"vos":{"totalDeletedFromMongo":2,"totalDeletedFromSearch":1},"blacklist":0,"irs":1,"fixedPeriodAlerting":0,"periodicReview":0,"uploadedClients":1,"activityCreated":0}}}},"400":{"description":"Invalid request.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"401":{"description":"Unauthenticated request.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"403":{"description":"Forbidden request.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"500":{"description":"An unexpected error occurred when performing client deletion.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/entity\/{entity_id}":{"delete":{"summary":"Delete single client","description":"Delete the client with the specified ID. This is a hard delete of the client along with all of their alerts and associated information.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"entitySingleDelete","tags":["Entity"],"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"},"description":"ID of the client to delete"}],"responses":{"200":{"description":"Client deleted successfully.","content":{"application\/json":{"schema":{"description":"Entity deletion response","type":"object","properties":{"message":{"type":"string","example":"Successfully deleted 2 entities."},"warnings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the entity that produced the warning"},"description":{"type":"string","example":"Entity does not exist"}}}},"alerts":{"description":"Alert deletion details","type":"object","properties":{"alerts":{"description":"Total number of alerts deleted","type":"number"},"evidence":{"description":"Total number of alert evidence items deleted","type":"number"},"reasons":{"description":"Total number alert reasons deleted","type":"number"},"annotations":{"description":"Total number of alert annotations deleted","type":"number"},"activity":{"description":"Total number of alert activities deleted","type":"number"},"attachments":{"description":"Total number of alert attachments deleted","type":"number"},"blacklistedEvidence":{"description":"Total number of alert black listed evidence items deleted","type":"number"}}},"activity":{"description":"Total number of activity items deleted","type":"number"},"assessmentStore":{"description":"Total number of assessment store items deleted","type":"number"},"jobErrors":{"description":"Total number of job errors deleted","type":"number"},"vos":{"description":"VOS deletion details","type":"object","properties":{"totalDeletedFromMongo":{"description":"Total items deleted from mongo","type":"number"},"totalDeletedFromSearch":{"description:":"Total items deleted from elastic search","type":"number"}}},"blacklist":{"description":"Total blacklist items deleted","type":"number"},"irs":{"description":"Total irs items deleted","type":"number"},"periodicReview":{"description":"Total periodic review items deleted","type":"number"},"uploadedClients":{"description":"Total uploaded client items deleted","type":"number"},"activityCreated":{"description":"Total activity created items deleted","type":"number"}}}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"401":{"description":"Unauthenticated request.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"403":{"description":"Forbidden request.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"404":{"description":"Specified client not found or not visible to the calling user.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"500":{"description":"An unexpected error occurred when performing client deletion.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/entity\/validate-data":{"post":{"summary":"Validate list entity and client data","description":"Check the validity of list entity (profile) and client data by comparing the hash stored on the entity with the expected hash in the request. Use the `prefix` parameter to scope validation to list entities or clients.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n\nHashes must be supplied when loading data (list import API or client import API). Ripjar does not generate hashes; they are supplied by the client to reconcile the version in the system with the source system.\n","operationId":"entityValidateData","tags":["Entity"],"parameters":[{"name":"prefix","in":"query","required":true,"schema":{"type":"string"},"description":"The endpoint takes a prefix parameter that defines the prefix used for the key of the entity. Only entities whose key starts with the given prefix will be validated.\n\n**List entities (profiles):** The keys are generated within the system, and are of the form:\nlistEntity:internal:provider:source:<ListEntityId>\nProvider and source are the values provided in the call to the list import API when this entity was loaded. The ListEntityId corresponds to the profileId of the specific list entity. Keys for list entities are automatically prefixed with listEntity, and so to validate list data the query should be: `\u2026\/entity\/validate-data?prefix=listEntity`\n\n**Clients:** The keys are generated within the system, and are of the form:\neoi:<ClientId>\nTo validate clients for a given client key, use: `\u2026\/entity\/validate-data?prefix=eoi`.\n"}],"requestBody":{"required":false,"description":"Line-delimited JSON (NDJSON); each line is a single JSON object describing one entity to validate. Each object must have a `key` (the entity key) and may optionally have a `hash` (the expected hash to compare). See the `DataValidationItem` schema for the structure.\n","content":{"text\/plain":{"schema":{"description":"Newline-delimited JSON, one object per line","allOf":[{"type":"object","description":"Specifies the ID and hash of an entity expected to exist in the system.","properties":{"key":{"type":"string","description":"The ID of the expected entity"},"hash":{"type":"string","description":"The hash value of the expected entity. Optional; when omitted, the endpoint will only check that the entity exists in the system (e.g. for clients that were loaded without a hash).\n"}},"required":["key"]}]},"examples":{"listEntity":{"summary":"List entities (prefix=listEntity)","description":"**Full request body (NDJSON \u2014 one JSON object per line):**\n\n```json\n{ \"key\": \"listEntity:internal:provider:source:listEntity1001\", \"hash\": \"sdfuh\" }\n{ \"key\": \"listEntity:internal:provider:source:listEntity1002\", \"hash\": \"aksjh\" }\n{ \"key\": \"listEntity:internal:provider:source:listEntity1004\", \"hash\": \"aksjh\" }\n{ \"key\": \"listEntity:internal:provider:source:listEntity1004\", \"hash\": \"aksjh\" }\n{ \"key\": \"listEntity:internal:provider:source:listEntity1005\" }\n```\n","value":{"key":"listEntity:internal:provider:source:listEntity1001","hash":"sdfuh"}},"eoi":{"summary":"Clients (prefix=eoi)","description":"**Full request body (NDJSON \u2014 one JSON object per line):**\n\n```json\n{ \"key\": \"eoi:123-4567-1001\", \"hash\": \"sdfuh\" }\n{ \"key\": \"eoi:123-4567-1002\", \"hash\": \"aksjh\" }\n{ \"key\": \"eoi:123-4567-1004\", \"hash\": \"aksjh\" }\n{ \"key\": \"eoi:123-4567-1004\", \"hash\": \"aksjh\" }\n{ \"key\": \"eoi:123-4567-1005\" }\n```\n","value":{"key":"eoi:123-4567-1001","hash":"sdfuh"}}}}}},"responses":{"200":{"description":"The data validation response, comprising a list of line-delimited JSON records describing the status of each record.\n\n**Examples:** Use the response example with the same name as the request body example (`listEntity` or `eoi`) \u2014 they are paired for documentation.\n","content":{"application\/octet-stream":{"schema":{"allOf":[{"type":"object","description":"A record detailing a record that was described in the validation request, or that exists in the system that was not included in the validation request, along with its \".\/paths\/alert\/id-status.yaml\"","properties":{"code":{"description":"An HTTP status code describing the status of the record in the system. Codes are represented as follows:\n  200 - The hash for the entity in the system matched the hash supplied\n  400 - The entity Id was duplicated in the validation request\n  404 - The specified entity Id was not found in the system\n  409 - The hash value presented for validation ('hashPresented') did not match the hash value stored in the system ('ourHash')\n  417 - This entity was stored in the system (and had a key that fell within the requested range) but was not present in the validation request\n","type":"integer","enum":[200,400,404,409,417]},"entityId":{"description":"The ID of the entity record that the response relates to.","type":"string"},"message":{"description":"Message describing details of the validation item.","type":"string"},"hashPresented":{"description":"The hash value that was provided for the record in the validation request.","type":"string"},"ourHash":{"description":"The hash value that was present in the system for the version of the record with the given ID.","type":"string"}},"required":["code","entityId"]}]},"examples":{"listEntity":{"summary":"Response for listEntity request example","description":"**Full response body (NDJSON \u2014 one JSON object per line):**\n\n```json\n{ \"code\": 200, \"entityId\": \"listEntity:internal:provider:source:listEntity1001\" }\n{ \"code\": 409, \"entityId\": \"listEntity:internal:provider:source:listEntity1002\", \"hashPresented\": \"aksjh\", \"ourHash\": \"ppohs\" }\n{ \"code\": 404, \"entityId\": \"listEntity:internal:provider:source:listEntity1004\" }\n{ \"code\": 400, \"entityId\": \"listEntity:internal:provider:source:listEntity1004\", \"message\": \"Entity id is duplicated\" }\n{ \"code\": 200, \"entityId\": \"listEntity:internal:provider:source:listEntity1005\" }\n```\n","value":{"code":200,"entityId":"listEntity:internal:provider:source:listEntity1001"}},"eoi":{"summary":"Response for eoi request example","description":"**Full response body (NDJSON \u2014 one JSON object per line):**\n\n```json\n{ \"code\": 200, \"entityId\": \"eoi:123-4567-1001\" }\n{ \"code\": 409, \"entityId\": \"eoi:123-4567-1002\", \"hashPresented\": \"aksjh\", \"ourHash\": \"ppohs\" }\n{ \"code\": 404, \"entityId\": \"eoi:123-4567-1004\" }\n{ \"code\": 400, \"entityId\": \"eoi:123-4567-1004\", \"message\": \"Entity id is duplicated\" }\n{ \"code\": 200, \"entityId\": \"eoi:123-4567-1005\" }\n```\n","value":{"code":200,"entityId":"eoi:123-4567-1001"}}}}}},"401":{"description":"Unauthenticated request"},"403":{"description":"Forbidden request"},"500":{"description":"An unexpected error occurred during data validation.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}},"examples":{"unexpectedError":{"summary":"Unexpected Error","value":{"code":"500","message":"An error occurred during data validation."}}}}}}}}},"\/articles\/{article_id}":{"get":{"summary":"Retrieve one news article by id","description":"Returns the news article for the given path value. That value may be either the article id (document id) or the original id from the article source;\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"articlesGetById","tags":["Articles"],"parameters":[{"name":"article_id","in":"path","required":true,"schema":{"type":"string"},"description":"Article id or original id (see operation description)."}],"responses":{"200":{"description":"Success.","content":{"application\/json":{"schema":{"type":"object","description":"News article payload returned by the Articles endpoints.","required":["id","originalId","publisher","riskTags","publishedDate","title","content"],"properties":{"id":{"type":"string","description":"Article document id."},"originalId":{"type":"string","nullable":true,"description":"Original id from the article source when available."},"publisher":{"type":"string","nullable":true,"description":"Publisher or source name."},"riskTags":{"type":"array","description":"Risk analytics labels.","items":{"type":"string"}},"publishedDate":{"type":"string","format":"date-time","nullable":true,"description":"Publication time when known."},"title":{"type":"string","nullable":true,"description":"Article headline when available."},"content":{"type":"string","nullable":true,"description":"Full article body text."}}}}}},"400":{"description":"Invalid request.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}},"examples":{"badInput":{"summary":"Bad input","value":{"code":"BAD_INPUT_FORMAT","message":"Bad input format"}}}}}},"401":{"description":"Unauthenticated.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"403":{"description":"Forbidden.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"404":{"description":"Article not found or not available to this caller.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}},"examples":{"notFound":{"summary":"Not found","value":{"code":"NOT_FOUND","message":"News article not found"}}}}}},"500":{"description":"Server error.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}},"examples":{"articleServiceError":{"summary":"Article service error","value":{"code":"ERROR_GETTING_NEWS_ARTICLE","message":"An error occurred retrieving the news article"}}}}}}}}},"\/articles\/entity\/{entity_id}":{"get":{"summary":"Stream news articles linked to an entity","description":"Streams linked news articles as JSON-L, empty body if none.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"articlesGetByEntityId","tags":["Articles"],"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"},"description":"Entity id."}],"responses":{"200":{"description":"Success.","content":{"application\/x-ndjson":{"schema":{"type":"object","description":"News article payload returned by the Articles endpoints.","required":["id","originalId","publisher","riskTags","publishedDate","title","content"],"properties":{"id":{"type":"string","description":"Article document id."},"originalId":{"type":"string","nullable":true,"description":"Original id from the article source when available."},"publisher":{"type":"string","nullable":true,"description":"Publisher or source name."},"riskTags":{"type":"array","description":"Risk analytics labels.","items":{"type":"string"}},"publishedDate":{"type":"string","format":"date-time","nullable":true,"description":"Publication time when known."},"title":{"type":"string","nullable":true,"description":"Article headline when available."},"content":{"type":"string","nullable":true,"description":"Full article body text."}}}}}},"400":{"description":"Invalid request.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}},"examples":{"badInput":{"summary":"Bad input","value":{"code":"BAD_INPUT_FORMAT","message":"Bad input format"}}}}}},"401":{"description":"Unauthenticated.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"403":{"description":"Forbidden.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}},"404":{"description":"Entity not found or not available to this caller.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}},"examples":{"notFound":{"summary":"Not found","value":{"code":"NOT_FOUND","message":"Not found"}}}}}},"500":{"description":"Server error.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}},"examples":{"articleServiceError":{"summary":"Article service error","value":{"code":"ERROR_GETTING_NEWS_ARTICLE","message":"An error occurred retrieving the news article"}}}}}}}}},"\/list\/import":{"post":{"summary":"Create a new or update a current list entity","description":"The List entity API allows identities to be screened against entities that appear on lists, for example, watchlists including sanctioned entities or PEP's.\nThis API endpoint is used to add or change list entities.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes, and a global concurrent request limit of 5 simultaneous requests per customer.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 2.4 s |\n| 90th percentile | 2.5 s |\n| 95th percentile | 2.6 s |\n| 98th percentile | 2.6 s |\n| 99th percentile | 2.6 s |\n<!-- operational-characteristics:end -->\n\n## Checking the list processing progress\n\nList entities are queued using Apache kafka. Checking the lag of the digest-torch-list group on the list-digest topic shows how many messages there are still to process. This can be done using the following command:\n`$ \u2026\/apps\/torch_tools\/bin\/kafka\/describeGroup.sh torch-list-digest``\n\nLists are only fully processed once the second stage of processing is also complete. The second stage of processing can be checked using a similar command:\n`$ \u2026\/apps\/torch_tools\/bin\/kafka\/describeGroup.sh torch-list-deltas``\n\nWhen the lag is zero for both topics, list processing is fully complete.\n\n## Checking log files\n\nA pm2 log file is produced for each of the two stages of processing.\n\u2022\tpm2 logs digest_torch_lists\n\u2022\tpm2 logs digest_torch_list_deltas\nFor more detailed information, you can check the sensitive log files:\n\n```\n$ tail -f digest_torch_lists-sensitive.log\n$ tail -f \/data0\/logs\/node\/digest_torch_list_deltas-sensitive.log\n```\n","operationId":"listImport","tags":["List Import"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":2355.08,"p90":2474.53,"p95":2600.04,"p98":2600.04,"p99":2600.04,"sampleSize":2194}},"parameters":[{"name":"source","in":"query","required":true,"schema":{"type":"string"},"description":"The source is the name of the collection of list entities within the provider. This string is shown in the user interface, and should be URL encoded, for example \u201cMy Test List\u201d would be encoded as \u201cMy%20Test%20List\u201d."},{"name":"provider","in":"query","required":true,"schema":{"type":"string"},"description":"The provider URL query parameter identifies who created the list entities, for example dowjones. This should be a single word without special characters."}],"requestBody":{"required":false,"content":{"application\/json":{"schema":{"type":"object","allOf":[{"description":"The list entity associated with this evidence. Present if the evidence is of type 'list' and the 'lists' enrichment is enabled","oneOf":[{"type":"object","allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}}],"properties":{"person":{"type":"object","description":"The person entity schema must contain the following fileds; firstName, middleName, surname, name\n","properties":{"name":{"type":"string","description":"Full name of the person. Can be used as well as, or instead of, fields for individual name parts"},"firstName":{"type":"string","description":"Given name of the person"},"surname":{"type":"string","description":"Family name of the person"},"aliases":{"type":"array","description":"An aray of alternative names by which a person is known. Fields in each name are as for the main name fields with some additions","items":{"type":"object","properties":{"type":{"type":"string"},"firstName":{"type":"string"},"surname":{"type":"string"},"middleName":{"type":"string"},"titleHonorific":{"type":"string"},"maidenName":{"type":"string"}}}},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER"],"description":"Known gender type of the person, must be in capitals"},"deceased":{"type":"boolean","description":"Is the person deceased?"},"birthPlace":{"type":"string","description":"The name of the persons birthplace. Populated automatically from birthPlaceCountryCode"},"birthPlaceCity":{"type":"string","description":"The persons city of birth"},"dateOfBirthArray":{"type":"array","description":"Possible values for the persons date of birth. This is an array to allow for the uncertanty in reported dates","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"images":{"type":"array","description":"URLs pointing to the images of, or related to, the person","items":{"type":"string"}},"birthPlaceCountryCode":{"type":"string","description":"The country code of the persons birth"},"citizenshipCode":{"type":"array","description":"Country codes of the countries for which the person has citizenship. May be more than one","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"residentOfCode":{"type":"array","description":"Country codes of the countries for which the person is domiciled. May be more than one","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"countryOfReportedAllegationCode":{"type":"array","description":"Country codes of the countries in which alleged misconduct took place. May be more than one","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"middleName":{"type":"string","description":"Middle name of the person"},"roles":{"type":"array","description":"Current jobs or roles of the person","items":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"categoryId":{"type":"string"},"since":{"type":"string","description":"Date in the form yyyy-mm-dd"}}}},"previousRoles":{"type":"array","description":"Past jobs or roles of the person","items":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"categoryId":{"type":"string"},"since":{"type":"string","description":"Date in the form yyyy-mm-dd"},"to":{"type":"string","description":"Date in the form yyyy-mm-dd"}}}},"jurisdictionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"deceasedDateArray":{"type":"array","description":"If the person is deceased (deceased=true), possible values for the persons date of death. This is an array to allow for uncertainty in reported cases"},"suffix":{"type":"string","description":"An honorific that comes after the person's name, rather than before"}}}}},{"type":"object","allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}}],"properties":{"company":{"type":"object","description":"The company entity schema must contain the following fields: name, keyTerms\n","properties":{"name":{"type":"string","description":"The companies main name"},"suffix":{"type":"string","description":"Company suffix, e.g. Ltd, PLC or GmbH"},"aliases":{"type":"array","description":"An array of alternative names by which a company is known","items":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"suffix":{"type":"string"},"entityName":{"type":"string"}}}},"dateOfRegistrationArray":{"type":"array","description":"Company registration dates\n","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"companyURLs":{"type":"array","description":"Associated URLs for the company","items":{"type":"string"}},"countryOfRegistrationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"countryOfAffiliationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"formerlySanctionedRegionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"sanctionedRegionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"cessationDateArray":{"type":"array","description":"For non-active companies, the date(s) on which the company ceased trading","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"keyTerms":{"type":"array","description":"Keywords used in entity matching to automatically match this list entity to client profiles that contain one or more of the key terms. Viewing the list entity will then show all linked client profiles","items":{"keyTerms":{"type":"string"}}}}}}},{"type":"object","allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}}],"properties":{"location":{"type":"object","description":"Location entities are an extension of entities. All of the base fields are included in addition to the fields defined below. \nLocations can be used to represent high risk countries, and can match with location fields on clients or other entities of \ninterest in order to highlight links between the entities and these countries.\n","properties":{"name":{"type":"string","description":"Name of the location"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"The country code of the location","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"locationType":{"type":"string","description":"This must be country"},"cities":{"type":"array","description":"A list of names of cities associated with this location","items":{"type":"string"}}}},"subType":{"type":"string","enum":["country","city","region","sub-region","free-trade-zone","airport","port"],"description":"The sub-type of a location entity"}}},{"allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}},{"type":"object","properties":{"entityType":{"type":"string","enum":["listVessel"]},"vesselCallSigns":{"type":"array","items":{"type":"string"}},"vesselTypes":{"type":"array","items":{"type":"string"}},"vesselTonnages":{"type":"array","items":{"type":"integer"}},"vesselOwners":{"type":"array","items":{"type":"string"}},"vesselCustomers":{"type":"array","items":{"type":"string"}},"vesselGrts":{"type":"array","items":{"type":"integer"}},"vesselFlags":{"type":"array","items":{"type":"string"}},"vesselFlagsCode":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"vesselImoNumber":{"type":"string"},"vesselAdditionalOperators":{"type":"array","items":{"type":"object","properties":{"operatorCategory":{"type":"string","enum":["groupBeneficialOwner","operator","registeredOwner","shipManager","technicalManager"]},"operatorName":{"type":"string"},"countryOfControl":{"type":"string"},"countryOfDomicile":{"type":"string"},"countryOfRegistration":{"type":"string"}}}}}}]},{"type":"object","allOf":[{"type":"object","allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}}],"properties":{"company":{"type":"object","description":"The company entity schema must contain the following fields: name, keyTerms\n","properties":{"name":{"type":"string","description":"The companies main name"},"suffix":{"type":"string","description":"Company suffix, e.g. Ltd, PLC or GmbH"},"aliases":{"type":"array","description":"An array of alternative names by which a company is known","items":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"suffix":{"type":"string"},"entityName":{"type":"string"}}}},"dateOfRegistrationArray":{"type":"array","description":"Company registration dates\n","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"companyURLs":{"type":"array","description":"Associated URLs for the company","items":{"type":"string"}},"countryOfRegistrationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"countryOfAffiliationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"formerlySanctionedRegionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"sanctionedRegionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"cessationDateArray":{"type":"array","description":"For non-active companies, the date(s) on which the company ceased trading","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"keyTerms":{"type":"array","description":"Keywords used in entity matching to automatically match this list entity to client profiles that contain one or more of the key terms. Viewing the list entity will then show all linked client profiles","items":{"keyTerms":{"type":"string"}}}}}}}],"properties":{"aircraft":{"type":"object","description":"Aircraft entities are an extension of company entities. As well as the base fields and aircraft-specific fields, all company properties are also included.\n","properties":{"name":{"type":"string","description":"The aircraft's tail number. The prefix of the tail number is used to determine the aircraft's country of origin."}}}}}],"discriminator":{"propertyName":"entityType","mapping":{"listPerson":".\/ListEntityPerson.yaml","listAircraft":".\/ListEntityAircraft.yaml","listLocation":".\/ListEntityLocation.yaml","listOrganisation":".\/ListEntityOrganisation.yaml","listVessel":".\/ListEntityVessel.yaml"}}}],"properties":{"action":{"type":"string","description":"The action to perform on the list entity - add (or update) or delete","enum":["add","del"]}},"required":["action"]}}}},"responses":{"200":{"description":"Entity successfully created\/changed"},"401":{"description":"Unauthenticated request"},"403":{"description":"Forbidden request"},"500":{"description":"An unexpected error occurred during list import.","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}},"examples":{"unexpectedError":{"summary":"Unexpected Error","value":{"code":"500","message":"An error occurred during list import."}}}}}}}}},"\/search\/{strategy}":{"post":{"summary":"Search against one or more identifiers using a strategy","description":"This performs a search against the Identity Resolution service to see\nwhat possible matches we have for the provided identifier(s).\nA result is returned for each entity record specified in the request body,\nand the order of the results matches the order of the entities in the request.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n\n<!-- operational-characteristics:start -->\n\n### Operational characteristics\n\nValues below are measured from production traffic. Only collected values are shown.\n\n**Latency distribution**\n\nLatency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).\n\n| Metric | Value |\n| --- | --- |\n| Median | 57 ms |\n| 90th percentile | 99 ms |\n| 95th percentile | 208 ms |\n| 98th percentile | 438 ms |\n| 99th percentile | 589 ms |\n<!-- operational-characteristics:end -->\n","operationId":"searchStrategy","tags":["Search"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":56.71,"p90":98.43,"p95":207.8,"p98":437.44,"p99":588.9,"sampleSize":578411}},"parameters":[{"name":"recordProperties","in":"query","description":"A comma-delimited list of the names of properties that should be included when returning records.\nIf returnRecords is false, this parameter is ignored.  If this parameter isn't specified, and\nreturnRecords is true, entire records are returned for matches.\n","required":false,"schema":{"type":"string"}},{"name":"returnQuery","in":"query","description":"Returns the query object as given under the \u201cquery\u201d key.","required":false,"schema":{"type":"boolean","default":false}},{"name":"returnReasons","in":"query","description":"Returns the match reasons for each result. Can be verbose.","required":false,"schema":{"type":"boolean","default":false}},{"name":"returnRecords","in":"query","description":"Returns the full details for each match.","required":false,"schema":{"type":"boolean","default":false}},{"name":"strategy","in":"path","description":"Search strategy to employ. Options are configuration-dependent.\n","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"array","description":"Array of entity records","minItems":1,"items":{"description":"The search entity associated with this evidence","oneOf":[{"type":"object","allOf":[{"type":"object","required":["type","name"],"properties":{"type":{"type":"string","enum":["person","aircraft","vessel","organisation","unknown"]},"name":{"type":"string"},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"}}}},"associatedCities":{"associatedCities":{"type":"array","items":{"type":"string"}}}}}],"properties":{"type":{"const":"person"},"forename":{"type":"string","description":"Given name of the person"},"surname":{"type":"string","description":"Family name of the person"},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER"],"description":"Known gender type of the person, must be in capitals"},"dateOfBirth":{"type":"array","description":"Possible values for the persons date of birth. This is an array to allow for the uncertanty in reported dates","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"nationalityCodes":{"type":"array","description":"Country codes of the countries for which the person has citizenship. May be more than one","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"countryOfResidenceCode":{"type":"array","description":"Country codes of the countries for which the person is domiciled. May be more than one","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"middleNames":{"type":"array","description":"Middle names of the person","items":{"type":"string"}}}},{"type":"object","allOf":[{"type":"object","required":["type","name"],"properties":{"type":{"type":"string","enum":["person","aircraft","vessel","organisation","unknown"]},"name":{"type":"string"},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"}}}},"associatedCities":{"associatedCities":{"type":"array","items":{"type":"string"}}}}}],"properties":{"type":{"const":"organisation"},"dateOfIncorporation":{"type":"array","description":"Company registration dates\n","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"countryOfIncorporation":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}}},{"type":"object","allOf":[{"type":"object","required":["type","name"],"properties":{"type":{"type":"string","enum":["person","aircraft","vessel","organisation","unknown"]},"name":{"type":"string"},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"}}}},"associatedCities":{"associatedCities":{"type":"array","items":{"type":"string"}}}}}],"properties":{"type":{"const":"vessel"},"associatedCountryCodes":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"countryOfIncorporation":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"vesselImoNumber":{"type":"string"},"vesselCallSign":{"type":"array","items":{"type":"string"}},"vesselFlagCode":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}}}},{"type":"object","allOf":[{"type":"object","required":["type","name"],"properties":{"type":{"type":"string","enum":["person","aircraft","vessel","organisation","unknown"]},"name":{"type":"string"},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"}}}},"associatedCities":{"associatedCities":{"type":"array","items":{"type":"string"}}}}}],"properties":{"type":{"const":"aircraft"},"associatedCountryCodes":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"dateOfIncorporation":{"type":"array","description":"Company registration dates\n","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}}}},{"type":"object","allOf":[{"type":"object","required":["type","name"],"properties":{"type":{"type":"string","enum":["person","aircraft","vessel","organisation","unknown"]},"name":{"type":"string"},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"}}}},"associatedCities":{"associatedCities":{"type":"array","items":{"type":"string"}}}}}],"properties":{"type":{"const":"unknown"},"associatedCountryCodes":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"aliases":{"type":"array","description":"An array of alternative names","items":{"type":"string"}}}}],"discriminator":{"propertyName":"type","mapping":{"person":"..\/..\/..\/common\/schemas\/search-entity\/SearchEntityPerson.yaml","aircraft":"..\/..\/..\/common\/schemas\/search-entity\/SearchEntityAircraft.yaml","organisation":"..\/..\/..\/common\/schemas\/search-entity\/SearchEntityOrganisation.yaml","vessel":"..\/..\/..\/common\/schemas\/search-entity\/SearchEntityVessel.yaml","unknown":"..\/..\/..\/common\/schemas\/search-entity\/SearchEntityUnknown.yaml"}}}}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"array","minItems":1,"items":{"description":"An array of objects equal in length to the number of records in the search\nrequest. Each object contains the results for the entity record in the same position\nin the request array.\n","type":"object","required":["results"],"properties":{"results":{"type":"array","minItems":0,"items":{"type":"object","required":["profileId","score"],"properties":{"profileId":{"type":"string","description":"Profile identifier for the record this match is for. Can be used\nin the records endpoint.\n"},"score":{"type":"number","format":"float","minimum":0,"maximum":1,"description":"Normalised matching score modelling the system's confidence in the match.\nA score of 0 means the system has no basis on which to believe the match\nis correct \u2014 naturally this should _never_ happen.\nA score of 1 means the system has full confidence in a match, and this\nalso never happens.\nHowever, as more and more pieces of independent evidence contribute\nto a match, this number geometrically grows closer to 1.\n"}}}}}}}}}},"400":{"description":"The request was invalid and at least one search could not be performed","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"}}}}}},"401":{"description":"Unauthenticated request"},"403":{"description":"The authenticated user cannot perform searches"},"404":{"description":"Strategy not found"},"500":{"description":"An unexpected error occurred performing the search","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/search\/record\/{profileId}":{"get":{"summary":"Retrieve a profile record given the ID.","description":"The search endpoint returns profile identifiers with their scores.\nThis endpoint retrieves the full records for those profiles.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"searchProfile","tags":["Search"],"x-operational-characteristics":{"description":"Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).\n","latencyDistribution":{"median":7,"p90":7,"p95":7,"p98":7,"p99":7,"sampleSize":3}},"parameters":[{"name":"profileId","in":"path","required":true,"description":"A unique identifier for a structured data profile of an entity that the\nsearch service might match a query against.\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Record profile retrieved","content":{"application\/json":{"schema":{"description":"The list entity associated with this evidence. Present if the evidence is of type 'list' and the 'lists' enrichment is enabled","oneOf":[{"type":"object","allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}}],"properties":{"person":{"type":"object","description":"The person entity schema must contain the following fileds; firstName, middleName, surname, name\n","properties":{"name":{"type":"string","description":"Full name of the person. Can be used as well as, or instead of, fields for individual name parts"},"firstName":{"type":"string","description":"Given name of the person"},"surname":{"type":"string","description":"Family name of the person"},"aliases":{"type":"array","description":"An aray of alternative names by which a person is known. Fields in each name are as for the main name fields with some additions","items":{"type":"object","properties":{"type":{"type":"string"},"firstName":{"type":"string"},"surname":{"type":"string"},"middleName":{"type":"string"},"titleHonorific":{"type":"string"},"maidenName":{"type":"string"}}}},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER"],"description":"Known gender type of the person, must be in capitals"},"deceased":{"type":"boolean","description":"Is the person deceased?"},"birthPlace":{"type":"string","description":"The name of the persons birthplace. Populated automatically from birthPlaceCountryCode"},"birthPlaceCity":{"type":"string","description":"The persons city of birth"},"dateOfBirthArray":{"type":"array","description":"Possible values for the persons date of birth. This is an array to allow for the uncertanty in reported dates","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"images":{"type":"array","description":"URLs pointing to the images of, or related to, the person","items":{"type":"string"}},"birthPlaceCountryCode":{"type":"string","description":"The country code of the persons birth"},"citizenshipCode":{"type":"array","description":"Country codes of the countries for which the person has citizenship. May be more than one","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"residentOfCode":{"type":"array","description":"Country codes of the countries for which the person is domiciled. May be more than one","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"countryOfReportedAllegationCode":{"type":"array","description":"Country codes of the countries in which alleged misconduct took place. May be more than one","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"middleName":{"type":"string","description":"Middle name of the person"},"roles":{"type":"array","description":"Current jobs or roles of the person","items":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"categoryId":{"type":"string"},"since":{"type":"string","description":"Date in the form yyyy-mm-dd"}}}},"previousRoles":{"type":"array","description":"Past jobs or roles of the person","items":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"categoryId":{"type":"string"},"since":{"type":"string","description":"Date in the form yyyy-mm-dd"},"to":{"type":"string","description":"Date in the form yyyy-mm-dd"}}}},"jurisdictionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"deceasedDateArray":{"type":"array","description":"If the person is deceased (deceased=true), possible values for the persons date of death. This is an array to allow for uncertainty in reported cases"},"suffix":{"type":"string","description":"An honorific that comes after the person's name, rather than before"}}}}},{"type":"object","allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}}],"properties":{"company":{"type":"object","description":"The company entity schema must contain the following fields: name, keyTerms\n","properties":{"name":{"type":"string","description":"The companies main name"},"suffix":{"type":"string","description":"Company suffix, e.g. Ltd, PLC or GmbH"},"aliases":{"type":"array","description":"An array of alternative names by which a company is known","items":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"suffix":{"type":"string"},"entityName":{"type":"string"}}}},"dateOfRegistrationArray":{"type":"array","description":"Company registration dates\n","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"companyURLs":{"type":"array","description":"Associated URLs for the company","items":{"type":"string"}},"countryOfRegistrationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"countryOfAffiliationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"formerlySanctionedRegionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"sanctionedRegionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"cessationDateArray":{"type":"array","description":"For non-active companies, the date(s) on which the company ceased trading","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"keyTerms":{"type":"array","description":"Keywords used in entity matching to automatically match this list entity to client profiles that contain one or more of the key terms. Viewing the list entity will then show all linked client profiles","items":{"keyTerms":{"type":"string"}}}}}}},{"type":"object","allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}}],"properties":{"location":{"type":"object","description":"Location entities are an extension of entities. All of the base fields are included in addition to the fields defined below. \nLocations can be used to represent high risk countries, and can match with location fields on clients or other entities of \ninterest in order to highlight links between the entities and these countries.\n","properties":{"name":{"type":"string","description":"Name of the location"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"The country code of the location","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"locationType":{"type":"string","description":"This must be country"},"cities":{"type":"array","description":"A list of names of cities associated with this location","items":{"type":"string"}}}},"subType":{"type":"string","enum":["country","city","region","sub-region","free-trade-zone","airport","port"],"description":"The sub-type of a location entity"}}},{"allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}},{"type":"object","properties":{"entityType":{"type":"string","enum":["listVessel"]},"vesselCallSigns":{"type":"array","items":{"type":"string"}},"vesselTypes":{"type":"array","items":{"type":"string"}},"vesselTonnages":{"type":"array","items":{"type":"integer"}},"vesselOwners":{"type":"array","items":{"type":"string"}},"vesselCustomers":{"type":"array","items":{"type":"string"}},"vesselGrts":{"type":"array","items":{"type":"integer"}},"vesselFlags":{"type":"array","items":{"type":"string"}},"vesselFlagsCode":{"type":"array","items":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"vesselImoNumber":{"type":"string"},"vesselAdditionalOperators":{"type":"array","items":{"type":"object","properties":{"operatorCategory":{"type":"string","enum":["groupBeneficialOwner","operator","registeredOwner","shipManager","technicalManager"]},"operatorName":{"type":"string"},"countryOfControl":{"type":"string"},"countryOfDomicile":{"type":"string"},"countryOfRegistration":{"type":"string"}}}}}}]},{"type":"object","allOf":[{"type":"object","allOf":[{"type":"object","required":["profileID","name","activeStatus"],"properties":{"profileID":{"type":"string","description":"Unique ID for this profile, used when creating relationships"},"entityType":{"type":"string","enum":["listPerson","listAircraft","listLocation","listOrganisation","listVessel"]},"name":{"type":"string"},"activeStatus":{"type":"string","enum":["Active","Inactive"],"description":"Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list."},"identityNumbers":{"description":"Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string.","type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"notes":{"type":"string"}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"line3":{"type":"string"},"line4":{"type":"string"},"poBox":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"postcode":{"type":"string"},"addressType":{"type":"string"}}}},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"profileNotes":{"type":"string"},"lists":{"type":"array","items":{"type":"object","description":"Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n","properties":{"id":{"type":"string","description":"ID of the list that the entity is on"},"name":{"type":"string","description":"Name of the list that the entity is on"},"hierarchy":{"type":"array","description":"Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n","items":{"id":{"type":"string"},"name":{"type":"string"},"parent":{"type":"string"}}},"active":{"type":"boolean","description":"Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n"},"listActive":{"type":"boolean","description":"Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false.\n"},"additionalFields":{"type":"array","description":"Any additional properties of the list as key\/value pairs\n","items":{"key":{"type":"string"},"value":{"type":"string"}}},"since":{"type":"string","format":"date","description":"When the entity was added to the list","example":"2023-12-25"},"to":{"type":"string","format":"date","description":"If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list","example":"2023-12-25"}}}},"sources":{"description":"Sources used when compiling the list entity","type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"entityName":{"type":"string"},"suffix":{"type":"string"},"forename":{"type":"string"},"middlename":{"type":"string"},"surname":{"type":"string"},"maidenName":{"type":"string"},"singleStringName":{"type":"string"},"titleHonorific":{"type":"string"}}}},"relationships":{"type":"array","description":"Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity","items":{"type":"object","properties":{"current":{"type":"boolean"},"type":{"type":"string"},"profileID":{"type":"integer"}}}},"categories":{"type":"array","description":"Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk'","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of risk category"},"value":{"type":"string","description":"Value of the risk e.g. high"}}}},"hash":{"type":"string","description":"A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system."}}}],"properties":{"company":{"type":"object","description":"The company entity schema must contain the following fields: name, keyTerms\n","properties":{"name":{"type":"string","description":"The companies main name"},"suffix":{"type":"string","description":"Company suffix, e.g. Ltd, PLC or GmbH"},"aliases":{"type":"array","description":"An array of alternative names by which a company is known","items":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"suffix":{"type":"string"},"entityName":{"type":"string"}}}},"dateOfRegistrationArray":{"type":"array","description":"Company registration dates\n","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"companyURLs":{"type":"array","description":"Associated URLs for the company","items":{"type":"string"}},"countryOfRegistrationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"countryOfAffiliationCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"formerlySanctionedRegionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"sanctionedRegionCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"enhancedRiskCountryCode":{"type":"string","maxLength":2,"minLength":2,"description":"An ISO-3166 alpha-2 country code digraph as defined here: <https:\/\/www.iso.org\/iso-3166-country-codes.html>\n","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"cessationDateArray":{"type":"array","description":"For non-active companies, the date(s) on which the company ceased trading","items":{"type":"string","format":"date","description":"An ISO-8601 compliant date string","example":"2023-12-25"}},"keyTerms":{"type":"array","description":"Keywords used in entity matching to automatically match this list entity to client profiles that contain one or more of the key terms. Viewing the list entity will then show all linked client profiles","items":{"keyTerms":{"type":"string"}}}}}}}],"properties":{"aircraft":{"type":"object","description":"Aircraft entities are an extension of company entities. As well as the base fields and aircraft-specific fields, all company properties are also included.\n","properties":{"name":{"type":"string","description":"The aircraft's tail number. The prefix of the tail number is used to determine the aircraft's country of origin."}}}}}],"discriminator":{"propertyName":"entityType","mapping":{"listPerson":".\/ListEntityPerson.yaml","listAircraft":".\/ListEntityAircraft.yaml","listLocation":".\/ListEntityLocation.yaml","listOrganisation":".\/ListEntityOrganisation.yaml","listVessel":".\/ListEntityVessel.yaml"}}}}}},"401":{"description":"Unauthenticated request"},"403":{"description":"The authenticated user cannot view records"},"404":{"description":"Profile record with that ID not found"},"500":{"description":"An unexpected error occurred","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/user\/search":{"post":{"summary":"Search users","description":"Search users that\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"userSearch","tags":["User"],"parameters":[{"in":"query","name":"includeDeleted","description":"Return deleted users","required":false,"schema":{"type":"string","enum":["true","false"]}}],"requestBody":{"required":true,"content":{"text\/plain":{"schema":{"type":"object","properties":{"cn":{"type":"string","description":"The user's canonical name. Used to lookup user accounts when performing certificate-based authentication."},"cns":{"type":"array","description":"Array of user's canonical names. Used to lookup user accounts when performing certificate-based authentication.","items":{"type":"string"}},"id":{"type":"number","example":10000},"ids":{"type":"array","items":{"type":"number"},"example":[10000,10001]},"email":{"type":"string","example":"john.smith@ripjar.com"},"username":{"type":"string","example":"John Smith"},"roles":{"type":"array","items":{"type":"string"},"example":["ROLE_1"]},"externalId":{"type":"string","example":"john.smith@ripjar.com"}}}}}},"responses":{"200":{"description":"Success - returns an array of user records that matches the given filter","content":{"text\/plain":{"schema":{"type":"array","items":{"type":"object","properties":{"username":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@ripjar.com"},"cn":{"type":"string","example":"john.smith@ripjar.com"},"clientKey":{"type":"string","example":"lowercasekey"},"customerExcludedApps":{"type":"array","nullable":true,"items":{"type":"string","example":"app"}},"roles":{"type":"array","items":{"type":"string","example":"ADMINISTRATOR"}},"security":{"type":"object"},"id":{"type":"number","example":10000},"externalId\"":{"type":"string","example":"john.smith@ripjar.com"},"mobile":{"type":"string","example":"01234567890"},"username_lowercase":{"type":"string","example":"john smith"},"accountLocked":{"type":"boolean","example":false},"failed_login_attempts":{"type":"number","example":0},"failed_login_timestamp":{"type":"number","example":-1},"whitelistedPermissions":{"type":"array","example":["Admin","AlertClose"],"items":{"type":"string"}},"customerName":{"type":"string"},"permissions":{"type":"array","items":{"type":"string","example":"Admin"}}}}}}}},"400":{"description":"Your request was invalid and the search could not be performed"},"401":{"description":"Unauthenticated request"},"403":{"description":"The authenticated user cannot search \/ view user records"},"500":{"description":"An unexpected error occurred performing the search","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/user\/import":{"post":{"summary":"Bulk import multiple users to the system","description":"Create or update multiple user accounts within the system.\n### Rate Limits\n\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n","operationId":"userImport","tags":["User"],"requestBody":{"required":true,"description":"A list of line-delimited JSON records, where each line is a complete JSON object that conforms to the user schema.","content":{"text\/plain":{"schema":{"type":"object","description":"An object representing a user in the system.","required":["username","email","cn"],"properties":{"excludedApps":{"type":"array","items":{"type":"string"},"description":"A list of the applications that this user is excluded from accessing. Not used in Labyrinth Screening."},"username":{"type":"string","description":"The name of the user. This is the value displayed when the user is referenced in the UI."},"email":{"type":"string","description":"The email address of the user. Can be used as part of basic authentication."},"mobile":{"type":"string","description":"The mobile\/cell phone number of the user."},"roles":{"type":"array","items":{"type":"string"},"description":"A list of the user roles that this user has.\nLabyrinth Screening makes use of defined user roles to control the actions a user may perform and to tailor the interface to the needs of particular users.\nEach role is made up of a set of permissions which provide fine grained control over the actions a user can perform. Roles can be configured to match the business roles required by the users of the Screening system.\nThese permissions used by the Screening system are described in the Ripjar Security Implementation document.\nWhen users are loaded into the system, each user account should include the list of roles they are allowed to perform.\n"},"password":{"type":"string","description":"The user's password, used for basic authentication or to retrieve a bearer auth (JWT) token. Not available in API responses. Required when creating or updating users.\n"},"cn":{"type":"string","description":"The user's canonical name. Used to lookup user accounts when performing certificate-based authentication."},"externalId":{"type":"string","description":"The user's ID external to the system. Typically maps to a username or ID in an external user entitlement system."},"security":{"type":"object","description":"The security attributes for this user.\nA user's security attributes govern the data items in the system (such as clients, alerts and assessments) that the user has visibility of. These are distinct from the user's roles, which govern the operations a user can carry out in the system.\nThe security schema contains a set of generic attributes that the user can be assigned. The meaning of these attributes varies depending on the security policy installed on the system.\nBy default, the security policy will compare the list of strings (also known as tags) in dataRolesN fields of the user to the list of strings in the orTagsN field in the security attributes of the data item. If the user has any of the tags that appear on the data item, they can view that item.\nIf the data item has multiple orTags fields, for example orTags1 and orTags2, the user must has at least one of the tags in each of the corresponding dataRoles fields, i.e. there is an AND logic between each attribute.\n","properties":{"dataRoles1":{"type":"array","items":{"type":"string"}},"dataRoles2":{"type":"array","items":{"type":"string"}},"dataRoles3":{"type":"array","items":{"type":"string"}},"compositeDataRoles1":{"type":"array","items":{"type":"object"}}}}}}}}},"responses":{"200":{"description":"Success - returns the set of user records that were added or updated","content":{"text\/plain":{"schema":{"type":"object","description":"An object representing a user in the system.","required":["username","email","cn"],"properties":{"excludedApps":{"type":"array","items":{"type":"string"},"description":"A list of the applications that this user is excluded from accessing. Not used in Labyrinth Screening."},"username":{"type":"string","description":"The name of the user. This is the value displayed when the user is referenced in the UI."},"email":{"type":"string","description":"The email address of the user. Can be used as part of basic authentication."},"mobile":{"type":"string","description":"The mobile\/cell phone number of the user."},"roles":{"type":"array","items":{"type":"string"},"description":"A list of the user roles that this user has.\nLabyrinth Screening makes use of defined user roles to control the actions a user may perform and to tailor the interface to the needs of particular users.\nEach role is made up of a set of permissions which provide fine grained control over the actions a user can perform. Roles can be configured to match the business roles required by the users of the Screening system.\nThese permissions used by the Screening system are described in the Ripjar Security Implementation document.\nWhen users are loaded into the system, each user account should include the list of roles they are allowed to perform.\n"},"password":{"type":"string","description":"The user's password, used for basic authentication or to retrieve a bearer auth (JWT) token. Not available in API responses. Required when creating or updating users.\n"},"cn":{"type":"string","description":"The user's canonical name. Used to lookup user accounts when performing certificate-based authentication."},"externalId":{"type":"string","description":"The user's ID external to the system. Typically maps to a username or ID in an external user entitlement system."},"security":{"type":"object","description":"The security attributes for this user.\nA user's security attributes govern the data items in the system (such as clients, alerts and assessments) that the user has visibility of. These are distinct from the user's roles, which govern the operations a user can carry out in the system.\nThe security schema contains a set of generic attributes that the user can be assigned. The meaning of these attributes varies depending on the security policy installed on the system.\nBy default, the security policy will compare the list of strings (also known as tags) in dataRolesN fields of the user to the list of strings in the orTagsN field in the security attributes of the data item. If the user has any of the tags that appear on the data item, they can view that item.\nIf the data item has multiple orTags fields, for example orTags1 and orTags2, the user must has at least one of the tags in each of the corresponding dataRoles fields, i.e. there is an AND logic between each attribute.\n","properties":{"dataRoles1":{"type":"array","items":{"type":"string"}},"dataRoles2":{"type":"array","items":{"type":"string"}},"dataRoles3":{"type":"array","items":{"type":"string"}},"compositeDataRoles1":{"type":"array","items":{"type":"object"}}}}}}}}},"400":{"description":"The request was invalid and the import could not be performed"},"401":{"description":"Unauthenticated request"},"403":{"description":"The authenticated user cannot add \/ update user records"},"500":{"description":"An unexpected error occurred performing the import","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/users":{"delete":{"summary":"Delete a list of users from the system.","description":"The Delete Users Endpoint is used to delete a large number of users in a single call. ### Rate Limits\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\nUser records are soft-deleted: the system retains basic essential information about the user for audit and display purposes, but the user account will be inaccessible.\n","operationId":"usersDelete","tags":["User"],"requestBody":{"required":true,"description":"A line-delimited list of JSON records conforming to the user delete request schema, and representing the IDs of the users to delete.","content":{"application\/octet-stream":{"schema":{"type":"object","description":"The identity of the user to delete.","oneOf":[{"externalId":null,"type":"string","description":"The external ID of the user to delete."},{"id":null,"type":"integer","description":"The internal Labyrinth Screening ID of the user to delete."}]}},"text\/plain":{"schema":{"type":"object","description":"The identity of the user to delete.","oneOf":[{"externalId":null,"type":"string","description":"The external ID of the user to delete."},{"id":null,"type":"integer","description":"The internal Labyrinth Screening ID of the user to delete."}]}}}},"responses":{"200":{"description":"Users deleted successfully"},"400":{"description":"Invalid request"},"401":{"description":"Unauthenticated request"},"403":{"description":"Forbidden request"},"500":{"description":"An unexpected error occurred when performing client deletion","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}},"\/users\/sync":{"post":{"summary":"Synchronize users to the system by replacing all current users with a new set","description":"The Synchronize Users endpoint will replace all of the users currently defined in the Labyrinth system with those in the payload received. The following rules are observed: - Any user currently within the system and not mentioned in the payload will be deleted. - The system will update any existing user where the `id` or `externalId` fields match. - Any user that is absent, both the `id` and `externalId` fields will be created. - If an `id` is provided, but could not be found, then an error will be returned. ### Rate Limits\nThis endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.\n`id` is a field created by the Labyrinth system.  Any record that contains an id that cannot be found in the system will result in a 404 error response. `externalId` is not a required field and so will be missing in the response if not provided. To update a user, then one or both of the `id` or `externalId` fields must be provided. The combination of the lineNumber and errors fields in the response should be used to diagnose which records could not be updated and why the operation was not successful.\n*Care should be taken with this mechanism since it is possible to delete all users by sending an empty payload.*\n","operationId":"usersSync","tags":["User"],"requestBody":{"required":true,"description":"A list of line-delimited JSON records that conform to the user schema and represent the full set of user records that should exist in the system once the operation has completed.","content":{"text\/plain":{"schema":{"type":"object","description":"An object representing a user in the system.","required":["username","email","cn"],"properties":{"excludedApps":{"type":"array","items":{"type":"string"},"description":"A list of the applications that this user is excluded from accessing. Not used in Labyrinth Screening."},"username":{"type":"string","description":"The name of the user. This is the value displayed when the user is referenced in the UI."},"email":{"type":"string","description":"The email address of the user. Can be used as part of basic authentication."},"mobile":{"type":"string","description":"The mobile\/cell phone number of the user."},"roles":{"type":"array","items":{"type":"string"},"description":"A list of the user roles that this user has.\nLabyrinth Screening makes use of defined user roles to control the actions a user may perform and to tailor the interface to the needs of particular users.\nEach role is made up of a set of permissions which provide fine grained control over the actions a user can perform. Roles can be configured to match the business roles required by the users of the Screening system.\nThese permissions used by the Screening system are described in the Ripjar Security Implementation document.\nWhen users are loaded into the system, each user account should include the list of roles they are allowed to perform.\n"},"password":{"type":"string","description":"The user's password, used for basic authentication or to retrieve a bearer auth (JWT) token. Not available in API responses. Required when creating or updating users.\n"},"cn":{"type":"string","description":"The user's canonical name. Used to lookup user accounts when performing certificate-based authentication."},"externalId":{"type":"string","description":"The user's ID external to the system. Typically maps to a username or ID in an external user entitlement system."},"security":{"type":"object","description":"The security attributes for this user.\nA user's security attributes govern the data items in the system (such as clients, alerts and assessments) that the user has visibility of. These are distinct from the user's roles, which govern the operations a user can carry out in the system.\nThe security schema contains a set of generic attributes that the user can be assigned. The meaning of these attributes varies depending on the security policy installed on the system.\nBy default, the security policy will compare the list of strings (also known as tags) in dataRolesN fields of the user to the list of strings in the orTagsN field in the security attributes of the data item. If the user has any of the tags that appear on the data item, they can view that item.\nIf the data item has multiple orTags fields, for example orTags1 and orTags2, the user must has at least one of the tags in each of the corresponding dataRoles fields, i.e. there is an AND logic between each attribute.\n","properties":{"dataRoles1":{"type":"array","items":{"type":"string"}},"dataRoles2":{"type":"array","items":{"type":"string"}},"dataRoles3":{"type":"array","items":{"type":"string"}},"compositeDataRoles1":{"type":"array","items":{"type":"object"}}}}}}}}},"responses":{"200":{"description":"Success - returns a list of line-delimited JSON records representing any errors that were encountered.","content":{"text\/plain":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"externalId":{"type":"string"},"lineNumber":{"type":"integer"},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"}}}}}}}}},"400":{"description":"Your request was invalid and the sync could not be performed"},"401":{"description":"Unauthenticated request"},"403":{"description":"The authenticated user cannot perform a synchronization"},"500":{"description":"An unexpected error occurred performing the synchronization","content":{"application\/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code that can be used when contacting support or looking up information"},"message":{"type":"string","description":"Human-readable description of the error, which will usually indicate possible next steps if applicable"},"status":{"type":"number","description":"HTTP Error code"}}}}}}}}}},"components":{"schemas":{"DataValidationItem":{"type":"object","description":"Specifies the ID and hash of an entity expected to exist in the system.","properties":{"key":{"type":"string","description":"The ID of the expected entity"},"hash":{"type":"string","description":"The hash value of the expected entity. Optional; when omitted, the endpoint will only check that the entity exists in the system (e.g. for clients that were loaded without a hash).\n"}},"required":["key"]},"DataValidationResponseItem":{"type":"object","description":"A record detailing a record that was described in the validation request, or that exists in the system that was not included in the validation request, along with its \".\/paths\/alert\/id-status.yaml\"","properties":{"code":{"description":"An HTTP status code describing the status of the record in the system. Codes are represented as follows:\n  200 - The hash for the entity in the system matched the hash supplied\n  400 - The entity Id was duplicated in the validation request\n  404 - The specified entity Id was not found in the system\n  409 - The hash value presented for validation ('hashPresented') did not match the hash value stored in the system ('ourHash')\n  417 - This entity was stored in the system (and had a key that fell within the requested range) but was not present in the validation request\n","type":"integer","enum":[200,400,404,409,417]},"entityId":{"description":"The ID of the entity record that the response relates to.","type":"string"},"message":{"description":"Message describing details of the validation item.","type":"string"},"hashPresented":{"description":"The hash value that was provided for the record in the validation request.","type":"string"},"ourHash":{"description":"The hash value that was present in the system for the version of the record with the given ID.","type":"string"}},"required":["code","entityId"]}},"securitySchemes":{"jwt":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT authentication is the preferred authentication method, and should be used for new integrations.  Contact support to request a service account."},"basicAuth":{"type":"http","scheme":"basic","description":"Basic authentication is supported for existing users, but is deprecated.  Existing users are encouraged to contact support for a dedicated service account and switch to JWT authentication."}}},"tags":[{"name":"Alert","description":"The Alert API allows clients to interact with alerts that have been raised through continuous monitoring."},{"name":"Alert Export","description":"The Alert Export API allows clients to export details of alerts, alert evidence and alert activities."},{"name":"Assessment","description":"The Assessment API allows clients to create and interact with assessments."},{"name":"Assessment Export","description":"The Assessment Export API allows clients to export details of assessments, assessment evidence and assessment activities."},{"name":"Attachment","description":"The Attachment API allows clients to upload attachment files to alerts"},{"name":"Client Import","description":"The Client Import API allows clients to bulk load client records representing entities to be screened as part of continuous monitoring."},{"name":"Client Delete","description":"The Client Delete endpoint allows clients to hard delete client records in the system."},{"name":"Entity","description":"The Entity API allows clients to retrieve details of and reconcile entities (i.e. clients, risk profiles and internal list entities) stored in the system."},{"name":"List Import","description":"The List API allows clients to bulk load internal list entities into the Screening system."},{"name":"User","description":"The User API allows clients to import and manage user accounts in the system."},{"name":"PDF Export","description":"The PDF Export API allows clients to create PDF documents of Alerts, Assessments and Searches."},{"name":"Excel Export","description":"The Excel Export API allows clients to create Excel spreadsheets containing client screening results and evidence."},{"name":"Disposition","description":"The Disposition API allows clients to create, retrieve, update and delete historical dispositions representing prior adjudication decisions."},{"name":"Search","description":"The Search API allows clients to run ad-hoc, low-latency searches. Results from searches are not persisted in the system."},{"name":"Articles","description":"Fetch a news article by id, or stream news articles linked to an entity as JSON-L."}]}