{"openapi":"3.1.0","info":{"title":"Screen Terminal — name screening API","description":"Screen names against PEP, sanctions and watchlists. Send your key in X-API-Key.","version":"0.1.0"},"paths":{"/v1/screen":{"post":{"tags":["screening"],"summary":"Screen","operationId":"screen_v1_screen_post","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenQuery"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/screen/batch":{"post":{"tags":["screening"],"summary":"Screen Batch","description":"Screen many names in one call (portfolio / ongoing-monitoring). Each is audited; the\nresponse summarises how many hit. Capped at 50 per call; each name counts as one screen.","operationId":"screen_batch_v1_screen_batch_post","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchScreenQuery"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"BatchScreenQuery":{"properties":{"queries":{"items":{"$ref":"#/components/schemas/ScreenQuery"},"type":"array","maxItems":50,"title":"Queries","description":"Up to 50 names to screen in one call"}},"type":"object","required":["queries"],"title":"BatchScreenQuery"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ScreenQuery":{"properties":{"name":{"type":"string","maxLength":200,"minLength":2,"title":"Name","examples":["Amara Okonkwo-Test"]},"dob":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Dob","description":"Date of birth — YYYY-MM-DD preferred; DD/MM/YYYY, '7 Oct 1952', YYYY-MM and YYYY are also accepted","examples":["1965-03-02"]},"country":{"anyOf":[{"type":"string","maxLength":56},{"type":"null"}],"title":"Country","description":"ISO-3166 alpha-2","examples":["XX"]},"aliases":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":8},{"type":"null"}],"title":"Aliases","description":"extra name forms to screen"}},"type":"object","required":["name"],"title":"ScreenQuery"},"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"}}}}