CINXE.COM

<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta charSet="utf-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="preload" as="image" href="/images/onfido.svg"/><link rel="preload" as="image" href="/images/onfido-logo-mini.svg"/><link rel="preload" as="image" href="/images/logo.png"/><link rel="preload" as="image" href="/images/SOC2.png"/><link rel="preload" as="image" href="/images/ISO27001.png"/><link rel="preload" as="image" href="/icons/postman.svg"/><link rel="preload" as="image" href="/icons/openApi.svg"/><link rel="preload" as="image" href="/icons/java.svg"/><link rel="preload" as="image" href="/icons/python.svg"/><link rel="preload" as="image" href="/icons/node.svg"/><link rel="stylesheet" href="/_next/static/css/ffb985fc15812f34.css" crossorigin="" data-precedence="next"/><link rel="stylesheet" href="/_next/static/css/5fd81c61ae2275bd.css" crossorigin="" data-precedence="next"/><link rel="preload" as="script" fetchPriority="low" href="/_next/static/chunks/webpack-df5aa8203ec4c19c.js" crossorigin=""/><script src="/_next/static/chunks/fd9d1056-84677288222e0c6f.js" async="" crossorigin=""></script><script src="/_next/static/chunks/69-6fe9dd061c0eded6.js" async="" crossorigin=""></script><script src="/_next/static/chunks/main-app-4e27ed7bf15197c3.js" async="" crossorigin=""></script><script src="/_next/static/chunks/446-3278feef196ddd95.js" async=""></script><script src="/_next/static/chunks/58-231460405b897e41.js" async=""></script><script src="/_next/static/chunks/app/layout-096ab1e2e910acac.js" async=""></script><script src="/_next/static/chunks/227-8e2bbef1ce1ab7ac.js" async=""></script><script src="/_next/static/chunks/531-de6dea8eae40067f.js" async=""></script><script src="/_next/static/chunks/app/page-429a2a471822df8c.js" async=""></script><script src="/_next/static/chunks/599-3057f8a397da50f4.js" async=""></script><script src="/_next/static/chunks/app/%5B...slug%5D/page-545a92e622e14d71.js" async=""></script><link rel="preload" href="https://www.googletagmanager.com/gtm.js?id=GTM-W5P8TZM" as="script"/><link rel="preload" as="image" href="/icons/php.svg"/><link rel="preload" as="image" href="/icons/ruby.svg"/><link rel="icon" href="https://onfido.com/wp-content/themes/onfido/static/icon-32x32.png" type="image/png"/><title>Release notes | Onfido</title><meta name="description" content="This is an overview of Onfido's API release notes"/><link rel="manifest" href="/manifest.webmanifest"/><meta name="robots" content="index, follow, nocache"/><meta name="googlebot" content="index, nofollow, noimageindex, max-video-preview:-1, max-image-preview:large, max-snippet:-1"/><meta property="og:title" content="Release notes"/><meta property="og:description" content="This is an overview of Onfido's API release notes"/><meta property="og:url" content="https://documentation.onfido.com/api/release-notes/"/><meta property="og:site_name" content="Onfido"/><meta property="og:locale" content="en_US"/><meta property="og:image" content="https://onfido.com/wp-content/uploads/2023/02/onfido-logo-feature-image-1200x628-1.png"/><meta property="og:image:width" content="1200"/><meta property="og:image:height" content="628"/><meta property="og:image:type" content="image/png"/><meta property="og:type" content="website"/><meta name="twitter:card" content="summary_large_image"/><meta name="twitter:creator" content="@onfido"/><meta name="twitter:title" content="Release notes"/><meta name="twitter:description" content="This is an overview of Onfido's API release notes"/><meta name="twitter:image" content="https://onfido.com/wp-content/uploads/2023/02/onfido-logo-feature-image-1200x628-1.png"/><link rel="shortcut icon" href="https://onfido.com/wp-content/themes/onfido/static/icon-32x32.png"/><link rel="icon" href="https://onfido.com/wp-content/themes/onfido/static/icon-32x32.png"/><link rel="apple-touch-icon" href="https://onfido.com/wp-content/themes/onfido/static/icon-48x48.png" sizes="48x48" type="image/png"/><link rel="apple-touch-icon" href="https://onfido.com/wp-content/themes/onfido/static/icon-72x72.png" sizes="72x72" type="image/png"/><link rel="apple-touch-icon" href="https://onfido.com/wp-content/themes/onfido/static/icon-96x96.png" sizes="96x96" type="image/png"/><link rel="apple-touch-icon" href="https://onfido.com/wp-content/themes/onfido/static/icon-144x144.png" sizes="144x144" type="image/png"/><link rel="apple-touch-icon" href="https://onfido.com/wp-content/themes/onfido/static/icon-192x192.png" sizes="192x192" type="image/png"/><link rel="apple-touch-icon" href="https://onfido.com/wp-content/themes/onfido/static/icon-256x256.png" sizes="256x256" type="image/png"/><link rel="apple-touch-icon" href="https://onfido.com/wp-content/themes/onfido/static/icon-384x384.png" sizes="384x384" type="image/png"/><link rel="apple-touch-icon" href="https://onfido.com/wp-content/themes/onfido/static/icon-512x512.png" sizes="512x512" type="image/png"/><script src="/_next/static/chunks/polyfills-c67a75d1b6f99dc8.js" crossorigin="" noModule=""></script></head><body class="body castor-theme--day"><noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-W5P8TZM" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript><template data-dgst="BAILOUT_TO_CLIENT_SIDE_RENDERING"></template><div class="header_header__w2BOs"><div class="header_global-navigation__0toMz"><div class="header_logo-banner__Ie10E"><a target="_blank" rel="noopener noreferrer" href="https://www.onfido.com"><img alt="Onfido Logo" height="45" class="header_logo__9b1Md" src="/images/onfido.svg"/><img alt="Onfido Logo" height="45" class="header_logo-mini__wjSx_" src="/images/onfido-logo-mini.svg"/></a><div class="header_divider__27zUn"></div><h1 class="header_title__PBp9J">Developers</h1></div><div class="navigation_navigation__6l728"><div class="navigation_global-buttons__1Iqoy"><a href="https://public.support.onfido.com/" class="ods-button -action--secondary">Support</a><a href="https://dashboard.onfido.com/users/sign_up" class="ods-button -action--primary">Try it now</a></div><div class="navigation_navigation-mini__mSY_w"><button class="ods-button -action--tertiary navigation_mini-button__QiQ4h"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true" aria-label="Open search button"><path d="M10 18a7.952 7.952 0 0 0 4.897-1.688l4.396 4.396 1.414-1.414-4.396-4.396A7.952 7.952 0 0 0 18 10c0-4.411-3.589-8-8-8s-8 3.589-8 8 3.589 8 8 8zm0-14c3.309 0 6 2.691 6 6s-2.691 6-6 6-6-2.691-6-6 2.691-6 6-6z"></path></svg></button><button class="ods-button -action--tertiary navigation_mini-button__QiQ4h"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true" aria-label="Open navigation menu button"><path d="M4 6h16v2H4zm0 5h16v2H4zm0 5h16v2H4z"></path></svg></button></div></div></div><div class="header_top-menubar__LRG13"><div class="menu_menu-bar__jyh9r"><a class="menu_menu-button__pbibj" href="/">Home</a><a class="menu_menu-button__pbibj" href="/getting-started/">Getting Started</a><a class="menu_menu-button__pbibj" href="/guide/">Product Guides</a><a class="menu_menu-button__pbibj menu_menu-button-active__VmE8W" href="/api/">API</a><a class="menu_menu-button__pbibj" href="/sdk/">SDKs</a></div><template data-dgst="BAILOUT_TO_CLIENT_SIDE_RENDERING"></template></div></div><div class="core"><div class="page_page__fWmUX page_with-toc-and-menu__z_klm"><div class="page_menu__iLhRw"><div class="pageMenu_menu___YmUI"><div class="pageMenu_content__dDKQC"><a class="pageMenu_static-mobile-menu-button__hMBOY" href="/"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true"><path d="M21 11H6.414l5.293-5.293-1.414-1.414L2.586 12l7.707 7.707 1.414-1.414L6.414 13H21z"></path></svg> Back to Home</a><div class="pageMenuLink_section__MzZdc"><div><a class="pageMenuLink_item__ufBd2" target="_self" href="/api/"><div class="pageMenuLink_content__rWzKm"><span>Overview</span></div></a><div class="pageMenuLink_children__e2g2r" style="display:none"></div></div></div><div class="pageMenuLink_section__MzZdc"><div class="pageMenuLink_title__q7hBj">Api</div><div><a class="pageMenuLink_item__ufBd2" target="_self" href="/api/latest/"><div class="pageMenuLink_content__rWzKm"><span>API reference</span></div></a><div class="pageMenuLink_children__e2g2r" style="display:none"></div></div><div><a class="pageMenuLink_item__ufBd2 pageMenuLink_active-item__onvga" target="_self" href="/api/release-notes/"><div class="pageMenuLink_content__rWzKm"><span>API Release notes</span></div></a><div class="pageMenuLink_children__e2g2r" style="display:flex"></div></div><div><a class="pageMenuLink_item__ufBd2" target="_self" href="/api/api-versioning-policy/"><div class="pageMenuLink_content__rWzKm"><span>API versioning policy</span></div></a><div class="pageMenuLink_children__e2g2r" style="display:none"></div></div><div><a class="pageMenuLink_item__ufBd2" target="_self" href="/api/api-v2-to-v3-migration-guide/"><div class="pageMenuLink_content__rWzKm"><span>API v2 to v3.6 migration guide</span></div></a><div class="pageMenuLink_children__e2g2r" style="display:none"></div></div><div><a class="pageMenuLink_item__ufBd2" target="_self" href="/api/api-v3-to-v3.6-migration-guide"><div class="pageMenuLink_content__rWzKm"><span>API v3 to v3.6 migration guide</span></div></a><div class="pageMenuLink_children__e2g2r" style="display:none"></div></div><div><a class="pageMenuLink_item__ufBd2" target="_self" href="/api/document-report-object/"><div class="pageMenuLink_content__rWzKm"><span>Document report object attributes</span></div></a><div class="pageMenuLink_children__e2g2r" style="display:none"></div></div><div><a class="pageMenuLink_item__ufBd2" target="_self" href="/api/identity-supported-countries-and-data/"><div class="pageMenuLink_content__rWzKm"><span>Recommended data inputs for Identity Enhanced reports</span></div></a><div class="pageMenuLink_children__e2g2r" style="display:none"></div></div><div><a class="pageMenuLink_item__ufBd2" target="_self" href="/api/manual-webhook-signature-verification/"><div class="pageMenuLink_content__rWzKm"><span>Manual webhook signature verification</span></div></a><div class="pageMenuLink_children__e2g2r" style="display:none"></div></div></div><div class="pageMenuLink_section__MzZdc"><div class="pageMenuLink_title__q7hBj">Integration Libraries</div><div><a class="pageMenuLink_item__ufBd2" target="_blank" href="https://god.gw.postman.com/run-collection/38453665-3be48048-00b8-43bf-8c91-82953801b7aa"><div class="pageMenuLink_content__rWzKm"><img alt="IconPostman collection" class="pageMenuLink_logo__Xxyey" src="/icons/postman.svg"/><span>Postman collection</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true" class="pageMenuLink_external-icon__kJTKK"><path d="m13 3 3.293 3.293-7 7 1.414 1.414 7-7L21 11V3z"></path><path d="M19 19H5V5h7l-2-2H5c-1.103 0-2 .897-2 2v14c0 1.103.897 2 2 2h14c1.103 0 2-.897 2-2v-5l-2-2v7z"></path></svg></div></a><div class="pageMenuLink_children__e2g2r" style="display:none"></div></div><div><a class="pageMenuLink_item__ufBd2" target="_blank" href="https://github.com/onfido/onfido-openapi-spec"><div class="pageMenuLink_content__rWzKm"><img alt="IconOpenAPI specifications" class="pageMenuLink_logo__Xxyey" src="/icons/openApi.svg"/><span>OpenAPI specifications</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true" class="pageMenuLink_external-icon__kJTKK"><path d="m13 3 3.293 3.293-7 7 1.414 1.414 7-7L21 11V3z"></path><path d="M19 19H5V5h7l-2-2H5c-1.103 0-2 .897-2 2v14c0 1.103.897 2 2 2h14c1.103 0 2-.897 2-2v-5l-2-2v7z"></path></svg></div></a><div class="pageMenuLink_children__e2g2r" style="display:none"></div></div><div><a class="pageMenuLink_item__ufBd2" target="_blank" href="https://github.com/onfido/onfido-java"><div class="pageMenuLink_content__rWzKm"><img alt="IconJava library" class="pageMenuLink_logo__Xxyey" src="/icons/java.svg"/><span>Java library</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true" class="pageMenuLink_external-icon__kJTKK"><path d="m13 3 3.293 3.293-7 7 1.414 1.414 7-7L21 11V3z"></path><path d="M19 19H5V5h7l-2-2H5c-1.103 0-2 .897-2 2v14c0 1.103.897 2 2 2h14c1.103 0 2-.897 2-2v-5l-2-2v7z"></path></svg></div></a><div class="pageMenuLink_children__e2g2r" style="display:none"></div></div><div><a class="pageMenuLink_item__ufBd2" target="_blank" href="https://github.com/onfido/onfido-python"><div class="pageMenuLink_content__rWzKm"><img alt="IconPython library" class="pageMenuLink_logo__Xxyey" src="/icons/python.svg"/><span>Python library</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true" class="pageMenuLink_external-icon__kJTKK"><path d="m13 3 3.293 3.293-7 7 1.414 1.414 7-7L21 11V3z"></path><path d="M19 19H5V5h7l-2-2H5c-1.103 0-2 .897-2 2v14c0 1.103.897 2 2 2h14c1.103 0 2-.897 2-2v-5l-2-2v7z"></path></svg></div></a><div class="pageMenuLink_children__e2g2r" style="display:none"></div></div><div><a class="pageMenuLink_item__ufBd2" target="_blank" href="https://github.com/onfido/onfido-node"><div class="pageMenuLink_content__rWzKm"><img alt="IconNode.js library" class="pageMenuLink_logo__Xxyey" src="/icons/node.svg"/><span>Node.js library</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true" class="pageMenuLink_external-icon__kJTKK"><path d="m13 3 3.293 3.293-7 7 1.414 1.414 7-7L21 11V3z"></path><path d="M19 19H5V5h7l-2-2H5c-1.103 0-2 .897-2 2v14c0 1.103.897 2 2 2h14c1.103 0 2-.897 2-2v-5l-2-2v7z"></path></svg></div></a><div class="pageMenuLink_children__e2g2r" style="display:none"></div></div><div><a class="pageMenuLink_item__ufBd2" target="_blank" href="https://github.com/onfido/onfido-php"><div class="pageMenuLink_content__rWzKm"><img alt="IconPHP library" class="pageMenuLink_logo__Xxyey" src="/icons/php.svg"/><span>PHP library</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true" class="pageMenuLink_external-icon__kJTKK"><path d="m13 3 3.293 3.293-7 7 1.414 1.414 7-7L21 11V3z"></path><path d="M19 19H5V5h7l-2-2H5c-1.103 0-2 .897-2 2v14c0 1.103.897 2 2 2h14c1.103 0 2-.897 2-2v-5l-2-2v7z"></path></svg></div></a><div class="pageMenuLink_children__e2g2r" style="display:none"></div></div><div><a class="pageMenuLink_item__ufBd2" target="_blank" href="https://github.com/onfido/onfido-ruby"><div class="pageMenuLink_content__rWzKm"><img alt="IconRuby library" class="pageMenuLink_logo__Xxyey" src="/icons/ruby.svg"/><span>Ruby library</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true" class="pageMenuLink_external-icon__kJTKK"><path d="m13 3 3.293 3.293-7 7 1.414 1.414 7-7L21 11V3z"></path><path d="M19 19H5V5h7l-2-2H5c-1.103 0-2 .897-2 2v14c0 1.103.897 2 2 2h14c1.103 0 2-.897 2-2v-5l-2-2v7z"></path></svg></div></a><div class="pageMenuLink_children__e2g2r" style="display:none"></div></div></div></div><div class="pageMenu_global-buttons__KMM2x"><a href="https://public.support.onfido.com/" class="ods-button -action--secondary">Support</a><a href="https://dashboard.onfido.com/users/sign_up" class="ods-button -action--primary">Try it now</a></div></div></div><div id="content" class="page_content__uUpdt page_with-menu__3lKbV"><div class="page_content-article___pEsh"><div class="layout_layout__Cpwpp"><h1 id="release-notes">Release notes<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h1> <h2 id="onfido-api">Onfido API<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h2> <h2 id="api-versioning-policy-update">API Versioning Policy update<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h2> <p>27 February 2023</p> <p>The API Versioning Policy was updated for API v3.6 onwards to accept backwards compatible changes, read more <a href="/api/api-versioning-policy#how-we-version-v36">in our versioning policy documentation</a>.</p> <h2 id="api-v36">API v3.6<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h2> <p>24 January 2023</p> <h3 id="-new-property-for-known-faces-report-matches">🖥 New property for known faces report matches<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h3> <p>The Known Faces report will perform matched applicant <strong>fuzzy name matching</strong> in the matches set so that matches where the <code>suspected</code> field is <code>true</code> should be considered as possible fraud. This will only work for clients where <strong>fuzzy name matching</strong> is configured, otherwise it will always return <code>true</code> for all matches.</p> <div class="codeSnippet_code-snippet__MnCuc"><div class="codeSnippet_header__yFhXX"><div class="codeSnippet_title__wd_BD">json</div><div class="copyButton_container__INBIo"><button aria-label="Copy code snippet button" class="ods-button -action--tertiary"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true" color="yellow"><path d="M20 2H10c-1.103 0-2 .897-2 2v4H4c-1.103 0-2 .897-2 2v10c0 1.103.897 2 2 2h10c1.103 0 2-.897 2-2v-4h4c1.103 0 2-.897 2-2V4c0-1.103-.897-2-2-2zM4 20V10h10l.002 10H4zm16-6h-4v-4c0-1.103-.897-2-2-2h-4V4h10v10z"></path></svg></button></div></div><div class="codeHighlight_code__bJvCm"><pre style="background-color:hsl(220, 13%, 18%);color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)" class="prism-code language-json"><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">1</span><span class="token plain">...</span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">2</span><span class="token plain"></span><span class="token property" style="color:hsl(355, 65%, 65%)">"matches"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">[</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">3</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">4</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"applicant_id"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token string" style="color:hsl(95, 38%, 62%)">"NTH_MATCHED_APPLICANT_ID"</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">5</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"score"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token number" style="color:hsl(29, 54%, 61%)">0.9915</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">6</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"media_id"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token string" style="color:hsl(95, 38%, 62%)">"LIVE_PHOTO_ID"</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">7</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"media_type"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token string" style="color:hsl(95, 38%, 62%)">"live_photos"</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">8</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"suspected"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token boolean" style="color:hsl(29, 54%, 61%)">true</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">9</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">10</span><span class="token plain"> ....</span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">11</span><span class="token plain"></span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">]</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">12</span><span class="token plain" style="display:inline-block"> </span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">13</span><span class="token plain"></span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">14</span><span class="token plain">...</span></div></pre></div></div> <p>Read more <a href="/guide/known-faces-report/">in our product documentation</a> or <a href="/api/latest/#known-faces-report">API reference</a>.</p> <h2 id="api-v35">API v3.5<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h2> <p>08 November 2022</p> <h3 id="-new-data-input-and-breakdown-for-identity-enhanced-kyc-report">🖥 New data input and breakdown for Identity Enhanced (KYC) report<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h3> <p>The Identity Enhanced (KYC) report will collect national id numbers and phone numbers as optional inputs for non-UK/non-US geos to help improve performance.</p> <p>As a result, a new breakdown <code>national_id_number</code> will be added for Identity Enhanced (KYC) reports.</p> <p><code>id_number</code> resource types have been expanded with the following new values: <code>voter_id</code>, <code>passport</code>, and <code>other</code>.</p> <p>A new breakdown <code>national_id_number</code> has been added to the <code>breakdown</code> field in the report response:</p> <div class="codeSnippet_code-snippet__MnCuc"><div class="codeSnippet_header__yFhXX"><div class="codeSnippet_title__wd_BD">json</div><div class="copyButton_container__INBIo"><button aria-label="Copy code snippet button" class="ods-button -action--tertiary"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true" color="yellow"><path d="M20 2H10c-1.103 0-2 .897-2 2v4H4c-1.103 0-2 .897-2 2v10c0 1.103.897 2 2 2h10c1.103 0 2-.897 2-2v-4h4c1.103 0 2-.897 2-2V4c0-1.103-.897-2-2-2zM4 20V10h10l.002 10H4zm16-6h-4v-4c0-1.103-.897-2-2-2h-4V4h10v10z"></path></svg></button></div></div><div class="codeHighlight_code__bJvCm"><pre style="background-color:hsl(220, 13%, 18%);color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)" class="prism-code language-json"><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">1</span><span class="token plain">...</span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">2</span><span class="token plain"></span><span class="token property" style="color:hsl(355, 65%, 65%)">"breakdown"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">3</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"national_id_number"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">4</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"result"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token string" style="color:hsl(95, 38%, 62%)">"clear"</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">5</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"breakdown"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">6</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"national_id_number_matched"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">7</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"results"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token string" style="color:hsl(95, 38%, 62%)">"clear"</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">8</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"properties"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">9</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"sources"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token string" style="color:hsl(95, 38%, 62%)">"Government"</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">10</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"type"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token string" style="color:hsl(95, 38%, 62%)">"Identity Card"</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">11</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">12</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">13</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">14</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">15</span><span class="token plain"></span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">16</span><span class="token plain">...</span></div></pre></div></div> <p>Read more <a href="/guide/identity-enhanced-report/">in our product documentation</a> or <a href="/api/latest/#identity-enhanced-report">API reference</a>.</p> <h3 id="expand-the-document-report">Expand the Document report<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h3> <p>As part of the Document report, we now assert if a document has been reused in a suspicious way. This verification result will be mapped to the new <code>repeat_attempts</code> sub-breakdown that was added under the <code>compromised_document</code> breakdown. The previous <code>compromised_document</code> verification that asserts whether the document is publicly available as compromised will be mapped to the <code>document_database</code> sub-breakdown.</p> <p>Below you will find examples comparing the previous and new response format.</p> <p>API versions prior to v3.5:</p> <div class="codeSnippet_code-snippet__MnCuc"><div class="codeSnippet_header__yFhXX"><div class="codeSnippet_title__wd_BD">json</div><div class="copyButton_container__INBIo"><button aria-label="Copy code snippet button" class="ods-button -action--tertiary"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true" color="yellow"><path d="M20 2H10c-1.103 0-2 .897-2 2v4H4c-1.103 0-2 .897-2 2v10c0 1.103.897 2 2 2h10c1.103 0 2-.897 2-2v-4h4c1.103 0 2-.897 2-2V4c0-1.103-.897-2-2-2zM4 20V10h10l.002 10H4zm16-6h-4v-4c0-1.103-.897-2-2-2h-4V4h10v10z"></path></svg></button></div></div><div class="codeHighlight_code__bJvCm"><pre style="background-color:hsl(220, 13%, 18%);color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)" class="prism-code language-json"><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">1</span><span class="token plain">...</span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">2</span><span class="token plain"></span><span class="token property" style="color:hsl(355, 65%, 65%)">"compromised_document"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">3</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"result"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token string" style="color:hsl(95, 38%, 62%)">"clear"</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">4</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">5</span><span class="token plain">...</span></div></pre></div></div> <p>API versions higher or equal to v3.5:</p> <div class="codeSnippet_code-snippet__MnCuc"><div class="codeSnippet_header__yFhXX"><div class="codeSnippet_title__wd_BD">json</div><div class="copyButton_container__INBIo"><button aria-label="Copy code snippet button" class="ods-button -action--tertiary"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true" color="yellow"><path d="M20 2H10c-1.103 0-2 .897-2 2v4H4c-1.103 0-2 .897-2 2v10c0 1.103.897 2 2 2h10c1.103 0 2-.897 2-2v-4h4c1.103 0 2-.897 2-2V4c0-1.103-.897-2-2-2zM4 20V10h10l.002 10H4zm16-6h-4v-4c0-1.103-.897-2-2-2h-4V4h10v10z"></path></svg></button></div></div><div class="codeHighlight_code__bJvCm"><pre style="background-color:hsl(220, 13%, 18%);color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)" class="prism-code language-json"><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">1</span><span class="token plain">...</span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">2</span><span class="token plain"></span><span class="token property" style="color:hsl(355, 65%, 65%)">"compromised_document"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">3</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"result"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token string" style="color:hsl(95, 38%, 62%)">"clear"</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">4</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"breakdown"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">5</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"document_database"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">6</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"result"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token string" style="color:hsl(95, 38%, 62%)">"clear"</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">7</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"properties"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">8</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">9</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"repeat_attempts"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">10</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"result"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token string" style="color:hsl(95, 38%, 62%)">"clear"</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">11</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"properties"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">12</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">13</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">14</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">15</span><span class="token plain">...</span></div></pre></div></div> <p>The <code>compromised_document</code> breakdown will now contain two sub-breakdowns:</p> <p><code>compromised_document_database</code> - this is the already existing sub-breakdown that asserts whether the document is publicly available as compromised.</p> <p><code>repeat_attempts</code> - a new sub-breakdown that asserts if a document has been reused in a suspicious way.</p> <h3 id="-proof-of-address-improvements">🏠 Proof of Address improvements<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h3> <p>The Proof of Address report has been improved by adding a <code>source_integrity</code> breakdown, as well as adding sub-breakdowns for <code>visual_fraud</code> and <code>digital_tampering</code>.</p> <div class="codeSnippet_code-snippet__MnCuc"><div class="codeSnippet_header__yFhXX"><div class="codeSnippet_title__wd_BD">json</div><div class="copyButton_container__INBIo"><button aria-label="Copy code snippet button" class="ods-button -action--tertiary"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true" color="yellow"><path d="M20 2H10c-1.103 0-2 .897-2 2v4H4c-1.103 0-2 .897-2 2v10c0 1.103.897 2 2 2h10c1.103 0 2-.897 2-2v-4h4c1.103 0 2-.897 2-2V4c0-1.103-.897-2-2-2zM4 20V10h10l.002 10H4zm16-6h-4v-4c0-1.103-.897-2-2-2h-4V4h10v10z"></path></svg></button></div></div><div class="codeHighlight_code__bJvCm"><pre style="background-color:hsl(220, 13%, 18%);color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)" class="prism-code language-json"><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">1</span><span class="token plain">...</span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">2</span><span class="token plain"></span><span class="token property" style="color:hsl(355, 65%, 65%)">"breakdown"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">3</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"source_integrity"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">4</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"result"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token string" style="color:hsl(95, 38%, 62%)">"clear"</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">5</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"breakdown"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">6</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"visible_fraud"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">7</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"result"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token string" style="color:hsl(95, 38%, 62%)">"clear"</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">8</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"properties"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">9</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">10</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"digital_tampering"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">11</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"result"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token string" style="color:hsl(95, 38%, 62%)">"clear"</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">12</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"properties"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">13</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">14</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">15</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">16</span><span class="token plain"></span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">17</span><span class="token plain">...</span></div></pre></div></div> <p>The <code>photos_of_screens</code> document source type has been added, as well as support for the following document types:</p> <ul> <li><code>general_letter</code></li> <li><code>insurance_statement</code></li> <li><code>pension_property_statement_letter</code></li> <li><code>mortgage_statement</code></li> <li><code>mobile_phone_bill</code></li> <li><code>identity_document_with_address</code></li> </ul> <p>We've also added new document validity rules and <code>expiry_date</code>. Read more in our <a href="/guide/proof-of-address-report/">product documentation</a> or <a href="/api/latest/#proof-of-address-report">API reference</a>.</p> <h2 id="api-v34">API v3.4<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h2> <p>4th May 2022</p> <h3 id="-us-biometrics-law-compliance">📜 US biometrics law compliance<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h3> <p>To ensure compliance with US laws on biometric data, and to take a privacy centric approach to protect the rights of end users, we have built a new process for gathering and submitting US end user consent.</p> <p>You must now submit the location of all end users and, where the location is the US, confirm that the end user has granted consent for Onfido, before submitting any checks, unless you are using the Onfido SDK, in which case you must instead update your SDK integration to the corresponding version listed in <a href="/guide/migration-guide-onfido-privacy-notices-and-consent#version-upgrades">MIGRATION GUIDE: ONFIDO PRIVACY NOTICES AND CONSENT (US)</a> to enable Onfido to collect and process this information automatically.</p> <p><code>location</code> has been added to the <a href="/api/latest/#applicants">applicant</a> and <a href="/api/latest/#upload-document">document</a> resource:</p> <div class="codeSnippet_code-snippet__MnCuc"><div class="codeSnippet_header__yFhXX"><div class="codeSnippet_title__wd_BD">json</div><div class="copyButton_container__INBIo"><button aria-label="Copy code snippet button" class="ods-button -action--tertiary"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true" color="yellow"><path d="M20 2H10c-1.103 0-2 .897-2 2v4H4c-1.103 0-2 .897-2 2v10c0 1.103.897 2 2 2h10c1.103 0 2-.897 2-2v-4h4c1.103 0 2-.897 2-2V4c0-1.103-.897-2-2-2zM4 20V10h10l.002 10H4zm16-6h-4v-4c0-1.103-.897-2-2-2h-4V4h10v10z"></path></svg></button></div></div><div class="codeHighlight_code__bJvCm"><pre style="background-color:hsl(220, 13%, 18%);color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)" class="prism-code language-json"><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">1</span><span class="token plain">...</span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">2</span><span class="token plain"></span><span class="token property" style="color:hsl(355, 65%, 65%)">"location"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">3</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"ip_address"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token string" style="color:hsl(95, 38%, 62%)">"219.44.17.31"</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">4</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"country_of_residence"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token string" style="color:hsl(95, 38%, 62%)">"USA"</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">5</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">6</span><span class="token plain">...</span></div></pre></div></div> <p><code>consents</code> has been added to the <a href="/api/latest/#create-applicant">applicant</a> resource:</p> <div class="codeSnippet_code-snippet__MnCuc"><div class="codeSnippet_header__yFhXX"><div class="codeSnippet_title__wd_BD">json</div><div class="copyButton_container__INBIo"><button aria-label="Copy code snippet button" class="ods-button -action--tertiary"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true" color="yellow"><path d="M20 2H10c-1.103 0-2 .897-2 2v4H4c-1.103 0-2 .897-2 2v10c0 1.103.897 2 2 2h10c1.103 0 2-.897 2-2v-4h4c1.103 0 2-.897 2-2V4c0-1.103-.897-2-2-2zM4 20V10h10l.002 10H4zm16-6h-4v-4c0-1.103-.897-2-2-2h-4V4h10v10z"></path></svg></button></div></div><div class="codeHighlight_code__bJvCm"><pre style="background-color:hsl(220, 13%, 18%);color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)" class="prism-code language-json"><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">1</span><span class="token plain">...</span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">2</span><span class="token plain"></span><span class="token property" style="color:hsl(355, 65%, 65%)">"consents"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">[</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">3</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">4</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"name"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token string" style="color:hsl(95, 38%, 62%)">"privacy_notices_read"</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">5</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"granted"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token boolean" style="color:hsl(29, 54%, 61%)">true</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">6</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">7</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">]</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">8</span><span class="token plain">...</span></div></pre></div></div> <p>For more information on how to upgrade your integration to use the latest consent parameters please see our <a href="/guide/migration-guide-onfido-privacy-notices-and-consent/">migration guide</a>.</p> <h3 id="-proof-of-address-improvements-1">🏠 Proof of Address improvements<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h3> <p>We've added the <code>address_parsed</code> and <code>unsupported_document_reason</code> properties as well as new support for the <code>address_certificate</code> document type.</p> <h2 id="api-v33">API v3.3<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h2> <p>18th February 2022</p> <h3 id="-expanded-proof-of-address-report">🏠 Expanded Proof of Address report<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h3> <p>The Proof of Address report has been expanded to include new supported issuing countries and date validation logic.</p> <p>The European Union, USA and Canada are now all supported issuing countries, in addition to the UK.</p> <p>The report also now asserts whether the submitted document has a valid date of issue. We've added the <code>valid_document_date</code> sub-breakdown under <code>document_classification</code>. The relevant part of the response from the API contains the following for a <code>clear</code> breakdown result:</p> <div class="codeSnippet_code-snippet__MnCuc"><div class="codeSnippet_header__yFhXX"><div class="codeSnippet_title__wd_BD">json</div><div class="copyButton_container__INBIo"><button aria-label="Copy code snippet button" class="ods-button -action--tertiary"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true" color="yellow"><path d="M20 2H10c-1.103 0-2 .897-2 2v4H4c-1.103 0-2 .897-2 2v10c0 1.103.897 2 2 2h10c1.103 0 2-.897 2-2v-4h4c1.103 0 2-.897 2-2V4c0-1.103-.897-2-2-2zM4 20V10h10l.002 10H4zm16-6h-4v-4c0-1.103-.897-2-2-2h-4V4h10v10z"></path></svg></button></div></div><div class="codeHighlight_code__bJvCm"><pre style="background-color:hsl(220, 13%, 18%);color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)" class="prism-code language-json"><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">1</span><span class="token plain">...</span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">2</span><span class="token plain"></span><span class="token property" style="color:hsl(355, 65%, 65%)">"document_classification"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">3</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"result"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token string" style="color:hsl(95, 38%, 62%)">"clear"</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">4</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"breakdown"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">5</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"valid_document_date"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">6</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"result"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token string" style="color:hsl(95, 38%, 62%)">"clear"</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">7</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"properties"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">8</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">9</span><span class="token plain">...</span></div></pre></div></div> <p>Read more <a href="/guide/proof-of-address-report/">in our product documentation</a> or <a href="/api/latest/#proof-of-address-report">API reference</a>.</p> <h2 id="watchlist-aml-report">Watchlist AML report<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h2> <p>12th January 2022</p> <p>🔍 We have introduced a new watchlist variant, Watchlist AML, which checks users against global watchlists and media sources. It expands on the current Watchlist standard report to include adverse media and is 6AMLD compliant.</p> <p>It is available to use across all versions of the Onfido API. Read more <a href="/guide/watchlist-reports/">in our product documentation</a> or <a href="/api/latest/#watchlist-aml">API reference</a>.</p> <h2 id="trusted-faces-for-face-authenticate">Trusted Faces for Face Authenticate<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h2> <p>15th November 2021</p> <p>👤 You can now enrol any user in Face Authenticate, without them needing to complete a Facial Similarity report with Onfido. This means Face Authenticate is available for everyone with no dependencies.</p> <p>Trusted Faces allows you to upload any image of the applicant that you trust, whether that is a file from an internal database or an image submitted for a Facial Similarity report.</p> <h2 id="image-quality-in-the-api">Image Quality in the API<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h2> <p>30th September 2021</p> <p>✅ We've added the <code>validate_image_quality</code> option when <a href="/api/latest/#upload-document">uploading a document using the API</a>. If requested, the submitted image will undergo an image quality validation, which checks the quality of the uploaded image. If the validation fails, a reason for the failure is returned and you can request the end user to retake the photo.</p> <p>Validating image quality at the point of document upload reduces the risk of an applicant submitting an image that is of insufficient quality to be verified by the Document report, improving pass rates and turn around times.</p> <p>It is available to use across all versions of the Onfido API. Read more in our <a href="/api/latest/#image-quality">API reference</a>.</p> <h2 id="face-authenticate">Face Authenticate<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h2> <p>19th August 2021</p> <p>🔁 It is now possible to re-verify end users who have already had their initial identity verified by Onfido. Face Authenticate offers a fully automated, real time comparison between an applicant's face and the recorded image of the applicant on your Onfido account, verifying if the face is a match and it is a real person.</p> <p>Face Authenticate can be used for account recovery, approving high risk transactions and enabling access to services along with multiple other use cases. It is available in API v3 onwards using the Onfido SDKs.</p> <h2 id="drivers-license-data-verification-dldv-report">Driver's License Data Verification (DLDV) report<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h2> <p>3rd August 2021</p> <p>🚗 United States driving licenses can be verified using a new report type, available in API v3 onwards. The DLDV report allows quick and accurate verification that a given driver's license is real, providing a strong signal against synthetic fraud.</p> <p>It verifies the authenticity of an end user's driving license by comparing the attributes on the document with the state Department of Motor Vehicles (DMV) databases.</p> <p>Read more <a href="/guide/drivers-license-data-verification-report/">in our product documentation</a> or <a href="/api/latest/#drivers-license-data-verification-report">API reference</a>.</p> <h2 id="api-v32">API v3.2<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h2> <p>24th June 2021</p> <p>### 🆗 Barcode validation</p> <p>We've added the <code>barcode</code> sub-breakdown under <code>data_validation</code> in the <a href="https://documentation.onfido.com/#document-report">Document report</a>.</p> <p>By comparing a document's barcode against the defined standard, we are able to provide a more robust assessment of the barcode's validity.</p> <p>This currently only applies to US and Canadian documents which contain a barcode.</p> <p>The relevant part of the response from the API is in the <a href="https://documentation.onfido.com/#document-report-object">Document report object</a>. It contains the following for a <code>consider</code> breakdown result:</p> <div class="codeSnippet_code-snippet__MnCuc"><div class="codeSnippet_header__yFhXX"><div class="codeSnippet_title__wd_BD">json</div><div class="copyButton_container__INBIo"><button aria-label="Copy code snippet button" class="ods-button -action--tertiary"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true" color="yellow"><path d="M20 2H10c-1.103 0-2 .897-2 2v4H4c-1.103 0-2 .897-2 2v10c0 1.103.897 2 2 2h10c1.103 0 2-.897 2-2v-4h4c1.103 0 2-.897 2-2V4c0-1.103-.897-2-2-2zM4 20V10h10l.002 10H4zm16-6h-4v-4c0-1.103-.897-2-2-2h-4V4h10v10z"></path></svg></button></div></div><div class="codeHighlight_code__bJvCm"><pre style="background-color:hsl(220, 13%, 18%);color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)" class="prism-code language-json"><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">1</span><span class="token plain">...</span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">2</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"data_validation"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">3</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"result"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token string" style="color:hsl(95, 38%, 62%)">"consider"</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">4</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"breakdown"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">5</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"barcode"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">6</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"result"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token string" style="color:hsl(95, 38%, 62%)">"consider"</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">7</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"properties"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">8</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">9</span><span class="token plain">...</span></div></pre></div></div> <p>### 📝 Specify documents for Facial Similarity reports</p> <p>You can now specify which uploaded document to process in both <a href="/api/latest/#document-report">Document</a> and <a href="/api/latest/#facial-similarity-reports">Facial Similarity</a> reports. This guarantees that the same document that was used and verified by the Document report will also be used for the Facial Similarity report, even if you are associating mutliple documents to a single applicant.</p> <p>Documents can be specified in the same way by using <code>document_ids</code> during <a href="/api/latest/#create-check">check creation</a>:</p> <p><code>"document_ids": ["<DOCUMENT_ID>"]</code></p> <p>If you specify <code>document_ids</code> with a check that doesn't contain a Document or Facial Similarity report you will receive the following <a href="/api/latest/#errors">error</a>:</p> <p><code>422 document_ids_with_unsupported_report</code></p> <p>When document IDs are associated with a Facial Similarity report, the document IDs of the documents used will be returned under the <code>documents</code> attribute of the <a href="/api/latest/#report-object">report object</a>.</p> <h3 id="-document-used-for-face-matching">👤👤 Document used for face matching<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h3> <p>We've added the <code>document_id</code> property to the <code>face_match</code> sub-breakdown under <code>face_comparison</code> in all <a href="https://documentation.onfido.com/#facial-similarity-reports">Facial Similarity report</a> types. This returns the unique identifier of the document used for the Facial Similarity report.</p> <p>You can use the document ID to find which document the applicant's live photo or video was matched against.</p> <p>The relevant part of the response from the API is in the <a href="https://documentation.onfido.com/#document-report-object">Facial Similarity report object</a>.</p> <div class="codeSnippet_code-snippet__MnCuc"><div class="codeSnippet_header__yFhXX"><div class="codeSnippet_title__wd_BD">json</div><div class="copyButton_container__INBIo"><button aria-label="Copy code snippet button" class="ods-button -action--tertiary"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true" color="yellow"><path d="M20 2H10c-1.103 0-2 .897-2 2v4H4c-1.103 0-2 .897-2 2v10c0 1.103.897 2 2 2h10c1.103 0 2-.897 2-2v-4h4c1.103 0 2-.897 2-2V4c0-1.103-.897-2-2-2zM4 20V10h10l.002 10H4zm16-6h-4v-4c0-1.103-.897-2-2-2h-4V4h10v10z"></path></svg></button></div></div><div class="codeHighlight_code__bJvCm"><pre style="background-color:hsl(220, 13%, 18%);color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)" class="prism-code language-json"><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">1</span><span class="token plain">...</span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">2</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"face_comparison"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">3</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"result"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token string" style="color:hsl(95, 38%, 62%)">"clear"</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">4</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"breakdown"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">5</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"face_match"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">6</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"result"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token string" style="color:hsl(95, 38%, 62%)">"clear"</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">7</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"properties"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">8</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"score"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token number" style="color:hsl(29, 54%, 61%)">0.6512</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">9</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"document_id"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token string" style="color:hsl(95, 38%, 62%)">"<DOCUMENT_ID>"</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">10</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">11</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">12</span><span class="token plain">...</span></div></pre></div></div> <h2 id="right-to-work-share-code">Right to Work share code<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h2> <p>11th May 2021</p> <p>🖥 Eligible non-UK and EU applicants can now use Onfido's Applicant Form to submit GOV.UK right to work share codes instead of documents to verify their right to work in the UK. Customers can also submit share codes, if they have them, using all active versions of the Onfido API.</p> <p><strong>Please note:</strong> This product is now deprecated and no longer available.</p> <h2 id="api-v31">API v3.1<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h2> <p>8th April 2021</p> <h3 id="-account-for-cases-where-we-dont-obtain-a-us-barcode">🎫 Account for cases where we don’t obtain a US barcode<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h3> <p>This will be enabled by default for all new customers.</p> <p>💬 <strong>If you're an existing customer, speak to your Onfido contact to enable this feature!</strong></p> <p>We've added the <code>multiple_data_sources_present</code> sub-breakdown under <code>data_consistency</code> in the <a href="https://documentation.onfido.com/#document-report">Document report</a>.</p> <p>This currently only applies to US Driving Licenses and US State Identity Cards, and specifically only when the barcode data is missing. The relevant part of the response from the API is in the <a href="https://documentation.onfido.com/#document-report-object">Document report object</a>. It contains the following for a <code>consider</code> breakdown result:</p> <div class="codeSnippet_code-snippet__MnCuc"><div class="codeSnippet_header__yFhXX"><div class="codeSnippet_title__wd_BD">json</div><div class="copyButton_container__INBIo"><button aria-label="Copy code snippet button" class="ods-button -action--tertiary"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true" color="yellow"><path d="M20 2H10c-1.103 0-2 .897-2 2v4H4c-1.103 0-2 .897-2 2v10c0 1.103.897 2 2 2h10c1.103 0 2-.897 2-2v-4h4c1.103 0 2-.897 2-2V4c0-1.103-.897-2-2-2zM4 20V10h10l.002 10H4zm16-6h-4v-4c0-1.103-.897-2-2-2h-4V4h10v10z"></path></svg></button></div></div><div class="codeHighlight_code__bJvCm"><pre style="background-color:hsl(220, 13%, 18%);color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)" class="prism-code language-json"><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">1</span><span class="token plain">...</span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">2</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"data_consistency"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">3</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"result"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token string" style="color:hsl(95, 38%, 62%)">"consider"</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">4</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"breakdown"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">5</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"multiple_data_sources_present"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">6</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"result"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token string" style="color:hsl(95, 38%, 62%)">"consider"</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">7</span><span class="token plain"> </span><span class="token property" style="color:hsl(355, 65%, 65%)">"properties"</span><span class="token operator" style="color:hsl(207, 82%, 66%)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">{</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">8</span><span class="token plain"> </span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">}</span><span class="token punctuation" style="color:hsl(220, 14%, 71%)">,</span><span class="token plain"></span></div><div class="token-line" style="color:hsl(220, 14%, 71%);text-shadow:0 1px rgba(0, 0, 0, 0.3)"><span class="codeHighlight_line-number__DxXha">9</span><span class="token plain">...</span></div></pre></div></div> <p><code>multiple_data_sources_present</code> acts as a validation for the data_consistency breakdown: if 2 sources are present, then data consistency is possible and the other sub-breakdowns are enabled.</p> <p><code>multiple_data_sources_present</code> can be disabled if needed. In this case, it will be returned as null and have no impact on the sub-result.</p> <h3 id="-pdf-downloads-of-check-results">✅ PDF downloads of check results<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h3> <p>You can now download PDFs of check results using an endpoint:</p> <p><code>GET /v3.1/checks/{check_id}/download</code></p> <p>Read more in <a href="/api/latest/#download-check">our API reference</a>.</p> <h3 id="-webhook-control-on-check">📩 Webhook control on check<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h3> <p>You can now specify which <a href="/api/latest/#webhook_ids">webhooks</a> will be activated for a check upon its creation.</p> <h2 id="onfido-python">onfido-python<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h2> <p>8th October 2020</p> <p>Joining our other new custom-written <a href="#https://documentation.onfido.com/#client-libraries">client libraries</a> and built with simplicity in mind is <a href="https://pypi.org/project/onfido-python/">onfido-python</a>! 🐍</p> <p>This project supersedes the auto-generated api-python-client library.</p> <h2 id="api-v30">API v3.0<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h2> <p>13th January 2020</p> <p>We wanted API v3 to improve on v2 in every possible way. We listened to our customers: we saw what could be clearer, what could be removed, and what could be simplified.</p> <p>API v3 isn’t a step change, but it is an evolution. It’s designed to get you up and running with our best-in-class identity verification API faster.</p> <p>If you’re an existing customer currently using API v2 but migrating to API v3, you may find our <a href="/api/api-v2-to-v3-migration-guide/">migration guide</a> more useful.</p> <h3 id="-cleaner-api-structure">🧼 Cleaner API structure<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h3> <p>Compared to API v2, we’ve simplified much of our endpoint structure, removed some inconsistencies in naming, and separated the report objects from check objects to make them more straightforward to process.</p> <h3 id="-simpler-applicant-creation">👩🏻🧔🏿 Simpler applicant creation<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h3> <p>Fields for applicant creation which were duplicated or unnecessary have been removed, and the array <code>addresses</code> has become the single object <code>address</code> nested inside applicant objects. This is now the only place you need to specify a country for an applicant.</p> <h3 id="-restructured-check-management">🏗 Restructured check management<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h3> <p>Checks, made up of reports, are the core of our product. Here are the main examples of how we’ve made check creation more streamlined:</p> <ul> <li>API v3 removes terminology such as “report type groups”, “variants” and “asynchronous checks”</li> <li>Specifying which report you need is now more straightforward, via an array called <code>report_names</code></li> <li>If you need to gather applicant information with our applicant form, simply use a Boolean switch in API v3</li> <li>Unless you specify otherwise, report data is returned as soon as it’s available by default for API v3 checks</li> <li>The request structure for creating a check is much simpler, and needs fewer lines of code each time</li> </ul> <h3 id="-a-new-biometrics-offering">📷 A new biometrics offering<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h3> <p>Facial Similarity Photo Fully Auto is only available in API v3 versions. You can read all about it in our comprehensive <a href="https://documentation.onfido.com/#photo-fully-auto">API reference documentation</a>.</p> <h3 id="-new-client-libraries">🎁 New client libraries<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h3> <p>For API v3 versions, we’ve moved away from auto-generated API client (wrapper) libraries via an OpenAPI specification. <a href="#https://documentation.onfido.com/#client-libraries">Our libraries are now custom-written instead</a>, to make your integration even easier.</p> <h2 id="️-let-us-know-what-you-think">⌨️ Let us know what you think<div class="anchor_inline__AyTvO"><div class="anchor_container__uDCLO anchor_inactive__S98f9"><div class="icon icon-link anchor_anchor__x3Mr3"></div><div data-search-ignore="true" class="anchor_copy__FnybB copy"></div></div></div></h2> <p>If you have any feedback or if you have any questions, contact our Client Support team at <a href="mailto:client-support@onfido.com">mailto:client-support@onfido.com</a>.</p></div></div></div><div class="page_table-of-content__A2hbk"><div class="tableOfContents_container__DMsle"><hr/><div class="tableOfContents_title__RsM_w"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true"><path d="M4 6h2v2H4zm0 5h2v2H4zm0 5h2v2H4zm16-8V6H8.023v2H18.8zM8 11h12v2H8zm0 5h12v2H8z"></path></svg> Table of contents</div><div class="tableOfContents_content-wrapper__rpV9n"><div><a href="#onfido-api"><div class="tableOfContents_content__lrspR">Onfido API</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div><div><a href="#api-versioning-policy-update"><div class="tableOfContents_content__lrspR">API Versioning Policy update</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div><div><a href="#api-v36"><div class="tableOfContents_content__lrspR">API v3.6<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true"><path d="M16.293 9.293 12 13.586 7.707 9.293l-1.414 1.414L12 16.414l5.707-5.707z"></path></svg></div></a><div class="tableOfContents_items__qlQt9" style="display:none"><div><a href="#-new-property-for-known-faces-report-matches"><div class="tableOfContents_content__lrspR">- 🖥 New property for known faces report matches</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div></div></div><div><a href="#api-v35"><div class="tableOfContents_content__lrspR">API v3.5<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true"><path d="M16.293 9.293 12 13.586 7.707 9.293l-1.414 1.414L12 16.414l5.707-5.707z"></path></svg></div></a><div class="tableOfContents_items__qlQt9" style="display:none"><div><a href="#-new-data-input-and-breakdown-for-identity-enhanced-kyc-report"><div class="tableOfContents_content__lrspR">- 🖥 New data input and breakdown for Identity Enhanced (KYC) report</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div><div><a href="#expand-the-document-report"><div class="tableOfContents_content__lrspR">- Expand the Document report</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div><div><a href="#-proof-of-address-improvements"><div class="tableOfContents_content__lrspR">- 🏠 Proof of Address improvements</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div></div></div><div><a href="#api-v34"><div class="tableOfContents_content__lrspR">API v3.4<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true"><path d="M16.293 9.293 12 13.586 7.707 9.293l-1.414 1.414L12 16.414l5.707-5.707z"></path></svg></div></a><div class="tableOfContents_items__qlQt9" style="display:none"><div><a href="#-us-biometrics-law-compliance"><div class="tableOfContents_content__lrspR">- 📜 US biometrics law compliance</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div><div><a href="#-proof-of-address-improvements-1"><div class="tableOfContents_content__lrspR">- 🏠 Proof of Address improvements</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div></div></div><div><a href="#api-v33"><div class="tableOfContents_content__lrspR">API v3.3<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true"><path d="M16.293 9.293 12 13.586 7.707 9.293l-1.414 1.414L12 16.414l5.707-5.707z"></path></svg></div></a><div class="tableOfContents_items__qlQt9" style="display:none"><div><a href="#-expanded-proof-of-address-report"><div class="tableOfContents_content__lrspR">- 🏠 Expanded Proof of Address report</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div></div></div><div><a href="#watchlist-aml-report"><div class="tableOfContents_content__lrspR">Watchlist AML report</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div><div><a href="#trusted-faces-for-face-authenticate"><div class="tableOfContents_content__lrspR">Trusted Faces for Face Authenticate</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div><div><a href="#image-quality-in-the-api"><div class="tableOfContents_content__lrspR">Image Quality in the API</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div><div><a href="#face-authenticate"><div class="tableOfContents_content__lrspR">Face Authenticate</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div><div><a href="#drivers-license-data-verification-dldv-report"><div class="tableOfContents_content__lrspR">Driver's License Data Verification (DLDV) report</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div><div><a href="#api-v32"><div class="tableOfContents_content__lrspR">API v3.2<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true"><path d="M16.293 9.293 12 13.586 7.707 9.293l-1.414 1.414L12 16.414l5.707-5.707z"></path></svg></div></a><div class="tableOfContents_items__qlQt9" style="display:none"><div><a href="#-document-used-for-face-matching"><div class="tableOfContents_content__lrspR">- 👤👤 Document used for face matching</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div></div></div><div><a href="#right-to-work-share-code"><div class="tableOfContents_content__lrspR">Right to Work share code</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div><div><a href="#api-v31"><div class="tableOfContents_content__lrspR">API v3.1<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true"><path d="M16.293 9.293 12 13.586 7.707 9.293l-1.414 1.414L12 16.414l5.707-5.707z"></path></svg></div></a><div class="tableOfContents_items__qlQt9" style="display:none"><div><a href="#-account-for-cases-where-we-dont-obtain-a-us-barcode"><div class="tableOfContents_content__lrspR">- 🎫 Account for cases where we don’t obtain a US barcode</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div><div><a href="#-pdf-downloads-of-check-results"><div class="tableOfContents_content__lrspR">- ✅ PDF downloads of check results</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div><div><a href="#-webhook-control-on-check"><div class="tableOfContents_content__lrspR">- 📩 Webhook control on check</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div></div></div><div><a href="#onfido-python"><div class="tableOfContents_content__lrspR">onfido-python</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div><div><a href="#api-v30"><div class="tableOfContents_content__lrspR">API v3.0<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true"><path d="M16.293 9.293 12 13.586 7.707 9.293l-1.414 1.414L12 16.414l5.707-5.707z"></path></svg></div></a><div class="tableOfContents_items__qlQt9" style="display:none"><div><a href="#-cleaner-api-structure"><div class="tableOfContents_content__lrspR">- 🧼 Cleaner API structure</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div><div><a href="#-simpler-applicant-creation"><div class="tableOfContents_content__lrspR">- 👩🏻🧔🏿 Simpler applicant creation</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div><div><a href="#-restructured-check-management"><div class="tableOfContents_content__lrspR">- 🏗 Restructured check management</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div><div><a href="#-a-new-biometrics-offering"><div class="tableOfContents_content__lrspR">- 📷 A new biometrics offering</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div><div><a href="#-new-client-libraries"><div class="tableOfContents_content__lrspR">- 🎁 New client libraries</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div></div></div><div><a href="#️-let-us-know-what-you-think"><div class="tableOfContents_content__lrspR">⌨️ Let us know what you think</div></a><div class="tableOfContents_items__qlQt9" style="display:none"></div></div></div></div></div><div class="page_floating-buttons__Y_thw"><div class="floatingNavigation_floating-container__vnBaU"><button style="border-radius:40px;padding:12px" class="ods-button -action--primary"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true" aria-label="Open navigation menu"><path d="M4 6h2v2H4zm0 5h2v2H4zm0 5h2v2H4zm16-8V6H8.023v2H18.8zM8 11h12v2H8zm0 5h12v2H8z"></path></svg></button></div></div></div></div><div class="footer_footer__mQF6i"><div class="footer_top-section__me__S"><div class="footer_marketing-links__IWvle"><div class="footer_section__jhdgK"><a class="footer_section-header__Uc_8K" href="https://onfido.com/solutions/">Solutions</a><a class="footer_section-link__ovosT" href="https://onfido.com/solutions/our-solutions/">Real Identity Platform</a><a class="footer_section-link__ovosT" href="https://onfido.com/solutions/verification-suite/">Verification Suite</a><a class="footer_section-link__ovosT" href="https://onfido.com/solutions/studio/">Onfido Studio</a><a class="footer_section-link__ovosT" href="https://onfido.com/solutions/atlas-ai/">Onfido Atlas</a><a class="footer_section-link__ovosT" href="https://onfido.com/solutions/smart-capture-sdk/">Smart Capture SDK</a></div><div class="footer_section__jhdgK"><a class="footer_section-header__Uc_8K" href="https://onfido.com/use-cases/">Challenges we solve</a><a class="footer_section-link__ovosT" href="https://onfido.com/use-cases/compliance/">Compliance</a><a class="footer_section-link__ovosT" href="https://onfido.com/use-cases/customer-acquisition/">Customer acquisition</a><a class="footer_section-link__ovosT" href="https://onfido.com/use-cases/customer-acquisition-cost/">Reducing cost of acquisition</a><a class="footer_section-link__ovosT" href="https://onfido.com/use-cases/fraud-prevention/">Fraud prevention</a></div><div class="footer_section__jhdgK"><a class="footer_section-header__Uc_8K" href="https://onfido.com/industries/">Industries</a><a class="footer_section-link__ovosT" href="https://onfido.com/industries/financial-services/">Financial Services</a><a class="footer_section-link__ovosT" href="https://onfido.com/industries/gaming/">Gaming</a><a class="footer_section-link__ovosT" href="https://onfido.com/industries/healthcare/">Healthcare</a><a class="footer_section-link__ovosT" href="https://onfido.com/industries/marketplaces-communities/">Marketplaces & communities</a><a class="footer_section-link__ovosT" href="https://onfido.com/industries/retail-ecommerce/">Retail & eCommerce</a><a class="footer_section-link__ovosT" href="https://onfido.com/industries/telecommunications/">Telecommunications</a><a class="footer_section-link__ovosT" href="https://onfido.com/industries/transport/">Transportation</a></div><div class="footer_section__jhdgK"><a class="footer_section-header__Uc_8K" href="https://onfido.com/company/">Our company</a><a class="footer_section-link__ovosT" href="https://onfido.com/company/about/">About Onfido</a><a class="footer_section-link__ovosT" href="https://onfido.com/company/partners/">Onfido partners</a><a class="footer_section-link__ovosT" href="https://onfido.com/company/certifications/">Certifications</a><a class="footer_section-link__ovosT" href="https://onfido.com/company/leadership/">Leadership</a><a class="footer_section-link__ovosT" href="https://onfido.com/company/press/">Press</a><a class="footer_section-link__ovosT" href="https://onfido.com/signup/">Contact us</a></div><div class="footer_section__jhdgK"><a class="footer_section-header__Uc_8K" href="https://onfido.com/company/">Resources</a><a class="footer_section-link__ovosT" href="https://onfido.com/category/blog/">Blog</a><a class="footer_section-link__ovosT" href="https://onfido.com/supported-documents/">Supported documents</a><a class="footer_section-link__ovosT" href="https://documentation.onfido.com/">Developer hub</a><a class="footer_section-link__ovosT" href="https://public.support.onfido.com/s/">Support</a><a class="footer_section-link__ovosT" href="https://dashboard.onfido.com/users/sign_in">Sign in</a></div></div><a class="footer_back-top__Tlp2D" href="#">Back to top<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true"><path d="m6.293 13.293 1.414 1.414L12 10.414l4.293 4.293 1.414-1.414L12 7.586z"></path></svg></a></div><div class="footer_accreditations__REnDo"><div><img alt="Onfido logo" src="/images/logo.png"/><span></span></div><div><span>Onfido uses 256-bit SSL encryption 100% of the time on every device.</span></div><div><img alt="SOC 2 Type II compliant" src="/images/SOC2.png"/><span>Onfido is SOC 2 Type II compliant.</span></div><div><img alt="ISO 27001 certified" src="/images/ISO27001.png"/><span>Onfido has been certified by BSI to ISO 27001 under certificate number IS 660122.</span></div></div><div class="footer_bottom-section__2rGHQ"><div class="footer_socials__RhVNP"><a href="https://www.facebook.com/Onfido/"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true" aria-label="Follow us facebook"><path d="M13.397 20.997v-8.196h2.765l.411-3.209h-3.176V7.548c0-.926.258-1.56 1.587-1.56h1.684V3.127A22.336 22.336 0 0 0 14.201 3c-2.444 0-4.122 1.492-4.122 4.231v2.355H7.332v3.209h2.753v8.202h3.312z"></path></svg></a><a href="https://www.linkedin.com/company/onfido"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true" aria-label="Follow us linkedin"><circle cx="4.983" cy="5.009" r="2.188"></circle><path d="M9.237 8.855v12.139h3.769v-6.003c0-1.584.298-3.118 2.262-3.118 1.937 0 1.961 1.811 1.961 3.218v5.904H21v-6.657c0-3.27-.704-5.783-4.526-5.783-1.835 0-3.065 1.007-3.568 1.96h-.051v-1.66H9.237zm-6.142 0H6.87v12.139H3.095z"></path></svg></a><a href="https://twitter.com/Onfido"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" focusable="false" data-castor-icon="true" aria-label="Follow us X (Twitter)"><path d="M19.633 7.997c.013.175.013.349.013.523 0 5.325-4.053 11.461-11.46 11.461-2.282 0-4.402-.661-6.186-1.809.324.037.636.05.973.05a8.07 8.07 0 0 0 5.001-1.721 4.036 4.036 0 0 1-3.767-2.793c.249.037.499.062.761.062.361 0 .724-.05 1.061-.137a4.027 4.027 0 0 1-3.23-3.953v-.05c.537.299 1.16.486 1.82.511a4.022 4.022 0 0 1-1.796-3.354c0-.748.199-1.434.548-2.032a11.457 11.457 0 0 0 8.306 4.215c-.062-.3-.1-.611-.1-.923a4.026 4.026 0 0 1 4.028-4.028c1.16 0 2.207.486 2.943 1.272a7.957 7.957 0 0 0 2.556-.973 4.02 4.02 0 0 1-1.771 2.22 8.073 8.073 0 0 0 2.319-.624 8.645 8.645 0 0 1-2.019 2.083z"></path></svg></a></div><div class="footer_global-links__WVPbr"><a href="https://onfido.statuspage.io/">Service Status</a><a href="https://onfido.com/privacy">Privacy Policy</a><a href="https://onfido.com/security">Security</a><a href="https://onfido.com/cookie-policy">Website Data Usage and Cookie Policy</a><a href="https://onfido.com/termsofuse">Terms of Use</a><a href="https://go.onfido.com/l/885253/2022-07-29/2l718j/885253/1659105051v0vJ2LAz/Modern_Slavery_Statement_Onfido_2022.pdf">Anti Modern Slavery Statement</a></div><div class="footer_copyright__dtYhr">© Onfido™, 2025. All rights reserved. Company Registration Number: 07479524.</div></div></div><script src="/_next/static/chunks/webpack-df5aa8203ec4c19c.js" crossorigin="" async=""></script><script>(self.__next_f=self.__next_f||[]).push([0]);self.__next_f.push([2,null])</script><script>self.__next_f.push([1,"1:HL[\"/_next/static/css/ffb985fc15812f34.css\",\"style\",{\"crossOrigin\":\"\"}]\n0:\"$L2\"\n"])</script><script>self.__next_f.push([1,"3:HL[\"/_next/static/css/5fd81c61ae2275bd.css\",\"style\",{\"crossOrigin\":\"\"}]\n"])</script><script>self.__next_f.push([1,"4:I[7690,[],\"\"]\n7:I[5613,[],\"\"]\n9:I[1778,[],\"\"]\na:I[7388,[\"446\",\"static/chunks/446-3278feef196ddd95.js\",\"58\",\"static/chunks/58-231460405b897e41.js\",\"185\",\"static/chunks/app/layout-096ab1e2e910acac.js\"],\"GoogleTagManager\"]\nb:I[231,[\"446\",\"static/chunks/446-3278feef196ddd95.js\",\"58\",\"static/chunks/58-231460405b897e41.js\",\"185\",\"static/chunks/app/layout-096ab1e2e910acac.js\"],\"AppWrapper\"]\nc:I[5250,[\"446\",\"static/chunks/446-3278feef196ddd95.js\",\"227\",\"static/chunks/227-8e2bbef1ce1ab7ac.js\",\"531\",\"static/chunks/531-de6dea8eae40067f.js\",\"931\",\"static/chunks/app/page-429a2a471822df8c.js\"],\"\"]\nd:I[3758,[\"446\",\"static/chunks/446-3278feef196ddd95.js\",\"58\",\"static/chunks/58-231460405b897e41.js\",\"185\",\"static/chunks/app/layout-096ab1e2e910acac.js\"],\"Navigation\"]\ne:I[8215,[\"446\",\"static/chunks/446-3278feef196ddd95.js\",\"227\",\"static/chunks/227-8e2bbef1ce1ab7ac.js\",\"531\",\"static/chunks/531-de6dea8eae40067f.js\",\"931\",\"static/chunks/app/page-429a2a471822df8c.js\"],\"Link\"]\nf:I[5346,[\"446\",\"static/chunks/446-3278feef196ddd95.js\",\"58\",\"static/chunks/58-231460405b897e41.js\",\"185\",\"static/chunks/app/layout-096ab1e2e910acac.js\"],\"Search\"]\n11:I[8955,[],\"\"]\n8:[\"slug\",\"api/release-notes\",\"c\"]\n12:[]\n"])</script><script>self.__next_f.push([1,"2:[[[\"$\",\"link\",\"0\",{\"rel\":\"stylesheet\",\"href\":\"/_next/static/css/ffb985fc15812f34.css\",\"precedence\":\"next\",\"crossOrigin\":\"\"}]],[\"$\",\"$L4\",null,{\"buildId\":\"9cHp3l4Z92sbO0hhxlKys\",\"assetPrefix\":\"\",\"initialCanonicalUrl\":\"/api/release-notes/\",\"initialTree\":[\"\",{\"children\":[[\"slug\",\"api/release-notes\",\"c\"],{\"children\":[\"__PAGE__?{\\\"slug\\\":[\\\"api\\\",\\\"release-notes\\\"]}\",{}]}]},\"$undefined\",\"$undefined\",true],\"initialSeedData\":[\"\",{\"children\":[[\"slug\",\"api/release-notes\",\"c\"],{\"children\":[\"__PAGE__\",{},[\"$L5\",\"$L6\",null]]},[\"$\",\"$L7\",null,{\"parallelRouterKey\":\"children\",\"segmentPath\":[\"children\",\"$8\",\"children\"],\"loading\":\"$undefined\",\"loadingStyles\":\"$undefined\",\"loadingScripts\":\"$undefined\",\"hasLoading\":false,\"error\":\"$undefined\",\"errorStyles\":\"$undefined\",\"errorScripts\":\"$undefined\",\"template\":[\"$\",\"$L9\",null,{}],\"templateStyles\":\"$undefined\",\"templateScripts\":\"$undefined\",\"notFound\":\"$undefined\",\"notFoundStyles\":\"$undefined\",\"styles\":[[\"$\",\"link\",\"0\",{\"rel\":\"stylesheet\",\"href\":\"/_next/static/css/5fd81c61ae2275bd.css\",\"precedence\":\"next\",\"crossOrigin\":\"\"}]]}]]},[null,[\"$\",\"html\",null,{\"lang\":\"en\",\"children\":[[\"$\",\"head\",null,{\"children\":[[\"$\",\"meta\",null,{\"charSet\":\"utf-8\"}],[\"$\",\"meta\",null,{\"name\":\"viewport\",\"content\":\"width=device-width, initial-scale=1.0\"}],[\"$\",\"link\",null,{\"rel\":\"icon\",\"href\":\"https://onfido.com/wp-content/themes/onfido/static/icon-32x32.png\",\"type\":\"image/png\"}]]}],[\"$\",\"$La\",null,{\"gtmId\":\"GTM-W5P8TZM\"}],[\"$\",\"body\",null,{\"className\":\"body castor-theme--day\",\"children\":[[\"$\",\"noscript\",null,{\"children\":[\"$\",\"iframe\",null,{\"src\":\"https://www.googletagmanager.com/ns.html?id=GTM-W5P8TZM\",\"height\":\"0\",\"width\":\"0\",\"style\":{\"display\":\"none\",\"visibility\":\"hidden\"}}]}],[\"$\",\"$Lb\",null,{\"children\":[[\"$\",\"div\",null,{\"className\":\"header_header__w2BOs\",\"children\":[[\"$\",\"div\",null,{\"className\":\"header_global-navigation__0toMz\",\"children\":[[\"$\",\"div\",null,{\"className\":\"header_logo-banner__Ie10E\",\"children\":[[\"$\",\"$Lc\",null,{\"target\":\"_blank\",\"rel\":\"noopener noreferrer\",\"href\":\"https://www.onfido.com\",\"children\":[[\"$\",\"img\",null,{\"alt\":\"Onfido Logo\",\"height\":45,\"className\":\"header_logo__9b1Md\",\"src\":\"/images/onfido.svg\"}],[\"$\",\"img\",null,{\"alt\":\"Onfido Logo\",\"height\":45,\"className\":\"header_logo-mini__wjSx_\",\"src\":\"/images/onfido-logo-mini.svg\"}]]}],[\"$\",\"div\",null,{\"className\":\"header_divider__27zUn\"}],[\"$\",\"h1\",null,{\"className\":\"header_title__PBp9J\",\"children\":\"Developers\"}]]}],[\"$\",\"$Ld\",null,{}]]}],[\"$\",\"div\",null,{\"className\":\"header_top-menubar__LRG13\",\"children\":[[\"$\",\"div\",null,{\"className\":\"menu_menu-bar__jyh9r\",\"children\":[[\"$\",\"$Le\",\"/\",{\"className\":\"menu_menu-button__pbibj\",\"partialMatch\":false,\"activeClassName\":\"menu_menu-button-active__VmE8W\",\"href\":\"/\",\"children\":\"Home\"}],[\"$\",\"$Le\",\"/getting-started\",{\"className\":\"menu_menu-button__pbibj\",\"partialMatch\":true,\"activeClassName\":\"menu_menu-button-active__VmE8W\",\"href\":\"/getting-started\",\"children\":\"Getting Started\"}],[\"$\",\"$Le\",\"/guide\",{\"className\":\"menu_menu-button__pbibj\",\"partialMatch\":true,\"activeClassName\":\"menu_menu-button-active__VmE8W\",\"href\":\"/guide\",\"children\":\"Product Guides\"}],[\"$\",\"$Le\",\"/api\",{\"className\":\"menu_menu-button__pbibj\",\"partialMatch\":true,\"activeClassName\":\"menu_menu-button-active__VmE8W\",\"href\":\"/api\",\"children\":\"API\"}],[\"$\",\"$Le\",\"/sdk\",{\"className\":\"menu_menu-button__pbibj\",\"partialMatch\":true,\"activeClassName\":\"menu_menu-button-active__VmE8W\",\"href\":\"/sdk\",\"children\":\"SDKs\"}]]}],[\"$\",\"$Lf\",null,{}]]}]]}],[\"$\",\"div\",null,{\"className\":\"core\",\"children\":[\"$\",\"$L7\",null,{\"parallelRouterKey\":\"children\",\"segmentPath\":[\"children\"],\"loading\":\"$undefined\",\"loadingStyles\":\"$undefined\",\"loadingScripts\":\"$undefined\",\"hasLoading\":false,\"error\":\"$undefined\",\"errorStyles\":\"$undefined\",\"errorScripts\":\"$undefined\",\"template\":[\"$\",\"$L9\",null,{}],\"templateStyles\":\"$undefined\",\"templateScripts\":\"$undefined\",\"notFound\":[[\"$\",\"title\",null,{\"children\":\"404: This page could not be found.\"}],[\"$\",\"div\",null,{\"style\":{\"fontFamily\":\"system-ui,\\\"Segoe UI\\\",Roboto,Helvetica,Arial,sans-serif,\\\"Apple Color Emoji\\\",\\\"Segoe UI Emoji\\\"\",\"height\":\"100vh\",\"textAlign\":\"center\",\"display\":\"flex\",\"flexDirection\":\"column\",\"alignItems\":\"center\",\"justifyContent\":\"center\"},\"children\":[\"$\",\"div\",null,{\"children\":[[\"$\",\"style\",null,{\"dangerouslySetInnerHTML\":{\"__html\":\"body{color:#000;background:#fff;margin:0}.next-error-h1{border-right:1px solid rgba(0,0,0,.3)}@media (prefers-color-scheme:dark){body{color:#fff;background:#000}.next-error-h1{border-right:1px solid rgba(255,255,255,.3)}}\"}}],[\"$\",\"h1\",null,{\"className\":\"next-error-h1\",\"style\":{\"display\":\"inline-block\",\"margin\":\"0 20px 0 0\",\"padding\":\"0 23px 0 0\",\"fontSize\":24,\"fontWeight\":500,\"verticalAlign\":\"top\",\"lineHeight\":\"49px\"},\"children\":\"404\"}],[\"$\",\"div\",null,{\"style\":{\"display\":\"inline-block\"},\"children\":[\"$\",\"h2\",null,{\"style\":{\"fontSize\":14,\"fontWeight\":400,\"lineHeight\":\"49px\",\"margin\":0},\"children\":\"This page could not be found.\"}]}]]}]}]],\"notFoundStyles\":[],\"styles\":null}]}],[\"$\",\"div\",null,{\"className\":\"footer_footer__mQF6i\",\"children\":[[\"$\",\"div\",null,{\"className\":\"footer_top-section__me__S\",\"children\":[[\"$\",\"div\",null,{\"className\":\"footer_marketing-links__IWvle\",\"children\":[[\"$\",\"div\",\"section-Solutions\",{\"className\":\"footer_section__jhdgK\",\"children\":[[\"$\",\"$Lc\",\"header-Solutions\",{\"href\":\"https://onfido.com/solutions/\",\"className\":\"footer_section-header__Uc_8K\",\"children\":\"Solutions\"}],[[\"$\",\"$Lc\",\"link-Real Identity Platform\",{\"href\":\"https://onfido.com/solutions/our-solutions/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Real Identity Platform\"}],[\"$\",\"$Lc\",\"link-Verification Suite\",{\"href\":\"https://onfido.com/solutions/verification-suite/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Verification Suite\"}],[\"$\",\"$Lc\",\"link-Onfido Studio\",{\"href\":\"https://onfido.com/solutions/studio/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Onfido Studio\"}],[\"$\",\"$Lc\",\"link-Onfido Atlas\",{\"href\":\"https://onfido.com/solutions/atlas-ai/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Onfido Atlas\"}],[\"$\",\"$Lc\",\"link-Smart Capture SDK\",{\"href\":\"https://onfido.com/solutions/smart-capture-sdk/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Smart Capture SDK\"}]]]}],[\"$\",\"div\",\"section-Challenges we solve\",{\"className\":\"footer_section__jhdgK\",\"children\":[[\"$\",\"$Lc\",\"header-Challenges we solve\",{\"href\":\"https://onfido.com/use-cases/\",\"className\":\"footer_section-header__Uc_8K\",\"children\":\"Challenges we solve\"}],[[\"$\",\"$Lc\",\"link-Compliance\",{\"href\":\"https://onfido.com/use-cases/compliance/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Compliance\"}],[\"$\",\"$Lc\",\"link-Customer acquisition\",{\"href\":\"https://onfido.com/use-cases/customer-acquisition/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Customer acquisition\"}],[\"$\",\"$Lc\",\"link-Reducing cost of acquisition\",{\"href\":\"https://onfido.com/use-cases/customer-acquisition-cost/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Reducing cost of acquisition\"}],[\"$\",\"$Lc\",\"link-Fraud prevention\",{\"href\":\"https://onfido.com/use-cases/fraud-prevention/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Fraud prevention\"}]]]}],[\"$\",\"div\",\"section-Industries\",{\"className\":\"footer_section__jhdgK\",\"children\":[[\"$\",\"$Lc\",\"header-Industries\",{\"href\":\"https://onfido.com/industries/\",\"className\":\"footer_section-header__Uc_8K\",\"children\":\"Industries\"}],[[\"$\",\"$Lc\",\"link-Financial Services\",{\"href\":\"https://onfido.com/industries/financial-services/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Financial Services\"}],[\"$\",\"$Lc\",\"link-Gaming\",{\"href\":\"https://onfido.com/industries/gaming/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Gaming\"}],[\"$\",\"$Lc\",\"link-Healthcare\",{\"href\":\"https://onfido.com/industries/healthcare/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Healthcare\"}],[\"$\",\"$Lc\",\"link-Marketplaces \u0026 communities\",{\"href\":\"https://onfido.com/industries/marketplaces-communities/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Marketplaces \u0026 communities\"}],[\"$\",\"$Lc\",\"link-Retail \u0026 eCommerce\",{\"href\":\"https://onfido.com/industries/retail-ecommerce/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Retail \u0026 eCommerce\"}],[\"$\",\"$Lc\",\"link-Telecommunications\",{\"href\":\"https://onfido.com/industries/telecommunications/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Telecommunications\"}],[\"$\",\"$Lc\",\"link-Transportation\",{\"href\":\"https://onfido.com/industries/transport/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Transportation\"}]]]}],[\"$\",\"div\",\"section-Our company\",{\"className\":\"footer_section__jhdgK\",\"children\":[[\"$\",\"$Lc\",\"header-Our company\",{\"href\":\"https://onfido.com/company/\",\"className\":\"footer_section-header__Uc_8K\",\"children\":\"Our company\"}],[[\"$\",\"$Lc\",\"link-About Onfido\",{\"href\":\"https://onfido.com/company/about/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"About Onfido\"}],[\"$\",\"$Lc\",\"link-Onfido partners\",{\"href\":\"https://onfido.com/company/partners/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Onfido partners\"}],[\"$\",\"$Lc\",\"link-Certifications\",{\"href\":\"https://onfido.com/company/certifications/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Certifications\"}],[\"$\",\"$Lc\",\"link-Leadership\",{\"href\":\"https://onfido.com/company/leadership/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Leadership\"}],[\"$\",\"$Lc\",\"link-Press\",{\"href\":\"https://onfido.com/company/press/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Press\"}],[\"$\",\"$Lc\",\"link-Contact us\",{\"href\":\"https://onfido.com/signup/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Contact us\"}]]]}],[\"$\",\"div\",\"section-Resources\",{\"className\":\"footer_section__jhdgK\",\"children\":[[\"$\",\"$Lc\",\"header-Resources\",{\"href\":\"https://onfido.com/company/\",\"className\":\"footer_section-header__Uc_8K\",\"children\":\"Resources\"}],[[\"$\",\"$Lc\",\"link-Blog\",{\"href\":\"https://onfido.com/category/blog/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Blog\"}],[\"$\",\"$Lc\",\"link-Supported documents\",{\"href\":\"https://onfido.com/supported-documents/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Supported documents\"}],[\"$\",\"$Lc\",\"link-Developer hub\",{\"href\":\"https://documentation.onfido.com/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Developer hub\"}],[\"$\",\"$Lc\",\"link-Support\",{\"href\":\"https://public.support.onfido.com/s/\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Support\"}],[\"$\",\"$Lc\",\"link-Sign in\",{\"href\":\"https://dashboard.onfido.com/users/sign_in\",\"className\":\"footer_section-link__ovosT\",\"children\":\"Sign in\"}]]]}]]}],[\"$\",\"a\",null,{\"className\":\"footer_back-top__Tlp2D\",\"href\":\"#\",\"children\":[\"Back to top\",[\"$\",\"svg\",null,{\"xmlns\":\"http://www.w3.org/2000/svg\",\"width\":24,\"height\":24,\"viewBox\":\"0 0 24 24\",\"fill\":\"currentColor\",\"focusable\":false,\"data-castor-icon\":true,\"children\":[\"$\",\"path\",null,{\"d\":\"m6.293 13.293 1.414 1.414L12 10.414l4.293 4.293 1.414-1.414L12 7.586z\"}]}]]}]]}],[\"$\",\"div\",null,{\"className\":\"footer_accreditations__REnDo\",\"children\":[[\"$\",\"div\",\"Onfido logo\",{\"children\":[[\"$\",\"img\",null,{\"alt\":\"Onfido logo\",\"src\":\"/images/logo.png\"}],[\"$\",\"span\",null,{\"children\":\"$undefined\"}]]}],[\"$\",\"div\",\"SSL encryption\",{\"children\":[\"$undefined\",[\"$\",\"span\",null,{\"children\":\"Onfido uses 256-bit SSL encryption 100% of the time on every device.\"}]]}],[\"$\",\"div\",\"SOC 2 Type II compliant\",{\"children\":[[\"$\",\"img\",null,{\"alt\":\"SOC 2 Type II compliant\",\"src\":\"/images/SOC2.png\"}],[\"$\",\"span\",null,{\"children\":\"Onfido is SOC 2 Type II compliant.\"}]]}],[\"$\",\"div\",\"ISO 27001 certified\",{\"children\":[[\"$\",\"img\",null,{\"alt\":\"ISO 27001 certified\",\"src\":\"/images/ISO27001.png\"}],[\"$\",\"span\",null,{\"children\":\"Onfido has been certified by BSI to ISO 27001 under certificate number IS 660122.\"}]]}]]}],[\"$\",\"div\",null,{\"className\":\"footer_bottom-section__2rGHQ\",\"children\":[[\"$\",\"div\",null,{\"className\":\"footer_socials__RhVNP\",\"children\":[[\"$\",\"$Lc\",null,{\"href\":\"https://www.facebook.com/Onfido/\",\"children\":[\"$\",\"svg\",null,{\"xmlns\":\"http://www.w3.org/2000/svg\",\"width\":24,\"height\":24,\"viewBox\":\"0 0 24 24\",\"fill\":\"currentColor\",\"focusable\":false,\"data-castor-icon\":true,\"aria-label\":\"Follow us facebook\",\"children\":[\"$\",\"path\",null,{\"d\":\"M13.397 20.997v-8.196h2.765l.411-3.209h-3.176V7.548c0-.926.258-1.56 1.587-1.56h1.684V3.127A22.336 22.336 0 0 0 14.201 3c-2.444 0-4.122 1.492-4.122 4.231v2.355H7.332v3.209h2.753v8.202h3.312z\"}]}]}],[\"$\",\"$Lc\",null,{\"href\":\"https://www.linkedin.com/company/onfido\",\"children\":[\"$\",\"svg\",null,{\"xmlns\":\"http://www.w3.org/2000/svg\",\"width\":24,\"height\":24,\"viewBox\":\"0 0 24 24\",\"fill\":\"currentColor\",\"focusable\":false,\"data-castor-icon\":true,\"aria-label\":\"Follow us linkedin\",\"children\":[[\"$\",\"circle\",null,{\"cx\":4.983,\"cy\":5.009,\"r\":2.188}],[\"$\",\"path\",null,{\"d\":\"M9.237 8.855v12.139h3.769v-6.003c0-1.584.298-3.118 2.262-3.118 1.937 0 1.961 1.811 1.961 3.218v5.904H21v-6.657c0-3.27-.704-5.783-4.526-5.783-1.835 0-3.065 1.007-3.568 1.96h-.051v-1.66H9.237zm-6.142 0H6.87v12.139H3.095z\"}]]}]}],[\"$\",\"$Lc\",null,{\"href\":\"https://twitter.com/Onfido\",\"children\":[\"$\",\"svg\",null,{\"xmlns\":\"http://www.w3.org/2000/svg\",\"width\":24,\"height\":24,\"viewBox\":\"0 0 24 24\",\"fill\":\"currentColor\",\"focusable\":false,\"data-castor-icon\":true,\"aria-label\":\"Follow us X (Twitter)\",\"children\":[\"$\",\"path\",null,{\"d\":\"M19.633 7.997c.013.175.013.349.013.523 0 5.325-4.053 11.461-11.46 11.461-2.282 0-4.402-.661-6.186-1.809.324.037.636.05.973.05a8.07 8.07 0 0 0 5.001-1.721 4.036 4.036 0 0 1-3.767-2.793c.249.037.499.062.761.062.361 0 .724-.05 1.061-.137a4.027 4.027 0 0 1-3.23-3.953v-.05c.537.299 1.16.486 1.82.511a4.022 4.022 0 0 1-1.796-3.354c0-.748.199-1.434.548-2.032a11.457 11.457 0 0 0 8.306 4.215c-.062-.3-.1-.611-.1-.923a4.026 4.026 0 0 1 4.028-4.028c1.16 0 2.207.486 2.943 1.272a7.957 7.957 0 0 0 2.556-.973 4.02 4.02 0 0 1-1.771 2.22 8.073 8.073 0 0 0 2.319-.624 8.645 8.645 0 0 1-2.019 2.083z\"}]}]}]]}],[\"$\",\"div\",null,{\"className\":\"footer_global-links__WVPbr\",\"children\":[[\"$\",\"$Lc\",\"Service Status\",{\"href\":\"https://onfido.statuspage.io/\",\"children\":\"Service Status\"}],[\"$\",\"$Lc\",\"Privacy Policy\",{\"href\":\"https://onfido.com/privacy\",\"children\":\"Privacy Policy\"}],[\"$\",\"$Lc\",\"Security\",{\"href\":\"https://onfido.com/security\",\"children\":\"Security\"}],[\"$\",\"$Lc\",\"Website Data Usage and Cookie Policy\",{\"href\":\"https://onfido.com/cookie-policy\",\"children\":\"Website Data Usage and Cookie Policy\"}],[\"$\",\"$Lc\",\"Terms of Use\",{\"href\":\"https://onfido.com/termsofuse\",\"children\":\"Terms of Use\"}],[\"$\",\"$Lc\",\"Anti Modern Slavery Statement\",{\"href\":\"https://go.onfido.com/l/885253/2022-07-29/2l718j/885253/1659105051v0vJ2LAz/Modern_Slavery_Statement_Onfido_2022.pdf\",\"children\":\"Anti Modern Slavery Statement\"}]]}],[\"$\",\"div\",null,{\"className\":\"footer_copyright__dtYhr\",\"children\":[\"© Onfido™, \",2025,\". All rights reserved. Company Registration Number: 07479524.\"]}]]}]]}]]}]]}]]}],null]],\"initialHead\":[false,\"$L10\"],\"globalErrorComponent\":\"$11\",\"missingSlots\":\"$W12\"}]]\n"])</script><script>self.__next_f.push([1,"10:[[\"$\",\"meta\",\"0\",{\"name\":\"viewport\",\"content\":\"width=device-width, initial-scale=1\"}],[\"$\",\"meta\",\"1\",{\"charSet\":\"utf-8\"}],[\"$\",\"title\",\"2\",{\"children\":\"Release notes | Onfido\"}],[\"$\",\"meta\",\"3\",{\"name\":\"description\",\"content\":\"This is an overview of Onfido's API release notes\"}],[\"$\",\"link\",\"4\",{\"rel\":\"manifest\",\"href\":\"/manifest.webmanifest\"}],[\"$\",\"meta\",\"5\",{\"name\":\"robots\",\"content\":\"index, follow, nocache\"}],[\"$\",\"meta\",\"6\",{\"name\":\"googlebot\",\"content\":\"index, nofollow, noimageindex, max-video-preview:-1, max-image-preview:large, max-snippet:-1\"}],[\"$\",\"meta\",\"7\",{\"property\":\"og:title\",\"content\":\"Release notes\"}],[\"$\",\"meta\",\"8\",{\"property\":\"og:description\",\"content\":\"This is an overview of Onfido's API release notes\"}],[\"$\",\"meta\",\"9\",{\"property\":\"og:url\",\"content\":\"https://documentation.onfido.com/api/release-notes/\"}],[\"$\",\"meta\",\"10\",{\"property\":\"og:site_name\",\"content\":\"Onfido\"}],[\"$\",\"meta\",\"11\",{\"property\":\"og:locale\",\"content\":\"en_US\"}],[\"$\",\"meta\",\"12\",{\"property\":\"og:image\",\"content\":\"https://onfido.com/wp-content/uploads/2023/02/onfido-logo-feature-image-1200x628-1.png\"}],[\"$\",\"meta\",\"13\",{\"property\":\"og:image:width\",\"content\":\"1200\"}],[\"$\",\"meta\",\"14\",{\"property\":\"og:image:height\",\"content\":\"628\"}],[\"$\",\"meta\",\"15\",{\"property\":\"og:image:type\",\"content\":\"image/png\"}],[\"$\",\"meta\",\"16\",{\"property\":\"og:type\",\"content\":\"website\"}],[\"$\",\"meta\",\"17\",{\"name\":\"twitter:card\",\"content\":\"summary_large_image\"}],[\"$\",\"meta\",\"18\",{\"name\":\"twitter:creator\",\"content\":\"@onfido\"}],[\"$\",\"meta\",\"19\",{\"name\":\"twitter:title\",\"content\":\"Release notes\"}],[\"$\",\"meta\",\"20\",{\"name\":\"twitter:description\",\"content\":\"This is an overview of Onfido's API release notes\"}],[\"$\",\"meta\",\"21\",{\"name\":\"twitter:image\",\"content\":\"https://onfido.com/wp-content/uploads/2023/02/onfido-logo-feature-image-1200x628-1.png\"}],[\"$\",\"link\",\"22\",{\"rel\":\"shortcut icon\",\"href\":\"https://onfido.com/wp-content/themes/onfido/static/icon-32x32.png\"}],[\"$\",\"link\",\"23\",{\"rel\":\"icon\",\"href\":\"https://onfido.com/wp-content/themes/onfido/static/icon-32x32.png\"}],[\"$\",\"link\",\"24\",{\"rel\":\"apple-touch-icon\",\"href\":\"https://onfido.com/wp-content/themes/onfido/static/icon-48x48.png\",\"sizes\":\"48x48\",\"type\":\"image/png\"}],[\"$\",\"link\",\"25\",{\"rel\":\"apple-touch-icon\",\"href\":\"https://onfido.com/wp-content/themes/onfido/static/icon-72x72.png\",\"sizes\":\"72x72\",\"type\":\"image/png\"}],[\"$\",\"link\",\"26\",{\"rel\":\"apple-touch-icon\",\"href\":\"https://onfido.com/wp-content/themes/onfido/static/icon-96x96.png\",\"sizes\":\"96x96\",\"type\":\"image/png\"}],[\"$\",\"link\",\"27\",{\"rel\":\"apple-touch-icon\",\"href\":\"https://onfido.com/wp-content/themes/onfido/static/icon-144x144.png\",\"sizes\":\"144x144\",\"type\":\"image/png\"}],[\"$\",\"link\",\"28\",{\"rel\":\"apple-touch-icon\",\"href\":\"https://onfido.com/wp-content/themes/onfido/static/icon-192x192.png\",\"sizes\":\"192x192\",\"type\":\"image/png\"}],[\"$\",\"link\",\"29\",{\"rel\":\"apple-touch-icon\",\"href\":\"https://onfido.com/wp-content/themes/onfido/static/icon-256x256.png\",\"sizes\":\"256x256\",\"type\":\"image/png\"}],[\"$\",\"link\",\"30\",{\"rel\":\"apple-touch-icon\",\"href\":\"https://onfido.com/wp-content/themes/onfido/static/icon-384x384.png\",\"sizes\":\"384x384\",\"type\":\"image/png\"}],[\"$\",\"link\",\"31\",{\"rel\":\"apple-touch-icon\",\"href\":\"https://onfido.com/wp-content/themes/onfido/static/icon-512x512.png\",\"sizes\":\"512x512\",\"type\":\"image/png\"}]]\n"])</script><script>self.__next_f.push([1,"5:null\n"])</script><script>self.__next_f.push([1,"13:I[531,[\"446\",\"static/chunks/446-3278feef196ddd95.js\",\"227\",\"static/chunks/227-8e2bbef1ce1ab7ac.js\",\"599\",\"static/chunks/599-3057f8a397da50f4.js\",\"531\",\"static/chunks/531-de6dea8eae40067f.js\",\"877\",\"static/chunks/app/%5B...slug%5D/page-545a92e622e14d71.js\"],\"Page\"]\n14:I[1606,[\"446\",\"static/chunks/446-3278feef196ddd95.js\",\"227\",\"static/chunks/227-8e2bbef1ce1ab7ac.js\",\"599\",\"static/chunks/599-3057f8a397da50f4.js\",\"531\",\"static/chunks/531-de6dea8eae40067f.js\",\"877\",\"static/chunks/app/%5B...slug%5D/page-545a92e622e14d71.js\"],\"CodeSnippetProvider\"]\n15:I[520,[\"446\",\"static/chunks/446-3278feef196ddd95.js\",\"227\",\"static/chunks/227-8e2bbef1ce1ab7ac.js\",\"599\",\"static/chunks/599-3057f8a397da50f4.js\",\"531\",\"static/chunks/531-de6dea8eae40067f.js\",\"877\",\"static/chunks/app/%5B...slug%5D/page-545a92e622e14d71.js\"],\"\"]\n16:I[1968,[\"446\",\"static/chunks/446-3278feef196ddd95.js\",\"227\",\"static/chunks/227-8e2bbef1ce1ab7ac.js\",\"599\",\"static/chunks/599-3057f8a397da50f4.js\",\"531\",\"static/chunks/531-de6dea8eae40067f.js\",\"877\",\"static/chunks/app/%5B...slug%5D/page-545a92e622e14d71.js\"],\"CodeSnippet\"]\n"])</script><script>self.__next_f.push([1,"6:[\"$\",\"$L13\",null,{\"menu\":[{\"title\":\"Api\",\"items\":[{\"title\":\"API reference\",\"href\":\"/api/latest\"},{\"title\":\"API Release notes\",\"href\":\"/api/release-notes\"},{\"title\":\"API versioning policy\",\"href\":\"/api/api-versioning-policy\"},{\"title\":\"API v2 to v3.6 migration guide\",\"href\":\"/api/api-v2-to-v3-migration-guide\"},{\"title\":\"API v3 to v3.6 migration guide\",\"href\":\"/api/api-v3-to-v3.6-migration-guide\"},{\"title\":\"Document report object attributes\",\"href\":\"/api/document-report-object\"},{\"title\":\"Recommended data inputs for Identity Enhanced reports\",\"href\":\"/api/identity-supported-countries-and-data\"},{\"title\":\"Manual webhook signature verification\",\"href\":\"/api/manual-webhook-signature-verification\"}]},{\"title\":\"Integration Libraries\",\"items\":[{\"title\":\"Postman collection\",\"href\":\"https://god.gw.postman.com/run-collection/38453665-3be48048-00b8-43bf-8c91-82953801b7aa\",\"icon\":\"/icons/postman.svg\",\"isExternal\":true},{\"title\":\"OpenAPI specifications\",\"href\":\"https://github.com/onfido/onfido-openapi-spec\",\"icon\":\"/icons/openApi.svg\",\"isExternal\":true},{\"title\":\"Java library\",\"href\":\"https://github.com/onfido/onfido-java\",\"icon\":\"/icons/java.svg\",\"isExternal\":true},{\"title\":\"Python library\",\"href\":\"https://github.com/onfido/onfido-python\",\"icon\":\"/icons/python.svg\",\"isExternal\":true},{\"title\":\"Node.js library\",\"href\":\"https://github.com/onfido/onfido-node\",\"icon\":\"/icons/node.svg\",\"isExternal\":true},{\"title\":\"PHP library\",\"href\":\"https://github.com/onfido/onfido-php\",\"icon\":\"/icons/php.svg\",\"isExternal\":true},{\"title\":\"Ruby library\",\"href\":\"https://github.com/onfido/onfido-ruby\",\"icon\":\"/icons/ruby.svg\",\"isExternal\":true}]}],\"basePath\":\"/api\",\"tableOfContents\":{\"items\":[{\"level\":1,\"links\":[],\"href\":\"#onfido-api\",\"title\":\"Onfido API\",\"childHrefs\":[]},{\"level\":1,\"links\":[],\"href\":\"#api-versioning-policy-update\",\"title\":\"API Versioning Policy update\",\"childHrefs\":[]},{\"level\":1,\"links\":[{\"level\":3,\"links\":[],\"href\":\"#-new-property-for-known-faces-report-matches\",\"title\":\"🖥 New property for known faces report matches\",\"childHrefs\":[]}],\"href\":\"#api-v36\",\"title\":\"API v3.6\",\"childHrefs\":[\"#-new-property-for-known-faces-report-matches\"]},{\"level\":1,\"links\":[{\"level\":3,\"links\":[],\"href\":\"#-new-data-input-and-breakdown-for-identity-enhanced-kyc-report\",\"title\":\"🖥 New data input and breakdown for Identity Enhanced (KYC) report\",\"childHrefs\":[]},{\"level\":3,\"links\":[],\"href\":\"#expand-the-document-report\",\"title\":\"Expand the Document report\",\"childHrefs\":[]},{\"level\":3,\"links\":[],\"href\":\"#-proof-of-address-improvements\",\"title\":\"🏠 Proof of Address improvements\",\"childHrefs\":[]}],\"href\":\"#api-v35\",\"title\":\"API v3.5\",\"childHrefs\":[\"#-new-data-input-and-breakdown-for-identity-enhanced-kyc-report\",\"#expand-the-document-report\",\"#-proof-of-address-improvements\"]},{\"level\":1,\"links\":[{\"level\":3,\"links\":[],\"href\":\"#-us-biometrics-law-compliance\",\"title\":\"📜 US biometrics law compliance\",\"childHrefs\":[]},{\"level\":3,\"links\":[],\"href\":\"#-proof-of-address-improvements-1\",\"title\":\"🏠 Proof of Address improvements\",\"childHrefs\":[]}],\"href\":\"#api-v34\",\"title\":\"API v3.4\",\"childHrefs\":[\"#-us-biometrics-law-compliance\",\"#-proof-of-address-improvements-1\"]},{\"level\":1,\"links\":[{\"level\":3,\"links\":[],\"href\":\"#-expanded-proof-of-address-report\",\"title\":\"🏠 Expanded Proof of Address report\",\"childHrefs\":[]}],\"href\":\"#api-v33\",\"title\":\"API v3.3\",\"childHrefs\":[\"#-expanded-proof-of-address-report\"]},{\"level\":1,\"links\":[],\"href\":\"#watchlist-aml-report\",\"title\":\"Watchlist AML report\",\"childHrefs\":[]},{\"level\":1,\"links\":[],\"href\":\"#trusted-faces-for-face-authenticate\",\"title\":\"Trusted Faces for Face Authenticate\",\"childHrefs\":[]},{\"level\":1,\"links\":[],\"href\":\"#image-quality-in-the-api\",\"title\":\"Image Quality in the API\",\"childHrefs\":[]},{\"level\":1,\"links\":[],\"href\":\"#face-authenticate\",\"title\":\"Face Authenticate\",\"childHrefs\":[]},{\"level\":1,\"links\":[],\"href\":\"#drivers-license-data-verification-dldv-report\",\"title\":\"Driver's License Data Verification (DLDV) report\",\"childHrefs\":[]},{\"level\":1,\"links\":[{\"level\":3,\"links\":[],\"href\":\"#-document-used-for-face-matching\",\"title\":\"👤👤 Document used for face matching\",\"childHrefs\":[]}],\"href\":\"#api-v32\",\"title\":\"API v3.2\",\"childHrefs\":[\"#-document-used-for-face-matching\"]},{\"level\":1,\"links\":[],\"href\":\"#right-to-work-share-code\",\"title\":\"Right to Work share code\",\"childHrefs\":[]},{\"level\":1,\"links\":[{\"level\":3,\"links\":[],\"href\":\"#-account-for-cases-where-we-dont-obtain-a-us-barcode\",\"title\":\"🎫 Account for cases where we don’t obtain a US barcode\",\"childHrefs\":[]},{\"level\":3,\"links\":[],\"href\":\"#-pdf-downloads-of-check-results\",\"title\":\"✅ PDF downloads of check results\",\"childHrefs\":[]},{\"level\":3,\"links\":[],\"href\":\"#-webhook-control-on-check\",\"title\":\"📩 Webhook control on check\",\"childHrefs\":[]}],\"href\":\"#api-v31\",\"title\":\"API v3.1\",\"childHrefs\":[\"#-account-for-cases-where-we-dont-obtain-a-us-barcode\",\"#-pdf-downloads-of-check-results\",\"#-webhook-control-on-check\"]},{\"level\":1,\"links\":[],\"href\":\"#onfido-python\",\"title\":\"onfido-python\",\"childHrefs\":[]},{\"level\":1,\"links\":[{\"level\":3,\"links\":[],\"href\":\"#-cleaner-api-structure\",\"title\":\"🧼 Cleaner API structure\",\"childHrefs\":[]},{\"level\":3,\"links\":[],\"href\":\"#-simpler-applicant-creation\",\"title\":\"👩🏻🧔🏿 Simpler applicant creation\",\"childHrefs\":[]},{\"level\":3,\"links\":[],\"href\":\"#-restructured-check-management\",\"title\":\"🏗 Restructured check management\",\"childHrefs\":[]},{\"level\":3,\"links\":[],\"href\":\"#-a-new-biometrics-offering\",\"title\":\"📷 A new biometrics offering\",\"childHrefs\":[]},{\"level\":3,\"links\":[],\"href\":\"#-new-client-libraries\",\"title\":\"🎁 New client libraries\",\"childHrefs\":[]}],\"href\":\"#api-v30\",\"title\":\"API v3.0\",\"childHrefs\":[\"#-cleaner-api-structure\",\"#-simpler-applicant-creation\",\"#-restructured-check-management\",\"#-a-new-biometrics-offering\",\"#-new-client-libraries\"]},{\"level\":1,\"links\":[],\"href\":\"#️-let-us-know-what-you-think\",\"title\":\"⌨️ Let us know what you think\",\"childHrefs\":[]}],\"skippedFirstHeader\":true,\"platform\":\"$undefined\",\"version\":\"$undefined\",\"type\":\"guide\"},\"children\":[\"$\",\"div\",null,{\"className\":\"layout_layout__Cpwpp\",\"children\":[\"$\",\"$L14\",null,{\"children\":[[\"$\",\"h1\",null,{\"id\":\"release-notes\",\"children\":[\"Release notes\",[\"$\",\"$L15\",null,{\"link\":\"#release-notes\"}]]}],\"\\n\",[\"$\",\"h2\",null,{\"id\":\"onfido-api\",\"children\":[\"Onfido API\",[\"$\",\"$L15\",null,{\"link\":\"#onfido-api\"}]]}],\"\\n\",[\"$\",\"h2\",null,{\"id\":\"api-versioning-policy-update\",\"children\":[\"API Versioning Policy update\",[\"$\",\"$L15\",null,{\"link\":\"#api-versioning-policy-update\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"27 February 2023\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"The API Versioning Policy was updated for API v3.6 onwards to accept backwards compatible changes, read more \",[\"$\",\"a\",null,{\"href\":\"/api/api-versioning-policy#how-we-version-v36\",\"children\":\"in our versioning policy documentation\"}],\".\"]}],\"\\n\",[\"$\",\"h2\",null,{\"id\":\"api-v36\",\"children\":[\"API v3.6\",[\"$\",\"$L15\",null,{\"link\":\"#api-v36\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"24 January 2023\"}],\"\\n\",[\"$\",\"h3\",null,{\"id\":\"-new-property-for-known-faces-report-matches\",\"children\":[\"🖥 New property for known faces report matches\",[\"$\",\"$L15\",null,{\"link\":\"#-new-property-for-known-faces-report-matches\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"The Known Faces report will perform matched applicant \",[\"$\",\"strong\",null,{\"children\":\"fuzzy name matching\"}],\" in the matches set so that matches where the \",[\"$\",\"code\",null,{\"children\":\"suspected\"}],\" field is \",[\"$\",\"code\",null,{\"children\":\"true\"}],\" should be considered as possible fraud. This will only work for clients where \",[\"$\",\"strong\",null,{\"children\":\"fuzzy name matching\"}],\" is configured, otherwise it will always return \",[\"$\",\"code\",null,{\"children\":\"true\"}],\" for all matches.\"]}],\"\\n\",[\"$\",\"$L16\",null,{\"title\":\"json\",\"snippets\":[{\"language\":\"json\",\"code\":\"...\\n\\\"matches\\\": [\\n {\\n \\\"applicant_id\\\": \\\"NTH_MATCHED_APPLICANT_ID\\\",\\n \\\"score\\\": 0.9915,\\n \\\"media_id\\\": \\\"LIVE_PHOTO_ID\\\",\\n \\\"media_type\\\": \\\"live_photos\\\",\\n \\\"suspected\\\": true\\n },\\n ....\\n]\\n\\n}\\n...\\n\"}]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"Read more \",[\"$\",\"a\",null,{\"href\":\"/guide/known-faces-report/\",\"children\":\"in our product documentation\"}],\" or \",[\"$\",\"a\",null,{\"href\":\"/api/latest/#known-faces-report\",\"children\":\"API reference\"}],\".\"]}],\"\\n\",[\"$\",\"h2\",null,{\"id\":\"api-v35\",\"children\":[\"API v3.5\",[\"$\",\"$L15\",null,{\"link\":\"#api-v35\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"08 November 2022\"}],\"\\n\",[\"$\",\"h3\",null,{\"id\":\"-new-data-input-and-breakdown-for-identity-enhanced-kyc-report\",\"children\":[\"🖥 New data input and breakdown for Identity Enhanced (KYC) report\",[\"$\",\"$L15\",null,{\"link\":\"#-new-data-input-and-breakdown-for-identity-enhanced-kyc-report\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"The Identity Enhanced (KYC) report will collect national id numbers and phone numbers as optional inputs for non-UK/non-US geos to help improve performance.\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"As a result, a new breakdown \",[\"$\",\"code\",null,{\"children\":\"national_id_number\"}],\" will be added for Identity Enhanced (KYC) reports.\"]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[[\"$\",\"code\",null,{\"children\":\"id_number\"}],\" resource types have been expanded with the following new values: \",[\"$\",\"code\",null,{\"children\":\"voter_id\"}],\", \",[\"$\",\"code\",null,{\"children\":\"passport\"}],\", and \",[\"$\",\"code\",null,{\"children\":\"other\"}],\".\"]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"A new breakdown \",[\"$\",\"code\",null,{\"children\":\"national_id_number\"}],\" has been added to the \",[\"$\",\"code\",null,{\"children\":\"breakdown\"}],\" field in the report response:\"]}],\"\\n\",[\"$\",\"$L16\",null,{\"title\":\"json\",\"snippets\":[{\"language\":\"json\",\"code\":\"...\\n\\\"breakdown\\\": {\\n \\\"national_id_number\\\": {\\n \\\"result\\\": \\\"clear\\\",\\n \\\"breakdown\\\": {\\n \\\"national_id_number_matched\\\": {\\n \\\"results\\\": \\\"clear\\\",\\n \\\"properties\\\": {\\n \\\"sources\\\": \\\"Government\\\",\\n \\\"type\\\": \\\"Identity Card\\\"\\n }\\n }\\n }\\n }\\n}\\n...\\n\"}]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"Read more \",[\"$\",\"a\",null,{\"href\":\"/guide/identity-enhanced-report/\",\"children\":\"in our product documentation\"}],\" or \",[\"$\",\"a\",null,{\"href\":\"/api/latest/#identity-enhanced-report\",\"children\":\"API reference\"}],\".\"]}],\"\\n\",[\"$\",\"h3\",null,{\"id\":\"expand-the-document-report\",\"children\":[\"Expand the Document report\",[\"$\",\"$L15\",null,{\"link\":\"#expand-the-document-report\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"As part of the Document report, we now assert if a document has been reused in a suspicious way. This verification result will be mapped to the new \",[\"$\",\"code\",null,{\"children\":\"repeat_attempts\"}],\" sub-breakdown that was added under the \",[\"$\",\"code\",null,{\"children\":\"compromised_document\"}],\" breakdown. The previous \",[\"$\",\"code\",null,{\"children\":\"compromised_document\"}],\" verification that asserts whether the document is publicly available as compromised will be mapped to the \",[\"$\",\"code\",null,{\"children\":\"document_database\"}],\" sub-breakdown.\"]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"Below you will find examples comparing the previous and new response format.\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"API versions prior to v3.5:\"}],\"\\n\",[\"$\",\"$L16\",null,{\"title\":\"json\",\"snippets\":[{\"language\":\"json\",\"code\":\"...\\n\\\"compromised_document\\\": {\\n \\\"result\\\": \\\"clear\\\"\\n }\\n...\\n\"}]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"API versions higher or equal to v3.5:\"}],\"\\n\",[\"$\",\"$L16\",null,{\"title\":\"json\",\"snippets\":[{\"language\":\"json\",\"code\":\"...\\n\\\"compromised_document\\\": {\\n \\\"result\\\": \\\"clear\\\",\\n \\\"breakdown\\\": {\\n \\\"document_database\\\": {\\n \\\"result\\\": \\\"clear\\\",\\n \\\"properties\\\": {}\\n },\\n \\\"repeat_attempts\\\": {\\n \\\"result\\\": \\\"clear\\\",\\n \\\"properties\\\": {}\\n }\\n }\\n },\\n...\\n\"}]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"The \",[\"$\",\"code\",null,{\"children\":\"compromised_document\"}],\" breakdown will now contain two sub-breakdowns:\"]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[[\"$\",\"code\",null,{\"children\":\"compromised_document_database\"}],\" - this is the already existing sub-breakdown that asserts whether the document is publicly available as compromised.\"]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[[\"$\",\"code\",null,{\"children\":\"repeat_attempts\"}],\" - a new sub-breakdown that asserts if a document has been reused in a suspicious way.\"]}],\"\\n\",[\"$\",\"h3\",null,{\"id\":\"-proof-of-address-improvements\",\"children\":[\"🏠 Proof of Address improvements\",[\"$\",\"$L15\",null,{\"link\":\"#-proof-of-address-improvements\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"The Proof of Address report has been improved by adding a \",[\"$\",\"code\",null,{\"children\":\"source_integrity\"}],\" breakdown, as well as adding sub-breakdowns for \",[\"$\",\"code\",null,{\"children\":\"visual_fraud\"}],\" and \",[\"$\",\"code\",null,{\"children\":\"digital_tampering\"}],\".\"]}],\"\\n\",[\"$\",\"$L16\",null,{\"title\":\"json\",\"snippets\":[{\"language\":\"json\",\"code\":\"...\\n\\\"breakdown\\\": {\\n \\\"source_integrity\\\": {\\n \\\"result\\\": \\\"clear\\\",\\n \\\"breakdown\\\": {\\n \\\"visible_fraud\\\": {\\n \\\"result\\\": \\\"clear\\\",\\n \\\"properties\\\": {}\\n },\\n \\\"digital_tampering\\\": {\\n \\\"result\\\": \\\"clear\\\",\\n \\\"properties\\\": {}\\n }\\n }\\n }\\n}\\n...\\n\"}]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"The \",[\"$\",\"code\",null,{\"children\":\"photos_of_screens\"}],\" document source type has been added, as well as support for the following document types:\"]}],\"\\n\",[\"$\",\"ul\",null,{\"children\":[\"\\n\",[\"$\",\"li\",null,{\"children\":[\"$\",\"code\",null,{\"children\":\"general_letter\"}]}],\"\\n\",[\"$\",\"li\",null,{\"children\":[\"$\",\"code\",null,{\"children\":\"insurance_statement\"}]}],\"\\n\",[\"$\",\"li\",null,{\"children\":[\"$\",\"code\",null,{\"children\":\"pension_property_statement_letter\"}]}],\"\\n\",[\"$\",\"li\",null,{\"children\":[\"$\",\"code\",null,{\"children\":\"mortgage_statement\"}]}],\"\\n\",[\"$\",\"li\",null,{\"children\":[\"$\",\"code\",null,{\"children\":\"mobile_phone_bill\"}]}],\"\\n\",[\"$\",\"li\",null,{\"children\":[\"$\",\"code\",null,{\"children\":\"identity_document_with_address\"}]}],\"\\n\"]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"We've also added new document validity rules and \",[\"$\",\"code\",null,{\"children\":\"expiry_date\"}],\". Read more in our \",[\"$\",\"a\",null,{\"href\":\"/guide/proof-of-address-report/\",\"children\":\"product documentation\"}],\" or \",[\"$\",\"a\",null,{\"href\":\"/api/latest/#proof-of-address-report\",\"children\":\"API reference\"}],\".\"]}],\"\\n\",[\"$\",\"h2\",null,{\"id\":\"api-v34\",\"children\":[\"API v3.4\",[\"$\",\"$L15\",null,{\"link\":\"#api-v34\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"4th May 2022\"}],\"\\n\",[\"$\",\"h3\",null,{\"id\":\"-us-biometrics-law-compliance\",\"children\":[\"📜 US biometrics law compliance\",[\"$\",\"$L15\",null,{\"link\":\"#-us-biometrics-law-compliance\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"To ensure compliance with US laws on biometric data, and to take a privacy centric approach to protect the rights of end users, we have built a new process for gathering and submitting US end user consent.\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"You must now submit the location of all end users and, where the location is the US, confirm that the end user has granted consent for Onfido, before submitting any checks, unless you are using the Onfido SDK, in which case you must instead update your SDK integration to the corresponding version listed in \",[\"$\",\"a\",null,{\"href\":\"/guide/migration-guide-onfido-privacy-notices-and-consent#version-upgrades\",\"children\":\"MIGRATION GUIDE: ONFIDO PRIVACY NOTICES AND CONSENT (US)\"}],\" to enable Onfido to collect and process this information automatically.\"]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[[\"$\",\"code\",null,{\"children\":\"location\"}],\" has been added to the \",[\"$\",\"a\",null,{\"href\":\"/api/latest/#applicants\",\"children\":\"applicant\"}],\" and \",[\"$\",\"a\",null,{\"href\":\"/api/latest/#upload-document\",\"children\":\"document\"}],\" resource:\"]}],\"\\n\",[\"$\",\"$L16\",null,{\"title\":\"json\",\"snippets\":[{\"language\":\"json\",\"code\":\"...\\n\\\"location\\\": {\\n \\\"ip_address\\\": \\\"219.44.17.31\\\",\\n \\\"country_of_residence\\\": \\\"USA\\\"\\n }\\n...\\n\"}]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[[\"$\",\"code\",null,{\"children\":\"consents\"}],\" has been added to the \",[\"$\",\"a\",null,{\"href\":\"/api/latest/#create-applicant\",\"children\":\"applicant\"}],\" resource:\"]}],\"\\n\",[\"$\",\"$L16\",null,{\"title\":\"json\",\"snippets\":[{\"language\":\"json\",\"code\":\"...\\n\\\"consents\\\": [\\n {\\n \\\"name\\\": \\\"privacy_notices_read\\\",\\n \\\"granted\\\": true\\n }\\n ]\\n...\\n\"}]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"For more information on how to upgrade your integration to use the latest consent parameters please see our \",[\"$\",\"a\",null,{\"href\":\"/guide/migration-guide-onfido-privacy-notices-and-consent/\",\"children\":\"migration guide\"}],\".\"]}],\"\\n\",[\"$\",\"h3\",null,{\"id\":\"-proof-of-address-improvements-1\",\"children\":[\"🏠 Proof of Address improvements\",[\"$\",\"$L15\",null,{\"link\":\"#-proof-of-address-improvements-1\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"We've added the \",[\"$\",\"code\",null,{\"children\":\"address_parsed\"}],\" and \",[\"$\",\"code\",null,{\"children\":\"unsupported_document_reason\"}],\" properties as well as new support for the \",[\"$\",\"code\",null,{\"children\":\"address_certificate\"}],\" document type.\"]}],\"\\n\",[\"$\",\"h2\",null,{\"id\":\"api-v33\",\"children\":[\"API v3.3\",[\"$\",\"$L15\",null,{\"link\":\"#api-v33\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"18th February 2022\"}],\"\\n\",[\"$\",\"h3\",null,{\"id\":\"-expanded-proof-of-address-report\",\"children\":[\"🏠 Expanded Proof of Address report\",[\"$\",\"$L15\",null,{\"link\":\"#-expanded-proof-of-address-report\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"The Proof of Address report has been expanded to include new supported issuing countries and date validation logic.\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"The European Union, USA and Canada are now all supported issuing countries, in addition to the UK.\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"The report also now asserts whether the submitted document has a valid date of issue. We've added the \",[\"$\",\"code\",null,{\"children\":\"valid_document_date\"}],\" sub-breakdown under \",[\"$\",\"code\",null,{\"children\":\"document_classification\"}],\". The relevant part of the response from the API contains the following for a \",[\"$\",\"code\",null,{\"children\":\"clear\"}],\" breakdown result:\"]}],\"\\n\",[\"$\",\"$L16\",null,{\"title\":\"json\",\"snippets\":[{\"language\":\"json\",\"code\":\"...\\n\\\"document_classification\\\":{\\n \\\"result\\\":\\\"clear\\\",\\n \\\"breakdown\\\":{\\n \\\"valid_document_date\\\":{\\n \\\"result\\\":\\\"clear\\\",\\n \\\"properties\\\":{}\\n },\\n...\\n\"}]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"Read more \",[\"$\",\"a\",null,{\"href\":\"/guide/proof-of-address-report/\",\"children\":\"in our product documentation\"}],\" or \",[\"$\",\"a\",null,{\"href\":\"/api/latest/#proof-of-address-report\",\"children\":\"API reference\"}],\".\"]}],\"\\n\",[\"$\",\"h2\",null,{\"id\":\"watchlist-aml-report\",\"children\":[\"Watchlist AML report\",[\"$\",\"$L15\",null,{\"link\":\"#watchlist-aml-report\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"12th January 2022\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"🔍 We have introduced a new watchlist variant, Watchlist AML, which checks users against global watchlists and media sources. It expands on the current Watchlist standard report to include adverse media and is 6AMLD compliant.\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"It is available to use across all versions of the Onfido API. Read more \",[\"$\",\"a\",null,{\"href\":\"/guide/watchlist-reports/\",\"children\":\"in our product documentation\"}],\" or \",[\"$\",\"a\",null,{\"href\":\"/api/latest/#watchlist-aml\",\"children\":\"API reference\"}],\".\"]}],\"\\n\",[\"$\",\"h2\",null,{\"id\":\"trusted-faces-for-face-authenticate\",\"children\":[\"Trusted Faces for Face Authenticate\",[\"$\",\"$L15\",null,{\"link\":\"#trusted-faces-for-face-authenticate\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"15th November 2021\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"👤 You can now enrol any user in Face Authenticate, without them needing to complete a Facial Similarity report with Onfido. This means Face Authenticate is available for everyone with no dependencies.\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"Trusted Faces allows you to upload any image of the applicant that you trust, whether that is a file from an internal database or an image submitted for a Facial Similarity report.\"}],\"\\n\",[\"$\",\"h2\",null,{\"id\":\"image-quality-in-the-api\",\"children\":[\"Image Quality in the API\",[\"$\",\"$L15\",null,{\"link\":\"#image-quality-in-the-api\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"30th September 2021\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"✅ We've added the \",[\"$\",\"code\",null,{\"children\":\"validate_image_quality\"}],\" option when \",[\"$\",\"a\",null,{\"href\":\"/api/latest/#upload-document\",\"children\":\"uploading a document using the API\"}],\". If requested, the submitted image will undergo an image quality validation, which checks the quality of the uploaded image. If the validation fails, a reason for the failure is returned and you can request the end user to retake the photo.\"]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"Validating image quality at the point of document upload reduces the risk of an applicant submitting an image that is of insufficient quality to be verified by the Document report, improving pass rates and turn around times.\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"It is available to use across all versions of the Onfido API. Read more in our \",[\"$\",\"a\",null,{\"href\":\"/api/latest/#image-quality\",\"children\":\"API reference\"}],\".\"]}],\"\\n\",[\"$\",\"h2\",null,{\"id\":\"face-authenticate\",\"children\":[\"Face Authenticate\",[\"$\",\"$L15\",null,{\"link\":\"#face-authenticate\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"19th August 2021\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"🔁 It is now possible to re-verify end users who have already had their initial identity verified by Onfido. Face Authenticate offers a fully automated, real time comparison between an applicant's face and the recorded image of the applicant on your Onfido account, verifying if the face is a match and it is a real person.\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"Face Authenticate can be used for account recovery, approving high risk transactions and enabling access to services along with multiple other use cases. It is available in API v3 onwards using the Onfido SDKs.\"}],\"\\n\",[\"$\",\"h2\",null,{\"id\":\"drivers-license-data-verification-dldv-report\",\"children\":[\"Driver's License Data Verification (DLDV) report\",[\"$\",\"$L15\",null,{\"link\":\"#drivers-license-data-verification-dldv-report\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"3rd August 2021\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"🚗 United States driving licenses can be verified using a new report type, available in API v3 onwards. The DLDV report allows quick and accurate verification that a given driver's license is real, providing a strong signal against synthetic fraud.\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"It verifies the authenticity of an end user's driving license by comparing the attributes on the document with the state Department of Motor Vehicles (DMV) databases.\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"Read more \",[\"$\",\"a\",null,{\"href\":\"/guide/drivers-license-data-verification-report/\",\"children\":\"in our product documentation\"}],\" or \",[\"$\",\"a\",null,{\"href\":\"/api/latest/#drivers-license-data-verification-report\",\"children\":\"API reference\"}],\".\"]}],\"\\n\",[\"$\",\"h2\",null,{\"id\":\"api-v32\",\"children\":[\"API v3.2\",[\"$\",\"$L15\",null,{\"link\":\"#api-v32\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"24th June 2021\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"### 🆗 Barcode validation\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"We've added the \",[\"$\",\"code\",null,{\"children\":\"barcode\"}],\" sub-breakdown under\\n\",[\"$\",\"code\",null,{\"children\":\"data_validation\"}],\" in the \",[\"$\",\"a\",null,{\"href\":\"https://documentation.onfido.com/#document-report\",\"children\":\"Document\\nreport\"}],\".\"]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"By comparing a document's barcode against the defined standard, we are able to provide a more robust assessment of the barcode's validity.\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"This currently only applies to US and Canadian documents which contain a barcode.\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"The relevant part of the response from the API is in the \",[\"$\",\"a\",null,{\"href\":\"https://documentation.onfido.com/#document-report-object\",\"children\":\"Document report\\nobject\"}],\". It contains\\nthe following for a \",[\"$\",\"code\",null,{\"children\":\"consider\"}],\" breakdown result:\"]}],\"\\n\",[\"$\",\"$L16\",null,{\"title\":\"json\",\"snippets\":[{\"language\":\"json\",\"code\":\"...\\n \\\"data_validation\\\": {\\n \\\"result\\\": \\\"consider\\\",\\n \\\"breakdown\\\": {\\n \\\"barcode\\\": {\\n \\\"result\\\": \\\"consider\\\",\\n \\\"properties\\\": {}\\n },\\n...\\n\"}]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"### 📝 Specify documents for Facial Similarity reports\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"You can now specify which uploaded document to process in both \",[\"$\",\"a\",null,{\"href\":\"/api/latest/#document-report\",\"children\":\"Document\"}],\" and \",[\"$\",\"a\",null,{\"href\":\"/api/latest/#facial-similarity-reports\",\"children\":\"Facial Similarity\"}],\" reports. This guarantees that the same document that was used and verified by the Document report will also be used for the Facial Similarity report, even if you are associating mutliple documents to a single applicant.\"]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"Documents can be specified in the same way by using \",[\"$\",\"code\",null,{\"children\":\"document_ids\"}],\" during \",[\"$\",\"a\",null,{\"href\":\"/api/latest/#create-check\",\"children\":\"check creation\"}],\":\"]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"$\",\"code\",null,{\"children\":\"\\\"document_ids\\\": [\\\"\u003cDOCUMENT_ID\u003e\\\"]\"}]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"If you specify \",[\"$\",\"code\",null,{\"children\":\"document_ids\"}],\" with a check that doesn't contain a Document or Facial Similarity report you will receive the following \",[\"$\",\"a\",null,{\"href\":\"/api/latest/#errors\",\"children\":\"error\"}],\":\"]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"$\",\"code\",null,{\"children\":\"422 document_ids_with_unsupported_report\"}]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"When document IDs are associated with a Facial Similarity report, the document IDs of the documents used will be returned under the \",[\"$\",\"code\",null,{\"children\":\"documents\"}],\" attribute of the \",[\"$\",\"a\",null,{\"href\":\"/api/latest/#report-object\",\"children\":\"report object\"}],\".\"]}],\"\\n\",[\"$\",\"h3\",null,{\"id\":\"-document-used-for-face-matching\",\"children\":[\"👤👤 Document used for face matching\",[\"$\",\"$L15\",null,{\"link\":\"#-document-used-for-face-matching\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"We've added the \",[\"$\",\"code\",null,{\"children\":\"document_id\"}],\" property to the \",[\"$\",\"code\",null,{\"children\":\"face_match\"}],\" sub-breakdown under\\n\",[\"$\",\"code\",null,{\"children\":\"face_comparison\"}],\" in all \",[\"$\",\"a\",null,{\"href\":\"https://documentation.onfido.com/#facial-similarity-reports\",\"children\":\"Facial Similarity\\nreport\"}],\" types. This returns the unique identifier of the document used for the Facial Similarity report.\"]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"You can use the document ID to find which document the applicant's live photo or video was matched against.\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"The relevant part of the response from the API is in the \",[\"$\",\"a\",null,{\"href\":\"https://documentation.onfido.com/#document-report-object\",\"children\":\"Facial Similarity report\\nobject\"}],\".\"]}],\"\\n\",[\"$\",\"$L16\",null,{\"title\":\"json\",\"snippets\":[{\"language\":\"json\",\"code\":\"...\\n \\\"face_comparison\\\": {\\n \\\"result\\\": \\\"clear\\\",\\n \\\"breakdown\\\": {\\n \\\"face_match\\\": {\\n \\\"result\\\": \\\"clear\\\",\\n \\\"properties\\\": {\\n \\\"score\\\": 0.6512,\\n \\\"document_id\\\": \\\"\u003cDOCUMENT_ID\u003e\\\"\\n }\\n },\\n...\\n\"}]}],\"\\n\",[\"$\",\"h2\",null,{\"id\":\"right-to-work-share-code\",\"children\":[\"Right to Work share code\",[\"$\",\"$L15\",null,{\"link\":\"#right-to-work-share-code\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"11th May 2021\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"🖥 Eligible non-UK and EU applicants can now use Onfido's Applicant Form to submit GOV.UK right to work share codes instead of documents to verify their right to work in the UK.\\nCustomers can also submit share codes, if they have them, using all active versions of the Onfido API.\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":[[\"$\",\"strong\",null,{\"children\":\"Please note:\"}],\" This product is now deprecated and no longer available.\"]}],\"\\n\",[\"$\",\"h2\",null,{\"id\":\"api-v31\",\"children\":[\"API v3.1\",[\"$\",\"$L15\",null,{\"link\":\"#api-v31\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"8th April 2021\"}],\"\\n\",[\"$\",\"h3\",null,{\"id\":\"-account-for-cases-where-we-dont-obtain-a-us-barcode\",\"children\":[\"🎫 Account for cases where we don’t obtain a US barcode\",[\"$\",\"$L15\",null,{\"link\":\"#-account-for-cases-where-we-dont-obtain-a-us-barcode\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"This will be enabled by default for all new customers.\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"💬 \",[\"$\",\"strong\",null,{\"children\":\"If you're an existing customer, speak to your Onfido contact to enable\\nthis feature!\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"We've added the \",[\"$\",\"code\",null,{\"children\":\"multiple_data_sources_present\"}],\" sub-breakdown under\\n\",[\"$\",\"code\",null,{\"children\":\"data_consistency\"}],\" in the \",[\"$\",\"a\",null,{\"href\":\"https://documentation.onfido.com/#document-report\",\"children\":\"Document\\nreport\"}],\".\"]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"This currently only applies to US Driving Licenses and US State Identity\\nCards, and specifically only when the barcode data is missing. The relevant\\npart of the response from the API is in the \",[\"$\",\"a\",null,{\"href\":\"https://documentation.onfido.com/#document-report-object\",\"children\":\"Document report\\nobject\"}],\". It contains\\nthe following for a \",[\"$\",\"code\",null,{\"children\":\"consider\"}],\" breakdown result:\"]}],\"\\n\",[\"$\",\"$L16\",null,{\"title\":\"json\",\"snippets\":[{\"language\":\"json\",\"code\":\"...\\n \\\"data_consistency\\\": {\\n \\\"result\\\": \\\"consider\\\",\\n \\\"breakdown\\\": {\\n \\\"multiple_data_sources_present\\\": {\\n \\\"result\\\": \\\"consider\\\",\\n \\\"properties\\\": {}\\n },\\n...\\n\"}]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[[\"$\",\"code\",null,{\"children\":\"multiple_data_sources_present\"}],\" acts as a validation for the data_consistency breakdown: if 2 sources are present, then data consistency is possible and the other sub-breakdowns are enabled.\"]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[[\"$\",\"code\",null,{\"children\":\"multiple_data_sources_present\"}],\" can be disabled if needed. In this case, it will be returned as null and have no impact on the sub-result.\"]}],\"\\n\",[\"$\",\"h3\",null,{\"id\":\"-pdf-downloads-of-check-results\",\"children\":[\"✅ PDF downloads of check results\",[\"$\",\"$L15\",null,{\"link\":\"#-pdf-downloads-of-check-results\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"You can now download PDFs of check results using an endpoint:\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"$\",\"code\",null,{\"children\":\"GET /v3.1/checks/{check_id}/download\"}]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"Read more in \",[\"$\",\"a\",null,{\"href\":\"/api/latest/#download-check\",\"children\":\"our API reference\"}],\".\"]}],\"\\n\",[\"$\",\"h3\",null,{\"id\":\"-webhook-control-on-check\",\"children\":[\"📩 Webhook control on check\",[\"$\",\"$L15\",null,{\"link\":\"#-webhook-control-on-check\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"You can now specify which \",[\"$\",\"a\",null,{\"href\":\"/api/latest/#webhook_ids\",\"children\":\"webhooks\"}],\" will be activated for a check upon its creation.\"]}],\"\\n\",[\"$\",\"h2\",null,{\"id\":\"onfido-python\",\"children\":[\"onfido-python\",[\"$\",\"$L15\",null,{\"link\":\"#onfido-python\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"8th October 2020\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"Joining our other new custom-written \",[\"$\",\"a\",null,{\"href\":\"#https://documentation.onfido.com/#client-libraries\",\"children\":\"client libraries\"}],\" and built with simplicity in mind is \",[\"$\",\"a\",null,{\"href\":\"https://pypi.org/project/onfido-python/\",\"children\":\"onfido-python\"}],\"! 🐍\"]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"This project supersedes the auto-generated api-python-client library.\"}],\"\\n\",[\"$\",\"h2\",null,{\"id\":\"api-v30\",\"children\":[\"API v3.0\",[\"$\",\"$L15\",null,{\"link\":\"#api-v30\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"13th January 2020\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"We wanted API v3 to improve on v2 in every possible way. We listened to our\\ncustomers: we saw what could be clearer, what could be removed, and what could\\nbe simplified.\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"API v3 isn’t a step change, but it is an evolution. It’s designed to get you\\nup and running with our best-in-class identity verification API faster.\"}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"If you’re an existing customer currently using API v2 but migrating to API\\nv3, you may find our \",[\"$\",\"a\",null,{\"href\":\"/api/api-v2-to-v3-migration-guide/\",\"children\":\"migration guide\"}],\" more\\nuseful.\"]}],\"\\n\",[\"$\",\"h3\",null,{\"id\":\"-cleaner-api-structure\",\"children\":[\"🧼 Cleaner API structure\",[\"$\",\"$L15\",null,{\"link\":\"#-cleaner-api-structure\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"Compared to API v2, we’ve simplified much of our endpoint structure, removed\\nsome inconsistencies in naming, and separated the report objects from check objects to make them more\\nstraightforward to process.\"}],\"\\n\",[\"$\",\"h3\",null,{\"id\":\"-simpler-applicant-creation\",\"children\":[\"👩🏻🧔🏿 Simpler applicant creation\",[\"$\",\"$L15\",null,{\"link\":\"#-simpler-applicant-creation\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"Fields for applicant creation which were duplicated or unnecessary have been\\nremoved, and the array \",[\"$\",\"code\",null,{\"children\":\"addresses\"}],\" has become the single object \",[\"$\",\"code\",null,{\"children\":\"address\"}],\"\\nnested inside applicant objects. This is now the only place you need to\\nspecify a country for an applicant.\"]}],\"\\n\",[\"$\",\"h3\",null,{\"id\":\"-restructured-check-management\",\"children\":[\"🏗 Restructured check management\",[\"$\",\"$L15\",null,{\"link\":\"#-restructured-check-management\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":\"Checks, made up of reports, are the core of our product. Here are the main\\nexamples of how we’ve made check creation more streamlined:\"}],\"\\n\",[\"$\",\"ul\",null,{\"children\":[\"\\n\",[\"$\",\"li\",null,{\"children\":\"API v3 removes terminology such as “report type groups”, “variants” and “asynchronous checks”\"}],\"\\n\",[\"$\",\"li\",null,{\"children\":[\"Specifying which report you need is now more straightforward, via an array called \",[\"$\",\"code\",null,{\"children\":\"report_names\"}]]}],\"\\n\",[\"$\",\"li\",null,{\"children\":\"If you need to gather applicant information with our applicant form, simply use a Boolean switch in API v3\"}],\"\\n\",[\"$\",\"li\",null,{\"children\":\"Unless you specify otherwise, report data is returned as soon as it’s available by default for API v3 checks\"}],\"\\n\",[\"$\",\"li\",null,{\"children\":\"The request structure for creating a check is much simpler, and needs fewer lines of code each time\"}],\"\\n\"]}],\"\\n\",[\"$\",\"h3\",null,{\"id\":\"-a-new-biometrics-offering\",\"children\":[\"📷 A new biometrics offering\",[\"$\",\"$L15\",null,{\"link\":\"#-a-new-biometrics-offering\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"Facial Similarity Photo Fully Auto is only available in\\nAPI v3 versions. You can read all about it in our comprehensive \",[\"$\",\"a\",null,{\"href\":\"https://documentation.onfido.com/#photo-fully-auto\",\"children\":\"API reference\\ndocumentation\"}],\".\"]}],\"\\n\",[\"$\",\"h3\",null,{\"id\":\"-new-client-libraries\",\"children\":[\"🎁 New client libraries\",[\"$\",\"$L15\",null,{\"link\":\"#-new-client-libraries\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"For API v3 versions, we’ve moved away from auto-generated API client (wrapper) libraries via an OpenAPI specification. \",[\"$\",\"a\",null,{\"href\":\"#https://documentation.onfido.com/#client-libraries\",\"children\":\"Our libraries are now custom-written instead\"}],\", to make your integration even easier.\"]}],\"\\n\",[\"$\",\"h2\",null,{\"id\":\"️-let-us-know-what-you-think\",\"children\":[\"⌨️ Let us know what you think\",[\"$\",\"$L15\",null,{\"link\":\"#️-let-us-know-what-you-think\"}]]}],\"\\n\",[\"$\",\"p\",null,{\"children\":[\"If you have any feedback or if you have any questions, contact our Client\\nSupport team at \",[\"$\",\"a\",null,{\"href\":\"mailto:client-support@onfido.com\",\"children\":\"mailto:client-support@onfido.com\"}],\".\"]}]]}]}]}]\n"])</script><script>self.__next_f.push([1,""])</script></body></html>