{
"status": "failed",
"message": "Authentication credentials were not provided."
}
Verify a customer’s Canadian passport by uploading a photo of the data page — no manual passport number entry required. We read the details and compare the face on the document with a selfie. No liveness check is needed.See Supported countries for every country you can verify passports from.
Passport is single-sided — only document_front is needed.
selfie_image is required — the face extracted from the document is compared against it. This is a still-image comparison (not liveness).
The country that issued the passport, as a two-letter country code: "CA"
data.expiry_date
string
Passport expiry date
data.is_expired
boolean
Always false on a 200. An expired document fails the check (see Expired documents)
data.photo
string
Base64-encoded face photo extracted from the document
data.extra_fields
object
Other details read from the data page — place_of_birth, issuing_authority, nin (if embedded), and mrz_line1/mrz_line2 if the machine-readable zone was legible, exactly as printed
data.face_match
object
Result of comparing the document’s face against selfie_image — see below
data.face_match.attempted
boolean
Whether a comparison was actually run
data.face_match.verified
boolean | null
true/false if the comparison ran; null if it couldn’t (see Face Match Notes)
data.face_match.decision
string
"MATCH" or "NO_MATCH"
data.face_match.confidence_percentage
number
Match confidence, 0–100
data.face_match.compare_mode
string
"COMPARISON_NO_LIVENESS" means the two photos were compared without a liveness check
Face Match Notes — if the comparison service itself fails, attempted reflects whether a comparison was actually run and verified comes back null with a reason field explaining why — this is different from verified: false, which means the comparison ran and the faces didn’t match. A face-match problem never blocks the underlying document data — the rest of data is still returned.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/schema.json","name":"Adhere by Smartcomply","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/smartcomply-f420ec6b/jv92DPiviz1ucERE/logo/adhere-logo.png?fit=max\u0026auto=format\u0026n=jv92DPiviz1ucERE\u0026q=85\u0026s=728c06a1bc2c8bb258aa32e95598d984","dark":"https://mintcdn.com/smartcomply-f420ec6b/jv92DPiviz1ucERE/logo/adhere-logo-dark.png?fit=max\u0026auto=format\u0026n=jv92DPiviz1ucERE\u0026q=85\u0026s=7f344999eff7e329fb404dabcc810f20"},"favicon":"https://mintcdn.com/smartcomply-f420ec6b/jv92DPiviz1ucERE/logo/adhere-logo.png?fit=max\u0026auto=format\u0026n=jv92DPiviz1ucERE\u0026q=85\u0026s=728c06a1bc2c8bb258aa32e95598d984","navbar":{"links":[{"href":"https://docs.adhere.smartcomply.com/changelog","label":"What's New"},{"href":"https://documenter.getpostman.com/view/55164637/2sBXwjxET7","label":"Postman Collection"},{"href":"https://docs.adhere.smartcomply.com/pages/support","label":"Get Help"}],"primary":{"type":"button","label":"Dashboard","href":"https://adhere-app.smartcomply.com"}},"banner":{"content":"Adhere v3 is live — faster identity verification across Nigeria, Ghana, Kenya, Rwanda \u0026 Uganda. [Explore what's new →](/introduction)","dismissible":true},"metadata":{"timestamp":false},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":"introduction"},{"language":"fr","href":"fr/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"smartcomply-f420ec6b","hasAudioNarration":false,"actualSubdomain":"smartcomply-f420ec6b","customDomains":["docs.smartcomply.com"],"gitSource":{"type":"github","owner":"anitajallas","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6af28e49f307e97d77e8410a","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"en","tag":"API Reference","count":186},{"language":"en","tag":"Onboarding Suite","count":130},{"language":"en","tag":"KYC","count":92},{"language":"fr","tag":"Référence API","count":84},{"language":"en","tag":"Nigeria","count":77},{"language":"fr","tag":"Suite d'intégration","count":59},{"language":"en","tag":"Credit Report","count":43},{"language":"fr","tag":"KYC","count":43},{"language":"fr","tag":"Nigeria","count":33},{"language":"en","tag":"Individual","count":32},{"language":"en","tag":"Fraud \u0026 Transaction Monitoring","count":31},{"language":"en","tag":"Data Verification","count":28},{"language":"fr","tag":"Vérification des données","count":28},{"language":"en","tag":"Kenya","count":22},{"language":"fr","tag":"Rapport de crédit","count":15},{"language":"en","tag":"Document Verification","count":12},{"language":"fr","tag":"Vérification de documents","count":12},{"language":"fr","tag":"Kenya","count":11},{"language":"fr","tag":"Individuel","count":11},{"language":"fr","tag":"Fraude et surveillance des transactions","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"rbac-expansion","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":"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":"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":"editor-metadata","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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"v3/kyc/document_verification/canada/Passport","slug":"/v3/kyc/document_verification/canada/Passport","pageMetadata":{"title":"Passport","sidebarTitle":"Passport","description":"Extract identity details from a Canadian passport.","openapi":"POST /api/onboarding/document_verification/canada/passport","href":"/v3/kyc/document_verification/canada/Passport"},"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: \"Extract identity details from a Canadian passport.\"\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={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Heading,Note,Table,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Verify a customer’s Canadian passport by uploading a photo of the data page — no manual passport number entry required. We read the details and compare the face on the document with a selfie. No liveness check is needed.`}),`\n`,_jsxs(_components.p,{children:[`See `,_jsx(_components.a,{href:`/v3/kyc/document_verification/global/Passport#supported-countries`,children:`Supported countries`}),` for every country you can verify passports from.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Passport is single-sided — only `,_jsx(_components.code,{children:`document_front`}),` is needed.`]})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`selfie_image`}),` is required — the face extracted from the document is compared against it. This is a still-image comparison (not liveness).`]})}),`\n`,_jsx(Heading,{level:`2`,id:`endpoint`,children:`Endpoint`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,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:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`POST /api/onboarding/document_verification/canada/passport`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`2`,id:`request`,children:`Request`}),`\n`,_jsx(Heading,{level:`3`,id:`headers`,children:`Headers`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Header`}),_jsx(_components.th,{children:`Value`}),_jsx(_components.th,{children:`Required`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`x-access-token`})}),_jsx(_components.td,{children:`Your API secret key`}),_jsx(_components.td,{children:`Yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`Content-Type`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`multipart/form-data`})}),_jsx(_components.td,{children:`Yes`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`body-parameters`,children:`Body Parameters`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Parameter`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Required`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`document_front`})}),_jsx(_components.td,{children:`file`}),_jsx(_components.td,{children:`Yes`}),_jsx(_components.td,{children:`Photo of the passport data page. JPG, PNG or single-page PDF, max 10MB`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`selfie_image`})}),_jsx(_components.td,{children:`file`}),_jsx(_components.td,{children:`Yes`}),_jsx(_components.td,{children:`A selfie to compare against the document’s face photo. JPG or PNG, max 5MB`})]})]})]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`A scanned document can be uploaded as a single-page PDF, for example `,_jsx(_components.code,{children:`-F \"document_front=@/path/to/scan.pdf\"`}),`.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`example`,children:`Example`}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`4`,language:`shellscript`,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:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://adhere-api.smartcomply.com/api/onboarding/document_verification/canada/passport\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"x-access-token: YOUR_SECRET_KEY\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -F`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"document_front=@/path/to/passport.jpg\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -F`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"selfie_image=@/path/to/selfie.jpg\"`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Node.js`,numberOfLines:`13`,language:`javascript`,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:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`13`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` formData`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` new`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` FormData`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`();`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`formData`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`append`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"document_front\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`fs`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`createReadStream`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/path/to/passport.jpg\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`));`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`formData`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`append`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"selfie_image\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`fs`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`createReadStream`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/path/to/selfie.jpg\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`));`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` fetch`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://adhere-api.smartcomply.com/api/onboarding/document_verification/canada/passport\"`}),_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`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` method:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"POST\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` headers:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"x-access-token\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"YOUR_SECRET_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` body:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` formData`}),_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`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` data`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` response`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`json`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`();`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Python`,numberOfLines:`11`,language:`python`,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:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`11`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`response `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests.post(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://adhere-api.smartcomply.com/api/onboarding/document_verification/canada/passport\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` headers`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"x-access-token\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"YOUR_SECRET_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` files`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"document_front\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`open`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/path/to/passport.jpg\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"rb\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`),`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"selfie_image\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`open`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/path/to/selfie.jpg\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"rb\"`}),_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`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`data `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` response.json()`})]}),`\n`]})})})]}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(Heading,{level:`3`,id:`200-ok`,children:`200 OK`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`status`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`\"success\"`}),` on a successful extraction`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`data.full_name`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Extracted full name`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`data.first_name`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Extracted first name`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`data.last_name`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Extracted last name`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`data.date_of_birth`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`Date of birth in `,_jsx(_components.code,{children:`YYYY-MM-DD`}),` format`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`data.gender`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Extracted gender`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`data.nationality`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Extracted nationality`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`data.id_number`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`The passport number`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`data.document_type`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`\"passport\"`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`data.document_country`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`The country that issued the passport, as a two-letter country code: `,_jsx(_components.code,{children:`\"CA\"`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`data.expiry_date`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Passport expiry date`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`data.is_expired`})}),_jsx(_components.td,{children:`boolean`}),_jsxs(_components.td,{children:[`Always `,_jsx(_components.code,{children:`false`}),` on a 200. An expired document fails the check (see `,_jsx(_components.a,{href:`#expired-documents`,children:`Expired documents`}),`)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`data.photo`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Base64-encoded face photo extracted from the document`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`data.extra_fields`})}),_jsx(_components.td,{children:`object`}),_jsxs(_components.td,{children:[`Other details read from the data page — `,_jsx(_components.code,{children:`place_of_birth`}),`, `,_jsx(_components.code,{children:`issuing_authority`}),`, `,_jsx(_components.code,{children:`nin`}),` (if embedded), and `,_jsx(_components.code,{children:`mrz_line1`}),`/`,_jsx(_components.code,{children:`mrz_line2`}),` if the machine-readable zone was legible, exactly as printed`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`data.face_match`})}),_jsx(_components.td,{children:`object`}),_jsxs(_components.td,{children:[`Result of comparing the document’s face against `,_jsx(_components.code,{children:`selfie_image`}),` — see below`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`data.face_match.attempted`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`Whether a comparison was actually run`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`data.face_match.verified`})}),_jsx(_components.td,{children:`boolean | null`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`true`}),`/`,_jsx(_components.code,{children:`false`}),` if the comparison ran; `,_jsx(_components.code,{children:`null`}),` if it couldn’t (see Face Match Notes)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`data.face_match.decision`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`\"MATCH\"`}),` or `,_jsx(_components.code,{children:`\"NO_MATCH\"`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`data.face_match.confidence_percentage`})}),_jsx(_components.td,{children:`number`}),_jsx(_components.td,{children:`Match confidence, 0–100`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`data.face_match.compare_mode`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`\"COMPARISON_NO_LIVENESS\"`}),` means the two photos were compared without a liveness check`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`data.face_match.selfie_image`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`URL of the uploaded selfie`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`message`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Human-readable result summary`})]})]})]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`31`,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:`31`,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:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"success\"`}),_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:` \"data\"`}),_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:` \"valid\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_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:` \"first_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"JAMES\"`}),_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:` \"last_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"TREMBLAY\"`}),_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:` \"full_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"TREMBLAY JAMES\"`}),_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:` \"date_of_birth\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"1988-07-22\"`}),_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:` \"gender\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"M\"`}),_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:` \"nationality\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"CANADIAN\"`}),_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:` \"id_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"GA123456\"`}),_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:`\"passport\"`}),_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_country\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"CA\"`}),_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:` \"expiry_date\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2027-09-30\"`}),_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:` \"is_expired\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_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:` \"photo\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/9j/4AAQSkZJRgABAQAAAQABAAD...\"`}),_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:` \"extra_fields\"`}),_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:` \"place_of_birth\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"TORONTO, ON\"`}),_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:` \"issuing_authority\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"GATINEAU, QC\"`})]}),`\n`,_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:` \"face_match\"`}),_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:` \"attempted\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_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:` \"verified\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_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:` \"decision\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"MATCH\"`}),_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:` \"confidence_percentage\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`92.4`}),_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:` \"compare_mode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"COMPARISON_NO_LIVENESS\"`}),_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:` \"selfie_image\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://.../selfie.jpg\"`})]}),`\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`,_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:`\"Document details retrieved successfully\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Face Match Notes`}),` — if the comparison service itself fails, `,_jsx(_components.code,{children:`attempted`}),` reflects whether a comparison was actually run and `,_jsx(_components.code,{children:`verified`}),` comes back `,_jsx(_components.code,{children:`null`}),` with a `,_jsx(_components.code,{children:`reason`}),` field explaining why — this is different from `,_jsx(_components.code,{children:`verified: false`}),`, which means the comparison ran and the faces didn’t match. A face-match problem never blocks the underlying document data — the rest of `,_jsx(_components.code,{children:`data`}),` is still returned.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`400-bad-request`,children:`400 Bad Request`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,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:`5`,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:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"failed\"`}),_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:` \"data\"`}),_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:`\"ID photo is too blurry — please retake in good lighting with a steady hand\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`expired-documents`,children:`Expired documents`}),`\n`,_jsxs(_components.p,{children:[`An expired passport fails the check. The extracted details are still returned in `,_jsx(_components.code,{children:`data`}),`, with `,_jsx(_components.code,{children:`is_expired: true`}),`:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`10`,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:`10`,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:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"failed\"`}),_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:` \"data\"`}),_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:`\"passport\"`}),_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_country\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"CA\"`}),_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:` \"expiry_date\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2021-08-15\"`}),_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:` \"is_expired\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`})]}),`\n`,_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:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Document Verification - Passport check failed: Document has expired.\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`401-unauthorized`,children:`401 Unauthorized`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,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:`4`,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:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"failed\"`}),_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:`\"Authentication credentials were not provided.\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`For a full list of error codes, see the `,_jsx(_components.a,{href:`/error_codes`,children:`Error Codes`}),` reference.`]})})]})}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":"Passport","sidebarTitle":"Passport","description":"Extract identity details from a Canadian passport.","openapi":"POST /api/onboarding/document_verification/canada/passport","href":"/v3/kyc/document_verification/canada/Passport"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Endpoint","slug":"endpoint","depth":2,"children":[]},{"title":"Request","slug":"request","depth":2,"children":[{"title":"Headers","slug":"headers","depth":3,"children":[]},{"title":"Body Parameters","slug":"body-parameters","depth":3,"children":[]},{"title":"Example","slug":"example","depth":3,"children":[]}]},{"title":"Response","slug":"response","depth":2,"children":[{"title":"200 OK","slug":"200-ok","depth":3,"children":[]},{"title":"400 Bad Request","slug":"400-bad-request","depth":3,"children":[]},{"title":"Expired documents","slug":"expired-documents","depth":3,"children":[]},{"title":"401 Unauthorized","slug":"401-unauthorized","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Document Verification"],"summary":"Document Verification — Canada Passport","operationId":"documentVerificationCanadaPassport","description":"Extract identity details from a Canadian passport.","requestBody":"2d35c682-7471-4e3f-83b0-40f1f9a62d82","responses":{"200":"8afcdaea-6c9f-4213-9ca8-4815309db41e","400":"5f5abc47-b349-42da-ac50-5bb52a643657","401":"e5285786-14ff-4dd5-8fbe-1c76d6aeaa66"},"method":"post","type":"path","servers":["4d594af0-162a-4f85-90a5-59769137c775"],"security":["0ff7b1c0-8eb4-4bcd-a861-868cb012a971"],"path":"/api/onboarding/document_verification/canada/passport","baseUrlOptions":["https://adhere-api.smartcomply.com"],"title":"Document Verification — Canada Passport","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["document_front"],"properties":{"document_front":{"type":"string","format":"binary","description":"Photo of the passport data page. JPG, PNG or single-page PDF, max 10MB.","isRequired":true,"uniqueKey":"document_front","typeLabel":"file"},"selfie_image":{"type":"string","format":"binary","description":"A selfie to compare against the face extracted from the document. JPG or PNG, max 5MB. Required.\n","uniqueKey":"selfie_image","typeLabel":"file"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"document_front":"\u003cstring>","selfie_image":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"8afcdaea-6c9f-4213-9ca8-4815309db41e":{"description":"Document details extracted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"success","uniqueKey":"status","typeLabel":"string"},"data":{"type":"object","properties":{"valid":{"type":"boolean","uniqueKey":"data.valid","typeLabel":"boolean"},"first_name":{"type":"string","uniqueKey":"data.first_name","typeLabel":"string"},"last_name":{"type":"string","uniqueKey":"data.last_name","typeLabel":"string"},"full_name":{"type":"string","uniqueKey":"data.full_name","typeLabel":"string"},"date_of_birth":{"type":"string","uniqueKey":"data.date_of_birth","typeLabel":"string"},"gender":{"type":"string","uniqueKey":"data.gender","typeLabel":"string"},"nationality":{"type":"string","uniqueKey":"data.nationality","typeLabel":"string"},"address":{"type":"string","uniqueKey":"data.address","typeLabel":"string"},"id_number":{"type":"string","uniqueKey":"data.id_number","typeLabel":"string"},"serial_number":{"type":"string","uniqueKey":"data.serial_number","typeLabel":"string"},"id_type":{"type":"string","uniqueKey":"data.id_type","typeLabel":"string"},"document_type":{"type":"string","uniqueKey":"data.document_type","typeLabel":"string"},"document_country":{"type":"string","description":"Passports only. The country that issued the passport, as an two-letter country code, for example RW.\n","uniqueKey":"data.document_country","typeLabel":"string"},"expiry_date":{"type":"string","uniqueKey":"data.expiry_date","typeLabel":"string"},"issue_date":{"type":"string","uniqueKey":"data.issue_date","typeLabel":"string"},"is_expired":{"type":"boolean","description":"Always false on a 200. An expired document fails the check with a 400; its details are still returned in data, with is_expired true.\n","uniqueKey":"data.is_expired","typeLabel":"boolean"},"photo":{"type":"string","description":"Base64-encoded face photo extracted from the document. Absent for document types with no face photo (cac_certificate, utility_bill).","uniqueKey":"data.photo","typeLabel":"string"},"extra_fields":{"type":"object","description":"Every other field read from the document that doesn't have its own dedicated field above. Varies by document_type and country.","uniqueKey":"data.extra_fields","typeLabel":"object"},"face_match":{"type":"object","description":"Present only when selfie_image was supplied.","properties":{"attempted":{"type":"boolean","uniqueKey":"data.face_match.attempted","typeLabel":"boolean"},"verified":{"oneOf":[{"type":"boolean","description":"true/false if the comparison ran; null if it couldn't (see reason).","uniqueKey":"data.face_match.verified.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"true/false if the comparison ran; null if it couldn't (see reason).","uniqueKey":"data.face_match.verified.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.face_match.verified","typeLabel":"boolean | null"},"decision":{"type":"string","enum":["MATCH","NO_MATCH"],"description":"The comparison's verdict.","uniqueKey":"data.face_match.decision","typeLabel":"enum\u003cstring>"},"confidence_percentage":{"type":"number","uniqueKey":"data.face_match.confidence_percentage","typeLabel":"number"},"compare_mode":{"type":"string","example":"COMPARISON_NO_LIVENESS","description":"COMPARISON_NO_LIVENESS: the two photos are compared; no liveness check is run on the selfie.\n","uniqueKey":"data.face_match.compare_mode","typeLabel":"string"},"selfie_image":{"type":"string","description":"URL of the uploaded selfie.","uniqueKey":"data.face_match.selfie_image","typeLabel":"string"},"reason":{"type":"string","description":"Present when verified is null — explains why the comparison couldn't run or complete.","uniqueKey":"data.face_match.reason","typeLabel":"string"}},"uniqueKey":"data.face_match","typeLabel":"object"}},"uniqueKey":"data","typeLabel":"object"},"message":{"type":"string","example":"Document details retrieved successfully","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"success","data":{"valid":true,"first_name":"\u003cstring>","last_name":"\u003cstring>","full_name":"\u003cstring>","date_of_birth":"\u003cstring>","gender":"\u003cstring>","nationality":"\u003cstring>","address":"\u003cstring>","id_number":"\u003cstring>","serial_number":"\u003cstring>","id_type":"\u003cstring>","document_type":"\u003cstring>","document_country":"\u003cstring>","expiry_date":"\u003cstring>","issue_date":"\u003cstring>","is_expired":true,"photo":"\u003cstring>","extra_fields":{},"face_match":{"attempted":true,"verified":true,"decision":"MATCH","confidence_percentage":123,"compare_mode":"COMPARISON_NO_LIVENESS","selfie_image":"\u003cstring>","reason":"\u003cstring>"}},"message":"Document details retrieved successfully"}}},"exampleType":"generated"}},"exampleType":"generated"},"5f5abc47-b349-42da-ac50-5bb52a643657":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"failed","uniqueKey":"status","typeLabel":"string"},"data":{"type":"array","items":{"oneOf":[{}],"uniqueKey":"data.items.[INDEX]","typeLabel":"any"},"uniqueKey":"data","typeLabel":"any[]"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"failed","data":["\u003cunknown>"],"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"e5285786-14ff-4dd5-8fbe-1c76d6aeaa66":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"failed","uniqueKey":"status","typeLabel":"string"},"message":{"type":"string","example":"Authentication credentials were not provided.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"failed","message":"Authentication credentials were not provided."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"0ff7b1c0-8eb4-4bcd-a861-868cb012a971":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-access-token","description":"Your Adhere API secret key","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"4d594af0-162a-4f85-90a5-59769137c775":{"url":"https://adhere-api.smartcomply.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-access-token","description":"Your Adhere API secret key","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-access-token","type":"string","description":"Your Adhere API secret key","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-access-token"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"smartcomply-f420ec6b","siteName":"Adhere by Smartcomply","title":"Passport - Adhere by Smartcomply","navMaps":{"firstHrefInVersion":{"v3":{"href":"/v3/kyc/document_verification/canada/Passport","matchLevel":0},"v2":{"href":"/introduction","matchLevel":2},"v1":{"href":"/introduction","matchLevel":2}},"firstHrefInLanguage":{"en":{"href":"/v3/kyc/document_verification/canada/Passport","matchLevel":0},"fr":{"href":"/fr/v3/kyc/document_verification/canada/Passport","matchLevel":1}}},"lastModified":"2026-10-19T09:42:05.812Z","originalFileLocation":"v3/kyc/document_verification/canada/Passport.mdx","locale":"en"},"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=\"description\" content=\"Extract identity details from a Canadian passport.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Adhere by Smartcomply\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/smartcomply-f420ec6b/noosT1oj8RDt5iYq/_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/smartcomply-f420ec6b/noosT1oj8RDt5iYq/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/smartcomply-f420ec6b/noosT1oj8RDt5iYq/_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/smartcomply-f420ec6b/noosT1oj8RDt5iYq/_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/smartcomply-f420ec6b/noosT1oj8RDt5iYq/_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/smartcomply-f420ec6b/noosT1oj8RDt5iYq/_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/smartcomply-f420ec6b/noosT1oj8RDt5iYq/_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/smartcomply-f420ec6b/noosT1oj8RDt5iYq/_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/smartcomply-f420ec6b/noosT1oj8RDt5iYq/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Passport - Adhere by Smartcomply\">\u003cmeta data-mint-head property=\"og:description\" content=\"Extract identity details from a Canadian passport.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Adhere by Smartcomply\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.smartcomply.com/v3/kyc/document_verification/canada/Passport\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://smartcomply-f420ec6b.mintlify.site/_mintlify/api/og/v2?division=Canada\u0026amp;title=Passport\u0026amp;description=Extract+identity+details+from+a+Canadian+passport.\u0026amp;theme=275165def0761b0b8fa8e21a\u0026amp;signature=af3aa5cef31bd10eeadc053a0b86e54ebf515cf150fd687eaef4d3491c6d850f\">\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=\"Passport - Adhere by Smartcomply\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Extract identity details from a Canadian passport.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://smartcomply-f420ec6b.mintlify.site/_mintlify/api/og/v2?division=Canada\u0026amp;title=Passport\u0026amp;description=Extract+identity+details+from+a+Canadian+passport.\u0026amp;theme=275165def0761b0b8fa8e21a\u0026amp;signature=af3aa5cef31bd10eeadc053a0b86e54ebf515cf150fd687eaef4d3491c6d850f\">\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/smartcomply-f420ec6b/noosT1oj8RDt5iYq/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Adhere by Smartcomply\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.smartcomply.com/v3/kyc/document_verification/canada/Passport\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v3/kyc/document_verification/canada/Passport.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.smartcomply.com/v3/kyc/document_verification/canada/Passport\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.smartcomply.com/fr/v3/kyc/document_verification/canada/Passport\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.smartcomply.com/v3/kyc/document_verification/canada/Passport\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.smartcomply.com/#organization\",\"name\":\"Adhere by Smartcomply\",\"url\":\"https://docs.smartcomply.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/smartcomply-f420ec6b/jv92DPiviz1ucERE/logo/adhere-logo.png?fit=max\u0026auto=format\u0026n=jv92DPiviz1ucERE\u0026q=85\u0026s=728c06a1bc2c8bb258aa32e95598d984\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.smartcomply.com#website\",\"name\":\"Adhere by Smartcomply\",\"url\":\"https://docs.smartcomply.com\",\"publisher\":{\"@id\":\"https://docs.smartcomply.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.smartcomply.com/v3/kyc/document_verification/canada/Passport#webpage\",\"url\":\"https://docs.smartcomply.com/v3/kyc/document_verification/canada/Passport\",\"name\":\"Passport\",\"description\":\"Extract identity details from a Canadian passport.\",\"dateModified\":\"2026-10-19T09:42:05.812Z\",\"isPartOf\":{\"@id\":\"https://docs.smartcomply.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.smartcomply.com/v3/kyc/document_verification/canada/Passport#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.smartcomply.com/v3/kyc/document_verification/canada/Passport#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.smartcomply.com/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Onboarding Suite\",\"item\":\"https://docs.smartcomply.com/v3/onboarding/introduction\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"KYC\",\"item\":\"https://docs.smartcomply.com/v3/kyc/nigeria/BVN\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Document Verification\",\"item\":\"https://docs.smartcomply.com/v3/kyc/document_verification/global/Passport\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Passport\",\"item\":\"https://docs.smartcomply.com/v3/kyc/document_verification/canada/Passport\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.smartcomply.com/v3/kyc/document_verification/canada/Passport#apireference\",\"headline\":\"Passport\",\"name\":\"Passport\",\"description\":\"Extract identity details from a Canadian passport.\",\"url\":\"https://docs.smartcomply.com/v3/kyc/document_verification/canada/Passport\",\"mainEntityOfPage\":{\"@id\":\"https://docs.smartcomply.com/v3/kyc/document_verification/canada/Passport#webpage\"},\"dateModified\":\"2026-10-19T09:42:05.812Z\",\"publisher\":{\"@id\":\"https://docs.smartcomply.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.smartcomply.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Adhere by Smartcomply\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Adhere by Smartcomply\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/v3/kyc/document_verification/canada/Passport.md","siteName":"Adhere by Smartcomply","nav":{"global":null,"languages":[{"language":"en","default":true,"versions":[{"version":"v3","groups":[{"group":"API Reference","pages":[{"group":"Get Started","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Quickstart","href":"/quickstart"},{"title":"Authentication","href":"/authentication"},{"title":"Error Codes","href":"/error_codes"},{"title":"Webhooks","href":"/webhooks"},{"title":"Changelog","sidebarTitle":"What's New","href":"/changelog"}]},{"group":"Common Use Cases","pages":[{"title":"Account \u0026 Identity Verification","sidebarTitle":"Account Verification","href":"/pages/account_verification"},{"title":"Lending \u0026 Loan Decisioning","sidebarTitle":"Lending","href":"/pages/lending"}]},{"group":"Libraries \u0026 Tools","pages":[{"title":"Web SDK","href":"/libraries/smartcomply_sdk"},{"title":"Android SDK","href":"/libraries/android_sdk"},{"title":"iOS SDK","href":"/libraries/ios_sdk"},{"title":"Postman Collection","sidebarTitle":"Postman Collection","href":"/libraries/postman"}]},{"group":"Biometrics","pages":[{"title":"Face Comparison","sidebarTitle":"Face Comparison","openapi":"POST /api/onboarding/biometrics/face/comparison","href":"/v3/biometrics/face_comparism"},{"title":"Face Liveness Check","sidebarTitle":"Face Liveness","openapi":"POST /api/onboarding/biometrics/face/liveliness_check/","href":"/v3/biometrics/face_liveliness"}]},{"group":"Onboarding Suite","pages":[{"group":"Customer Onboarding","pages":[{"title":"Customer Onboarding","sidebarTitle":"Overview","href":"/v3/onboarding/introduction"},{"title":"Verify Customer","sidebarTitle":"Verify Customer","openapi":"POST /api/onboarding/verify_customer","href":"/v3/onboarding/verify_customer"},{"title":"Get Onboarding Settings","sidebarTitle":"Get Settings","openapi":"GET /api/onboarding/settings","href":"/v3/onboarding/get_settings"},{"title":"Update Onboarding Settings","sidebarTitle":"Update Settings","openapi":"POST /api/onboarding/settings","href":"/v3/onboarding/update_settings"}]},{"group":"KYC","pages":[{"group":"Data Verification","pages":[{"group":"Nigeria","pages":[{"title":"Bank Verification Number (BVN)","sidebarTitle":"BVN","openapi":"POST /api/onboarding/nigeria_kyc/bvn/","href":"/v3/kyc/nigeria/BVN"},{"title":"Bank Verification Number Advanced (BVN)","sidebarTitle":"BVN Advanced","openapi":"POST /api/onboarding/nigeria_kyc/bvn_advanced/","href":"/v3/kyc/nigeria/BVN_Advanced"},{"title":"Corporate Affairs Commission (CAC)","sidebarTitle":"CAC","openapi":"POST /api/onboarding/nigeria_kyc/cac/","href":"/v3/kyc/nigeria/CAC"},{"title":"CAC Advanced","sidebarTitle":"CAC Advanced","openapi":"POST /api/onboarding/nigeria_kyc/cac_advanced/","href":"/v3/kyc/nigeria/CAC_Advanced"},{"title":"Company Tax ID","sidebarTitle":"Company Tax ID","openapi":"POST /api/onboarding/business/company_tax_id/","href":"/v3/kyc/nigeria/company_tax_id"},{"title":"Driver's License","sidebarTitle":"Driver's License","openapi":"POST /api/onboarding/nigeria_kyc/driver_license/","href":"/v3/kyc/nigeria/Drivers_License"},{"title":"National Identity Number (NIN)","sidebarTitle":"NIN","openapi":"POST /api/onboarding/nigeria_kyc/nin/","href":"/v3/kyc/nigeria/nin"},{"title":"NIN with Face","sidebarTitle":"NIN with Face","openapi":"POST /api/onboarding/nigeria_kyc/nin_with_face/","href":"/v3/kyc/nigeria/nin_with_face"},{"title":"NUBAN Verification","sidebarTitle":"NUBAN","openapi":"POST /api/onboarding/nigeria_kyc/nuban/","href":"/v3/kyc/nigeria/nuban"},{"title":"NUBAN Advanced","sidebarTitle":"NUBAN Advanced","openapi":"POST /api/onboarding/nigeria_kyc/nuban_advanced/","href":"/v3/kyc/nigeria/nuban_advanced"},{"title":"Passport Verification","sidebarTitle":"Passport","openapi":"POST /api/onboarding/nigeria_kyc/passport/","href":"/v3/kyc/nigeria/passport_verification"},{"title":"Phone Number Advanced","sidebarTitle":"Phone Number Advanced","openapi":"POST /api/onboarding/nigeria_kyc/phone_no_advanced/","href":"/v3/kyc/nigeria/Phone_Number_Advanced"},{"title":"Phone Number Basic","sidebarTitle":"Phone Number Basic","openapi":"POST /api/onboarding/nigeria_kyc/phone_no_basic/","href":"/v3/kyc/nigeria/phone_number_basic"},{"title":"Company TIN","sidebarTitle":"Company TIN","openapi":"POST /api/onboarding/nigeria_kyc/tin/","href":"/v3/kyc/nigeria/tin"},{"title":"Virtual NIN (VNIN)","sidebarTitle":"VNIN","openapi":"POST /api/onboarding/nigeria_kyc/vnin/","href":"/v3/kyc/nigeria/VNIN"},{"title":"Voter's ID","sidebarTitle":"Voter's ID","openapi":"POST /api/onboarding/nigeria_kyc/voters_id/","href":"/v3/kyc/nigeria/Voters_ID"}]},{"group":"Kenya","pages":[{"title":"National ID Basic","sidebarTitle":"National ID Basic","openapi":"POST /api/onboarding/kenya_kyc/national_id_basic/","href":"/v3/kyc/kenya/national_id_basic"},{"title":"National ID Advanced","sidebarTitle":"National ID Advanced","openapi":"POST /api/onboarding/kenya_kyc/national_id_advance/","href":"/v3/kyc/kenya/national_id_advance"},{"title":"Business Registration","sidebarTitle":"Business Registration","openapi":"POST /api/onboarding/kenya_kyc/business_registration/","href":"/v3/kyc/kenya/business_registration"},{"title":"Alien ID","sidebarTitle":"Alien ID","openapi":"POST /api/onboarding/kenya_kyc/alien_id/","href":"/v3/kyc/kenya/alien_ID"},{"title":"KRA PIN","sidebarTitle":"KRA PIN","openapi":"POST /api/onboarding/kenya_kyc/kra_pin/","href":"/v3/kyc/kenya/kra_pin"},{"title":"Kenya Passport","sidebarTitle":"Passport","openapi":"POST /api/onboarding/kenya_kyc/passport/","href":"/v3/kyc/kenya/Passport_Verification"},{"title":"Driver's License","sidebarTitle":"Driver's License","openapi":"POST /api/onboarding/kenya_kyc/drivers_license/","href":"/v3/kyc/kenya/Drivers_License"}]},{"group":"Ghana","pages":[{"title":"Ghana ID Card","sidebarTitle":"ID Card","openapi":"POST /api/onboarding/ghana_kyc/id_card/","href":"/v3/kyc/ghana/ID_Card"},{"title":"Ghana ID Card Advanced","sidebarTitle":"ID Card Advanced","openapi":"POST /api/onboarding/ghana_kyc/id_card_with_face/","href":"/v3/kyc/ghana/ID_Card_with_face"},{"title":"International Passport","sidebarTitle":"International Passport","openapi":"POST /api/onboarding/ghana_kyc/international_passport/","href":"/v3/kyc/ghana/International_Passport"}]},{"group":"Cote d'Ivoire","pages":[{"title":"National ID","sidebarTitle":"National ID","openapi":"POST /api/onboarding/cote_divoire_kyc/national_id/","href":"/v3/kyc/cote_d_ivoire/National_ID"}]},{"group":"South Africa","pages":[{"title":"National ID","sidebarTitle":"National ID","openapi":"POST /api/onboarding/south_africa_kyc/national_id/","href":"/v3/kyc/south_africa/National_ID"}]}]},{"group":"Document Verification","pages":[{"group":"Global","pages":[{"title":"Passport","sidebarTitle":"Passport","openapi":"POST /api/onboarding/document_verification/passport","href":"/v3/kyc/document_verification/global/Passport"}]},{"group":"Nigeria","pages":[{"title":"National ID","sidebarTitle":"National ID","openapi":"POST /api/onboarding/document_verification/nigeria/national_id","href":"/v3/kyc/document_verification/nigeria/National_ID"},{"title":"Passport","sidebarTitle":"Passport","openapi":"POST /api/onboarding/document_verification/nigeria/passport","href":"/v3/kyc/document_verification/nigeria/Passport"},{"title":"Driver's License","sidebarTitle":"Driver's License","openapi":"POST /api/onboarding/document_verification/nigeria/drivers_license","href":"/v3/kyc/document_verification/nigeria/Drivers_License"},{"title":"Voter's Card","sidebarTitle":"Voter's Card","openapi":"POST /api/onboarding/document_verification/nigeria/voters_card","href":"/v3/kyc/document_verification/nigeria/Voters_Card"}]},{"group":"Kenya","pages":[{"title":"Kenya National ID","sidebarTitle":"National ID","openapi":"POST /api/onboarding/document_verification/kenya/kenya_id","href":"/v3/kyc/document_verification/kenya/Kenya_ID"},{"title":"Passport","sidebarTitle":"Passport","openapi":"POST /api/onboarding/document_verification/kenya/passport","href":"/v3/kyc/document_verification/kenya/Passport"}]},{"group":"Ghana","pages":[{"title":"Passport","sidebarTitle":"Passport","description":"Extract identity details from a Ghanaian passport.","openapi":"POST /api/onboarding/document_verification/ghana/passport","href":"/v3/kyc/document_verification/ghana/Passport"}]},{"group":"Canada","pages":[{"title":"Passport","sidebarTitle":"Passport","openapi":"POST /api/onboarding/document_verification/canada/passport","href":"/v3/kyc/document_verification/canada/Passport"}]},{"group":"USA","pages":[{"title":"Passport","sidebarTitle":"Passport","description":"Extract identity details from a United States passport.","openapi":"POST /api/onboarding/document_verification/usa/passport","href":"/v3/kyc/document_verification/usa/Passport"}]},{"group":"Cote d'Ivoire","pages":[{"title":"Passport","sidebarTitle":"Passport","openapi":"POST /api/onboarding/document_verification/cote_d_ivoire/passport","href":"/v3/kyc/document_verification/cote_d_ivoire/Passport"}]},{"group":"UK","pages":[{"title":"Passport","sidebarTitle":"Passport","openapi":"POST /api/onboarding/document_verification/uk/passport","href":"/v3/kyc/document_verification/uk/Passport"}]}]}]},{"group":"Credit Report","pages":[{"group":"Nigeria","pages":[{"group":"Business","pages":[{"title":"CRC Business Credit History","sidebarTitle":"CRC Credit History","openapi":"POST /api/onboarding/business/crc/","href":"/v3/credit/business/crc-business_credit_history"},{"title":"First Central Business Credit History","sidebarTitle":"First Central History","openapi":"POST /api/onboarding/business/first_central/","href":"/v3/credit/business/first-central_business_credit_history"},{"title":"Premium Business Credit History","sidebarTitle":"Premium Credit History","openapi":"POST /api/onboarding/business/premium/","href":"/v3/credit/business/premium_business_credit_history"}]},{"group":"Individual","pages":[{"title":"First Central Credit Summary","sidebarTitle":"First Central Summary","openapi":"POST /api/onboarding/individual/first_central_summary/","href":"/v3/credit/individual/First_Central_Credit_Summary"},{"title":"First Central Full Credit Report","sidebarTitle":"First Central Full Report","openapi":"POST /api/onboarding/individual/first_central_full/","href":"/v3/credit/individual/First_Central_Full_Credit_Report"},{"title":"Credit Registry Credit Summary","sidebarTitle":"CRC Credit Summary","openapi":"POST /api/onboarding/individual/credit_registry_summary/","href":"/v3/credit/individual/Credit_Registry_Credit_Summary"},{"title":"Credit Registry Full Credit Report","sidebarTitle":"CRC Full Credit Report","openapi":"POST /api/onboarding/individual/credit_registry_full/","href":"/v3/credit/individual/Credit_Registry_Full_Credit_Report"},{"title":"Premium Individual Credit Report","sidebarTitle":"Premium Credit Report","openapi":"POST /api/onboarding/individual/premium/","href":"/v3/credit/individual/Credit_Report_Premium"},{"title":"First Central Credit Score","sidebarTitle":"First Central Score","openapi":"POST /api/onboarding/individual/credit_scores_first_central/","href":"/v3/credit/individual/First_Central_Credit_Score"},{"title":"CRC Credit Score","sidebarTitle":"CRC Credit Score","openapi":"POST /api/onboarding/individual/credit_scores_crc/","href":"/v3/credit/individual/CRC_Credit_Score"},{"title":"CRC Credit History","sidebarTitle":"CRC Credit History","openapi":"POST /api/onboarding/individual/crc_summary/","href":"/v3/credit/individual/CRC_Credit_History"},{"title":"CRC Full Credit Report","sidebarTitle":"CRC Full Report","openapi":"POST /api/onboarding/individual/crc_full/","href":"/v3/credit/individual/CRC_full_credit_report"},{"title":"Credit Registry History Advanced","sidebarTitle":"CRC History Advanced","openapi":"POST /api/onboarding/individual/credit_registry_history_advanced/","href":"/v3/credit/individual/Credt_Registry_History_Advanced"}]}]},{"group":"Kenya","pages":[{"group":"Individual","pages":[{"title":"Kenya Individual Credit Report","sidebarTitle":"Kenya Credit Report","openapi":"POST /api/onboarding/kenya/individual_credit/","href":"/v3/credit/individual/Kenya_Individual_Credit"}]},{"group":"Business","pages":[{"title":"Kenya Business Credit Report","sidebarTitle":"Kenya Credit Report","openapi":"POST /api/onboarding/kenya/company_credit/","href":"/v3/credit/business/Kenya_Business_Credit"}]}]}]}]},{"group":"Fraud \u0026 Transaction Monitoring","pages":[{"group":"Transaction Monitoring","pages":[{"title":"Transaction Monitoring","sidebarTitle":"Overview","href":"/v3/transaction/transaction_monitoring/transaction_monitoring_overview"},{"title":"Submit Transaction for Monitoring","sidebarTitle":"Submit Transaction","href":"/v3/transaction/transaction_monitoring/post_transaction_request"},{"title":"User Journey Tracking","sidebarTitle":"User Journey","openapi":"POST /api/v1/journey/event/","href":"/v3/transaction/transaction_monitoring/user_journey"}]},{"group":"Transaction Screening","pages":[{"title":"Transaction Screening","sidebarTitle":"Overview","href":"/v3/transaction/transaction_screening/overview"},{"title":"Screen a Transaction","sidebarTitle":"Screen Transaction","openapi":"POST /api/v1/monitoring/transaction_screening","href":"/v3/transaction/transaction_screening/post_transaction_screening"}]},{"group":"KYC","pages":[{"title":"Get All KYC Search Results","sidebarTitle":"Get All KYC Results","openapi":"GET /api/v1/monitoring/kyc_search/","href":"/v3/transaction/kyc/get_all_search_results"},{"title":"Get KYC Result by ID","sidebarTitle":"Get KYC by ID","openapi":"GET /api/v1/monitoring/kyc_search/{id}/","href":"/v3/transaction/kyc/get_entity_kyc_by_id"},{"title":"Run KYC Check","sidebarTitle":"Run KYC Check","openapi":"POST /api/v1/monitoring/kyc_search/","href":"/v3/transaction/kyc/post_kyc_check"}]}]},{"group":"Loan Fraud Check","pages":[{"title":"Loan Fraud Check — Overview","sidebarTitle":"Overview","href":"/v3/loan/introduction"},{"title":"Individual Loan Fraud Check","sidebarTitle":"Individual Fraud Check","openapi":"POST /api/v1/loan/fraud_check/","href":"/v3/loan/individual_fraud_check"},{"title":"Business Loan Fraud Check","sidebarTitle":"Business Fraud Check","openapi":"POST /api/v1/loan/fraud_check/","href":"/v3/loan/business_fraud_check"}]}]}]},{"version":"v2","pages":[{"title":"v2","href":"/introduction"}]},{"version":"v1","pages":[{"title":"v1","href":"/introduction"}]}]},{"language":"fr","pages":[{"title":"fr","href":"/fr/v3/kyc/document_verification/canada/Passport"}]}]},"basePath":"","title":"Passport - Adhere by Smartcomply","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-6DXXLlfN.js","dist-CmKHfscc.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-C3kuh_dz.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","AssistantPageLink-U3mI6Ljh.js"]}