{ "error": "validation_error", "message": "The given data was invalid.", "details": { "redirect_url": ["The redirect url must be a valid URL."], "document_type": ["The selected document type is invalid."] }}
429 Too Many Requests
{ "error": "rate_limit_exceeded", "message": "Too many requests. Please retry after 30 seconds.", "details": { "retry_after": 30 }}
Every response includes an X-Request-Id header. Always include this when contacting support about a specific error.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Verilock","colors":{"primary":"#6D28D9","light":"#8B5CF6","dark":"#4C1D95"},"favicon":"/favicon.png","logo":{"light":"https://mintcdn.com/verilock/bwVOMsXFy9iNfdcg/logo/light.png?fit=max\u0026auto=format\u0026n=bwVOMsXFy9iNfdcg\u0026q=85\u0026s=b8876563ec4edc501d7a46231f8d03f2","dark":"https://mintcdn.com/verilock/bwVOMsXFy9iNfdcg/logo/dark.png?fit=max\u0026auto=format\u0026n=bwVOMsXFy9iNfdcg\u0026q=85\u0026s=bf16e43e48de0bf11b3b8111e37ba27c","href":"https://verilock.io"},"api":{"mdx":{"server":"https://verilock.io/api/v1","auth":{"method":"bearer","name":null}}},"appearance":{"default":"dark","strict":false},"background":{"decoration":null,"color":{"light":null,"dark":"#0B0F1A"}},"navbar":{"links":[{"label":"Support","href":"mailto:support@verilock.io"},{"label":"Dashboard","href":"https://verilock.io/dashboard"}],"primary":{"type":"button","label":"Get API Key","href":"https://verilock.io/dashboard/api-keys"}},"seo":{"indexing":"navigable"},"footer":{"socials":{"website":"https://verilock.io","linkedin":"https://linkedin.com/company/verilock","x":"https://x.com/verilock"}},"integrations":{},"fonts":{"heading":{"family":"Inter","weight":700},"body":{"family":"Inter","weight":400}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Changelog","href":"https://verilock.io/changelog","icon":"list"},{"anchor":"Community","href":"https://discord.gg/verilock","icon":"discord"},{"anchor":"Status","href":"https://status.verilock.io","icon":"signal-bars"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"verilock","hasAudioNarration":false,"actualSubdomain":"verilock","customDomains":["developer.verilock.io"],"gitSource":{"type":"gitlab","owner":"duvaneck","repo":"verilock-docs","projectId":80292100,"deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21db8b271fd09fad7d5212","collectionId":"44074c66-9289-4a1f-87f6-71e49baab33e","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21db8b271fd09fad7d5212:success","clientVersion":"0.0.3894","searchFilterCounts":[{"language":"default","tag":"Documentation","count":44},{"language":"default","tag":"SDKs","count":20},{"language":"default","tag":"Self-Hosted","count":14},{"language":"default","tag":"Integrations","count":11},{"language":"default","tag":"Verification Enhancements","count":8},{"language":"default","tag":"API Reference","count":7},{"language":"default","tag":"KYC Verification","count":7},{"language":"default","tag":"Transaction Monitoring","count":6},{"language":"default","tag":"Data \u0026 Compliance","count":5},{"language":"default","tag":"Decentralized Identity","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"editor-branches-v2-autocommit","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2","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":"teamspace","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","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":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"client-snapshot-docs-config","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"reference/response-codes","slug":"/reference/response-codes","pageMetadata":{"title":"Response Codes","description":"HTTP status codes returned by the Verilock API.","icon":"circle-check","href":"/reference/response-codes"},"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: \"HTTP status codes returned by the Verilock API.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`The Verilock API uses standard HTTP status codes. `,_jsx(_components.strong,{children:`2xx`}),` = success, `,_jsx(_components.strong,{children:`4xx`}),` = client error, `,_jsx(_components.strong,{children:`5xx`}),` = server error.`]}),`\n`,_jsx(Heading,{level:`2`,id:`success-codes`,children:`Success Codes`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Name`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`200`})}),_jsx(_components.td,{children:`OK`}),_jsx(_components.td,{children:`Request succeeded. Response body contains the requested data.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`201`})}),_jsx(_components.td,{children:`Created`}),_jsx(_components.td,{children:`Resource successfully created (sessions, API keys, webhooks).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`204`})}),_jsx(_components.td,{children:`No Content`}),_jsx(_components.td,{children:`Request succeeded with no response body (DELETE operations).`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`client-error-codes`,children:`Client Error Codes`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Name`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:`Bad Request`}),_jsx(_components.td,{children:`Malformed request body, missing fields, or invalid JSON.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`401`})}),_jsx(_components.td,{children:`Unauthorized`}),_jsx(_components.td,{children:`API key is missing, invalid, or revoked.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsx(_components.td,{children:`Forbidden`}),_jsx(_components.td,{children:`Valid key but insufficient permissions. Check your plan or key scopes.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:`Not Found`}),_jsx(_components.td,{children:`Resource does not exist. Verify endpoint URL and resource ID.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:`Conflict`}),_jsx(_components.td,{children:`State conflict (e.g., approving an already-declined session).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`422`})}),_jsx(_components.td,{children:`Unprocessable Entity`}),_jsxs(_components.td,{children:[`Well-formed request with semantic errors. See `,_jsx(_components.code,{children:`details`}),` for field-level messages.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`429`})}),_jsx(_components.td,{children:`Too Many Requests`}),_jsxs(_components.td,{children:[`Rate limit exceeded. Respect the `,_jsx(_components.code,{children:`Retry-After`}),` header.`]})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`server-error-codes`,children:`Server Error Codes`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Name`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`500`})}),_jsx(_components.td,{children:`Internal Server Error`}),_jsxs(_components.td,{children:[`Unexpected error on our end. Include `,_jsx(_components.code,{children:`X-Request-Id`}),` when contacting support.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`503`})}),_jsx(_components.td,{children:`Service Unavailable`}),_jsx(_components.td,{children:`Temporary unavailability. Retry with exponential backoff.`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`error-response-format`,children:`Error Response Format`}),`\n`,_jsx(_components.p,{children:`All errors return a consistent JSON structure:`}),`\n`,_jsx(CodeBlock,{filename:`422 Unprocessable Entity`,numberOfLines:`8`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`8`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"validation_error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"The given data was invalid.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"details\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"redirect_url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"The redirect url must be a valid URL.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"document_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"The selected document type is invalid.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(CodeBlock,{filename:`429 Too Many Requests`,numberOfLines:`7`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`7`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"rate_limit_exceeded\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Too many requests. Please retry after 30 seconds.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"details\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"retry_after\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`30`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`Every response includes an `,_jsx(_components.code,{children:`X-Request-Id`}),` header. Always include this when contacting support about a specific error.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Response Codes","description":"HTTP status codes returned by the Verilock API.","icon":"circle-check","href":"/reference/response-codes"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Success Codes","slug":"success-codes","depth":2,"children":[]},{"title":"Client Error Codes","slug":"client-error-codes","depth":2,"children":[]},{"title":"Server Error Codes","slug":"server-error-codes","depth":2,"children":[]},{"title":"Error Response Format","slug":"error-response-format","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"verilock","siteName":"Verilock","title":"Response Codes - Verilock","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-03-16T13:37:07.871Z","originalFileLocation":"reference/response-codes.mdx"},"headHtml":"\u003cmeta data-mint-head name=\"description\" content=\"HTTP status codes returned by the Verilock API.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Verilock\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/verilock/3rzLZFHSYd1f1GWn/_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/verilock/3rzLZFHSYd1f1GWn/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/verilock/3rzLZFHSYd1f1GWn/_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/verilock/3rzLZFHSYd1f1GWn/_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/verilock/3rzLZFHSYd1f1GWn/_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/verilock/3rzLZFHSYd1f1GWn/_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/verilock/3rzLZFHSYd1f1GWn/_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/verilock/3rzLZFHSYd1f1GWn/_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/verilock/3rzLZFHSYd1f1GWn/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Response Codes - Verilock\">\u003cmeta data-mint-head property=\"og:description\" content=\"HTTP status codes returned by the Verilock API.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Verilock\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.verilock.io/reference/response-codes\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Response Codes - Verilock\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"HTTP status codes returned by the Verilock API.\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/verilock/3rzLZFHSYd1f1GWn/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Verilock\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6D28D9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.verilock.io/reference/response-codes\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/response-codes.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.verilock.io/#organization\",\"name\":\"Verilock\",\"url\":\"https://developer.verilock.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/verilock/bwVOMsXFy9iNfdcg/logo/light.png?fit=max\u0026auto=format\u0026n=bwVOMsXFy9iNfdcg\u0026q=85\u0026s=b8876563ec4edc501d7a46231f8d03f2\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.verilock.io#website\",\"name\":\"Verilock\",\"url\":\"https://developer.verilock.io\",\"publisher\":{\"@id\":\"https://developer.verilock.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.verilock.io/reference/response-codes#webpage\",\"url\":\"https://developer.verilock.io/reference/response-codes\",\"name\":\"Response Codes\",\"description\":\"HTTP status codes returned by the Verilock API.\",\"dateModified\":\"2026-03-16T13:37:07.871Z\",\"isPartOf\":{\"@id\":\"https://developer.verilock.io#website\"},\"breadcrumb\":{\"@id\":\"https://developer.verilock.io/reference/response-codes#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.verilock.io/reference/response-codes#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Verilock\",\"item\":\"https://developer.verilock.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Response Codes\",\"item\":\"https://developer.verilock.io/reference/response-codes\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://developer.verilock.io/reference/response-codes#article\",\"headline\":\"Response Codes\",\"name\":\"Response Codes\",\"description\":\"HTTP status codes returned by the Verilock API.\",\"url\":\"https://developer.verilock.io/reference/response-codes\",\"mainEntityOfPage\":{\"@id\":\"https://developer.verilock.io/reference/response-codes#webpage\"},\"dateModified\":\"2026-03-16T13:37:07.871Z\",\"publisher\":{\"@id\":\"https://developer.verilock.io/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.verilock.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Verilock\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Verilock","nav":{"global":{"anchors":[{"anchor":"Changelog","href":"https://verilock.io/changelog","icon":"list"},{"anchor":"Community","href":"https://discord.gg/verilock","icon":"discord"},{"anchor":"Status","href":"https://status.verilock.io","icon":"signal-bars"}]},"tabs":[{"tab":"Documentation","groups":[{"group":"Getting Started","pages":[{"title":"Verilock API","sidebarTitle":"Introduction","icon":"bolt","href":"/getting-started/introduction"},{"title":"Authentication","icon":"key","href":"/getting-started/authentication"},{"title":"Base URL \u0026 Versioning","sidebarTitle":"Base URL","icon":"globe","href":"/getting-started/base-url"},{"title":"API Keys","icon":"lock","href":"/getting-started/api-keys"}]},{"group":"Integrations","pages":[{"title":"Integrations","icon":"puzzle-piece","href":"/integrations/overview"},{"title":"Webhooks","icon":"webhook","href":"/integrations/webhooks"},{"title":"Slack","icon":"slack","href":"/integrations/slack"},{"title":"Jira","icon":"jira","href":"/integrations/jira"},{"title":"ServiceNow","icon":"ticket","href":"/integrations/servicenow"},{"title":"Zapier","icon":"bolt","href":"/integrations/zapier"},{"title":"WordPress \u0026 WooCommerce","icon":"wordpress","href":"/integrations/wordpress"},{"title":"Shopify","icon":"shopify","href":"/integrations/shopify"},{"title":"Salesforce","icon":"salesforce","href":"/integrations/salesforce"},{"title":"Auth Engine","icon":"fingerprint","href":"/integrations/auth-engine"},{"title":"Chainalysis","description":"Screen cryptocurrency wallets for risk with Chainalysis KYT.","icon":"link","href":"/integrations/chainalysis"}]},{"group":"Reference","pages":[{"title":"Response Codes","icon":"circle-check","href":"/reference/response-codes"},{"title":"Error Handling","description":"Handle Verilock API errors gracefully with structured error responses.","icon":"triangle-exclamation","href":"/reference/errors"},{"title":"Risk Score Engine","icon":"gauge-high","href":"/reference/risk-scoring"},{"title":"Embeddable Widget","icon":"window-maximize","href":"/reference/widget"}]},{"group":"AML Screening","pages":[{"title":"Screen Person","api":"POST /aml/screen","href":"/aml-screening/screen-person"},{"title":"Get AML Result","api":"GET /aml/screen/{id}","href":"/aml-screening/get-result"},{"title":"AML Decision","api":"POST /aml/screen/{id}/decision","href":"/aml-screening/submit-decision"}]},{"group":"Transaction Monitoring","pages":[{"title":"Transaction Types","api":"GET /transactions/types","href":"/transaction-monitoring/list-types"},{"title":"Screen Transaction","api":"POST /transactions/screen","href":"/transaction-monitoring/screen-transaction"},{"title":"Batch Screening","api":"POST /transactions/screen/batch","href":"/transaction-monitoring/batch-screening"},{"title":"List Transactions","api":"GET /transactions","href":"/transaction-monitoring/list-transactions"},{"title":"Get Transaction","api":"GET /transactions/{id}","href":"/transaction-monitoring/get-transaction"},{"title":"Transaction Decision","api":"POST /transactions/{id}/decision","href":"/transaction-monitoring/submit-decision"}]},{"group":"Verification Enhancements","pages":[{"title":"Active Liveness","icon":"face-viewfinder","api":"POST /sessions/{id}/liveness-challenge","href":"/premium-features/active-liveness"},{"title":"Biometric Authentication","api":"POST /auth/biometric","href":"/premium-features/biometric-auth"},{"title":"Face Search (1:N)","api":"POST /face-search","href":"/premium-features/face-search"},{"title":"Video KYC","icon":"video","api":"POST /sessions/{id}/video","href":"/premium-features/video-kyc"},{"title":"Document Fraud Detection","icon":"file-shield","href":"/premium-features/document-fraud-detection"},{"title":"Device Fingerprinting","icon":"fingerprint","api":"POST /sessions/{id}/device-fingerprint","href":"/premium-features/device-fingerprinting"},{"title":"Behavioral Biometrics","icon":"hand-pointer","href":"/premium-features/behavioral-biometrics"},{"title":"Ambient Verification","icon":"satellite-dish","href":"/premium-features/ambient-verification"}]},{"group":"Data \u0026 Compliance","pages":[{"title":"Age Verification","api":"POST /age-verify","href":"/premium-features/age-verification"},{"title":"Database Validation","api":"POST /database/validate","href":"/premium-features/database-validation"},{"title":"Address Extraction","icon":"location-dot","href":"/premium-features/address-extraction"},{"title":"Continuous AML Monitoring","icon":"radar","href":"/premium-features/continuous-monitoring"},{"title":"Orchestration Rules","icon":"diagram-project","href":"/premium-features/orchestration-rules"}]},{"group":"Decentralized Identity","pages":[{"title":"Reusable KYC Credentials","api":"POST /credentials","href":"/premium-features/reusable-kyc"},{"title":"Zero-Knowledge Proofs","icon":"lock-keyhole","api":"POST /zkp/prove","href":"/premium-features/zero-knowledge-proofs"},{"title":"Identity Graph","icon":"circle-nodes","href":"/premium-features/identity-graph"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/kyc-sessions/create-session"}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/sdks/overview"}]},{"tab":"Decentralized Identity","pages":[{"title":"Decentralized Identity","href":"/premium-features/verifiable-credentials"}]},{"tab":"Self-Hosted","pages":[{"title":"Self-Hosted","href":"/self-hosted/overview"}]}]},"title":"Response Codes - Verilock","buildId":"dpl_8LJVMfxYNq6LJkohTrn2iyWT8umj","deploymentId":"dpl_8LJVMfxYNq6LJkohTrn2iyWT8umj","dynamics":[],"chunks":[]}