{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"safely.bio Customer Screening API","colors":{"primary":"#009988","light":"#009988","dark":"#007a6d"},"logo":{"light":"https://mintcdn.com/safely-bio/9LDIcxEByg07LomV/logo/light.svg?fit=max\u0026auto=format\u0026n=9LDIcxEByg07LomV\u0026q=85\u0026s=5f4f31b65d8671a6f66e33f9494597b1","dark":"https://mintcdn.com/safely-bio/9LDIcxEByg07LomV/logo/dark.svg?fit=max\u0026auto=format\u0026n=9LDIcxEByg07LomV\u0026q=85\u0026s=3ca91112d3327842a94e59ffe47da5f7","href":"https://safely.bio"},"favicon":"https://mintcdn.com/safely-bio/9LDIcxEByg07LomV/favicon.svg?fit=max\u0026auto=format\u0026n=9LDIcxEByg07LomV\u0026q=85\u0026s=8af16d40b0e2b27742eb4e5949170e35","api":{"playground":{"display":"none"}},"appearance":{"default":"light"},"background":{"color":{"light":"#fafaf8","dark":"#151a19"}},"fonts":{"family":"Instrument Sans"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"safely-bio","hasAudioNarration":false,"actualSubdomain":"safely-bio","customDomains":["docs.safely.bio"],"gitSource":{"type":"github","owner":"safelybio","repo":"verify-api","deployBranch":"v3","contentDirectory":"docs/public","isPrivate":true,"mountPath":"","label":"","_id":"6ae7ff8302fe2a17a6afdb58"},"chroma":{"latestBuiltDeploymentHistoryId":"6ae8019b02fe2a17a6afed7e","collectionId":"95795e98-d341-4af8-8491-f9d569bb10e6","liveDeploymentHistoryId":"6ae8019b02fe2a17a6afed7e","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae805b87369e74a65b98bef","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Guide","count":5},{"language":"default","tag":"API reference","count":3},{"language":"default","tag":"Screenings","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"styles.css","content":".tryit-button{background-color:#098!important;color:#fff!important}.tryit-button:hover{background-color:#007a6d!important}"}],"page":{"pagePath":"api-reference/screenings/start-screening-a-customer","slug":"/api-reference/screenings/start-screening-a-customer","pageMetadata":{"title":"Start screening a customer","description":"Returns 202 with a pending screening, or 200 with the saved screening for a retry with the same request_key and body.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/screenings","href":"/api-reference/screenings/start-screening-a-customer","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns 202 with a pending screening, or 200 with the saved screening for a retry with the same request_key and body.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Start screening a customer","description":"Returns 202 with a pending screening, or 200 with the saved screening for a retry with the same request_key and body.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/screenings","href":"/api-reference/screenings/start-screening-a-customer","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Returns 202 with a pending screening, or 200 with the saved screening for a retry with the same request_key and body.","operationId":"create_v1_screenings_post","requestBody":"80fb347e-fe95-4ca4-a78d-77920b45475f","responses":{"200":"b14a6c0a-7ece-490d-9df2-42efae9791be","202":"49790cdd-e034-495e-bd19-0698900013da","400":"b7370672-2570-4599-94b5-d49a1ed5b305","401":"3670b4a3-5d3d-4a0f-8289-af00e518a625","404":"b5ea41c4-c99e-44a9-b335-4b5c3a4bd2c2","409":"60a50493-7a1c-47a5-a585-5d456fd39db6","413":"3de0e3cb-78af-4663-91e0-34542e71947f","429":"552ee995-caaa-474f-9964-43e019b46b8f","503":"5e3228ad-782b-490d-a2e7-4b9fb7f2c926"},"security":["a00bd0f7-6c01-4a93-a2db-7c0e86b7e51a"],"summary":"Start screening a customer","tags":["Screenings"],"method":"post","type":"path","servers":["06c15be1-ce92-431d-9845-b6248bdfbe66"],"path":"/v1/screenings","baseUrlOptions":["https://api.safely.bio"],"title":"Start screening a customer","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"customer":{"additionalProperties":false,"properties":{"country":{"description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","title":"Country","type":"string","isRequired":true,"uniqueKey":"customer.country","typeLabel":"string"},"email":{"description":"The person's email address.","maxLength":320,"pattern":"^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$","title":"Email","type":"string","isRequired":true,"uniqueKey":"customer.email","typeLabel":"string"},"name":{"description":"The person's full name.","maxLength":500,"minLength":1,"title":"Name","type":"string","isRequired":true,"uniqueKey":"customer.name","typeLabel":"string"},"organization":{"description":"The organization the person says they work for.","maxLength":500,"minLength":1,"title":"Organization","type":"string","isRequired":true,"uniqueKey":"customer.organization","typeLabel":"string"},"billing_address":{"oneOf":[{"type":"object","title":"Address","required":["line1","city","country"],"properties":{"city":{"maxLength":500,"minLength":1,"title":"City","type":"string","isRequired":true,"uniqueKey":"customer.billing_address.oneOf.0.city","typeLabel":"string"},"country":{"description":"Two-letter ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","title":"Country","type":"string","isRequired":true,"uniqueKey":"customer.billing_address.oneOf.0.country","typeLabel":"string"},"line1":{"maxLength":500,"minLength":1,"title":"Line1","type":"string","isRequired":true,"uniqueKey":"customer.billing_address.oneOf.0.line1","typeLabel":"string"},"line2":{"oneOf":[{"type":"string","title":"Line2","maxLength":500,"minLength":1,"uniqueKey":"customer.billing_address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","title":"Line2","uniqueKey":"customer.billing_address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.billing_address.oneOf.0.line2","typeLabel":"string | null"},"postal_code":{"oneOf":[{"type":"string","title":"Postal Code","maxLength":20,"minLength":1,"uniqueKey":"customer.billing_address.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Postal Code","uniqueKey":"customer.billing_address.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.billing_address.oneOf.0.postal_code","typeLabel":"string | null"},"region":{"oneOf":[{"type":"string","title":"Region","maxLength":500,"minLength":1,"uniqueKey":"customer.billing_address.oneOf.0.region.oneOf.0","typeLabel":"string"},{"type":"null","title":"Region","uniqueKey":"customer.billing_address.oneOf.0.region.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.billing_address.oneOf.0.region","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"customer.billing_address.oneOf.0","typeLabel":"Address · object"},{"type":"null","uniqueKey":"customer.billing_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.billing_address","typeLabel":"Address · object | null"},"group":{"oneOf":[{"type":"string","title":"Group","description":"Lab, group or department. It gives context to AI research; no rule depends on it.","maxLength":500,"minLength":1,"uniqueKey":"customer.group.oneOf.0","typeLabel":"string"},{"type":"null","title":"Group","description":"Lab, group or department. It gives context to AI research; no rule depends on it.","uniqueKey":"customer.group.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.group","typeLabel":"string | null"},"orcid":{"oneOf":[{"type":"string","title":"Orcid","description":"ORCID iD. It strengthens identity matching.","maxLength":50,"uniqueKey":"customer.orcid.oneOf.0","typeLabel":"string"},{"type":"null","title":"Orcid","description":"ORCID iD. It strengthens identity matching.","uniqueKey":"customer.orcid.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.orcid","typeLabel":"string | null"},"shipping_address":{"oneOf":[{"type":"object","title":"Address","description":"Address checks use this address, or the billing address when it is absent.","required":["line1","city","country"],"properties":{"city":{"maxLength":500,"minLength":1,"title":"City","type":"string","isRequired":true,"uniqueKey":"customer.shipping_address.oneOf.0.city","typeLabel":"string"},"country":{"description":"Two-letter ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","title":"Country","type":"string","isRequired":true,"uniqueKey":"customer.shipping_address.oneOf.0.country","typeLabel":"string"},"line1":{"maxLength":500,"minLength":1,"title":"Line1","type":"string","isRequired":true,"uniqueKey":"customer.shipping_address.oneOf.0.line1","typeLabel":"string"},"line2":{"oneOf":[{"type":"string","title":"Line2","maxLength":500,"minLength":1,"uniqueKey":"customer.shipping_address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","title":"Line2","uniqueKey":"customer.shipping_address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.shipping_address.oneOf.0.line2","typeLabel":"string | null"},"postal_code":{"oneOf":[{"type":"string","title":"Postal Code","maxLength":20,"minLength":1,"uniqueKey":"customer.shipping_address.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Postal Code","uniqueKey":"customer.shipping_address.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.shipping_address.oneOf.0.postal_code","typeLabel":"string | null"},"region":{"oneOf":[{"type":"string","title":"Region","maxLength":500,"minLength":1,"uniqueKey":"customer.shipping_address.oneOf.0.region.oneOf.0","typeLabel":"string"},{"type":"null","title":"Region","uniqueKey":"customer.shipping_address.oneOf.0.region.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.shipping_address.oneOf.0.region","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"customer.shipping_address.oneOf.0","typeLabel":"Address · object"},{"type":"null","description":"Address checks use this address, or the billing address when it is absent.","uniqueKey":"customer.shipping_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.shipping_address","typeLabel":"Address · object | null"}},"required":["name","email","organization","country"],"title":"Customer","type":"object","isRequired":true,"uniqueKey":"customer","typeLabel":"Customer · object"},"policy":{"description":"The screening policy agreed with you, such as basic-onboarding.","maxLength":100,"minLength":1,"title":"Policy","type":"string","isRequired":true,"uniqueKey":"policy","typeLabel":"string"},"request_key":{"description":"Your unique key for this request. Retrying with the same key and body returns the same screening.","maxLength":200,"minLength":1,"title":"Request Key","type":"string","isRequired":true,"uniqueKey":"request_key","typeLabel":"string"},"reference":{"oneOf":[{"type":"string","title":"Reference","description":"Your own record ID, returned unchanged.","maxLength":500,"minLength":1,"uniqueKey":"reference.oneOf.0","typeLabel":"string"},{"type":"null","title":"Reference","description":"Your own record ID, returned unchanged.","uniqueKey":"reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"reference","typeLabel":"string | null"},"test_scenario":{"oneOf":[{"type":"string","title":"Test Scenario","description":"Test keys only: return a fixed screening without running checks.","enum":["approve","review","deny","slow","failed","unknown_values"],"uniqueKey":"test_scenario.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Test Scenario","description":"Test keys only: return a fixed screening without running checks.","uniqueKey":"test_scenario.oneOf.1","typeLabel":"null"}],"uniqueKey":"test_scenario","typeLabel":"enum\u003cstring> | null"}},"required":["request_key","policy","customer"],"title":"ScreeningRequest","type":"object","uniqueKey":"","typeLabel":"ScreeningRequest · object"},"examples":{"Example":{"title":"Example","value":{"customer":{"country":"\u003cstring>","email":"\u003cstring>","name":"\u003cstring>","organization":"\u003cstring>","billing_address":{"city":"\u003cstring>","country":"\u003cstring>","line1":"\u003cstring>","line2":"\u003cstring>","postal_code":"\u003cstring>","region":"\u003cstring>"},"group":"\u003cstring>","orcid":"\u003cstring>","shipping_address":{"city":"\u003cstring>","country":"\u003cstring>","line1":"\u003cstring>","line2":"\u003cstring>","postal_code":"\u003cstring>","region":"\u003cstring>"}},"policy":"\u003cstring>","request_key":"\u003cstring>","reference":"\u003cstring>"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"b14a6c0a-7ece-490d-9df2-42efae9791be":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"categories":{"items":{"additionalProperties":false,"properties":{"category":{"description":"restrictions, organization, affiliation, scientist or address; tolerate new values.","title":"Category","type":"string","isRequired":true,"uniqueKey":"categories.items.[INDEX].category","typeLabel":"string"},"reasons":{"description":"Why the result is not clear.","items":{"additionalProperties":false,"properties":{"code":{"description":"Stable reason code; tolerate new codes. Current codes: address_far_from_organization, address_not_confirmed, affiliation_not_confirmed, check_unavailable, country_risk, email_domain_invalid, export_control_match, input_missing, lookalike_domain, mail_drop, new_email_domain, no_life_sciences_activity, no_publications_found, organization_not_found, personal_email, residential_address, restriction_not_cleared, sanctions_match.","title":"Code","type":"string","isRequired":true,"uniqueKey":"categories.items.[INDEX].reasons.items.[INDEX].code","typeLabel":"string"},"message":{"description":"Readable explanation; wording may change.","title":"Message","type":"string","isRequired":true,"uniqueKey":"categories.items.[INDEX].reasons.items.[INDEX].message","typeLabel":"string"}},"required":["code","message"],"title":"Reason","type":"object","uniqueKey":"categories.items.[INDEX].reasons.items.[INDEX]","typeLabel":"Reason · object"},"title":"Reasons","type":"array","isRequired":true,"uniqueKey":"categories.items.[INDEX].reasons","typeLabel":"Reason · object[]"},"result":{"description":"clear, note, flag or not_checked; treat unknown values as note.","title":"Result","type":"string","isRequired":true,"uniqueKey":"categories.items.[INDEX].result","typeLabel":"string"}},"required":["category","result","reasons"],"title":"Category","type":"object","uniqueKey":"categories.items.[INDEX]","typeLabel":"Category · object"},"title":"Categories","type":"array","isRequired":true,"uniqueKey":"categories","typeLabel":"Category · object[]"},"completed_at":{"oneOf":[{"type":"string","title":"Completed At","format":"date-time","isRequired":true,"uniqueKey":"completed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Completed At","isRequired":true,"uniqueKey":"completed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"completed_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"format":"date-time","title":"Created At","type":"string","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"decision":{"oneOf":[{"type":"object","title":"RecordedDecision","required":["action","decided_at"],"properties":{"action":{"enum":["approved","refused","more_information_requested","reported"],"title":"Action","type":"string","isRequired":true,"uniqueKey":"decision.oneOf.0.action","typeLabel":"enum\u003cstring>"},"decided_at":{"format":"date-time","title":"Decided At","type":"string","isRequired":true,"uniqueKey":"decision.oneOf.0.decided_at","typeLabel":"string\u003cdate-time>"},"decided_by":{"oneOf":[{"type":"string","title":"Decided By","maxLength":500,"minLength":1,"uniqueKey":"decision.oneOf.0.decided_by.oneOf.0","typeLabel":"string"},{"type":"null","title":"Decided By","uniqueKey":"decision.oneOf.0.decided_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"decision.oneOf.0.decided_by","typeLabel":"string | null"},"reason":{"oneOf":[{"type":"string","title":"Reason","maxLength":500,"minLength":1,"uniqueKey":"decision.oneOf.0.reason.oneOf.0","typeLabel":"string"},{"type":"null","title":"Reason","uniqueKey":"decision.oneOf.0.reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"decision.oneOf.0.reason","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"decision.oneOf.0","typeLabel":"RecordedDecision · object"},{"type":"null","isRequired":true,"uniqueKey":"decision.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"decision","typeLabel":"RecordedDecision · object | null"},"id":{"description":"Opaque identifier of up to 255 characters; do not parse it.","title":"Id","type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"livemode":{"title":"Livemode","type":"boolean","isRequired":true,"uniqueKey":"livemode","typeLabel":"boolean"},"policy":{"title":"Policy","type":"string","isRequired":true,"uniqueKey":"policy","typeLabel":"string"},"recommendation":{"oneOf":[{"type":"string","title":"Recommendation","description":"approve, review or deny once completed; treat unknown values as review.","isRequired":true,"uniqueKey":"recommendation.oneOf.0","typeLabel":"string"},{"type":"null","title":"Recommendation","description":"approve, review or deny once completed; treat unknown values as review.","isRequired":true,"uniqueKey":"recommendation.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"recommendation","typeLabel":"string | null"},"reference":{"oneOf":[{"type":"string","title":"Reference","isRequired":true,"uniqueKey":"reference.oneOf.0","typeLabel":"string"},{"type":"null","title":"Reference","isRequired":true,"uniqueKey":"reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"reference","typeLabel":"string | null"},"request_key":{"title":"Request Key","type":"string","isRequired":true,"uniqueKey":"request_key","typeLabel":"string"},"status":{"description":"pending, completed or failed; tolerate new values.","title":"Status","type":"string","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"summary":{"oneOf":[{"type":"string","title":"Summary","description":"Plain text of at most 1,000 characters.","isRequired":true,"uniqueKey":"summary.oneOf.0","typeLabel":"string"},{"type":"null","title":"Summary","description":"Plain text of at most 1,000 characters.","isRequired":true,"uniqueKey":"summary.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"summary","typeLabel":"string | null"},"error":{"oneOf":[{"type":"object","title":"ErrorBody","required":["code","message"],"properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"error.oneOf.0.code","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"error.oneOf.0.message","typeLabel":"string"},"field":{"oneOf":[{"type":"string","title":"Field","uniqueKey":"error.oneOf.0.field.oneOf.0","typeLabel":"string"},{"type":"null","title":"Field","uniqueKey":"error.oneOf.0.field.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.oneOf.0.field","typeLabel":"string | null"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","uniqueKey":"error.oneOf.0.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","uniqueKey":"error.oneOf.0.request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.oneOf.0.request_id","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"error.oneOf.0","typeLabel":"ErrorBody · object"},{"type":"null","uniqueKey":"error.oneOf.1","typeLabel":"null"}],"uniqueKey":"error","typeLabel":"ErrorBody · object | null"},"object":{"const":"screening","default":"screening","title":"Object","type":"string","uniqueKey":"object","typeLabel":"string"}},"required":["id","livemode","status","request_key","reference","policy","recommendation","categories","summary","created_at","completed_at","decision"],"title":"Screening","type":"object","uniqueKey":"","typeLabel":"Screening · object"},"examples":{"Example":{"title":"Example","value":{"categories":[{"category":"\u003cstring>","reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}],"result":"\u003cstring>"}],"completed_at":"2023-11-07T05:31:56Z","created_at":"2023-11-07T05:31:56Z","decision":{"action":"approved","decided_at":"2023-11-07T05:31:56Z","decided_by":"\u003cstring>","reason":"\u003cstring>"},"id":"\u003cstring>","livemode":true,"policy":"\u003cstring>","recommendation":"\u003cstring>","reference":"\u003cstring>","request_key":"\u003cstring>","status":"\u003cstring>","summary":"\u003cstring>","error":{"code":"\u003cstring>","message":"\u003cstring>","field":"\u003cstring>","request_id":"\u003cstring>"},"object":"screening"}}},"exampleType":"generated"}},"description":"The saved screening for a retry","exampleType":"generated"},"49790cdd-e034-495e-bd19-0698900013da":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"categories":{"items":{"additionalProperties":false,"properties":{"category":{"description":"restrictions, organization, affiliation, scientist or address; tolerate new values.","title":"Category","type":"string","isRequired":true,"uniqueKey":"categories.items.[INDEX].category","typeLabel":"string"},"reasons":{"description":"Why the result is not clear.","items":{"additionalProperties":false,"properties":{"code":{"description":"Stable reason code; tolerate new codes. Current codes: address_far_from_organization, address_not_confirmed, affiliation_not_confirmed, check_unavailable, country_risk, email_domain_invalid, export_control_match, input_missing, lookalike_domain, mail_drop, new_email_domain, no_life_sciences_activity, no_publications_found, organization_not_found, personal_email, residential_address, restriction_not_cleared, sanctions_match.","title":"Code","type":"string","isRequired":true,"uniqueKey":"categories.items.[INDEX].reasons.items.[INDEX].code","typeLabel":"string"},"message":{"description":"Readable explanation; wording may change.","title":"Message","type":"string","isRequired":true,"uniqueKey":"categories.items.[INDEX].reasons.items.[INDEX].message","typeLabel":"string"}},"required":["code","message"],"title":"Reason","type":"object","uniqueKey":"categories.items.[INDEX].reasons.items.[INDEX]","typeLabel":"Reason · object"},"title":"Reasons","type":"array","isRequired":true,"uniqueKey":"categories.items.[INDEX].reasons","typeLabel":"Reason · object[]"},"result":{"description":"clear, note, flag or not_checked; treat unknown values as note.","title":"Result","type":"string","isRequired":true,"uniqueKey":"categories.items.[INDEX].result","typeLabel":"string"}},"required":["category","result","reasons"],"title":"Category","type":"object","uniqueKey":"categories.items.[INDEX]","typeLabel":"Category · object"},"title":"Categories","type":"array","isRequired":true,"uniqueKey":"categories","typeLabel":"Category · object[]"},"completed_at":{"oneOf":[{"type":"string","title":"Completed At","format":"date-time","isRequired":true,"uniqueKey":"completed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Completed At","isRequired":true,"uniqueKey":"completed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"completed_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"format":"date-time","title":"Created At","type":"string","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"decision":{"oneOf":[{"type":"object","title":"RecordedDecision","required":["action","decided_at"],"properties":{"action":{"enum":["approved","refused","more_information_requested","reported"],"title":"Action","type":"string","isRequired":true,"uniqueKey":"decision.oneOf.0.action","typeLabel":"enum\u003cstring>"},"decided_at":{"format":"date-time","title":"Decided At","type":"string","isRequired":true,"uniqueKey":"decision.oneOf.0.decided_at","typeLabel":"string\u003cdate-time>"},"decided_by":{"oneOf":[{"type":"string","title":"Decided By","maxLength":500,"minLength":1,"uniqueKey":"decision.oneOf.0.decided_by.oneOf.0","typeLabel":"string"},{"type":"null","title":"Decided By","uniqueKey":"decision.oneOf.0.decided_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"decision.oneOf.0.decided_by","typeLabel":"string | null"},"reason":{"oneOf":[{"type":"string","title":"Reason","maxLength":500,"minLength":1,"uniqueKey":"decision.oneOf.0.reason.oneOf.0","typeLabel":"string"},{"type":"null","title":"Reason","uniqueKey":"decision.oneOf.0.reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"decision.oneOf.0.reason","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"decision.oneOf.0","typeLabel":"RecordedDecision · object"},{"type":"null","isRequired":true,"uniqueKey":"decision.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"decision","typeLabel":"RecordedDecision · object | null"},"id":{"description":"Opaque identifier of up to 255 characters; do not parse it.","title":"Id","type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"livemode":{"title":"Livemode","type":"boolean","isRequired":true,"uniqueKey":"livemode","typeLabel":"boolean"},"policy":{"title":"Policy","type":"string","isRequired":true,"uniqueKey":"policy","typeLabel":"string"},"recommendation":{"oneOf":[{"type":"string","title":"Recommendation","description":"approve, review or deny once completed; treat unknown values as review.","isRequired":true,"uniqueKey":"recommendation.oneOf.0","typeLabel":"string"},{"type":"null","title":"Recommendation","description":"approve, review or deny once completed; treat unknown values as review.","isRequired":true,"uniqueKey":"recommendation.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"recommendation","typeLabel":"string | null"},"reference":{"oneOf":[{"type":"string","title":"Reference","isRequired":true,"uniqueKey":"reference.oneOf.0","typeLabel":"string"},{"type":"null","title":"Reference","isRequired":true,"uniqueKey":"reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"reference","typeLabel":"string | null"},"request_key":{"title":"Request Key","type":"string","isRequired":true,"uniqueKey":"request_key","typeLabel":"string"},"status":{"description":"pending, completed or failed; tolerate new values.","title":"Status","type":"string","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"summary":{"oneOf":[{"type":"string","title":"Summary","description":"Plain text of at most 1,000 characters.","isRequired":true,"uniqueKey":"summary.oneOf.0","typeLabel":"string"},{"type":"null","title":"Summary","description":"Plain text of at most 1,000 characters.","isRequired":true,"uniqueKey":"summary.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"summary","typeLabel":"string | null"},"error":{"oneOf":[{"type":"object","title":"ErrorBody","required":["code","message"],"properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"error.oneOf.0.code","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"error.oneOf.0.message","typeLabel":"string"},"field":{"oneOf":[{"type":"string","title":"Field","uniqueKey":"error.oneOf.0.field.oneOf.0","typeLabel":"string"},{"type":"null","title":"Field","uniqueKey":"error.oneOf.0.field.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.oneOf.0.field","typeLabel":"string | null"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","uniqueKey":"error.oneOf.0.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","uniqueKey":"error.oneOf.0.request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.oneOf.0.request_id","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"error.oneOf.0","typeLabel":"ErrorBody · object"},{"type":"null","uniqueKey":"error.oneOf.1","typeLabel":"null"}],"uniqueKey":"error","typeLabel":"ErrorBody · object | null"},"object":{"const":"screening","default":"screening","title":"Object","type":"string","uniqueKey":"object","typeLabel":"string"}},"required":["id","livemode","status","request_key","reference","policy","recommendation","categories","summary","created_at","completed_at","decision"],"title":"Screening","type":"object","uniqueKey":"","typeLabel":"Screening · object"},"examples":{"Example":{"title":"Example","value":{"categories":[{"category":"\u003cstring>","reasons":[{"code":"\u003cstring>","message":"\u003cstring>"}],"result":"\u003cstring>"}],"completed_at":"2023-11-07T05:31:56Z","created_at":"2023-11-07T05:31:56Z","decision":{"action":"approved","decided_at":"2023-11-07T05:31:56Z","decided_by":"\u003cstring>","reason":"\u003cstring>"},"id":"\u003cstring>","livemode":true,"policy":"\u003cstring>","recommendation":"\u003cstring>","reference":"\u003cstring>","request_key":"\u003cstring>","status":"\u003cstring>","summary":"\u003cstring>","error":{"code":"\u003cstring>","message":"\u003cstring>","field":"\u003cstring>","request_id":"\u003cstring>"},"object":"screening"}}},"exampleType":"generated"}},"description":"Successful Response","exampleType":"generated"},"b7370672-2570-4599-94b5-d49a1ed5b305":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"error":{"additionalProperties":false,"properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"field":{"oneOf":[{"type":"string","title":"Field","uniqueKey":"error.field.oneOf.0","typeLabel":"string"},{"type":"null","title":"Field","uniqueKey":"error.field.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.field","typeLabel":"string | null"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.request_id","typeLabel":"string | null"}},"required":["code","message"],"title":"ErrorBody","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorBody · object"}},"required":["error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","field":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Invalid request or unknown policy","exampleType":"generated"},"3670b4a3-5d3d-4a0f-8289-af00e518a625":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"error":{"additionalProperties":false,"properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"field":{"oneOf":[{"type":"string","title":"Field","uniqueKey":"error.field.oneOf.0","typeLabel":"string"},{"type":"null","title":"Field","uniqueKey":"error.field.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.field","typeLabel":"string | null"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.request_id","typeLabel":"string | null"}},"required":["code","message"],"title":"ErrorBody","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorBody · object"}},"required":["error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","field":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Missing, invalid or revoked key","exampleType":"generated"},"b5ea41c4-c99e-44a9-b335-4b5c3a4bd2c2":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"error":{"additionalProperties":false,"properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"field":{"oneOf":[{"type":"string","title":"Field","uniqueKey":"error.field.oneOf.0","typeLabel":"string"},{"type":"null","title":"Field","uniqueKey":"error.field.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.field","typeLabel":"string | null"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.request_id","typeLabel":"string | null"}},"required":["code","message"],"title":"ErrorBody","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorBody · object"}},"required":["error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","field":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"No such screening for this key","exampleType":"generated"},"60a50493-7a1c-47a5-a585-5d456fd39db6":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"error":{"additionalProperties":false,"properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"field":{"oneOf":[{"type":"string","title":"Field","uniqueKey":"error.field.oneOf.0","typeLabel":"string"},{"type":"null","title":"Field","uniqueKey":"error.field.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.field","typeLabel":"string | null"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.request_id","typeLabel":"string | null"}},"required":["code","message"],"title":"ErrorBody","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorBody · object"}},"required":["error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","field":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"The request_key was used with a different body","exampleType":"generated"},"3de0e3cb-78af-4663-91e0-34542e71947f":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"error":{"additionalProperties":false,"properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"field":{"oneOf":[{"type":"string","title":"Field","uniqueKey":"error.field.oneOf.0","typeLabel":"string"},{"type":"null","title":"Field","uniqueKey":"error.field.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.field","typeLabel":"string | null"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.request_id","typeLabel":"string | null"}},"required":["code","message"],"title":"ErrorBody","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorBody · object"}},"required":["error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","field":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"The body exceeds 64 KB","exampleType":"generated"},"552ee995-caaa-474f-9964-43e019b46b8f":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"error":{"additionalProperties":false,"properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"field":{"oneOf":[{"type":"string","title":"Field","uniqueKey":"error.field.oneOf.0","typeLabel":"string"},{"type":"null","title":"Field","uniqueKey":"error.field.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.field","typeLabel":"string | null"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.request_id","typeLabel":"string | null"}},"required":["code","message"],"title":"ErrorBody","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorBody · object"}},"required":["error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","field":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Too many requests, or the daily screening limit is reached","exampleType":"generated"},"5e3228ad-782b-490d-a2e7-4b9fb7f2c926":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"error":{"additionalProperties":false,"properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"field":{"oneOf":[{"type":"string","title":"Field","uniqueKey":"error.field.oneOf.0","typeLabel":"string"},{"type":"null","title":"Field","uniqueKey":"error.field.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.field","typeLabel":"string | null"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.request_id","typeLabel":"string | null"}},"required":["code","message"],"title":"ErrorBody","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorBody · object"}},"required":["error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","field":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"A required service is unavailable","exampleType":"generated"}},"security":{"a00bd0f7-6c01-4a93-a2db-7c0e86b7e51a":{"HTTPBearer":{"description":"Send the API key as a Bearer token.","scheme":"bearer","type":"http","scopes":[],"schemeName":"HTTPBearer"}}},"servers":{"06c15be1-ce92-431d-9845-b6248bdfbe66":{"url":"https://api.safely.bio"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"Send the API key as a Bearer token.","scheme":"bearer","type":"http","scopes":[],"schemeName":"HTTPBearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Send the API key as a Bearer token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"HTTPBearer","name":"Authorization"}],"title":"HTTPBearer"}]},"originalFileLocation":"openapi.json"},"subdomain":"safely-bio","siteName":"safely.bio Customer Screening API","title":"Start screening a customer - safely.bio Customer Screening API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-02T03:38:35.400Z","originalFileLocation":"api-reference/screenings/start-screening-a-customer.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns 202 with a pending screening, or 200 with the saved screening for a retry with the same request_key and body.\">\u003cmeta data-mint-head name=\"application-name\" content=\"safely.bio Customer Screening API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/safely-bio/Zd2UsBBibyoUeWMY/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/safely-bio/Zd2UsBBibyoUeWMY/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/safely-bio/Zd2UsBBibyoUeWMY/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/safely-bio/Zd2UsBBibyoUeWMY/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/safely-bio/Zd2UsBBibyoUeWMY/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/safely-bio/Zd2UsBBibyoUeWMY/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/safely-bio/Zd2UsBBibyoUeWMY/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/safely-bio/Zd2UsBBibyoUeWMY/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/safely-bio/Zd2UsBBibyoUeWMY/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Start screening a customer - safely.bio Customer Screening API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns 202 with a pending screening, or 200 with the saved screening for a retry with the same request_key and body.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"safely.bio Customer Screening API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.safely.bio/api-reference/screenings/start-screening-a-customer\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://safely-bio.mintlify.app/_mintlify/api/og/v2?division=Screenings\u0026amp;title=Start+screening+a+customer\u0026amp;description=Returns+202+with+a+pending+screening%2C+or+200+with+the+saved+screening+for+a+retry+with+the+same+request_key+and+body.\u0026amp;theme=20236ec35a605f9dc1878517\u0026amp;signature=84ddc859733ccafa3dc07fc1207ae41010ebb9acf558e5c89322af808b5a575f\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Start screening a customer - safely.bio Customer Screening API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns 202 with a pending screening, or 200 with the saved screening for a retry with the same request_key and body.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://safely-bio.mintlify.app/_mintlify/api/og/v2?division=Screenings\u0026amp;title=Start+screening+a+customer\u0026amp;description=Returns+202+with+a+pending+screening%2C+or+200+with+the+saved+screening+for+a+retry+with+the+same+request_key+and+body.\u0026amp;theme=20236ec35a605f9dc1878517\u0026amp;signature=84ddc859733ccafa3dc07fc1207ae41010ebb9acf558e5c89322af808b5a575f\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/safely-bio/Zd2UsBBibyoUeWMY/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"safely.bio Customer Screening API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#009988\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.safely.bio/api-reference/screenings/start-screening-a-customer\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/screenings/start-screening-a-customer.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.safely.bio/#organization\",\"name\":\"safely.bio Customer Screening API\",\"url\":\"https://docs.safely.bio\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/safely-bio/9LDIcxEByg07LomV/logo/light.svg?fit=max\u0026auto=format\u0026n=9LDIcxEByg07LomV\u0026q=85\u0026s=5f4f31b65d8671a6f66e33f9494597b1\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.safely.bio#website\",\"name\":\"safely.bio Customer Screening API\",\"url\":\"https://docs.safely.bio\",\"publisher\":{\"@id\":\"https://docs.safely.bio/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.safely.bio/api-reference/screenings/start-screening-a-customer#webpage\",\"url\":\"https://docs.safely.bio/api-reference/screenings/start-screening-a-customer\",\"name\":\"Start screening a customer\",\"description\":\"Returns 202 with a pending screening, or 200 with the saved screening for a retry with the same request_key and body.\",\"dateModified\":\"2026-11-02T03:38:35.400Z\",\"isPartOf\":{\"@id\":\"https://docs.safely.bio#website\"},\"breadcrumb\":{\"@id\":\"https://docs.safely.bio/api-reference/screenings/start-screening-a-customer#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.safely.bio/api-reference/screenings/start-screening-a-customer#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"safely.bio Customer Screening API\",\"item\":\"https://docs.safely.bio\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Start screening a customer\",\"item\":\"https://docs.safely.bio/api-reference/screenings/start-screening-a-customer\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.safely.bio/api-reference/screenings/start-screening-a-customer#apireference\",\"headline\":\"Start screening a customer\",\"name\":\"Start screening a customer\",\"description\":\"Returns 202 with a pending screening, or 200 with the saved screening for a retry with the same request_key and body.\",\"url\":\"https://docs.safely.bio/api-reference/screenings/start-screening-a-customer\",\"mainEntityOfPage\":{\"@id\":\"https://docs.safely.bio/api-reference/screenings/start-screening-a-customer#webpage\"},\"dateModified\":\"2026-11-02T03:38:35.400Z\",\"publisher\":{\"@id\":\"https://docs.safely.bio/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.safely.bio#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"safely.bio Customer Screening API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"safely.bio Customer Screening API","nav":{"global":null,"tabs":[{"tab":"Guide","pages":[{"title":"Guide","href":""}]},{"tab":"API reference","groups":[{"group":"Screenings","pages":[{"title":"Start screening a customer","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/screenings","href":"/api-reference/screenings/start-screening-a-customer"},{"title":"Retrieve a screening","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /v1/screenings/{screening_id}","href":"/api-reference/screenings/retrieve-a-screening"},{"title":"Record the provider's decision","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/screenings/{screening_id}/decision","href":"/api-reference/screenings/record-the-providers-decision"}]}]}]},"basePath":"","title":"Start screening a customer - safely.bio Customer Screening API","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}