{
"data": null,
"error": {
"code": "ORG_NOT_VERIFIED_LIMIT_EXCEEDED",
"message": "Unverified organizations are limited to 5 identity-revealing sessions per 24 hours.",
"hint": "Verify the organization in the platform settings, or wait until the rolling window resets. Age-gate-only sessions remain available.",
"docs": "https://kayle.id/docs/api/sessions#create"
}
}
{
"data": null,
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error.",
"hint": "The server encountered an error.",
"docs": "https://kayle.id/docs/api/errors"
}
}
{
"data": null,
"error": {
"code": "ORG_NOT_VERIFIED_LIMIT_EXCEEDED",
"message": "Unverified organizations are limited to 5 identity-revealing sessions per 24 hours.",
"hint": "Verify the organization in the platform settings, or wait until the rolling window resets. Age-gate-only sessions remain available.",
"docs": "https://kayle.id/docs/api/sessions#create"
}
}
{
"data": null,
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error.",
"hint": "The server encountered an error.",
"docs": "https://kayle.id/docs/api/errors"
}
}
Optional URL to redirect the user to after the verification session is completed. Must use https:// (http:// is only accepted for localhost in development).
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Kayle ID","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/kayleinc/OvKCFmIJ536peVZx/logo/light.svg?fit=max\u0026auto=format\u0026n=OvKCFmIJ536peVZx\u0026q=85\u0026s=e29929fe0af035a7d1d096a194c61b37","dark":"https://mintcdn.com/kayleinc/OvKCFmIJ536peVZx/logo/dark.svg?fit=max\u0026auto=format\u0026n=OvKCFmIJ536peVZx\u0026q=85\u0026s=f2f0060e6fc31e3d9a36af63935d5262"},"favicon":"https://mintcdn.com/kayleinc/OvKCFmIJ536peVZx/favicon.svg?fit=max\u0026auto=format\u0026n=OvKCFmIJ536peVZx\u0026q=85\u0026s=759a0ef74eb34e1d7ba32ae89687f1d6","navbar":{"links":[{"icon":"github","href":"https://github.com/KayleAI/kayle-id","label":"GitHub"}],"primary":{"type":"button","label":"Dashboard","href":"https://kayle.id"}},"footer":{"socials":{"x":"https://x.com/kaylehq","github":"https://github.com/KayleAI","linkedin":"https://linkedin.com/company/kayleai"}},"fonts":{"family":"Inter"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"kayleinc","hasAudioNarration":false,"actualSubdomain":"kayleinc","customDomains":["docs.kayle.id"],"gitSource":{"type":"github","owner":"kayleai","repo":"kayle-id-v1","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21ddf3ab250d2c4881b8eb","collectionId":"58e297b8-c44e-48bf-8229-0df4e37849ff","schemaVersion":"v2"},"feedback":{"thumbs":false},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6a21ddf3ab250d2c4881b8eb:success","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"API reference","count":59},{"language":"default","tag":"Endpoints","count":53},{"language":"default","tag":"Webhooks","count":24},{"language":"default","tag":"Organizations","count":20},{"language":"default","tag":"Guides","count":16},{"language":"default","tag":"Verifications","count":5},{"language":"default","tag":"Webhook events","count":4},{"language":"default","tag":"API Keys","count":4},{"language":"default","tag":"Sessions","count":4},{"language":"default","tag":"Webhook payloads","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"per-site-search-delta","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":"editor-private-page-search","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":"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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/sessions/create-a-new-verification-session","slug":"/api-reference/sessions/create-a-new-verification-session","pageMetadata":{"title":"Create a new verification session","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/sessions","href":"/api-reference/sessions/create-a-new-verification-session","autogeneratedByOpenApi":true},"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":"Create a new verification session","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/sessions","href":"/api-reference/sessions/create-a-new-verification-session","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Sessions"],"summary":"Create a new verification session","security":["c1d36e06-b804-4b0b-b955-b1084b378f8b"],"requestBody":"3d6f8eca-7ead-4d9d-bfce-29ae4bf9bd2b","responses":{"200":"bbf57822-6106-418f-b3e5-976500373dd4","400":"ca31858c-e72e-4bb9-8830-bfac5f417627","410":"9835dcc7-d838-4a54-8e25-8bcf6c496269","429":"36895cdb-997e-464c-9690-f53406a2612e","500":"e59466c3-a4dd-41b5-ae92-7ed7ebb08048"},"method":"post","type":"path","servers":["a489d2c3-e750-4c13-bfa6-dedb37f10408"],"path":"/v1/sessions","baseUrlOptions":["http://127.0.0.1:8787"],"title":"Create a new verification session","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"redirect_url":{"type":"string","maxLength":2048,"description":"Optional URL to redirect the user to after the verification session is completed. Must use https:// (http:// is only accepted for localhost in development).","uniqueKey":"redirect_url","typeLabel":"string"},"share_fields":{"type":"object","additionalProperties":{"type":"object","properties":{"required":{"type":"boolean","description":"Whether this field is required by the RC.","isRequired":true,"uniqueKey":"share_fields.additionalProperties.required","typeLabel":"boolean"},"reason":{"type":"string","maxLength":200,"description":"Human-readable reason for requesting this field. Required for most claims; may be empty for an `age_over_X` claim when `date_of_birth` is also requested in the same session.","isRequired":true,"uniqueKey":"share_fields.additionalProperties.reason","typeLabel":"string"}},"required":["required","reason"],"uniqueKey":"share_fields.additionalProperties","typeLabel":"object"},"description":"Optional map of requested share fields keyed by claim key. Each entry must include `required` (boolean) and `reason` (non-empty string, max 200).","uniqueKey":"share_fields","typeLabel":"object"},"webhook_endpoint_id":{"oneOf":[{"type":"string","description":"Optional webhook endpoint ID or endpoint ID list to target for this session. When omitted, events fan out to every enabled subscribed endpoint.","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$","uniqueKey":"webhook_endpoint_id.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_-]+$","uniqueKey":"webhook_endpoint_id.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"Optional webhook endpoint ID or endpoint ID list to target for this session. When omitted, events fan out to every enabled subscribed endpoint.","maxItems":25,"minItems":1,"uniqueKey":"webhook_endpoint_id.oneOf.1","typeLabel":"string[]"}],"uniqueKey":"webhook_endpoint_id","typeLabel":"string | string[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"redirect_url":"\u003cstring>","share_fields":{},"webhook_endpoint_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"bbf57822-6106-418f-b3e5-976500373dd4":{"description":"Successful operation. Returns the newly created verification session.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the verification session","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"status":{"type":"string","enum":["created","in_progress","succeeded","failed","expired","cancelled"],"description":"The status of the verification session","isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"failure_code":{"oneOf":[{"type":"string","enum":["document_authenticity_failed","document_active_authentication_failed","document_chip_authentication_failed","document_anti_cloning_attestation_failed","document_data_invalid","liveness_failed","selfie_face_mismatch"],"description":"Terminal failure code when status='failed'. Null in any other state.","isRequired":true,"uniqueKey":"data.failure_code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["document_authenticity_failed","document_active_authentication_failed","document_chip_authentication_failed","document_anti_cloning_attestation_failed","document_data_invalid","liveness_failed","selfie_face_mismatch"],"description":"Terminal failure code when status='failed'. Null in any other state.","isRequired":true,"uniqueKey":"data.failure_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.failure_code","typeLabel":"enum\u003cstring> | null"},"nfc_tries_used":{"type":"integer","minimum":0,"maximum":3,"description":"Number of NFC chip-read failures the session has consumed. The session terminalizes on the 3rd failure.","isRequired":true,"uniqueKey":"data.nfc_tries_used","typeLabel":"integer"},"liveness_tries_used":{"type":"integer","minimum":0,"maximum":3,"description":"Number of liveness check failures the session has consumed. The session terminalizes on the 3rd failure.","isRequired":true,"uniqueKey":"data.liveness_tries_used","typeLabel":"integer"},"contract_version":{"type":"integer","description":"Version of the session share contract.","isRequired":true,"uniqueKey":"data.contract_version","typeLabel":"integer"},"share_fields":{"type":"object","additionalProperties":{"type":"object","properties":{"required":{"type":"boolean","description":"Whether this field must always be shared.","isRequired":true,"uniqueKey":"data.share_fields.additionalProperties.required","typeLabel":"boolean"},"reason":{"type":"string","description":"Reason shown to the user for this field.","isRequired":true,"uniqueKey":"data.share_fields.additionalProperties.reason","typeLabel":"string"},"source":{"type":"string","enum":["default","rc"],"description":"Whether the field came from defaults or RC request.","isRequired":true,"uniqueKey":"data.share_fields.additionalProperties.source","typeLabel":"enum\u003cstring>"}},"required":["required","reason","source"],"uniqueKey":"data.share_fields.additionalProperties","typeLabel":"object"},"description":"Effective normalized share fields used by this session.","isRequired":true,"uniqueKey":"data.share_fields","typeLabel":"object"},"redirect_url":{"oneOf":[{"type":"string","description":"The URL to redirect to after the verification session is completed, if provided by the integrator.","isRequired":true,"uniqueKey":"data.redirect_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL to redirect to after the verification session is completed, if provided by the integrator.","isRequired":true,"uniqueKey":"data.redirect_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.redirect_url","typeLabel":"string | null"},"webhook_endpoint_id":{"oneOf":[{"type":"string","description":"The webhook endpoint or endpoint list selected for this session, or null when events fan out to all enabled subscribed endpoints.","isRequired":true,"uniqueKey":"data.webhook_endpoint_id.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"data.webhook_endpoint_id.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"The webhook endpoint or endpoint list selected for this session, or null when events fan out to all enabled subscribed endpoints.","isRequired":true,"uniqueKey":"data.webhook_endpoint_id.oneOf.1","typeLabel":"string[]"},{"type":"null","description":"The webhook endpoint or endpoint list selected for this session, or null when events fan out to all enabled subscribed endpoints.","isRequired":true,"uniqueKey":"data.webhook_endpoint_id.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.webhook_endpoint_id","typeLabel":"string | string[] | null"},"verification_url":{"type":"string","format":"uri","description":"The URL that the platform should send the user to in order to complete the verification. Includes the one-shot `cancel_token` as a query parameter so the verify browser / native app can pass it back when cancelling.","isRequired":true,"uniqueKey":"data.verification_url","typeLabel":"string\u003curi>"},"expires_at":{"type":"string","description":"The expiration time of the verification session","isRequired":true,"uniqueKey":"data.expires_at","typeLabel":"string"},"completed_at":{"oneOf":[{"type":"string","description":"The time the verification session reached a terminal state (i.e., succeeded, failed, expired or cancelled), or null if not yet terminal.","isRequired":true,"uniqueKey":"data.completed_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"The time the verification session reached a terminal state (i.e., succeeded, failed, expired or cancelled), or null if not yet terminal.","isRequired":true,"uniqueKey":"data.completed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.completed_at","typeLabel":"string | null"},"created_at":{"type":"string","description":"The time the verification session was created","isRequired":true,"uniqueKey":"data.created_at","typeLabel":"string"},"updated_at":{"type":"string","description":"The time the verification session was last updated","isRequired":true,"uniqueKey":"data.updated_at","typeLabel":"string"},"cancel_token":{"type":"string","description":"One-shot token required by `POST /v1/verify/session/:id/cancel`. Returned only on session creation.","uniqueKey":"data.cancel_token","typeLabel":"string"}},"required":["id","status","failure_code","nfc_tries_used","liveness_tries_used","contract_version","share_fields","redirect_url","webhook_endpoint_id","verification_url","expires_at","completed_at","created_at","updated_at"],"examples":[{"id":"vs_mza7vecksrtyfw193ekcvl5vnws3bt1lz96buu3iw7zidckf8dga2zx2echb3t16","status":"created","failure_code":null,"nfc_tries_used":0,"liveness_tries_used":0,"contract_version":1,"share_fields":{"document_type_code":{"required":false,"reason":"Needed to know the document type code","source":"rc"},"date_of_birth":{"required":true,"reason":"Needed to verify age eligibility","source":"rc"},"kayle_document_id":{"required":true,"reason":"Sharing \"Kayle Document ID\"","source":"default"}},"redirect_url":"https://example.com/redirect","webhook_endpoint_id":null,"verification_url":"https://verify.kayle.id/vs_mza7vecksrtyfw193ekcvl5vnws3bt1lz96buu3iw7zidckf8dga2zx2echb3t16","expires_at":"2025-01-01T00:00:00Z","completed_at":null,"created_at":"2025-01-01T00:00:00Z","updated_at":"2025-01-01T00:00:00Z"}],"isRequired":true,"uniqueKey":"data","typeLabel":"object"},"error":{"type":"null","isRequired":true,"uniqueKey":"error","typeLabel":"null"}},"required":["data","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"vs_mza7vecksrtyfw193ekcvl5vnws3bt1lz96buu3iw7zidckf8dga2zx2echb3t16","status":"created","failure_code":null,"nfc_tries_used":0,"liveness_tries_used":0,"contract_version":1,"share_fields":{"document_type_code":{"required":false,"reason":"Needed to know the document type code","source":"rc"},"date_of_birth":{"required":true,"reason":"Needed to verify age eligibility","source":"rc"},"kayle_document_id":{"required":true,"reason":"Sharing \"Kayle Document ID\"","source":"default"}},"redirect_url":"https://example.com/redirect","webhook_endpoint_id":null,"verification_url":"https://verify.kayle.id/vs_mza7vecksrtyfw193ekcvl5vnws3bt1lz96buu3iw7zidckf8dga2zx2echb3t16","expires_at":"2025-01-01T00:00:00Z","completed_at":null,"created_at":"2025-01-01T00:00:00Z","updated_at":"2025-01-01T00:00:00Z"},"error":null}}},"exampleType":"generated"}},"exampleType":"generated"},"ca31858c-e72e-4bb9-8830-bfac5f417627":{"description":"Bad request.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null","description":"Empty data object.","isRequired":true,"uniqueKey":"data","typeLabel":"null"},"error":{"oneOf":[{"type":"object","properties":{"code":{"type":"string","description":"The error code","isRequired":true,"uniqueKey":"error.oneOf.0.code","typeLabel":"string"},"message":{"type":"string","description":"The error message","isRequired":true,"uniqueKey":"error.oneOf.0.message","typeLabel":"string"},"hint":{"type":"string","description":"A hint to help the user fix the error","isRequired":true,"uniqueKey":"error.oneOf.0.hint","typeLabel":"string"},"docs":{"type":"string","description":"A link to the documentation for the error","isRequired":true,"uniqueKey":"error.oneOf.0.docs","typeLabel":"string"}},"required":["code","message","hint","docs"],"isRequired":true,"uniqueKey":"error.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"code":{"type":"string","description":"The error code"},"message":{"type":"string","description":"The error message"},"hint":{"type":"string","description":"A hint to help the user fix the error"},"docs":{"type":"string","description":"A link to the documentation for the error"}},"required":["code","message","hint","docs"],"isRequired":true,"uniqueKey":"error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error","typeLabel":"object | null"}},"required":["data","error"],"example":{"data":null,"error":{"code":"UNKNOWN_CLAIM_KEY","message":"Unknown claim key.","hint":"Use a supported claim key from the share contract allowlist.","docs":"https://kayle.id/docs/api/sessions#create"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":null,"error":{"code":"UNKNOWN_CLAIM_KEY","message":"Unknown claim key.","hint":"Use a supported claim key from the share contract allowlist.","docs":"https://kayle.id/docs/api/sessions#create"}}}},"exampleType":"generated"}},"exampleType":"generated"},"9835dcc7-d838-4a54-8e25-8bcf6c496269":{"description":"Organization is scheduled for deletion.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null","description":"Empty data object.","isRequired":true,"uniqueKey":"data","typeLabel":"null"},"error":{"oneOf":[{"type":"object","properties":{"code":{"type":"string","description":"The error code","isRequired":true,"uniqueKey":"error.oneOf.0.code","typeLabel":"string"},"message":{"type":"string","description":"The error message","isRequired":true,"uniqueKey":"error.oneOf.0.message","typeLabel":"string"},"hint":{"type":"string","description":"A hint to help the user fix the error","isRequired":true,"uniqueKey":"error.oneOf.0.hint","typeLabel":"string"},"docs":{"type":"string","description":"A link to the documentation for the error","isRequired":true,"uniqueKey":"error.oneOf.0.docs","typeLabel":"string"}},"required":["code","message","hint","docs"],"isRequired":true,"uniqueKey":"error.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"code":{"type":"string","description":"The error code"},"message":{"type":"string","description":"The error message"},"hint":{"type":"string","description":"A hint to help the user fix the error"},"docs":{"type":"string","description":"A link to the documentation for the error"}},"required":["code","message","hint","docs"],"isRequired":true,"uniqueKey":"error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error","typeLabel":"object | null"}},"required":["data","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":null,"error":{"code":"\u003cstring>","message":"\u003cstring>","hint":"\u003cstring>","docs":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"36895cdb-997e-464c-9690-f53406a2612e":{"description":"Unverified organization has exceeded the rolling 24h session limit.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null","description":"Empty data object.","isRequired":true,"uniqueKey":"data","typeLabel":"null"},"error":{"oneOf":[{"type":"object","properties":{"code":{"type":"string","description":"The error code","isRequired":true,"uniqueKey":"error.oneOf.0.code","typeLabel":"string"},"message":{"type":"string","description":"The error message","isRequired":true,"uniqueKey":"error.oneOf.0.message","typeLabel":"string"},"hint":{"type":"string","description":"A hint to help the user fix the error","isRequired":true,"uniqueKey":"error.oneOf.0.hint","typeLabel":"string"},"docs":{"type":"string","description":"A link to the documentation for the error","isRequired":true,"uniqueKey":"error.oneOf.0.docs","typeLabel":"string"}},"required":["code","message","hint","docs"],"isRequired":true,"uniqueKey":"error.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"code":{"type":"string","description":"The error code"},"message":{"type":"string","description":"The error message"},"hint":{"type":"string","description":"A hint to help the user fix the error"},"docs":{"type":"string","description":"A link to the documentation for the error"}},"required":["code","message","hint","docs"],"isRequired":true,"uniqueKey":"error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error","typeLabel":"object | null"}},"required":["data","error"],"example":{"data":null,"error":{"code":"ORG_NOT_VERIFIED_LIMIT_EXCEEDED","message":"Unverified organizations are limited to 5 identity-revealing sessions per 24 hours.","hint":"Verify the organization in the platform settings, or wait until the rolling window resets. Age-gate-only sessions remain available.","docs":"https://kayle.id/docs/api/sessions#create"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":null,"error":{"code":"ORG_NOT_VERIFIED_LIMIT_EXCEEDED","message":"Unverified organizations are limited to 5 identity-revealing sessions per 24 hours.","hint":"Verify the organization in the platform settings, or wait until the rolling window resets. Age-gate-only sessions remain available.","docs":"https://kayle.id/docs/api/sessions#create"}}}},"exampleType":"generated"}},"exampleType":"generated"},"e59466c3-a4dd-41b5-ae92-7ed7ebb08048":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null","isRequired":true,"uniqueKey":"data","typeLabel":"null"},"error":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_SERVER_ERROR"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","enum":["Internal server error."],"isRequired":true,"uniqueKey":"error.message","typeLabel":"enum\u003cstring>"},"hint":{"type":"string","enum":["The server encountered an error."],"isRequired":true,"uniqueKey":"error.hint","typeLabel":"enum\u003cstring>"},"docs":{"type":"string","enum":["https://kayle.id/docs/api/errors"],"isRequired":true,"uniqueKey":"error.docs","typeLabel":"enum\u003cstring>"}},"required":["code","message","hint","docs"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["data","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":null,"error":{"code":"INTERNAL_SERVER_ERROR","message":"Internal server error.","hint":"The server encountered an error.","docs":"https://kayle.id/docs/api/errors"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"c1d36e06-b804-4b0b-b955-b1084b378f8b":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{"a489d2c3-e750-4c13-bfa6-dedb37f10408":{"url":"http://127.0.0.1:8787","description":""}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"kayleinc","siteName":"Kayle ID","title":"Create a new verification session - Kayle ID","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-21T19:28:17.977Z","originalFileLocation":"api-reference/sessions/create-a-new-verification-session.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=\"system\"}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=\"application-name\" content=\"Kayle ID\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/kayleinc/KTaRBTrVnYkcklFO/_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/kayleinc/KTaRBTrVnYkcklFO/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/kayleinc/KTaRBTrVnYkcklFO/_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/kayleinc/KTaRBTrVnYkcklFO/_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/kayleinc/KTaRBTrVnYkcklFO/_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/kayleinc/KTaRBTrVnYkcklFO/_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/kayleinc/KTaRBTrVnYkcklFO/_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/kayleinc/KTaRBTrVnYkcklFO/_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/kayleinc/KTaRBTrVnYkcklFO/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a new verification session - Kayle ID\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Kayle ID\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.kayle.id/api-reference/sessions/create-a-new-verification-session\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://kayleinc.mintlify.app/_mintlify/api/og/v2?division=Sessions\u0026amp;title=Create+a+new+verification+session\u0026amp;theme=e3c641c517497b291cbab776\u0026amp;signature=4600f0796e4e0ee261c77d953f1e357e632f818b2e3b357cad3638f032bb907f\">\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=\"Create a new verification session - Kayle ID\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://kayleinc.mintlify.app/_mintlify/api/og/v2?division=Sessions\u0026amp;title=Create+a+new+verification+session\u0026amp;theme=e3c641c517497b291cbab776\u0026amp;signature=4600f0796e4e0ee261c77d953f1e357e632f818b2e3b357cad3638f032bb907f\">\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/kayleinc/KTaRBTrVnYkcklFO/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Kayle ID\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.kayle.id/api-reference/sessions/create-a-new-verification-session\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/sessions/create-a-new-verification-session.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.kayle.id/#organization\",\"name\":\"Kayle ID\",\"url\":\"https://docs.kayle.id\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/kayleinc/OvKCFmIJ536peVZx/logo/light.svg?fit=max\u0026auto=format\u0026n=OvKCFmIJ536peVZx\u0026q=85\u0026s=e29929fe0af035a7d1d096a194c61b37\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.kayle.id#website\",\"name\":\"Kayle ID\",\"url\":\"https://docs.kayle.id\",\"publisher\":{\"@id\":\"https://docs.kayle.id/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.kayle.id/api-reference/sessions/create-a-new-verification-session#webpage\",\"url\":\"https://docs.kayle.id/api-reference/sessions/create-a-new-verification-session\",\"name\":\"Create a new verification session\",\"dateModified\":\"2026-05-21T19:28:17.977Z\",\"isPartOf\":{\"@id\":\"https://docs.kayle.id#website\"},\"breadcrumb\":{\"@id\":\"https://docs.kayle.id/api-reference/sessions/create-a-new-verification-session#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.kayle.id/api-reference/sessions/create-a-new-verification-session#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.kayle.id/api-reference/account/list-organisations-the-caller-is-the-sole-owner-of\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Sessions\",\"item\":\"https://docs.kayle.id/api-reference/sessions/list-all-sessions\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a new verification session\",\"item\":\"https://docs.kayle.id/api-reference/sessions/create-a-new-verification-session\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.kayle.id/api-reference/sessions/create-a-new-verification-session#apireference\",\"headline\":\"Create a new verification session\",\"name\":\"Create a new verification session\",\"url\":\"https://docs.kayle.id/api-reference/sessions/create-a-new-verification-session\",\"mainEntityOfPage\":{\"@id\":\"https://docs.kayle.id/api-reference/sessions/create-a-new-verification-session#webpage\"},\"dateModified\":\"2026-05-21T19:28:17.977Z\",\"publisher\":{\"@id\":\"https://docs.kayle.id/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.kayle.id#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Kayle ID\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Kayle ID","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Introduction","pages":[{"title":"API introduction","icon":"circle-info","href":"/api-reference/introduction"},{"title":"Errors","icon":"circle-exclamation","href":"/api-reference/errors"}]},{"group":"Endpoints","pages":[{"group":"Account","pages":[{"title":"List organisations the caller is the sole owner of","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/auth/account/owned-organizations","href":"/api-reference/account/list-organisations-the-caller-is-the-sole-owner-of"}]},{"group":"API Keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/auth/api-keys","href":"/api-reference/api-keys/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/auth/api-keys","href":"/api-reference/api-keys/create-an-api-key"},{"title":"Delete an API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/auth/api-keys/{id}","href":"/api-reference/api-keys/delete-an-api-key"},{"title":"Update an API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/auth/api-keys/{id}","href":"/api-reference/api-keys/update-an-api-key"}]},{"group":"Organizations","pages":[{"title":"Create an organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/auth/orgs","href":"/api-reference/organizations/create-an-organization"},{"title":"Upload an organization logo","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/auth/orgs/logo","href":"/api-reference/organizations/upload-an-organization-logo"},{"title":"Request deletion of an organization. Sends an 8-character confirmation code to the requesting owner.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/auth/orgs/request-delete","href":"/api-reference/organizations/request-deletion-of-an-organization-sends-an-8-character-confirmation-code-to-the-requesting-owner"},{"title":"Confirm a previously requested organization deletion using the 8-character code emailed to the requester. Schedules hard delete 48 hours out.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/auth/orgs/confirm-delete","href":"/api-reference/organizations/confirm-a-previously-requested-organization-deletion-using-the-8-character-code-emailed-to-the-requester-schedules-hard-delete-48-hours-out"},{"title":"Cancel a scheduled organization deletion. Owners or admins of the organization may cancel.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/auth/orgs/cancel-delete","href":"/api-reference/organizations/cancel-a-scheduled-organization-deletion-owners-or-admins-of-the-organization-may-cancel"},{"title":"Record that an owner has accepted the organization verification terms.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/auth/orgs/accept-verification-terms","href":"/api-reference/organizations/record-that-an-owner-has-accepted-the-organization-verification-terms"},{"title":"Update the self-asserted business details (legal name, jurisdiction, registration number) for the active organization.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/auth/orgs/business-details","href":"/api-reference/organizations/update-the-self-asserted-business-details-legal-name-jurisdiction-registration-number-for-the-active-organization"},{"title":"Start a DNS-based domain verification challenge.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/auth/orgs/domains/challenges/dns","href":"/api-reference/organizations/start-a-dns-based-domain-verification-challenge"},{"title":"Poll a DNS challenge — verifies the TXT record is in place.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/auth/orgs/domains/challenges/dns/verify","href":"/api-reference/organizations/poll-a-dns-challenge-—-verifies-the-txt-record-is-in-place"},{"title":"List verified domains and active challenges for the active org.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/auth/orgs/domains","href":"/api-reference/organizations/list-verified-domains-and-active-challenges-for-the-active-org"},{"title":"Revoke a verified domain.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/auth/orgs/domains/{id}","href":"/api-reference/organizations/revoke-a-verified-domain"},{"title":"List the redirect URI allowlist for the active organization.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/auth/orgs/redirect-uris","href":"/api-reference/organizations/list-the-redirect-uri-allowlist-for-the-active-organization"},{"title":"Register a redirect URI on a verified domain.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/auth/orgs/redirect-uris","href":"/api-reference/organizations/register-a-redirect-uri-on-a-verified-domain"},{"title":"Remove a redirect URI from the allowlist.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/auth/orgs/redirect-uris/{id}","href":"/api-reference/organizations/remove-a-redirect-uri-from-the-allowlist"},{"title":"List audit-log entries for the active organization. Owner/admin only.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/auth/orgs/audit-logs","href":"/api-reference/organizations/list-audit-log-entries-for-the-active-organization-owneradmin-only"},{"title":"Suspend a member of the active organization. The membership row is preserved so audit-log entries can keep attributing past actions to the user; only an owner/admin can act, and the last active owner cannot be suspended.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/auth/orgs/members/{id}","href":"/api-reference/organizations/suspend-a-member-of-the-active-organization-the-membership-row-is-preserved-so-audit-log-entries-can-keep-attributing-past-actions-to-the-user;-only-an-owneradmin-can-act-and-the-last-active-owner-cannot-be-suspended"},{"title":"Leave the active organization. The caller's membership is suspended (not deleted) so audit attribution is preserved. The last active owner cannot leave.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/auth/orgs/members/leave","href":"/api-reference/organizations/leave-the-active-organization-the-callers-membership-is-suspended-not-deleted-so-audit-attribution-is-preserved-the-last-active-owner-cannot-leave"},{"title":"Reinstate a previously-suspended member of the active organization. Only an owner/admin can act.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/auth/orgs/members/{id}/reinstate","href":"/api-reference/organizations/reinstate-a-previously-suspended-member-of-the-active-organization-only-an-owneradmin-can-act"},{"title":"Get the active organization's current relying-party integration terms status.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/auth/orgs/rp-terms","href":"/api-reference/organizations/get-the-active-organizations-current-relying-party-integration-terms-status"},{"title":"Record that an owner accepted the current relying-party integration terms.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/auth/orgs/rp-terms","href":"/api-reference/organizations/record-that-an-owner-accepted-the-current-relying-party-integration-terms"}]},{"group":"Analytics","pages":[{"title":"Get organization session analytics overview","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/analytics/sessions/overview","href":"/api-reference/analytics/get-organization-session-analytics-overview"}]},{"group":"Webhooks","pages":[{"title":"Get a webhook event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/events/{event_id}","href":"/api-reference/webhooks/get-a-webhook-event"},{"title":"List webhook events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/events","href":"/api-reference/webhooks/list-webhook-events"},{"title":"Replay a webhook event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/events/{event_id}/replay","href":"/api-reference/webhooks/replay-a-webhook-event"},{"title":"List webhook deliveries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhooks/deliveries","href":"/api-reference/webhooks/list-webhook-deliveries"},{"title":"Retry a webhook delivery","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhooks/deliveries/{delivery_id}/retry","href":"/api-reference/webhooks/retry-a-webhook-delivery"},{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhooks/endpoints","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhooks/endpoints","href":"/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"List webhook encryption keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhooks/endpoints/{endpoint_id}/keys","href":"/api-reference/webhooks/list-webhook-encryption-keys"},{"title":"Create a webhook encryption key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhooks/endpoints/{endpoint_id}/keys","href":"/api-reference/webhooks/create-a-webhook-encryption-key"},{"title":"Reveal a webhook endpoint signing secret","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhooks/endpoints/{endpoint_id}/signing-secret/reveal","href":"/api-reference/webhooks/reveal-a-webhook-endpoint-signing-secret"},{"title":"Rotate a webhook endpoint signing secret","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhooks/endpoints/{endpoint_id}/signing-secret/rotate","href":"/api-reference/webhooks/rotate-a-webhook-endpoint-signing-secret"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhooks/endpoints/{endpoint_id}","href":"/api-reference/webhooks/get-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/webhooks/endpoints/{endpoint_id}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/webhooks/endpoints/{endpoint_id}","href":"/api-reference/webhooks/update-a-webhook-endpoint"},{"title":"Get a webhook event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhooks/events/{event_id}","href":"/api-reference/webhooks/get-a-webhook-event-1"},{"title":"List webhook events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhooks/events","href":"/api-reference/webhooks/list-webhook-events-1"},{"title":"Replay a webhook event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhooks/events/{event_id}/replay","href":"/api-reference/webhooks/replay-a-webhook-event-1"},{"title":"Deactivate a webhook encryption key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhooks/keys/{key_id}/deactivate","href":"/api-reference/webhooks/deactivate-a-webhook-encryption-key"},{"title":"Reactivate a webhook encryption key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhooks/keys/{key_id}/reactivate","href":"/api-reference/webhooks/reactivate-a-webhook-encryption-key"}]},{"group":"Sessions","pages":[{"title":"List all sessions","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/sessions","href":"/api-reference/sessions/list-all-sessions"},{"title":"Create a new verification session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/sessions","href":"/api-reference/sessions/create-a-new-verification-session"},{"title":"Get a session by ID","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/sessions/{id}","href":"/api-reference/sessions/get-a-session-by-id"},{"title":"Cancel a session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/sessions/{id}/cancel","href":"/api-reference/sessions/cancel-a-session"}]},{"group":"Webhook payloads","pages":[{"title":"Verificationsessionsucceeded payload","version":null,"deprecated":null,"openapi":"/api-reference/openapi.json webhook verification.session.succeeded","href":"/api-reference/webhook-payloads/verificationsessionsucceeded-payload"},{"title":"Verificationsessionfailed payload","version":null,"deprecated":null,"openapi":"/api-reference/openapi.json webhook verification.session.failed","href":"/api-reference/webhook-payloads/verificationsessionfailed-payload"},{"title":"Verificationsessionexpired payload","version":null,"deprecated":null,"openapi":"/api-reference/openapi.json webhook verification.session.expired","href":"/api-reference/webhook-payloads/verificationsessionexpired-payload"},{"title":"Verificationsessioncancelled payload","version":null,"deprecated":null,"openapi":"/api-reference/openapi.json webhook verification.session.cancelled","href":"/api-reference/webhook-payloads/verificationsessioncancelled-payload"}]}]},{"group":"Webhook events","pages":[{"title":"verification.session.succeeded","href":"/api-reference/webhooks/verification-session-succeeded"},{"title":"verification.session.failed","href":"/api-reference/webhooks/verification-session-failed"},{"title":"verification.session.expired","href":"/api-reference/webhooks/verification-session-expired"},{"title":"verification.session.cancelled","href":"/api-reference/webhooks/verification-session-cancelled"}]}]}]},"title":"Create a new verification session - Kayle ID","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}