{"openapi":"3.1.0","info":{"title":"Vigil KYC screen (paid)","description":"Vigil KYC screen: check one company and up to three named people against sanctions and exclusions lists, with an evidence pack and PDF","version":"0.1.13"},"servers":[{"url":"https://cairn.cmdrvl.com/vigil-paid/v1"}],"paths":{"/health":{"get":{"summary":"Health","operationId":"health_vigil_paid_v1_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/":{"get":{"summary":"Offer","operationId":"offer_vigil_paid_v1__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/screen":{"post":{"summary":"Screen","operationId":"screen_vigil_paid_v1_screen_post","requestBody":{"content":{"application/json":{"schema":{"properties":{"company":{"type":"string","description":"the legal name to screen (required)"},"persons":{"items":{"oneOf":[{"type":"string"},{"properties":{"name":{"type":"string"},"dob":{"type":"string","description":"YYYY or YYYY-MM-DD"},"nationality":{"type":"string","description":"ISO 3166-1 alpha-2"}},"type":"object","required":["name"]}]},"type":"array","maxItems":3,"description":"up to 3 named people"},"wait_seconds":{"type":"integer","maximum":240.0,"minimum":0.0,"description":"how long to wait for the sealed pack before answering 202 with a result_url","default":15}},"type":"object","required":["company"]},"example":{"company":"Example Holdings LLC","persons":["Jane Example",{"name":"John Example","dob":"1970","nationality":"US"}]}}},"required":true},"responses":{"200":{"description":"the sealed screen: severity, routing, recommendation, potential matches, sources read, pack id, report_pdf_url","content":{"application/json":{"schema":{}}}},"202":{"description":"still running after wait_seconds; GET result_url (with the token) until 200; no further payment"},"400":{"description":"malformed request; refused before any payment challenge"},"429":{"description":"too many unpaid requests from this address (before payment), or this payer's queue is full (after payment: refunded; no hourly limit — screens queue and are served in turn)"},"502":{"description":"the screen did not complete; the payment is refunded"},"402":{"description":"Payment required: one WWW-Authenticate: Payment challenge per payment method (Machine Payments Protocol); pay, then retry the same request with the credential","content":{"application/problem+json":{}}}},"x-payment-info":{"offers":[{"method":"tempo","intent":"charge","amount":"1000000","currency":"0x20C000000000000000000000b9537d11c60E8b50","description":"Vigil KYC screen: check one company and up to three named people against sanctions and exclusions lists, with an evidence pack and PDF"},{"method":"stripe","intent":"charge","amount":"100","currency":"usd","description":"Vigil KYC screen: check one company and up to three named people against sanctions and exclusions lists, with an evidence pack and PDF"}]}}},"/screen/{job_id}":{"get":{"summary":"Result","operationId":"result_vigil_paid_v1_screen__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"token","in":"query","required":false,"schema":{"type":"string","default":"","title":"Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/screen/{job_id}/report.pdf":{"get":{"summary":"Report","operationId":"report_vigil_paid_v1_screen__job_id__report_pdf_get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"token","in":"query","required":false,"schema":{"type":"string","default":"","title":"Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"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"}}},"x-service-info":{"name":"Vigil KYC screen","description":"Vigil KYC screen: check one company and up to three named people against sanctions and exclusions lists, with an evidence pack and PDF","docs":{"llms":"https://cairn.cmdrvl.com/vigil-paid/v1/llms.txt","offer":"https://cairn.cmdrvl.com/vigil-paid/v1/"},"price":{"amount":"1.00","currency":"usd","per":"completed screen"},"livemode":true}}