{"openapi":"3.1.0","info":{"title":"sancticheck.com Client Integration API","version":"0.1.0","description":"Client API-key endpoints only. Obtain a named key from your company API keys tab. Use Authorization: Bearer <key>. Each key has client-administrator access to its assigned company. Staff operations, sign-in and key management are not part of this integration API.","contact":{"email":"support@sancticheck.com"}},"servers":[{"url":"https://api.sancticheck.com","description":"Production"},{"url":"http://localhost:8000","description":"Local development"}],"security":[{"ClientAPIKey":[]}],"paths":{"/api/v1/clients/{client_id}/screening/settings":{"get":{"tags":["Screening"],"summary":"Company","operationId":"company_api_v1_clients__client_id__screening_settings_get","parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanySettingsOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Read platform default, nullable company override and effective threshold (1 to 5 stars).","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"},"patch":{"tags":["Screening"],"summary":"Update Company","operationId":"update_company_api_v1_clients__client_id__screening_settings_patch","parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyThreshold"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanySettingsOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Set company threshold to 1 through 5, or null to inherit the platform default. Queues screening; preserves existing reviews until evidence or customer identity changes.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"}},"/api/v1/clients/{client_id}/groups/{group_id}/screening-threshold":{"patch":{"tags":["Portfolio"],"summary":"Threshold","operationId":"threshold_api_v1_clients__client_id__groups__group_id__screening_threshold_patch","parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Group Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupThreshold"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Set screening_threshold to 1 through 5 or null to inherit the company default. Also supported for Unassigned.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"}},"/api/v1/clients/{client_id}/screening/dashboard":{"get":{"tags":["Screening"],"summary":"Dashboard","operationId":"dashboard_api_v1_clients__client_id__screening_dashboard_get","parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}},{"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"}},{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":200,"default":"","title":"Q"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"enum":["ACTION_REQUIRED","CONFIRMED","NO_OUTSTANDING","PENDING"],"type":"string"},{"type":"null"}],"title":"Status"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Paginated portfolio screening status, counts, latest record check and next scheduled check. Includes failed checks awaiting retry; last_scan_at is latest record activity, not completion of a whole-company cycle.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"}},"/api/v1/clients/{client_id}/screening/records/{record_id}":{"get":{"tags":["Screening"],"summary":"Detail","operationId":"detail_api_v1_clients__client_id__screening_records__record_id__get","parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}},{"name":"record_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Record Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Read current candidates, preserved evidence and recent meaningful history. This view is audited separately and does not create a screening-history entry.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"}},"/api/v1/clients/{client_id}/screening/records/{record_id}/history":{"get":{"tags":["Screening"],"summary":"History","operationId":"history_api_v1_clients__client_id__screening_records__record_id__history_get","parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}},{"name":"record_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Record Id"}},{"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":{"$ref":"#/components/schemas/Page_EventOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Paginate immutable screening changes and review decisions for reporting. Routine views and unchanged daily checks are excluded; latest scan timestamps remain available on the screening record.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"}},"/api/v1/clients/{client_id}/screening/matches/{match_id}/review":{"post":{"tags":["Screening"],"summary":"Review","operationId":"review_api_v1_clients__client_id__screening_matches__match_id__review_post","parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}},{"name":"match_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Match Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/app__domain__screening__schemas__Review"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Message"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Save FALSE_POSITIVE, CONFIRMED or NEEDS_REVIEW with notes. Copy version from the latest match detail response; stale versions return 409 and must be refreshed before deciding.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"}},"/api/v1/clients/{client_id}/groups/linked-companies":{"get":{"tags":["Portfolio"],"summary":"Linked Companies","operationId":"linked_companies_api_v1_clients__client_id__groups_linked_companies_get","parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}},{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":200,"default":"","title":"Q"}},{"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":100,"title":"Page Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_RecordOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"List active companies in this client portfolio for the optional linked_to_id field. Supports q and pagination.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"}},"/api/v1/clients":{"get":{"tags":["Companies"],"summary":"Listing","operationId":"listing_api_v1_clients_get","parameters":[{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":200,"default":"","title":"Q"}},{"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":{"$ref":"#/components/schemas/Page_ClientOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"List the company assigned to this API key. Supports q, page and page_size.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"}},"/api/v1/clients/{client_id}":{"get":{"tags":["Companies"],"summary":"Detail","operationId":"detail_api_v1_clients__client_id__get","parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Read the assigned company.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"}},"/api/v1/clients/{client_id}/audit":{"get":{"tags":["Companies"],"summary":"Logs","operationId":"logs_api_v1_clients__client_id__audit_get","parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}},{"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":{"$ref":"#/components/schemas/Page_AuditOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Read company activity. API-key actions include the key name.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"}},"/api/v1/users":{"get":{"tags":["Accounts"],"summary":"Users","operationId":"users_api_v1_users_get","parameters":[{"name":"client_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Client Id"}},{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":200,"default":"","title":"Q"}},{"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":{"$ref":"#/components/schemas/Page_UserOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"List users in the assigned company. Staff users are excluded.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"}},"/api/v1/users/invite":{"post":{"tags":["Accounts"],"summary":"Invite","operationId":"invite_api_v1_users_invite_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invite"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too many attempts. Wait up to 15 minutes before retrying."}},"description":"Invite a user or client administrator to the assigned company. Email is queued; invitations expire after 48 hours. Staff access cannot be granted.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"}},"/api/v1/users/{user_id}":{"patch":{"tags":["Accounts"],"summary":"Update User","operationId":"update_user_api_v1_users__user_id__patch","parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Update a company user. Omit unchanged fields. Staff access cannot be granted and the last active client administrator is protected.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"}},"/api/v1/users/{user_id}/resend-invitation":{"post":{"tags":["Accounts"],"summary":"Resend","operationId":"resend_api_v1_users__user_id__resend_invitation_post","parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Message"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too many attempts. Wait up to 15 minutes before retrying."}},"description":"Replace an unaccepted invitation and queue a new email. The previous link becomes invalid.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"}},"/api/v1/clients/{client_id}/groups":{"get":{"tags":["Portfolio"],"summary":"Groups","operationId":"groups_api_v1_clients__client_id__groups_get","parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}},{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":200,"default":"","title":"Q"}},{"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":{"$ref":"#/components/schemas/Page_GroupOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"List company groups with record_count counting all active records, including linked descendants. Unassigned appears first; remaining groups are ordered by name.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"},"post":{"tags":["Portfolio"],"summary":"Create Group","operationId":"create_group_api_v1_clients__client_id__groups_post","parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupInput"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Create a group. Names are trimmed and must be unique within the company, ignoring case.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"}},"/api/v1/clients/{client_id}/groups/{group_id}":{"get":{"tags":["Portfolio"],"summary":"Group","operationId":"group_api_v1_clients__client_id__groups__group_id__get","parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Group Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Read a company group.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"},"patch":{"tags":["Portfolio"],"summary":"Update Group","operationId":"update_group_api_v1_clients__client_id__groups__group_id__patch","parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Group Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Replace group name and description. The Unassigned group cannot be changed.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"},"delete":{"tags":["Portfolio"],"summary":"Delete Group","operationId":"delete_group_api_v1_clients__client_id__groups__group_id__delete","parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Group Id"}},{"name":"confirm","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Confirm"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Message"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Archive a group and move its active records to Unassigned. Nonempty groups require confirm=true. Unassigned cannot be deleted.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"}},"/api/v1/clients/{client_id}/groups/{group_id}/records":{"get":{"tags":["Portfolio"],"summary":"Records","operationId":"records_api_v1_clients__client_id__groups__group_id__records_get","parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Group Id"}},{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":200,"default":"","title":"Q"}},{"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"}},{"name":"hierarchy","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Hierarchy"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_RecordOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"List active portfolio records in a group. Set hierarchy=true to keep linked records beneath their company, paginating whole families. depth and linked_to_name describe the displayed hierarchy.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"},"post":{"tags":["Portfolio"],"summary":"Create Record","operationId":"create_record_api_v1_clients__client_id__groups__group_id__records_post","parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Group Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordInput"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Create a portfolio record using a generic name and typed identifying information. Optional linked_to_id must reference an active organisation in the same client; relationship_role describes the link. Cycles are rejected.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"}},"/api/v1/clients/{client_id}/groups/{group_id}/records/{record_id}":{"get":{"tags":["Portfolio"],"summary":"Record","operationId":"record_api_v1_clients__client_id__groups__group_id__records__record_id__get","parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Group Id"}},{"name":"record_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Record Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Read an active portfolio record.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"},"patch":{"tags":["Portfolio"],"summary":"Update Record","operationId":"update_record_api_v1_clients__client_id__groups__group_id__records__record_id__patch","parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Group Id"}},{"name":"record_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Record Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Replace record fields. Supply group_id to move within the same company; null moves to Unassigned, omission keeps the current group. Omitted collection fields reset to their schema defaults.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"},"delete":{"tags":["Portfolio"],"summary":"Delete Record","operationId":"delete_record_api_v1_clients__client_id__groups__group_id__records__record_id__delete","parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Group Id"}},{"name":"record_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Record Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Message"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Archive a portfolio record while preserving its history.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"}},"/api/v1/sanctions/search":{"get":{"tags":["Sanctions"],"summary":"Search","operationId":"search_api_v1_sanctions_search_get","parameters":[{"name":"exact","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Exact"}},{"name":"classification","in":"query","required":false,"schema":{"anyOf":[{"enum":["SANCTIONS","PEP","CRIME","NARCOTICS","TERRORISM","MONEY_LAUNDERING","TERRORIST_FINANCING","PROLIFERATION","CORRUPTION","FRAUD","ORGANISED_CRIME","HUMAN_TRAFFICKING","HUMAN_RIGHTS_ABUSES","CYBERCRIME","ARMS_TRAFFICKING","SANCTIONS_EVASION","REGULATORY_ACTION","DEBARMENT","SANCTIONS_LINKED","SANCTIONS_CONTROL","COUNTER_SANCTIONS","RCA","WANTED","PERSON_OF_INTEREST","REGULATORY_WARNING","EXPORT_CONTROL","EXPORT_CONTROL_LINKED","TRADE_RISK","INVESTMENT_RISK","INVESTMENT_BAN","DISQUALIFIED","FINANCIAL_CRIME","WAR_CRIMES","TRAFFICKING","THEFT","ENVIRONMENTAL_VIOLATIONS","FORCED_LABOUR","FROZEN_ASSET","MARITIME_DETENTION","SHADOW_FLEET","OLIGARCH","CLONE_ENTITY","HIGH_RISK_AREA","SCREENING_INTEREST","CRIMINAL_LEADERSHIP"],"type":"string"},{"type":"null"}],"title":"Classification"}},{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":200,"default":"","title":"Q"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResults"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Search active full names and aliases using PostgreSQL trigram candidates and the same confidence rules as daily screening. At least 3 letters or numbers, or 2 East Asian characters; at most 10 consolidated profiles. Best full-name similarity ranks first, with primary-name agreement breaking ties. Configured company suffixes are ignored for organisations. Initials, surname-only matches and conflicting generation suffixes are capped below 4 stars. Ratings: 5 for scores at least 97 with exact meaningful-token agreement, 4 at least 90, 3 at least 60, 2 at least 40, otherwise 1. matched_name identifies the source name or alias used. Repeated aliases do not boost confidence. sources lists conservatively linked providers; has_more indicates further candidates. classifications optionally filters candidates.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"}},"/api/v1/sanctions/search/{record_id}":{"get":{"tags":["Sanctions"],"summary":"Search Detail","operationId":"search_detail_api_v1_sanctions_search__record_id__get","parameters":[{"name":"record_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Record Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Read a sanctions lookup result, including source, aliases and original provider information. Inactive records and disabled sources return 404.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"}},"/api/v1/sanctions/search/{record_id}/profile":{"get":{"tags":["Sanctions"],"summary":"Search Profile","operationId":"search_profile_api_v1_sanctions_search__record_id__profile_get","parameters":[{"name":"record_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Record Id"}},{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":200,"default":"","title":"Q"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreeningProfile"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Read a consolidated profile from any member record ID. Optional q supplies the search relevance rating. Includes all active, enabled records linked by shared explicit identifiers or exact full name and full birth date, excluding conflicting evidence. Each record retains its source, classifications and enrichment. Does not merge stored provider evidence.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"}},"/api/v1/reports":{"post":{"tags":["Screening reports"],"summary":"Create Report","operationId":"create_report_api_v1_reports_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportRequest"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Queue a detailed PDF screening report for background generation. kind is profile for a consolidated source profile, or portfolio for an authorised company record and its screening history. Portfolio requires client_id. Optional q records the profile search and confidence. Returns 202 while queued or generating, or 200 when reusing a completed report less than 24 hours old. Poll the report metadata for status and download its authenticated PDF URL when ready. Older reports remain available.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"},"get":{"tags":["Screening reports"],"summary":"Reports","operationId":"reports_api_v1_reports_get","parameters":[{"name":"client_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Client Id"}},{"name":"record_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Record Id"}},{"name":"kind","in":"query","required":false,"schema":{"anyOf":[{"enum":["profile","portfolio"],"type":"string"},{"type":"null"}],"title":"Kind"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"enum":["queued","processing","ready","failed"],"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"for_request","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"For Request"}},{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":200,"default":"","title":"Q"}},{"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":{"$ref":"#/components/schemas/Page_ReportOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"List report jobs and saved reports within the API key company, optionally filtered by record_id, kind, status or subject name q. Paginated and newest first.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"}},"/api/v1/reports/{report_id}":{"get":{"tags":["Screening reports"],"summary":"Report Metadata","operationId":"report_metadata_api_v1_reports__report_id__get","parameters":[{"name":"report_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Report Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Read saved report metadata within the API key company, including the SHA-256 of its PDF.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"}},"/api/v1/reports/{report_id}/pdf":{"get":{"tags":["Screening reports"],"summary":"Download","operationId":"download_api_v1_reports__report_id__pdf_get","parameters":[{"name":"report_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Report Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request or business rule","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Action not permitted or company inactive","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Resource not found within this company","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"409":{"description":"Conflict, duplicate name or protected last administrator","content":{"application/json":{"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Download the original saved PDF within the API key company. Authenticate this request as well. Source updates do not change an already generated report.","security":[{"ClientAPIKey":[]}],"x-access":"Administrator of the API key company"}}},"components":{"schemas":{"CompanySettingsOut":{"properties":{"threshold":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Threshold"},"platform_threshold":{"type":"integer","title":"Platform Threshold"},"effective_threshold":{"type":"integer","title":"Effective Threshold"}},"type":"object","required":["threshold","platform_threshold","effective_threshold"],"title":"CompanySettingsOut"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"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"},"CompanyThreshold":{"properties":{"threshold":{"anyOf":[{"type":"integer","maximum":5.0,"minimum":1.0},{"type":"null"}],"title":"Threshold"}},"additionalProperties":false,"type":"object","title":"CompanyThreshold"},"GroupThreshold":{"properties":{"screening_threshold":{"anyOf":[{"type":"integer","maximum":5.0,"minimum":1.0},{"type":"null"}],"title":"Screening Threshold"}},"additionalProperties":false,"type":"object","title":"GroupThreshold"},"GroupOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"client_id":{"type":"string","format":"uuid","title":"Client Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"is_default":{"type":"boolean","title":"Is Default"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"record_count":{"type":"integer","title":"Record Count"},"screening_threshold":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Screening Threshold"},"effective_screening_threshold":{"type":"integer","title":"Effective Screening Threshold","default":4}},"type":"object","required":["id","client_id","name","description","is_default","created_at","record_count"],"title":"GroupOut"},"DashboardOut":{"properties":{"counts":{"$ref":"#/components/schemas/CountsOut"},"last_scan_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Scan At"},"next_scan_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Scan At"},"scan_error_count":{"type":"integer","title":"Scan Error Count"},"items":{"items":{"$ref":"#/components/schemas/DashboardRecordOut"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"}},"type":"object","required":["counts","last_scan_at","next_scan_at","scan_error_count","items","total","page","page_size"],"title":"DashboardOut"},"CountsOut":{"properties":{"action_required":{"type":"integer","title":"Action Required"},"confirmed":{"type":"integer","title":"Confirmed"},"no_outstanding":{"type":"integer","title":"No Outstanding"},"pending":{"type":"integer","title":"Pending"}},"type":"object","required":["action_required","confirmed","no_outstanding","pending"],"title":"CountsOut"},"DashboardRecordOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"group_id":{"type":"string","format":"uuid","title":"Group Id"},"group_name":{"type":"string","title":"Group Name"},"linked_to_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Linked To Name"},"status":{"type":"string","title":"Status"},"last_scanned_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Scanned At"},"threshold":{"type":"integer","title":"Threshold"},"match_count":{"type":"integer","title":"Match Count"},"highest_rating":{"type":"integer","title":"Highest Rating"}},"type":"object","required":["id","name","group_id","group_name","linked_to_name","status","last_scanned_at","threshold","match_count","highest_rating"],"title":"DashboardRecordOut"},"DetailOut":{"properties":{"record":{"$ref":"#/components/schemas/RecordOut"},"status":{"type":"string","title":"Status"},"last_scanned_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Scanned At"},"next_scan_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Scan At"},"threshold":{"type":"integer","title":"Threshold"},"last_error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Error"},"matches":{"items":{"$ref":"#/components/schemas/MatchOut"},"type":"array","title":"Matches"},"history":{"items":{"$ref":"#/components/schemas/EventOut"},"type":"array","title":"History"},"history_has_more":{"type":"boolean","title":"History Has More"}},"type":"object","required":["record","status","last_scanned_at","next_scan_at","threshold","last_error","matches","history","history_has_more"],"title":"DetailOut"},"RecordOut":{"properties":{"linked_to_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Linked To Id"},"relationship_role":{"type":"string","maxLength":200,"title":"Relationship Role","default":""},"name":{"type":"string","maxLength":500,"minLength":1,"title":"Name"},"entity_type":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","UNKNOWN"],"title":"Entity Type","default":"PERSON"},"aliases":{"items":{"type":"string"},"type":"array","maxItems":100,"title":"Aliases"},"dates":{"items":{"$ref":"#/components/schemas/RecordDate"},"type":"array","maxItems":100,"title":"Dates"},"identifiers":{"items":{"$ref":"#/components/schemas/TypedValue"},"type":"array","maxItems":100,"title":"Identifiers"},"countries":{"items":{"$ref":"#/components/schemas/TypedValue"},"type":"array","maxItems":100,"title":"Countries"},"addresses":{"items":{"type":"string"},"type":"array","maxItems":100,"title":"Addresses"},"notes":{"type":"string","maxLength":10000,"title":"Notes","default":""},"id":{"type":"string","format":"uuid","title":"Id"},"client_id":{"type":"string","format":"uuid","title":"Client Id"},"group_id":{"type":"string","format":"uuid","title":"Group Id"},"normalized_name":{"type":"string","title":"Normalized Name"},"linked_to_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Linked To Name"},"depth":{"type":"integer","title":"Depth","default":0},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"additionalProperties":false,"type":"object","required":["linked_to_id","relationship_role","name","entity_type","aliases","dates","identifiers","countries","addresses","notes","id","client_id","group_id","normalized_name","linked_to_name","depth","created_at","updated_at"],"title":"RecordOut"},"RecordDate":{"properties":{"type":{"type":"string","maxLength":80,"minLength":1,"title":"Type"},"precision":{"type":"string","enum":["DAY","MONTH","YEAR","RANGE"],"title":"Precision"},"value":{"type":"string","maxLength":10,"title":"Value"},"end_value":{"anyOf":[{"type":"string","maxLength":10},{"type":"null"}],"title":"End Value"}},"additionalProperties":false,"type":"object","required":["type","precision","value"],"title":"RecordDate"},"TypedValue":{"properties":{"type":{"type":"string","maxLength":80,"minLength":1,"title":"Type"},"value":{"type":"string","maxLength":500,"minLength":1,"title":"Value"}},"additionalProperties":false,"type":"object","required":["type","value"],"title":"TypedValue"},"MatchOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"sanction_record_id":{"type":"string","format":"uuid","title":"Sanction Record Id"},"name":{"type":"string","title":"Name"},"source_name":{"type":"string","title":"Source Name"},"classifications":{"items":{"type":"string"},"type":"array","title":"Classifications"},"rating":{"type":"integer","title":"Rating"},"active":{"type":"boolean","title":"Active"},"decision":{"type":"string","title":"Decision"},"evidence":{"additionalProperties":true,"type":"object","title":"Evidence"},"first_matched_at":{"type":"string","format":"date-time","title":"First Matched At"},"last_seen_at":{"type":"string","format":"date-time","title":"Last Seen At"},"reviewed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reviewed At"},"review_notes":{"type":"string","title":"Review Notes"},"version":{"type":"string","title":"Version"}},"type":"object","required":["id","sanction_record_id","name","source_name","classifications","rating","active","decision","evidence","first_matched_at","last_seen_at","reviewed_at","review_notes","version"],"title":"MatchOut"},"EventOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"event_type":{"type":"string","title":"Event Type"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"details":{"additionalProperties":true,"type":"object","title":"Details"}},"type":"object","required":["id","event_type","created_at","details"],"title":"EventOut"},"Page_EventOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/EventOut"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"}},"type":"object","required":["items","total","page","page_size"],"title":"Page[EventOut]"},"app__domain__screening__schemas__Review":{"properties":{"version":{"type":"string","maxLength":64,"minLength":64,"title":"Version"},"decision":{"type":"string","enum":["FALSE_POSITIVE","CONFIRMED","NEEDS_REVIEW"],"title":"Decision"},"notes":{"type":"string","maxLength":10000,"title":"Notes","default":""}},"additionalProperties":false,"type":"object","required":["version","decision"],"title":"Review"},"Message":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"Message"},"Page_RecordOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/RecordOut"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"}},"type":"object","required":["items","total","page","page_size"],"title":"Page[RecordOut]"},"Page_ClientOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ClientOut"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"}},"type":"object","required":["items","total","page","page_size"],"title":"Page[ClientOut]"},"ClientOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"is_active":{"type":"boolean","title":"Is Active"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","name","is_active","created_at"],"title":"ClientOut"},"Page_AuditOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AuditOut"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"}},"type":"object","required":["items","total","page","page_size"],"title":"Page[AuditOut]"},"AuditOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"actor_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Actor Id"},"actor_key_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Actor Key Id"},"actor_key_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Actor Key Name"},"actor_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Actor Name"},"actor_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Actor Email"},"client_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Client Id"},"action":{"type":"string","title":"Action"},"target_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Target Id"},"details":{"additionalProperties":true,"type":"object","title":"Details"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","actor_id","actor_key_id","actor_key_name","actor_name","actor_email","client_id","action","target_id","details","created_at"],"title":"AuditOut"},"Page_UserOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/UserOut"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"}},"type":"object","required":["items","total","page","page_size"],"title":"Page[UserOut]"},"UserOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"email":{"type":"string","title":"Email"},"name":{"type":"string","title":"Name"},"role":{"type":"string","title":"Role"},"is_staff":{"type":"boolean","title":"Is Staff"},"is_active":{"type":"boolean","title":"Is Active"},"client_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Client Id"},"client_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Name"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"invited":{"type":"boolean","title":"Invited"}},"type":"object","required":["id","email","name","role","is_staff","is_active","client_id","created_at","invited"],"title":"UserOut"},"Invite":{"properties":{"email":{"type":"string","format":"email","title":"Email"},"name":{"type":"string","maxLength":200,"title":"Name","default":""},"client_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Client Id"},"role":{"type":"string","enum":["CLIENT_ADMIN","USER"],"title":"Role","default":"USER"},"is_staff":{"type":"boolean","title":"Is Staff","default":false,"const":false}},"additionalProperties":false,"type":"object","required":["email"],"title":"Invite"},"UserUpdate":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Name"},"role":{"anyOf":[{"type":"string","enum":["CLIENT_ADMIN","USER"]},{"type":"null"}],"title":"Role"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active"}},"additionalProperties":false,"type":"object","title":"UserUpdate"},"Page_GroupOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/GroupOut"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"}},"type":"object","required":["items","total","page","page_size"],"title":"Page[GroupOut]"},"GroupInput":{"properties":{"name":{"type":"string","maxLength":200,"minLength":1,"title":"Name"},"description":{"type":"string","maxLength":2000,"title":"Description","default":""}},"additionalProperties":false,"type":"object","required":["name"],"title":"GroupInput"},"RecordInput":{"properties":{"linked_to_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Linked To Id"},"relationship_role":{"type":"string","maxLength":200,"title":"Relationship Role","default":""},"name":{"type":"string","maxLength":500,"minLength":1,"title":"Name"},"entity_type":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","UNKNOWN"],"title":"Entity Type","default":"PERSON"},"aliases":{"items":{"type":"string"},"type":"array","maxItems":100,"title":"Aliases"},"dates":{"items":{"$ref":"#/components/schemas/RecordDate"},"type":"array","maxItems":100,"title":"Dates"},"identifiers":{"items":{"$ref":"#/components/schemas/TypedValue"},"type":"array","maxItems":100,"title":"Identifiers"},"countries":{"items":{"$ref":"#/components/schemas/TypedValue"},"type":"array","maxItems":100,"title":"Countries"},"addresses":{"items":{"type":"string"},"type":"array","maxItems":100,"title":"Addresses"},"notes":{"type":"string","maxLength":10000,"title":"Notes","default":""}},"additionalProperties":false,"type":"object","required":["name"],"title":"RecordInput"},"RecordUpdate":{"properties":{"linked_to_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Linked To Id"},"relationship_role":{"type":"string","maxLength":200,"title":"Relationship Role","default":""},"name":{"type":"string","maxLength":500,"minLength":1,"title":"Name"},"entity_type":{"type":"string","enum":["PERSON","ORGANISATION","VESSEL","UNKNOWN"],"title":"Entity Type","default":"PERSON"},"aliases":{"items":{"type":"string"},"type":"array","maxItems":100,"title":"Aliases"},"dates":{"items":{"$ref":"#/components/schemas/RecordDate"},"type":"array","maxItems":100,"title":"Dates"},"identifiers":{"items":{"$ref":"#/components/schemas/TypedValue"},"type":"array","maxItems":100,"title":"Identifiers"},"countries":{"items":{"$ref":"#/components/schemas/TypedValue"},"type":"array","maxItems":100,"title":"Countries"},"addresses":{"items":{"type":"string"},"type":"array","maxItems":100,"title":"Addresses"},"notes":{"type":"string","maxLength":10000,"title":"Notes","default":""},"group_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Group Id"}},"additionalProperties":false,"type":"object","required":["name"],"title":"RecordUpdate"},"SearchResults":{"properties":{"complete":{"type":"boolean","title":"Complete","default":true},"items":{"items":{"$ref":"#/components/schemas/SearchResult"},"type":"array","title":"Items"},"has_more":{"type":"boolean","title":"Has More"},"minimum_characters":{"type":"integer","title":"Minimum Characters","default":3}},"type":"object","required":["items","has_more"],"title":"SearchResults"},"SearchResult":{"properties":{"matched_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Matched Name"},"match_rating":{"type":"integer","maximum":5.0,"minimum":1.0,"title":"Match Rating"},"matched_words":{"type":"integer","title":"Matched Words"},"sources":{"items":{"$ref":"#/components/schemas/SearchSource"},"type":"array","title":"Sources"},"record_count":{"type":"integer","title":"Record Count"},"classifications":{"items":{"type":"string","enum":["SANCTIONS","PEP","CRIME","NARCOTICS","TERRORISM","MONEY_LAUNDERING","TERRORIST_FINANCING","PROLIFERATION","CORRUPTION","FRAUD","ORGANISED_CRIME","HUMAN_TRAFFICKING","HUMAN_RIGHTS_ABUSES","CYBERCRIME","ARMS_TRAFFICKING","SANCTIONS_EVASION","REGULATORY_ACTION","DEBARMENT","SANCTIONS_LINKED","SANCTIONS_CONTROL","COUNTER_SANCTIONS","RCA","WANTED","PERSON_OF_INTEREST","REGULATORY_WARNING","EXPORT_CONTROL","EXPORT_CONTROL_LINKED","TRADE_RISK","INVESTMENT_RISK","INVESTMENT_BAN","DISQUALIFIED","FINANCIAL_CRIME","WAR_CRIMES","TRAFFICKING","THEFT","ENVIRONMENTAL_VIOLATIONS","FORCED_LABOUR","FROZEN_ASSET","MARITIME_DETENTION","SHADOW_FLEET","OLIGARCH","CLONE_ENTITY","HIGH_RISK_AREA","SCREENING_INTEREST","CRIMINAL_LEADERSHIP"]},"type":"array","title":"Classifications"},"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"entity_type":{"type":"string","title":"Entity Type"},"reference_numbers":{"items":{"type":"string"},"type":"array","title":"Reference Numbers"},"source_name":{"type":"string","title":"Source Name"},"source_website":{"type":"string","title":"Source Website"},"source_last_success_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Source Last Success At"}},"type":"object","required":["match_rating","matched_words","sources","record_count","classifications","id","name","entity_type","reference_numbers","source_name","source_website","source_last_success_at"],"title":"SearchResult"},"SearchSource":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"last_success_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Success At"}},"type":"object","required":["id","name","last_success_at"],"title":"SearchSource"},"SearchDetail":{"properties":{"classifications":{"items":{"type":"string","enum":["SANCTIONS","PEP","CRIME","NARCOTICS","TERRORISM","MONEY_LAUNDERING","TERRORIST_FINANCING","PROLIFERATION","CORRUPTION","FRAUD","ORGANISED_CRIME","HUMAN_TRAFFICKING","HUMAN_RIGHTS_ABUSES","CYBERCRIME","ARMS_TRAFFICKING","SANCTIONS_EVASION","REGULATORY_ACTION","DEBARMENT","SANCTIONS_LINKED","SANCTIONS_CONTROL","COUNTER_SANCTIONS","RCA","WANTED","PERSON_OF_INTEREST","REGULATORY_WARNING","EXPORT_CONTROL","EXPORT_CONTROL_LINKED","TRADE_RISK","INVESTMENT_RISK","INVESTMENT_BAN","DISQUALIFIED","FINANCIAL_CRIME","WAR_CRIMES","TRAFFICKING","THEFT","ENVIRONMENTAL_VIOLATIONS","FORCED_LABOUR","FROZEN_ASSET","MARITIME_DETENTION","SHADOW_FLEET","OLIGARCH","CLONE_ENTITY","HIGH_RISK_AREA","SCREENING_INTEREST","CRIMINAL_LEADERSHIP"]},"type":"array","title":"Classifications"},"id":{"type":"string","format":"uuid","title":"Id"},"source_id":{"type":"string","format":"uuid","title":"Source Id"},"external_id":{"type":"string","title":"External Id"},"name":{"type":"string","title":"Name"},"entity_type":{"type":"string","title":"Entity Type"},"active":{"type":"boolean","title":"Active"},"reference_numbers":{"items":{},"type":"array","title":"Reference Numbers"},"names":{"items":{},"type":"array","title":"Names"},"dates":{"items":{},"type":"array","title":"Dates"},"identifiers":{"items":{},"type":"array","title":"Identifiers"},"locations":{"items":{},"type":"array","title":"Locations"},"programs":{"items":{},"type":"array","title":"Programs"},"attributes":{"additionalProperties":true,"type":"object","title":"Attributes"},"snapshot_id":{"type":"string","format":"uuid","title":"Snapshot Id"},"first_seen_at":{"type":"string","format":"date-time","title":"First Seen At"},"last_seen_at":{"type":"string","format":"date-time","title":"Last Seen At"},"last_changed_at":{"type":"string","format":"date-time","title":"Last Changed At"},"enrichment":{"$ref":"#/components/schemas/ReportEnrichment"},"provider_details":{"additionalProperties":true,"type":"object","title":"Provider Details"},"source_name":{"type":"string","title":"Source Name"},"source_website":{"type":"string","title":"Source Website"},"match_rating":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Match Rating"},"source_last_success_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Source Last Success At"}},"type":"object","required":["classifications","id","source_id","external_id","name","entity_type","active","reference_numbers","names","dates","identifiers","locations","programs","attributes","snapshot_id","first_seen_at","last_seen_at","last_changed_at","enrichment","provider_details","source_name","source_website","source_last_success_at"],"title":"SearchDetail"},"ReportEnrichment":{"properties":{"status":{"type":"string","title":"Status"},"outdated":{"type":"boolean","title":"Outdated"},"result":{"anyOf":[{"$ref":"#/components/schemas/ReportResult"},{"type":"null"}]},"providers":{"additionalProperties":{"additionalProperties":true,"type":"object"},"type":"object","title":"Providers"}},"type":"object","required":["status","outdated","result"],"title":"ReportEnrichment"},"ReportResult":{"properties":{"provider":{"type":"string","title":"Provider","default":"wikidata"},"id":{"type":"string","format":"uuid","title":"Id"},"revision_id":{"type":"string","format":"uuid","title":"Revision Id"},"entity_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entity Id"},"retrieved_at":{"type":"string","format":"date-time","title":"Retrieved At"},"refresh_after":{"type":"string","format":"date-time","title":"Refresh After"},"data":{"additionalProperties":true,"type":"object","title":"Data"}},"type":"object","required":["id","revision_id","entity_id","retrieved_at","refresh_after","data"],"title":"ReportResult"},"ScreeningProfile":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"classifications":{"items":{"type":"string","enum":["SANCTIONS","PEP","CRIME","NARCOTICS","TERRORISM","MONEY_LAUNDERING","TERRORIST_FINANCING","PROLIFERATION","CORRUPTION","FRAUD","ORGANISED_CRIME","HUMAN_TRAFFICKING","HUMAN_RIGHTS_ABUSES","CYBERCRIME","ARMS_TRAFFICKING","SANCTIONS_EVASION","REGULATORY_ACTION","DEBARMENT","SANCTIONS_LINKED","SANCTIONS_CONTROL","COUNTER_SANCTIONS","RCA","WANTED","PERSON_OF_INTEREST","REGULATORY_WARNING","EXPORT_CONTROL","EXPORT_CONTROL_LINKED","TRADE_RISK","INVESTMENT_RISK","INVESTMENT_BAN","DISQUALIFIED","FINANCIAL_CRIME","WAR_CRIMES","TRAFFICKING","THEFT","ENVIRONMENTAL_VIOLATIONS","FORCED_LABOUR","FROZEN_ASSET","MARITIME_DETENTION","SHADOW_FLEET","OLIGARCH","CLONE_ENTITY","HIGH_RISK_AREA","SCREENING_INTEREST","CRIMINAL_LEADERSHIP"]},"type":"array","title":"Classifications"},"records":{"items":{"$ref":"#/components/schemas/SearchDetail"},"type":"array","title":"Records"},"match_rating":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Match Rating"}},"type":"object","required":["id","name","classifications","records"],"title":"ScreeningProfile"},"ReportRequest":{"properties":{"kind":{"type":"string","enum":["profile","portfolio"],"title":"Kind"},"record_id":{"type":"string","format":"uuid","title":"Record Id"},"client_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Client Id"},"q":{"type":"string","maxLength":200,"title":"Q","default":""}},"additionalProperties":false,"type":"object","required":["kind","record_id"],"title":"ReportRequest"},"ReportOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"reference":{"type":"string","title":"Reference"},"subject_name":{"type":"string","title":"Subject Name"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"pdf_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pdf Url"},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"},"kind":{"type":"string","enum":["profile","portfolio"],"title":"Kind"},"record_id":{"type":"string","format":"uuid","title":"Record Id"},"client_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Client Id"},"company_name":{"type":"string","title":"Company Name"},"created_by":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Created By"},"created_by_name":{"type":"string","title":"Created By Name"},"generated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Generated At"},"status":{"type":"string","enum":["queued","processing","ready","failed"],"title":"Status"},"error":{"type":"string","title":"Error"},"reusable_until":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reusable Until"},"can_regenerate":{"type":"boolean","title":"Can Regenerate"},"reused":{"type":"boolean","title":"Reused","default":false}},"type":"object","required":["id","reference","subject_name","created_at","pdf_url","sha256","kind","record_id","client_id","company_name","created_by","created_by_name","generated_at","status","error","reusable_until","can_regenerate"],"title":"ReportOut"},"Page_ReportOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ReportOut"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"}},"type":"object","required":["items","total","page","page_size"],"title":"Page[ReportOut]"}},"securitySchemes":{"ClientAPIKey":{"type":"http","scheme":"bearer","bearerFormat":"sancticheck client API key","description":"Use the secret shown once when a client administrator or staff member creates a named key. Not a JWT login token."}}}}