{"openapi":"3.1.0","info":{"title":"Profile Match Console","version":"2.0.0"},"paths":{"/api/v1":{"get":{"tags":["API v1"],"summary":"What this API offers (the base URL)","operationId":"index_api_v1_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Index Api V1 Get"}}}}}}},"/api/v1/health":{"get":{"tags":["API v1"],"summary":"Check the service is up","operationId":"health_api_v1_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Health Api V1 Health Get"}}}}}}},"/api/v1/reference":{"get":{"tags":["API v1"],"summary":"Fields and codes a record accepts","operationId":"reference_api_v1_reference_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Reference Api V1 Reference Get"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v1/population-types":{"get":{"tags":["API v1"],"summary":"The population types a person can belong to","operationId":"population_types_api_v1_population_types_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Response Population Types Api V1 Population Types Get"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v1/settings":{"get":{"tags":["API v1"],"summary":"Current match settings","operationId":"get_settings_api_v1_settings_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Get Settings Api V1 Settings Get"}}}}},"security":[{"APIKeyHeader":[]}]},"patch":{"tags":["API v1"],"summary":"Change match settings (admin key)","operationId":"change_settings_api_v1_settings_patch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsChange"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Change Settings Api V1 Settings Patch"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v1/match":{"post":{"tags":["API v1"],"summary":"Compare two to six person records","operationId":"match_api_v1_match_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMatchRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Match Api V1 Match Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v1/matches":{"get":{"tags":["API v1"],"summary":"Search saved matches","operationId":"list_matches_api_v1_matches_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"query","required":false,"schema":{"type":"string","default":"","title":"Name"}},{"name":"document","in":"query","required":false,"schema":{"type":"string","default":"","title":"Document"}},{"name":"nationality","in":"query","required":false,"schema":{"type":"string","default":"","title":"Nationality"}},{"name":"verdict","in":"query","required":false,"schema":{"type":"string","pattern":"^(|Match|Review|No match)$","default":"","title":"Verdict"}},{"name":"source","in":"query","required":false,"schema":{"type":"string","pattern":"^(|console|api)$","default":"","title":"Source"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","default":"","title":"Since"}},{"name":"until","in":"query","required":false,"schema":{"type":"string","default":"","title":"Until"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Page Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response List Matches Api V1 Matches Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/matches/{match_id}":{"get":{"tags":["API v1"],"summary":"One saved match with its records and result","operationId":"get_match_api_v1_matches__match_id__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"match_id","in":"path","required":true,"schema":{"type":"integer","title":"Match Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Match Api V1 Matches  Match Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/search":{"post":{"tags":["API v1"],"summary":"Search the population for one person","operationId":"search_api_v1_search_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Search Api V1 Search Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v1/searches":{"get":{"tags":["API v1"],"summary":"The search log","operationId":"list_searches_api_v1_searches_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"source","in":"query","required":false,"schema":{"type":"string","pattern":"^(|console|api)$","default":"","title":"Source"}},{"name":"verdict","in":"query","required":false,"schema":{"type":"string","pattern":"^(|Match|Review|No match|none)$","default":"","title":"Verdict"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","default":"","title":"Since"}},{"name":"until","in":"query","required":false,"schema":{"type":"string","default":"","title":"Until"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Page Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response List Searches Api V1 Searches Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/performance":{"get":{"tags":["API v1"],"summary":"Counts and timings of matches, searches and imports","operationId":"performance_report_api_v1_performance_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":365,"minimum":1,"default":7,"title":"Days"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Performance Report Api V1 Performance Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/registry":{"get":{"tags":["API v1"],"summary":"Population summary","operationId":"registry_stats_api_v1_registry_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Registry Stats Api V1 Registry Get"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v1/registry/people":{"get":{"tags":["API v1"],"summary":"Find people in the population","operationId":"list_people_api_v1_registry_people_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Page Size"}},{"name":"q","in":"query","required":false,"schema":{"type":"string","default":"","title":"Q"}},{"name":"dob","in":"query","required":false,"schema":{"type":"string","default":"","title":"Dob"}},{"name":"nationality","in":"query","required":false,"schema":{"type":"string","default":"","title":"Nationality"}},{"name":"gender","in":"query","required":false,"schema":{"type":"string","pattern":"^(|M|F|X|-)$","default":"","title":"Gender"}},{"name":"document","in":"query","required":false,"schema":{"type":"string","default":"","title":"Document"}},{"name":"doc_type","in":"query","required":false,"schema":{"type":"string","pattern":"^(|P|V|I|-)$","default":"","title":"Doc Type"}},{"name":"doc_country","in":"query","required":false,"schema":{"type":"string","default":"","title":"Doc Country"}},{"name":"ref","in":"query","required":false,"schema":{"type":"string","default":"","title":"Ref"}},{"name":"batch_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Batch Id"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","default":"","title":"Since"}},{"name":"until","in":"query","required":false,"schema":{"type":"string","default":"","title":"Until"}},{"name":"population_type","in":"query","required":false,"schema":{"type":"string","maxLength":40,"description":"A type code; - for people with no type yet","default":"","title":"Population Type"},"description":"A type code; - for people with no type yet"},{"name":"sort","in":"query","required":false,"schema":{"type":"string","pattern":"^(name|dob|added)$","default":"name","title":"Sort"}},{"name":"direction","in":"query","required":false,"schema":{"type":"string","pattern":"^(asc|desc)$","default":"asc","title":"Direction"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response List People Api V1 Registry People Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["API v1"],"summary":"Add a person to the population","operationId":"add_person_api_v1_registry_people_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PopulationPerson"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Add Person Api V1 Registry People Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/registry/people/ref/{ref}":{"get":{"tags":["API v1"],"summary":"One person, by your ref","operationId":"get_by_ref_api_v1_registry_people_ref__ref__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"ref","in":"path","required":true,"schema":{"type":"string","title":"Ref"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get By Ref Api V1 Registry People Ref  Ref  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["API v1"],"summary":"Add or replace a person, by your ref","operationId":"put_by_ref_api_v1_registry_people_ref__ref__put","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"ref","in":"path","required":true,"schema":{"type":"string","title":"Ref"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PopulationPerson"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Put By Ref Api V1 Registry People Ref  Ref  Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/registry/people/{person_id}":{"get":{"tags":["API v1"],"summary":"One person","operationId":"get_person_api_v1_registry_people__person_id__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"person_id","in":"path","required":true,"schema":{"type":"integer","title":"Person Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Person Api V1 Registry People  Person Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["API v1"],"summary":"Replace a person's details","operationId":"update_person_api_v1_registry_people__person_id__put","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"person_id","in":"path","required":true,"schema":{"type":"integer","title":"Person Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PopulationPerson"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Update Person Api V1 Registry People  Person Id  Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["API v1"],"summary":"Remove a person from the population","operationId":"delete_person_api_v1_registry_people__person_id__delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"person_id","in":"path","required":true,"schema":{"type":"integer","title":"Person Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Delete Person Api V1 Registry People  Person Id  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/registry/imports":{"get":{"tags":["API v1"],"summary":"Every import, newest first","operationId":"list_imports_api_v1_registry_imports_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Response List Imports Api V1 Registry Imports Get"}}}}},"security":[{"APIKeyHeader":[]}]},"post":{"tags":["API v1"],"summary":"Add or update many people as one import","operationId":"import_people_api_v1_registry_imports_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Import People Api V1 Registry Imports Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v1/registry/imports/{import_id}/undo":{"post":{"tags":["API v1"],"summary":"Undo an import","operationId":"undo_import_api_v1_registry_imports__import_id__undo_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"import_id","in":"path","required":true,"schema":{"type":"integer","title":"Import Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Undo Import Api V1 Registry Imports  Import Id  Undo Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/registry/clear":{"post":{"tags":["API v1"],"summary":"Remove everyone from the population (admin key)","operationId":"clear_api_v1_registry_clear_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClearRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Clear Api V1 Registry Clear Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/keys":{"get":{"tags":["Key management"],"summary":"List Keys","operationId":"list_keys_api_keys_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Response List Keys Api Keys Get"}}}}}},"post":{"tags":["Key management"],"summary":"Create Key","operationId":"create_key_api_keys_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Create Key Api Keys Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/keys/{key_id}":{"delete":{"tags":["Key management"],"summary":"Revoke Key","operationId":"revoke_key_api_keys__key_id__delete","parameters":[{"name":"key_id","in":"path","required":true,"schema":{"type":"integer","title":"Key Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Revoke Key Api Keys  Key Id  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/population/stats":{"get":{"tags":["Population"],"summary":"Stats","operationId":"stats_api_population_stats_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Stats Api Population Stats Get"}}}}}}},"/api/population":{"get":{"tags":["Population"],"summary":"Search","operationId":"search_api_population_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Page Size"}},{"name":"q","in":"query","required":false,"schema":{"type":"string","default":"","title":"Q"}},{"name":"dob","in":"query","required":false,"schema":{"type":"string","default":"","title":"Dob"}},{"name":"nationality","in":"query","required":false,"schema":{"type":"string","default":"","title":"Nationality"}},{"name":"gender","in":"query","required":false,"schema":{"type":"string","pattern":"^(|M|F|X|-)$","default":"","title":"Gender"}},{"name":"document","in":"query","required":false,"schema":{"type":"string","default":"","title":"Document"}},{"name":"doc_type","in":"query","required":false,"schema":{"type":"string","pattern":"^(|P|V|I|-)$","default":"","title":"Doc Type"}},{"name":"doc_country","in":"query","required":false,"schema":{"type":"string","default":"","title":"Doc Country"}},{"name":"ref","in":"query","required":false,"schema":{"type":"string","default":"","title":"Ref"}},{"name":"batch_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Batch Id"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","default":"","title":"Since"}},{"name":"until","in":"query","required":false,"schema":{"type":"string","default":"","title":"Until"}},{"name":"population_type","in":"query","required":false,"schema":{"type":"string","maxLength":40,"description":"A type code; - for people with no type yet","default":"","title":"Population Type"},"description":"A type code; - for people with no type yet"},{"name":"sort","in":"query","required":false,"schema":{"type":"string","pattern":"^(name|dob|added)$","default":"name","title":"Sort"}},{"name":"direction","in":"query","required":false,"schema":{"type":"string","pattern":"^(asc|desc)$","default":"asc","title":"Direction"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Search Api Population Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Population"],"summary":"Add","operationId":"add_api_population_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonIn"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Add Api Population Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/population/template.xlsx":{"get":{"tags":["Population"],"summary":"Template","operationId":"template_api_population_template_xlsx_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/population/export.xlsx":{"get":{"tags":["Population"],"summary":"Export","operationId":"export_api_population_export_xlsx_get","parameters":[{"name":"q","in":"query","required":false,"schema":{"type":"string","default":"","title":"Q"}},{"name":"dob","in":"query","required":false,"schema":{"type":"string","default":"","title":"Dob"}},{"name":"nationality","in":"query","required":false,"schema":{"type":"string","default":"","title":"Nationality"}},{"name":"gender","in":"query","required":false,"schema":{"type":"string","pattern":"^(|M|F|X|-)$","default":"","title":"Gender"}},{"name":"document","in":"query","required":false,"schema":{"type":"string","default":"","title":"Document"}},{"name":"doc_type","in":"query","required":false,"schema":{"type":"string","pattern":"^(|P|V|I|-)$","default":"","title":"Doc Type"}},{"name":"doc_country","in":"query","required":false,"schema":{"type":"string","default":"","title":"Doc Country"}},{"name":"ref","in":"query","required":false,"schema":{"type":"string","default":"","title":"Ref"}},{"name":"batch_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Batch Id"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","default":"","title":"Since"}},{"name":"until","in":"query","required":false,"schema":{"type":"string","default":"","title":"Until"}},{"name":"population_type","in":"query","required":false,"schema":{"type":"string","maxLength":40,"description":"A type code; - for people with no type yet","default":"","title":"Population Type"},"description":"A type code; - for people with no type yet"},{"name":"sort","in":"query","required":false,"schema":{"type":"string","pattern":"^(name|dob|added)$","default":"name","title":"Sort"}},{"name":"direction","in":"query","required":false,"schema":{"type":"string","pattern":"^(asc|desc)$","default":"asc","title":"Direction"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/population/batches":{"get":{"tags":["Population"],"summary":"Batches","operationId":"batches_api_population_batches_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Response Batches Api Population Batches Get"}}}}}}},"/api/population/batches/{batch_id}/undo":{"post":{"tags":["Population"],"summary":"Undo","operationId":"undo_api_population_batches__batch_id__undo_post","parameters":[{"name":"batch_id","in":"path","required":true,"schema":{"type":"integer","title":"Batch Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Undo Api Population Batches  Batch Id  Undo Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/population/check":{"post":{"tags":["Population"],"summary":"Check Person","operationId":"check_person_api_population_check_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Check Person Api Population Check Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/population/delete":{"post":{"tags":["Population"],"summary":"Delete","operationId":"delete_api_population_delete_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_delete_api_population_delete_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Delete Api Population Delete Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/population/clear":{"post":{"tags":["Population"],"summary":"Clear","operationId":"clear_api_population_clear_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClearRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Clear Api Population Clear Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/population/database":{"get":{"tags":["Population"],"summary":"Database","operationId":"database_api_population_database_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Database Api Population Database Get"}}}}}}},"/api/population/database/test":{"post":{"tags":["Population"],"summary":"Test Database","operationId":"test_database_api_population_database_test_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Test Database Api Population Database Test Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/population/database/connections/{conn_id}/password":{"get":{"tags":["Population"],"summary":"Saved Password","description":"A saved PostgreSQL password, for the Database panel's show button (server only).","operationId":"saved_password_api_population_database_connections__conn_id__password_get","parameters":[{"name":"conn_id","in":"path","required":true,"schema":{"type":"string","title":"Conn Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Saved Password Api Population Database Connections  Conn Id  Password Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/population/database/connections":{"put":{"tags":["Population"],"summary":"Save Connection","description":"Add or change a saved connection. Changing the active one reconnects the\nserver first; if that fails, nothing is saved.","operationId":"save_connection_api_population_database_connections_put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Save Connection Api Population Database Connections Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/population/database/connections/{conn_id}":{"delete":{"tags":["Population"],"summary":"Delete Connection","operationId":"delete_connection_api_population_database_connections__conn_id__delete","parameters":[{"name":"conn_id","in":"path","required":true,"schema":{"type":"string","title":"Conn Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Delete Connection Api Population Database Connections  Conn Id  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/population/database/activate":{"post":{"tags":["Population"],"summary":"Activate","description":"Make a saved connection the active one: the server switches to it at once\n(copying the population into it if asked). If it cannot, nothing changes.","operationId":"activate_api_population_database_activate_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Activate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Activate Api Population Database Activate Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/population/import":{"post":{"tags":["Population"],"summary":"Preview","operationId":"preview_api_population_import_post","parameters":[{"name":"file_name","in":"query","required":false,"schema":{"type":"string","maxLength":200,"default":"population.xlsx","title":"File Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Preview Api Population Import Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/population/import/{token}/commit":{"post":{"tags":["Population"],"summary":"Commit","operationId":"commit_api_population_import__token__commit_post","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","title":"Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Commit"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Commit Api Population Import  Token  Commit Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/population/import/{token}/rejected.xlsx":{"get":{"tags":["Population"],"summary":"Rejected Rows","operationId":"rejected_rows_api_population_import__token__rejected_xlsx_get","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","title":"Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/population/types":{"get":{"tags":["Population"],"summary":"Types","operationId":"types_api_population_types_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Types Api Population Types Get"}}}}}},"post":{"tags":["Population"],"summary":"Add Type","operationId":"add_type_api_population_types_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TypeIn"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Add Type Api Population Types Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/population/types/{code}":{"put":{"tags":["Population"],"summary":"Edit Type","operationId":"edit_type_api_population_types__code__put","parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","title":"Code"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TypeEdit"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Edit Type Api Population Types  Code  Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Population"],"summary":"Delete Type","operationId":"delete_type_api_population_types__code__delete","parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","title":"Code"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Delete Type Api Population Types  Code  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/population/types/{code}/assign-untyped":{"post":{"tags":["Population"],"summary":"Assign Untyped","operationId":"assign_untyped_api_population_types__code__assign_untyped_post","parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","title":"Code"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Assign Untyped Api Population Types  Code  Assign Untyped Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/population/{person_id}":{"get":{"tags":["Population"],"summary":"Get","operationId":"get_api_population__person_id__get","parameters":[{"name":"person_id","in":"path","required":true,"schema":{"type":"integer","title":"Person Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Api Population  Person Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Population"],"summary":"Update","operationId":"update_api_population__person_id__put","parameters":[{"name":"person_id","in":"path","required":true,"schema":{"type":"integer","title":"Person Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Update Api Population  Person Id  Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Population"],"summary":"Delete One","operationId":"delete_one_api_population__person_id__delete","parameters":[{"name":"person_id","in":"path","required":true,"schema":{"type":"integer","title":"Person Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Delete One Api Population  Person Id  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/meta":{"get":{"summary":"Meta","operationId":"meta_api_meta_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Meta Api Meta Get"}}}}}}},"/api/match":{"post":{"summary":"Match","operationId":"match_api_match_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Match Api Match Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/search":{"post":{"summary":"Search","description":"The search page's call: the person against the population, with the server's\nthresholds unless the request overrides them. `exclude_id` leaves out the person\na \"find similar people\" search started from.","operationId":"search_api_search_post","parameters":[{"name":"exclude_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Exclude Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Search Api Search Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/searches":{"get":{"summary":"List Searches","description":"The search log for the history page, with the strongest person's name.","operationId":"list_searches_api_searches_get","parameters":[{"name":"source","in":"query","required":false,"schema":{"type":"string","pattern":"^(|console|api)$","default":"","title":"Source"}},{"name":"verdict","in":"query","required":false,"schema":{"type":"string","pattern":"^(|Match|Review|No match|none)$","default":"","title":"Verdict"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","default":"","title":"Since"}},{"name":"until","in":"query","required":false,"schema":{"type":"string","default":"","title":"Until"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Page Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response List Searches Api Searches Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/performance":{"get":{"summary":"Performance Report","operationId":"performance_report_api_performance_get","parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":365,"minimum":1,"default":7,"title":"Days"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Performance Report Api Performance Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/history":{"get":{"summary":"List History","operationId":"list_history_api_history_get","parameters":[{"name":"name","in":"query","required":false,"schema":{"type":"string","default":"","title":"Name"}},{"name":"document","in":"query","required":false,"schema":{"type":"string","default":"","title":"Document"}},{"name":"nationality","in":"query","required":false,"schema":{"type":"string","default":"","title":"Nationality"}},{"name":"verdict","in":"query","required":false,"schema":{"type":"string","pattern":"^(|Match|Review|No match)$","default":"","title":"Verdict"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","default":"","title":"Since"}},{"name":"until","in":"query","required":false,"schema":{"type":"string","default":"","title":"Until"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Page Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response List History Api History Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/history/{match_id}":{"get":{"summary":"Get History","operationId":"get_history_api_history__match_id__get","parameters":[{"name":"match_id","in":"path","required":true,"schema":{"type":"integer","title":"Match Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get History Api History  Match Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/":{"get":{"summary":"Index","operationId":"index__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/history":{"get":{"summary":"History Page","operationId":"history_page_history_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/search":{"get":{"summary":"Search Page","operationId":"search_page_search_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/population":{"get":{"summary":"Population Page","operationId":"population_page_population_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/settings":{"get":{"summary":"Settings Page","operationId":"settings_page_settings_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api-reference":{"get":{"summary":"Api Page","operationId":"api_page_api_reference_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api-reference/integration-spec.md":{"get":{"summary":"Integration Spec","operationId":"integration_spec_api_reference_integration_spec_md_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/history/{match_id}":{"get":{"summary":"Saved Match Page","operationId":"saved_match_page_history__match_id__get","parameters":[{"name":"match_id","in":"path","required":true,"schema":{"type":"integer","title":"Match Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Activate":{"properties":{"id":{"type":"string","maxLength":40,"minLength":1,"title":"Id"},"copy_population":{"type":"boolean","title":"Copy Population","description":"Copy the population in use now into it, which must be empty","default":false}},"type":"object","required":["id"],"title":"Activate"},"ApiMatchRequest":{"properties":{"records":{"items":{"$ref":"#/components/schemas/ApiRecord"},"type":"array","maxItems":6,"minItems":2,"title":"Records"},"settings":{"$ref":"#/components/schemas/MatchOptions","default":{}}},"type":"object","required":["records"],"title":"ApiMatchRequest"},"ApiRecord":{"properties":{"given_name":{"type":"string","title":"Given Name","default":""},"surname":{"type":"string","title":"Surname","default":""},"dob":{"type":"string","title":"Dob","description":"YYYY-MM-DD","default":""},"gender":{"type":"string","title":"Gender","description":"M, F or X; empty if unknown","default":""},"nationality":{"type":"string","title":"Nationality","description":"Country name or ISO code","default":""},"doc_type":{"type":"string","title":"Doc Type","description":"P passport, V visa, I national ID","default":"P"},"doc_number":{"type":"string","title":"Doc Number","default":""},"doc_country":{"type":"string","title":"Doc Country","description":"Issuing country, name or ISO code","default":""},"doc_expiry":{"type":"string","title":"Doc Expiry","description":"YYYY-MM-DD","default":""},"ref":{"type":"string","maxLength":64,"title":"Ref","description":"Your own reference for the record, returned with the result","default":""}},"type":"object","title":"ApiRecord"},"Body_delete_api_population_delete_post":{"properties":{"ids":{"items":{"type":"integer"},"type":"array","maxItems":1000,"minItems":1,"title":"Ids"}},"type":"object","required":["ids"],"title":"Body_delete_api_population_delete_post"},"ClearRequest":{"properties":{"confirm":{"type":"integer","minimum":0.0,"title":"Confirm","description":"The number of people now in the population"}},"type":"object","required":["confirm"],"title":"ClearRequest"},"Commit":{"properties":{"on_existing":{"type":"string","enum":["update","skip"],"title":"On Existing","default":"update"}},"type":"object","title":"Commit"},"ConnectionIn":{"properties":{"id":{"type":"string","maxLength":40,"title":"Id","description":"Empty for a new connection","default":""},"name":{"type":"string","maxLength":60,"title":"Name","default":""},"engine":{"type":"string","enum":["duckdb","postgres"],"title":"Engine"},"duckdb":{"$ref":"#/components/schemas/DuckDBSettings"},"postgres":{"$ref":"#/components/schemas/PostgresSettings"}},"type":"object","required":["engine","duckdb","postgres"],"title":"ConnectionIn"},"DuckDBSettings":{"properties":{"path":{"type":"string","maxLength":500,"minLength":1,"title":"Path"}},"type":"object","required":["path"],"title":"DuckDBSettings"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ImportRequest":{"properties":{"people":{"items":{"$ref":"#/components/schemas/PopulationPerson"},"type":"array","maxItems":5000,"minItems":1,"title":"People"},"on_existing":{"type":"string","enum":["update","skip"],"title":"On Existing","default":"update"}},"type":"object","required":["people"],"title":"ImportRequest"},"KeyRequest":{"properties":{"name":{"type":"string","maxLength":60,"minLength":1,"title":"Name"},"scope":{"type":"string","enum":["match","registry","admin"],"title":"Scope","default":"match"}},"type":"object","required":["name"],"title":"KeyRequest"},"MatchOptions":{"properties":{"match_threshold":{"anyOf":[{"type":"number","exclusiveMaximum":1.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Match Threshold"},"review_threshold":{"anyOf":[{"type":"number","exclusiveMaximum":1.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Review Threshold"},"save":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Save","description":"Save this run to the match history"}},"type":"object","title":"MatchOptions"},"MatchRequest":{"properties":{"records":{"items":{"$ref":"#/components/schemas/RecordIn"},"type":"array","maxItems":6,"minItems":2,"title":"Records"}},"type":"object","required":["records"],"title":"MatchRequest"},"Person":{"properties":{"given_name":{"type":"string","title":"Given Name","default":""},"surname":{"type":"string","title":"Surname","default":""},"dob":{"type":"string","title":"Dob","description":"YYYY-MM-DD","default":""},"gender":{"type":"string","title":"Gender","description":"M, F or X; empty if unknown","default":""},"nationality":{"type":"string","title":"Nationality","description":"Country name or ISO code","default":""},"doc_type":{"type":"string","title":"Doc Type","description":"P passport, V visa, I national ID","default":"P"},"doc_number":{"type":"string","title":"Doc Number","default":""},"doc_country":{"type":"string","title":"Doc Country","description":"Issuing country, name or ISO code","default":""},"doc_expiry":{"type":"string","title":"Doc Expiry","description":"YYYY-MM-DD","default":""}},"type":"object","title":"Person"},"PersonIn":{"properties":{"ref":{"type":"string","title":"Ref","default":""},"given_name":{"type":"string","title":"Given Name","default":""},"surname":{"type":"string","title":"Surname","default":""},"dob":{"type":"string","title":"Dob","default":""},"gender":{"type":"string","title":"Gender","default":""},"nationality":{"type":"string","title":"Nationality","default":""},"doc_type":{"type":"string","title":"Doc Type","default":""},"doc_number":{"type":"string","title":"Doc Number","default":""},"doc_country":{"type":"string","title":"Doc Country","default":""},"doc_expiry":{"type":"string","title":"Doc Expiry","default":""},"population_types":{"items":{"type":"string"},"type":"array","maxItems":20,"title":"Population Types"}},"type":"object","title":"PersonIn"},"PopulationPerson":{"properties":{"given_name":{"type":"string","title":"Given Name","default":""},"surname":{"type":"string","title":"Surname","default":""},"dob":{"type":"string","title":"Dob","description":"YYYY-MM-DD","default":""},"gender":{"type":"string","title":"Gender","description":"M, F or X; empty if unknown","default":""},"nationality":{"type":"string","title":"Nationality","description":"Country name or ISO code","default":""},"doc_type":{"type":"string","title":"Doc Type","description":"P passport, V visa, I national ID; a document number without a type is a passport","default":""},"doc_number":{"type":"string","title":"Doc Number","default":""},"doc_country":{"type":"string","title":"Doc Country","description":"Issuing country, name or ISO code","default":""},"doc_expiry":{"type":"string","title":"Doc Expiry","description":"YYYY-MM-DD","default":""},"ref":{"type":"string","maxLength":64,"title":"Ref","description":"Your own reference; unique in the population when set","default":""},"population_types":{"items":{"type":"string"},"type":"array","maxItems":20,"title":"Population Types","description":"Required: one or more population type codes (or names), from GET /api/v1/population-types"}},"type":"object","title":"PopulationPerson"},"PostgresSettings":{"properties":{"host":{"type":"string","maxLength":255,"title":"Host","default":""},"port":{"type":"integer","maximum":65535.0,"minimum":1.0,"title":"Port","default":5432},"database":{"type":"string","maxLength":63,"title":"Database","default":""},"user":{"type":"string","maxLength":63,"title":"User","default":""},"password":{"type":"string","maxLength":500,"title":"Password","description":"Empty keeps the saved password","default":""},"sslmode":{"type":"string","enum":["disable","allow","prefer","require","verify-ca","verify-full"],"title":"Sslmode","default":"prefer"},"pool_size":{"type":"integer","maximum":64.0,"minimum":1.0,"title":"Pool Size","default":8}},"type":"object","title":"PostgresSettings"},"RecordIn":{"properties":{"given_name":{"type":"string","title":"Given Name","default":""},"surname":{"type":"string","title":"Surname","default":""},"dob":{"type":"string","title":"Dob","description":"YYYY-MM-DD","default":""},"gender":{"type":"string","title":"Gender","description":"M, F or X; empty if unknown","default":""},"nationality":{"type":"string","title":"Nationality","description":"Country name or ISO code","default":""},"doc_type":{"type":"string","title":"Doc Type","description":"P passport, V visa, I national ID","default":"P"},"doc_number":{"type":"string","title":"Doc Number","default":""},"doc_country":{"type":"string","title":"Doc Country","description":"Issuing country, name or ISO code","default":""},"doc_expiry":{"type":"string","title":"Doc Expiry","description":"YYYY-MM-DD","default":""},"key":{"type":"string","maxLength":4,"minLength":1,"title":"Key"}},"type":"object","required":["key"],"title":"RecordIn","description":"A console record, lettered A to F."},"SearchOptions":{"properties":{"top_k":{"type":"integer","maximum":50.0,"minimum":1.0,"title":"Top K","description":"Most results to return","default":10},"min_probability":{"type":"number","exclusiveMaximum":1.0,"minimum":0.0,"title":"Min Probability","description":"Leave out results below this probability","default":0.0},"match_threshold":{"anyOf":[{"type":"number","exclusiveMaximum":1.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Match Threshold"},"review_threshold":{"anyOf":[{"type":"number","exclusiveMaximum":1.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Review Threshold"}},"type":"object","title":"SearchOptions"},"SearchRequest":{"properties":{"person":{"$ref":"#/components/schemas/Person"},"population_types":{"items":{"type":"string"},"type":"array","maxItems":20,"title":"Population Types","description":"Search only people of these population types (codes or names); empty or left out searches everyone"},"settings":{"$ref":"#/components/schemas/SearchOptions","default":{"top_k":10,"min_probability":0.0}}},"type":"object","required":["person"],"title":"SearchRequest"},"SettingsChange":{"properties":{"match_threshold":{"anyOf":[{"type":"number","exclusiveMaximum":1.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Match Threshold"},"review_threshold":{"anyOf":[{"type":"number","exclusiveMaximum":1.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Review Threshold"},"save_api_runs":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Save Api Runs"}},"type":"object","title":"SettingsChange"},"TypeEdit":{"properties":{"name":{"type":"string","maxLength":60,"minLength":1,"title":"Name"},"description":{"type":"string","maxLength":300,"title":"Description","default":""}},"type":"object","required":["name"],"title":"TypeEdit"},"TypeIn":{"properties":{"code":{"type":"string","maxLength":40,"minLength":1,"title":"Code"},"name":{"type":"string","maxLength":60,"minLength":1,"title":"Name"},"description":{"type":"string","maxLength":300,"title":"Description","default":""}},"type":"object","required":["code","name"],"title":"TypeIn"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"X-API-Key"}}}}