Domain > developers.veriff.com

More information on this domain is in AlienVault OTX

Whois

Property	Value
Email	veriff.com@domainsbyproxy.com
NameServer	NS-1766.AWSDNS-28.CO.UK
Created	2006-04-12 17:11:04
Changed	2021-01-07 08:19:34
Registrar	GoDaddy.com, LLC

DNS Resolutions

Date	IP Address
2020-05-04	52.49.50.24 (ClassC)
2024-10-29	54.246.77.194 (ClassC)

HTTP/1.1 200 OKDate: Tue, 29 Oct 2024 18:36:00 GMTContent-Type: text/htmlContent-Length: 899343Connection: keep-alivelast-modified: Tue, 22 Oct 2024 09:18:09 GMTvary: Accept-Encodingetag: 67176dd1-db90faccept-ranges: bytesx-envoy-upstream-service-time: 0x-envoy-decorator-operation: slate-documentation.crow.svc.cluster.local:80/*X-Frame-Options: SAMEORIGINX-Permitted-Cross-Domain-Policies: noneX-XSS-Protection: 1; modeblock

!doctype html>html>  head>    link hrefimages/favicon.png relicon typeimage/png />    meta charsetutf-8>    meta contentIEedge,chrome1 http-equivX-UA-Compatible>    meta nameviewport contentwidthdevice-width, initial-scale1, maximum-scale1>    title>Developers Documentation/title>    meta namedescription contentVeriff ID verification technical documentation. We verify real people and identify fraud. Veriff stands by the Real People>    meta namekeywords contentVeriff ID Verification technical documentation, fraud prevention, KYC, Compliance, Verification>    style>      .highlight table td { padding: 5px; }.highlight table pre { margin: 0; }.highlight .cm {  color: #999988;  font-style: italic;}.highlight .cp {  color: #999999;  font-weight: bold;}.highlight .c1 {  color: #999988;  font-style: italic;}.highlight .cs {  color: #999999;  font-weight: bold;  font-style: italic;}.highlight .c, .highlight .cd {  color: #999988;  font-style: italic;}.highlight .err {  color: #a61717;  background-color: #e3d2d2;}.highlight .gd {  color: #000000;  background-color: #ffdddd;}.highlight .ge {  color: #000000;  font-style: italic;}.highlight .gr {  color: #aa0000;}.highlight .gh {  color: #999999;}.highlight .gi {  color: #000000;  background-color: #ddffdd;}.highlight .go {  color: #888888;}.highlight .gp {  color: #555555;}.highlight .gs {  font-weight: bold;}.highlight .gu {  color: #aaaaaa;}.highlight .gt {  color: #aa0000;}.highlight .kc {  color: #000000;  font-weight: bold;}.highlight .kd {  color: #000000;  font-weight: bold;}.highlight .kn {  color: #000000;  font-weight: bold;}.highlight .kp {  color: #000000;  font-weight: bold;}.highlight .kr {  color: #000000;  font-weight: bold;}.highlight .kt {  color: #445588;  font-weight: bold;}.highlight .k, .highlight .kv {  color: #000000;  font-weight: bold;}.highlight .mf {  color: #009999;}.highlight .mh {  color: #009999;}.highlight .il {  color: #009999;}.highlight .mi {  color: #009999;}.highlight .mo {  color: #009999;}.highlight .m, .highlight .mb, .highlight .mx {  color: #009999;}.highlight .sb {  color: #d14;}.highlight .sc {  color: #d14;}.highlight .sd {  color: #d14;}.highlight .s2 {  color: #d14;}.highlight .se {  color: #d14;}.highlight .sh {  color: #d14;}.highlight .si {  color: #d14;}.highlight .sx {  color: #d14;}.highlight .sr {  color: #009926;}.highlight .s1 {  color: #d14;}.highlight .ss {  color: #990073;}.highlight .s {  color: #d14;}.highlight .na {  color: #008080;}.highlight .bp {  color: #999999;}.highlight .nb {  color: #0086B3;}.highlight .nc {  color: #445588;  font-weight: bold;}.highlight .no {  color: #008080;}.highlight .nd {  color: #3c5d5d;  font-weight: bold;}.highlight .ni {  color: #800080;}.highlight .ne {  color: #990000;  font-weight: bold;}.highlight .nf {  color: #990000;  font-weight: bold;}.highlight .nl {  color: #990000;  font-weight: bold;}.highlight .nn {  color: #555555;}.highlight .nt {  color: #000080;}.highlight .vc {  color: #008080;}.highlight .vg {  color: #008080;}.highlight .vi {  color: #008080;}.highlight .nv {  color: #008080;}.highlight .ow {  color: #000000;  font-weight: bold;}.highlight .o {  color: #000000;  font-weight: bold;}.highlight .w {  color: #bbbbbb;}.highlight {  background-color: #f8f8f8;}    /style>    link hrefstylesheets/screen.css relstylesheet mediascreen />    link hrefstylesheets/print.css relstylesheet mediaprint />      script srcjavascripts/all.js>/script>  /head>!-- Google Tag Manager -->script>(function(w,d,s,l,i){wlwl||;wl.push({gtm.start:new Date().getTime(),event:gtm.js});var fd.getElementsByTagName(s)0,jd.createElement(s),dll!dataLayer?&l+l:;j.asynctrue;j.srchttps://www.googletagmanager.com/gtm.js?id+i+dl;f.parentNode.insertBefore(j,f);})(window,document,script,dataLayer,GTM-P2ZZ69R);/script>!-- Hotjar Tracking Code for https://developers.veriff.com/ -->script>    (function(h,o,t,j,a,r){        h.hjh.hj||function(){(h.hj.qh.hj.q||).push(arguments)};        h._hjSettings{hjid:2399106,hjsv:6};        ao.getElementsByTagName(head)0;        ro.createElement(script);r.async1;        r.srct+h._hjSettings.hjid+j+h._hjSettings.hjsv;        a.appendChild(r);    })(window,document,https://static.hotjar.com/c/hotjar-,.js?sv);/script>  body classindex>    !-- Google Tag Manager (noscript) -->  noscript>iframe srchttps://www.googletagmanager.com/ns.html?idGTM-P2ZZ69R  height0 width0 styledisplay:none;visibility:hidden>/iframe>/noscript>    !-- End Google Tag Manager (noscript) -->    a href# idnav-button>      span>        NAV        img srcimages/navbar.png alt />      /span>    /a>    div classtoc-wrapper>      a hrefhttps://www.veriff.com>      img srcimages/logo.svg classlogo alt />      /a>        div classsearch>          input typetext classsearch idinput-search placeholderSearch>        /div>        ul classsearch-results>/ul>      ul idtoc classtoc-list-h1>          li>            a href#introduction classtoc-h1 toc-link data-titleIntroduction>Introduction/a>          /li>          li>            a href#getting-started-with-veriff classtoc-h1 toc-link data-titleGetting Started With Veriff>Getting Started With Veriff/a>              ul classtoc-list-h2>                  li>                    a href#signing-up classtoc-h2 toc-link data-titleSigning up>Signing up/a>                  /li>                  li>                    a href#logging-in classtoc-h2 toc-link data-titleLogging in>Logging in/a>                      ul classtoc-list-h3>                          li>                            a href#new-user-accounts classtoc-h3 toc-link data-titleNew user accounts>New user accounts/a>                          /li>                      /ul>                  /li>                  li>                    a href#creating-an-integration classtoc-h2 toc-link data-titleCreating an integration>Creating an integration/a>                      ul classtoc-list-h3>                          li>                            a href#test-integrations classtoc-h3 toc-link data-titleTest integrations>Test integrations/a>                          /li>                          li>                            a href#live-integrations classtoc-h3 toc-link data-titleLive integrations>Live integrations/a>                          /li>                      /ul>                  /li>                  li>                    a href#quick-guide-of-idv-using-the-sdks classtoc-h2 toc-link data-titleQuick guide of IDV using the SDKs>Quick guide of IDV using the SDKs/a>                      ul classtoc-list-h3>                          li>                            a href#quick-overview-of-the-steps classtoc-h3 toc-link data-titleQuick overview of the steps>Quick overview of the steps/a>                          /li>                          li>                            a href#using-the-api-to-generate-a-session-for-the-sdk classtoc-h3 toc-link data-titleUsing the API to generate a session for the SDK>Using the API to generate a session for the SDK/a>                          /li>                          li>                            a href#what-happens-after-the-end-user-leaves-the-verification-flow classtoc-h3 toc-link data-titleWhat happens after the end-user leaves the verification flow?>What happens after the end-user leaves the verification flow?/a>                          /li>                          li>                            a href#sdk-sessions-lifecycle-diagram classtoc-h3 toc-link data-titleSDK sessions lifecycle diagram>SDK sessions lifecycle diagram/a>                          /li>                      /ul>                  /li>                  li>                    a href#quick-guide-of-the-idv-using-the-api classtoc-h2 toc-link data-titleQuick guide of the IDV using the API>Quick guide of the IDV using the API/a>                      ul classtoc-list-h3>                          li>                            a href#quick-overview-of-the-steps-2 classtoc-h3 toc-link data-titleQuick overview of the steps>Quick overview of the steps/a>                          /li>                          li>                            a href#using-the-api-to-generate-a-session-for-api classtoc-h3 toc-link data-titleUsing the API to generate a session for API>Using the API to generate a session for API/a>                          /li>                          li>                            a href#api-sessions-lifecycle-diagram classtoc-h3 toc-link data-titleAPI sessions lifecycle diagram>API sessions lifecycle diagram/a>                          /li>                      /ul>                  /li>                  li>                    a href#generating-session-manually classtoc-h2 toc-link data-titleGenerating session manually>Generating session manually/a>                  /li>                  li>                    a href#setting-up-webhooks classtoc-h2 toc-link data-titleSetting up webhooks>Setting up webhooks/a>                  /li>                  li>                    a href#verification-session-statuses classtoc-h2 toc-link data-titleVerification session statuses>Verification session statuses/a>                      ul classtoc-list-h3>                          li>                            a href#session-statuses-explained classtoc-h3 toc-link data-titleSession statuses explained>Session statuses explained/a>                          /li>                          li>                            a href#fetching-the-session-statuses classtoc-h3 toc-link data-titleFetching the session statuses>Fetching the session statuses/a>                          /li>                      /ul>                  /li>                  li>                    a href#verification-decisions classtoc-h2 toc-link data-titleVerification decisions>Verification decisions/a>                      ul classtoc-list-h3>                          li>                            a href#decisions-explained classtoc-h3 toc-link data-titleDecisions explained>Decisions explained/a>                          /li>                          li>                            a href#triggering-decisions-manually-for-testing classtoc-h3 toc-link data-titleTriggering decisions manually for testing>Triggering decisions manually for testing/a>                          /li>                          li>                            a href#fetching-the-decision classtoc-h3 toc-link data-titleFetching the decision>Fetching the decision/a>                          /li>                      /ul>                  /li>                  li>                    a href#verification-session-events classtoc-h2 toc-link data-titleVerification session events>Verification session events/a>                  /li>                  li>                    a href#backwards-compatible-changes classtoc-h2 toc-link data-titleBackwards compatible changes>Backwards compatible changes/a>                  /li>                  li>                    a href#try-our-demos classtoc-h2 toc-link data-titleTry our demos>Try our demos/a>                  /li>                  li>                    a href#browser-support-for-verification-flow classtoc-h2 toc-link data-titleBrowser support for verification flow>Browser support for verification flow/a>                      ul classtoc-list-h3>                          li>                            a href#supported-browsers classtoc-h3 toc-link data-titleSupported browsers>Supported browsers/a>                          /li>                          li>                            a href#not-supported-browsers classtoc-h3 toc-link data-titleNot supported browsers>Not supported browsers/a>                          /li>                      /ul>                  /li>                  li>                    a href#allowlisted-urls-and-ip-addresses classtoc-h2 toc-link data-titleAllowlisted URLs and IP addresses>Allowlisted URLs and IP addresses/a>                      ul classtoc-list-h3>                          li>                            a href#allowlisted-urls classtoc-h3 toc-link data-titleAllowlisted URLs>Allowlisted URLs/a>                          /li>                          li>                            a href#allowlisted-ip-addresses classtoc-h3 toc-link data-titleAllowlisted IP addresses>Allowlisted IP addresses/a>                          /li>                      /ul>                  /li>                  li>                    a href#test-the-api-collection-in-postman classtoc-h2 toc-link data-titleTest the API Collection in Postman>Test the API Collection in Postman/a>                  /li>              /ul>          /li>          li>            a href#integrations-test-guide classtoc-h1 toc-link data-titleIntegrations Test Guide>Integrations Test Guide/a>              ul classtoc-list-h2>                  li>                    a href#testing-verification-sessions-checklist classtoc-h2 toc-link data-titleTesting verification sessions checklist>Testing verification sessions checklist/a>                  /li>                  li>                    a href#testing-security classtoc-h2 toc-link data-titleTesting security>Testing security/a>                  /li>                  li>                    a href#testing-responses classtoc-h2 toc-link data-titleTesting responses>Testing responses/a>                  /li>                  li>                    a href#testing-process-in-your-app classtoc-h2 toc-link data-titleTesting process in your app>Testing process in your app/a>                  /li>                  li>                    a href#mobile-testing classtoc-h2 toc-link data-titleMobile testing>Mobile testing/a>                  /li>                  li>                    a href#api-upload-testing classtoc-h2 toc-link data-titleAPI Upload testing>API Upload testing/a>                  /li>                  li>                    a href#batch-testing classtoc-h2 toc-link data-titleBatch testing>Batch testing/a>                  /li>                  li>                    a href#end-user-in-the-flow classtoc-h2 toc-link data-titleEnd-User In The Flow>End-User In The Flow/a>                  /li>                  li>                    a href#session-status-diagram classtoc-h2 toc-link data-titleSession Status Diagram>Session Status Diagram/a>                  /li>              /ul>          /li>          li>            a href#sdk-guide classtoc-h1 toc-link data-titleSDK Guide>SDK Guide/a>              ul classtoc-list-h2>                  li>                    a href#why-use-the-sdk classtoc-h2 toc-link data-titleWhy use the SDK?>Why use the SDK?/a>                      ul classtoc-list-h3>                          li>                            a href#sdk-customization-guides classtoc-h3 toc-link data-titleSDK customization guides>SDK customization guides/a>                          /li>                      /ul>                  /li>                  li>                    a href#prerequisites-to-use-the-sdks classtoc-h2 toc-link data-titlePrerequisites to use the SDKs>Prerequisites to use the SDKs/a>                  /li>                  li>                    a href#android-sdk classtoc-h2 toc-link data-titleAndroid SDK>Android SDK/a>                      ul classtoc-list-h3>                          li>                            a href#android-sdk-requirements classtoc-h3 toc-link data-titleAndroid SDK Requirements>Android SDK Requirements/a>                          /li>                          li>                            a href#adding-the-android-sdk classtoc-h3 toc-link data-titleAdding the Android SDK>Adding the Android SDK/a>                          /li>                          li>                            a href#permissions classtoc-h3 toc-link data-titlePermissions>Permissions/a>                          /li>                          li>                            a href#starting-the-verification-flow classtoc-h3 toc-link data-titleStarting the verification flow>Starting the verification flow/a>                          /li>                          li>                            a href#customizing-the-sdk classtoc-h3 toc-link data-titleCustomizing the SDK>Customizing the SDK/a>                          /li>                          li>                            a href#more-customization-options classtoc-h3 toc-link data-titleMore customization options>More customization options/a>                          /li>                          li>                            a href#adding-vendor-data classtoc-h3 toc-link data-titleAdding vendor data>Adding vendor data/a>                          /li>                          li>                            a href#getting-the-verification-status classtoc-h3 toc-link data-titleGetting the verification status>Getting the verification status/a>                          /li>                          li>                            a href#adding-error-logging classtoc-h3 toc-link data-titleAdding error logging>Adding error logging/a>                          /li>                          li>                            a href#excluding-ml-kit-support classtoc-h3 toc-link data-titleExcluding ML Kit support>Excluding ML Kit support/a>                          /li>                          li>                            a href#android-sdk-changelog classtoc-h3 toc-link data-titleAndroid SDK Changelog>Android SDK Changelog/a>                          /li>                          li>                            a href#migrating-veriff-android-sdk-from-5-x-x-to-6-0-0 classtoc-h3 toc-link data-titleMigrating Veriff Android SDK from 5.x.x to 6.0.0>Migrating Veriff Android SDK from 5.x.x to 6.0.0/a>                          /li>                          li>                            a href#migrating-veriff-android-sdk-from-4-x-x-to-5-0-0 classtoc-h3 toc-link data-titleMigrating Veriff Android SDK from 4.x.x to 5.0.0>Migrating Veriff Android SDK from 4.x.x to 5.0.0/a>                          /li>                          li>                            a href#migrating-veriff-android-sdk-from-3-x-x-to-4-0-0 classtoc-h3 toc-link data-titleMigrating Veriff Android SDK from 3.x.x to 4.0.0>Migrating Veriff Android SDK from 3.x.x to 4.0.0/a>                          /li>                          li>                            a href#migrating-veriff-android-sdk-from-2-x-x-to-3-0-0 classtoc-h3 toc-link data-titleMigrating Veriff Android SDK from 2.x.x to 3.0.0>Migrating Veriff Android SDK from 2.x.x to 3.0.0/a>                          /li>                      /ul>                  /li>                  li>                    a href#ios-sdk classtoc-h2 toc-link data-titleiOS SDK>iOS SDK/a>                      ul classtoc-list-h3>                          li>                            a href#ios-sdk-requirements classtoc-h3 toc-link data-titleiOS SDK Requirements>iOS SDK Requirements/a>                          /li>                          li>                            a href#adding-the-sdk-to-the-project classtoc-h3 toc-link data-titleAdding the SDK to the project>Adding the SDK to the project/a>                          /li>                          li>                            a href#adding-permissions classtoc-h3 toc-link data-titleAdding permissions>Adding permissions/a>                          /li>                          li>                            a href#starting-verification-flow classtoc-h3 toc-link data-titleStarting verification flow>Starting verification flow/a>                          /li>                          li>                            a href#customize-user-interface-optional classtoc-h3 toc-link data-titleCustomize user interface (Optional)>Customize user interface (Optional)/a>                          /li>                          li>                            a href#vendor-data classtoc-h3 toc-link data-titleVendor data>Vendor data/a>                          /li>                          li>                            a href#start-the-verification-flow-by-using-the-configuration classtoc-h3 toc-link data-titleStart the verification flow by using the configuration>Start the verification flow by using the configuration/a>                          /li>                          li>                            a href#handling-result-codes-from-sdk classtoc-h3 toc-link data-titleHandling result codes from SDK>Handling result codes from SDK/a>                          /li>                          li>                            a href#notes classtoc-h3 toc-link data-titleNotes>Notes/a>                          /li>                          li>                            a href#migrating-to-veriff-ios-3-0-0 classtoc-h3 toc-link data-titleMigrating to Veriff iOS 3.0.0>Migrating to Veriff iOS 3.0.0/a>                          /li>                          li>                            a href#migrating-to-veriff-ios-4-0-0 classtoc-h3 toc-link data-titleMigrating to Veriff iOS 4.0.0>Migrating to Veriff iOS 4.0.0/a>                          /li>                          li>                            a href#migrating-to-veriff-ios-5-0-0 classtoc-h3 toc-link data-titleMigrating to Veriff iOS 5.0.0>Migrating to Veriff iOS 5.0.0/a>                          /li>                          li>                            a href#migrating-to-veriff-ios-6-0-0 classtoc-h3 toc-link data-titleMigrating to Veriff iOS 6.0.0>Migrating to Veriff iOS 6.0.0/a>                          /li>                          li>                            a href#migrating-to-veriff-ios-7-0-0 classtoc-h3 toc-link data-titleMigrating to Veriff iOS 7.0.0>Migrating to Veriff iOS 7.0.0/a>                          /li>                          li>                            a href#ios-sdk-changelog classtoc-h3 toc-link data-titleiOS SDK Changelog>iOS SDK Changelog/a>                          /li>                      /ul>                  /li>                  li>                    a href#flutter-plugin classtoc-h2 toc-link data-titleFlutter Plugin>Flutter Plugin/a>                      ul classtoc-list-h3>                          li>                            a href#requirements classtoc-h3 toc-link data-titleRequirements>Requirements/a>                          /li>                          li>                            a href#install-the-plugin-to-your-project classtoc-h3 toc-link data-titleInstall the plugin to your project>Install the plugin to your project/a>                          /li>                          li>                            a href#declare-foreground-service-sync-for-google-play classtoc-h3 toc-link data-titleDeclare foreground service sync for Google Play>Declare foreground service sync for Google Play/a>                          /li>                          li>                            a href#ios-specific-configuration classtoc-h3 toc-link data-titleiOS specific configuration>iOS specific configuration/a>                          /li>                          li>                            a href#launching-the-verification-flow classtoc-h3 toc-link data-titleLaunching the verification flow>Launching the verification flow/a>                          /li>                          li>                            a href#customize-user-interface-optional classtoc-h3 toc-link data-titleCustomize user interface (Optional)>Customize user interface (Optional)/a>                          /li>                          li>                            a href#vendor-data classtoc-h3 toc-link data-titleVendor data>Vendor data/a>                          /li>                          li>                            a href#handling-the-results-from-plugin classtoc-h3 toc-link data-titleHandling the results from plugin>Handling the results from plugin/a>                          /li>                      /ul>                  /li>                  li>                    a href#react-native-sdk classtoc-h2 toc-link data-titleReact Native SDK>React Native SDK/a>                      ul classtoc-list-h3>                          li>                            a href#react-native-sdk-requirements classtoc-h3 toc-link data-titleReact Native SDK requirements>React Native SDK requirements/a>                          /li>                          li>                            a href#add-the-sdk-to-a-project classtoc-h3 toc-link data-titleAdd the SDK to a project>Add the SDK to a project/a>                          /li>                          li>                            a href#update-android-build-gradle-file classtoc-h3 toc-link data-titleUpdate Android build.gradle file>Update Android code>build.gradle/code> file/a>                          /li>                          li>                            a href#declare-foreground-service-sync-for-google-play classtoc-h3 toc-link data-titleDeclare foreground service sync for Google Play>Declare foreground service sync for Google Play/a>                          /li>                          li>                            a href#ios-specific-setup classtoc-h3 toc-link data-titleiOS Specific setup>iOS Specific setup/a>                          /li>                          li>                            a href#using-the-veriff-react-native-sdk classtoc-h3 toc-link data-titleUsing the Veriff React Native SDK>Using the Veriff React Native SDK/a>                          /li>                          li>                            a href#user-interface-customization classtoc-h3 toc-link data-titleUser Interface customization>User Interface customization/a>                          /li>                          li>                            a href#handling-the-result-from-the-sdk classtoc-h3 toc-link data-titleHandling the result from the SDK>Handling the result from the SDK/a>                          /li>                          li>                            a href#migrating-to-react-native-sdk-3-0-0 classtoc-h3 toc-link data-titleMigrating to React Native SDK 3.0.0>Migrating to React Native SDK 3.0.0/a>                          /li>                          li>                            a href#migrating-to-react-native-sdk-2-0-0 classtoc-h3 toc-link data-titleMigrating to React Native SDK 2.0.0>Migrating to React Native SDK 2.0.0/a>                          /li>                          li>                            a href#react-native-sdk-changelog classtoc-h3 toc-link data-titleReact Native SDK Changelog>React Native SDK Changelog/a>                          /li>                      /ul>                  /li>                  li>                    a href#cordova-plugin classtoc-h2 toc-link data-titleCordova Plugin>Cordova Plugin/a>                      ul classtoc-list-h3>                          li>                            a href#cordova-requirements classtoc-h3 toc-link data-titleCordova requirements>Cordova requirements/a>                          /li>                          li>                            a href#add-the-plugin-to-a-project classtoc-h3 toc-link data-titleAdd the plugin to a project>Add the plugin to a project/a>                          /li>                          li>                            a href#declare-foreground-service-sync-for-google-play classtoc-h3 toc-link data-titleDeclare foreground service sync for Google Play>Declare foreground service sync for Google Play/a>                          /li>                          li>                            a href#ios-specific-setup classtoc-h3 toc-link data-titleiOS Specific setup>iOS Specific setup/a>                          /li>                          li>                            a href#using-the-veriff-cordova-plugin classtoc-h3 toc-link data-titleUsing the Veriff Cordova plugin>Using the Veriff Cordova plugin/a>                          /li>                          li>                            a href#user-interface-customization classtoc-h3 toc-link data-titleUser Interface customization>User Interface customization/a>                          /li>                          li>                            a href#handling-the-result-from-the-sdk classtoc-h3 toc-link data-titleHandling the result from the SDK>Handling the result from the SDK/a>                          /li>                      /ul>                  /li>                  li>                    a href#javascript-sdk classtoc-h2 toc-link data-titleJavascript SDK>Javascript SDK/a>                      ul classtoc-list-h3>                          li>                            a href#install-js-sdk classtoc-h3 toc-link data-titleInstall JS SDK>Install JS SDK/a>                          /li>                          li>                            a href#adding-js-sdk classtoc-h3 toc-link data-titleAdding JS SDK>Adding JS SDK/a>                          /li>                          li>                            a href#adding-viewport-meta-tag classtoc-h3 toc-link data-titleAdding viewport meta tag>Adding viewport meta tag/a>                          /li>                      /ul>                  /li>                  li>                    a href#incontext-javascript-sdk classtoc-h2 toc-link data-titleInContext Javascript SDK>InContext Javascript SDK/a>                      ul classtoc-list-h3>                          li>                            a href#install-incontext-js-sdk classtoc-h3 toc-link data-titleInstall InContext JS SDK>Install InContext JS SDK/a>                          /li>                          li>                            a href#adding-incontext-js-sdk classtoc-h3 toc-link data-titleAdding InContext JS SDK>Adding InContext JS SDK/a>                          /li>                          li>                            a href#listening-for-events classtoc-h3 toc-link data-titleListening for events>Listening for events/a>                          /li>                          li>                            a href#using-with-inline-script classtoc-h3 toc-link data-titleUsing with inline script>Using with inline script/a>                          /li>                          li>                            a href#options classtoc-h3 toc-link data-titleOptions>Options/a>                          /li>                          li>                            a href#close-veriff-modal classtoc-h3 toc-link data-titleClose Veriff modal>Close Veriff modal/a>                          /li>                          li>                            a href#onreload classtoc-h3 toc-link data-titleonReload>onReload/a>                          /li>                          li>                            a href#adding-content-security-policy-to-incontext-sdk classtoc-h3 toc-link data-titleAdding Content Security Policy to InContext SDK>Adding Content Security Policy to InContext SDK/a>                          /li>                          li>                            a href#allow-camera-requests-in-your-permissions-policy classtoc-h3 toc-link data-titleAllow camera requests in your Permissions Policy>Allow camera requests in your Permissions Policy/a>                          /li>                      /ul>                  /li>                  li>                    a href#integrate-by-redirection classtoc-h2 toc-link data-titleIntegrate by Redirection>Integrate by Redirection/a>                      ul classtoc-list-h3>                          li>                            a href#using-redirection classtoc-h3 toc-link data-titleUsing redirection>Using redirection/a>                          /li>                          li>                            a href#query-parameters classtoc-h3 toc-link data-titleQuery parameters>Query parameters/a>                          /li>                      /ul>                  /li>                  li>                    a href#sdk-support-policy classtoc-h2 toc-link data-titleSDK Support Policy>SDK Support Policy/a>                  /li>                  li>                    a href#supported-languages classtoc-h2 toc-link data-titleSupported languages>Supported languages/a>                  /li>                  li>                    a href#sessions-lifecycle-diagram-sdk classtoc-h2 toc-link data-titleSessions lifecycle diagram (SDK)>Sessions lifecycle diagram (SDK)/a>                  /li>              /ul>          /li>          li>            a href#api-guide classtoc-h1 toc-link data-titleAPI Guide>API Guide/a>              ul classtoc-list-h2>                  li>                    a href#why-use-the-api classtoc-h2 toc-link data-titleWhy use the API?>Why use the API?/a>                  /li>                  li>                    a href#customer-39-s-api-flow-in-a-nutshell classtoc-h2 toc-link data-titleCustomers API flow in a nutshell>Customers API flow in a nutshell/a>                  /li>                  li>                    a href#prerequisites-to-use-the-api classtoc-h2 toc-link data-titlePrerequisites to use the API>Prerequisites to use the API/a>                  /li>                  li>                    a href#prerequisites-to-create-api-requests classtoc-h2 toc-link data-titlePrerequisites to create API requests>Prerequisites to create API requests/a>                      ul classtoc-list-h3>                          li>                            a href#api-keys classtoc-h3 toc-link data-titleAPI keys>API keys/a>                          /li>                          li>                            a href#shared-secret-key-rotation classtoc-h3 toc-link data-titleShared secret key rotation>Shared secret key rotation/a>                          /li>                      /ul>                  /li>                  li>                    a href#api-url-and-headers classtoc-h2 toc-link data-titleAPI URL and Headers>API URL and Headers/a>                  /li>                  li>                    a href#backwards-compatible-changes classtoc-h2 toc-link data-titleBackwards compatible changes>Backwards compatible changes/a>                  /li>                  li>                    a href#api-reference classtoc-h2 toc-link data-titleAPI Reference>API Reference/a>                      ul classtoc-list-h3>                          li>                            a href#endpoints classtoc-h3 toc-link data-titleEndpoints>Endpoints/a>                          /li>                          li>                            a href#post-sessions classtoc-h3 toc-link data-title POST  /sessions>span classmethod method-post> POST /span> /sessions/a>                          /li>                          li>                            a href#post-sessions-sessionid-media classtoc-h3 toc-link data-titlePOST /sessions/{sessionId}/media>span classmethod method-post>POST/span> /sessions/{sessionId}/media/a>                          /li>                          li>                            a href#post-sessions-sessionid-collected-data classtoc-h3 toc-link data-title POST  /sessions/{sessionId}/collected-data>span classmethod method-post> POST /span> /sessions/{sessionId}/collected-data/a>                          /li>                          li>                            a href#patch-sessions-sessionid classtoc-h3 toc-link data-titlePATCH /sessions/{sessionId}>PATCH /sessions/{sessionId}/a>                          /li>                          li>                            a href#get-sessions-sessionid-attempts classtoc-h3 toc-link data-titleGET /sessions/{sessionId}/attempts>span classmethod method-get>GET/span> /sessions/{sessionId}/attempts/a>                          /li>                          li>                            a href#get-sessions-sessionid-decision classtoc-h3 toc-link data-titleGET /sessions/{sessionId}/decision>span classmethod method-get>GET/span> /sessions/{sessionId}/decision/a>                          /li>                          li>                            a href#get-sessions-sessionid-person classtoc-h3 toc-link data-titleGET /sessions/{sessionId}/person>span classmethod method-get>GET/span> /sessions/{sessionId}/person/a>                          /li>                          li>                            a href#get-sessions-sessionid-media classtoc-h3 toc-link data-titleGET /sessions/{sessionId}/media>span classmethod method-get>GET/span> /sessions/{sessionId}/media/a>                          /li>                          li>                            a href#get-sessions-sessionid-watchlist-screening classtoc-h3 toc-link data-titleGET /sessions/{sessionId}/watchlist-screening>span classmethod method-get>GET/span> /sessions/{sessionId}/watchlist-screening/a>                          /li>                          li>                            a href#delete-sessions-sessionid classtoc-h3 toc-link data-titleDELETE /sessions/{sessionId}>span classmethod method-delete>DELETE/span> /sessions/{sessionId}/a>                          /li>                          li>                            a href#get-attempts-attemptid-media classtoc-h3 toc-link data-titleGET /attempts/{attemptId}/media>span classmethod method-get>GET/span> /attempts/{attemptId}/media/a>                          /li>                          li>                            a href#get-media-mediaid classtoc-h3 toc-link data-titleGET /media/{mediaId}>span classmethod method-get>GET/span> /media/{mediaId}/a>                          /li>                          li>                            a href#get-address-addressid-media classtoc-h3 toc-link data-titleGET /address/{addressId}/media>span classmethod method-get>GET/span> /address/{addressId}/media/a>                          /li>                          li>                            a href#get-address-media-mediaid classtoc-h3 toc-link data-titleGET /address-media/{mediaId}>span classmethod method-get>GET/span> /address-media/{mediaId}/a>                          /li>                          li>                            a href#post-validate-registry classtoc-h3 toc-link data-titlePOST /validate-registry>span classmethod method-post>POST/span> /validate-registry/a>                          /li>                          li>                            a href#post-sync-api-veriff-me-v1-validate-registry classtoc-h3 toc-link data-titlePOST sync-api.veriff.me/v1/validate-registry>span classmethod method-post>POST/span> sync-api.veriff.me/v1/validate-registry/a>                          /li>                          li>                            a href#post-sessions-sessionid-consents classtoc-h3 toc-link data-titlePOST /sessions/{sessionId}/consents>span classmethod method-post>POST/span> /sessions/{sessionId}/consents/a>                          /li>                          li>                            a href#get-sessions-sessionid-decision-ine-registry classtoc-h3 toc-link data-titleGET /sessions/{sessionId}/decision/ine-registry>span classmethod method-get>GET/span> /sessions/{sessionId}/decision/ine-registry/a>                          /li>                          li>                            a href#get-sessions-sessionid-decision-curp-registry classtoc-h3 toc-link data-titleGET /sessions/{sessionId}/decision/curp-registry>span classmethod method-get>GET/span> /sessions/{sessionId}/decision/curp-registry/a>                          /li>                          li>                            a href#get-sessions-sessionid-decision-combined-ine-curp-registry classtoc-h3 toc-link data-titleGET /sessions/{sessionId}/decision/combined-ine-curp-registry>span classmethod method-get>GET/span> /sessions/{sessionId}/decision/combined-ine-curp-registry/a>                          /li>                      /ul>                  /li>                  li>                    a href#test-the-requests-in-postman classtoc-h2 toc-link data-titleTest the requests in Postman>Test the requests in Postman/a>                  /li>                  li>                    a href#api-requests-signing-with-x-hmac-signature classtoc-h2 toc-link data-titleAPI requests signing with X-HMAC-SIGNATURE>API requests signing with X-HMAC-SIGNATURE/a>                      ul classtoc-list-h3>                          li>                            a href#generate-an-x-hmac-signature classtoc-h3 toc-link data-titleGenerate an X-HMAC-SIGNATURE>Generate an X-HMAC-SIGNATURE/a>                          /li>                          li>                            a href#validate-x-hmac-signature-locally classtoc-h3 toc-link data-titleValidate X-HMAC-SIGNATURE locally>Validate X-HMAC-SIGNATURE locally/a>                          /li>                          li>                            a href#what-is-an-x-hmac-signature classtoc-h3 toc-link data-titleWhat is an X-HMAC-SIGNATURE?>What is an X-HMAC-SIGNATURE?/a>                          /li>                      /ul>                  /li>                  li>                    a href#sessions-lifecycle-diagram-api classtoc-h2 toc-link data-titleSessions lifecycle diagram (API)>Sessions lifecycle diagram (API)/a>                  /li>              /ul>          /li>          li>            a href#webhooks classtoc-h1 toc-link data-titleWebhooks>Webhooks/a>              ul classtoc-list-h2>                  li>                    a href#configuring-the-webhook-endpoint classtoc-h2 toc-link data-titleConfiguring the webhook endpoint>Configuring the webhook endpoint/a>                  /li>                  li>                    a href#handling-security classtoc-h2 toc-link data-titleHandling security>Handling security/a>                  /li>                  li>                    a href#different-webhook-types classtoc-h2 toc-link data-titleDifferent webhook types>Different webhook types/a>                  /li>                  li>                    a href#decision-webhook classtoc-h2 toc-link data-titleDecision webhook>Decision webhook/a>                  /li>                  li>                    a href#event-webhook classtoc-h2 toc-link data-titleEvent webhook>Event webhook/a>                      ul classtoc-list-h3>                          li>                            a href#possible-events-over-the-webhook classtoc-h3 toc-link data-titlePossible events over the webhook>Possible events over the webhook/a>                          /li>                          li>                            a href#event-webhook-payload classtoc-h3 toc-link data-titleEvent webhook payload>Event webhook payload/a>                          /li>                      /ul>                  /li>                  li>                    a href#watchlist-screening-webhook classtoc-h2 toc-link data-titleWatchlist screening webhook>Watchlist screening webhook/a>                  /li>                  li>                    a href#ine-registry-validation-webhook classtoc-h2 toc-link data-titleINE registry validation webhook>INE registry validation webhook/a>                  /li>                  li>                    a href#curp-registry-validation-webhook classtoc-h2 toc-link data-titleCURP registry validation webhook>CURP registry validation webhook/a>                  /li>                  li>                    a href#combined-ine-curp-validation-webhook classtoc-h2 toc-link data-titleCombined INE CURP validation webhook>Combined INE CURP validation webhook/a>                  /li>                  li>                    a href#user-defined-session-statuses-webhook classtoc-h2 toc-link data-titleUser-defined session statuses webhook>User-defined session statuses webhook/a>                  /li>                  li>                    a href#webhooks-testing classtoc-h2 toc-link data-titleWebhooks testing>Webhooks testing/a>                  /li>              /ul>          /li>          li>            a href#full-auto classtoc-h1 toc-link data-titleFull Auto>Full Auto/a>              ul classtoc-list-h2>                  li>                    a href#full-auto-prerequisites classtoc-h2 toc-link data-titleFull Auto prerequisites>Full Auto prerequisites/a>                  /li>                  li>                    a href#full-auto-flow classtoc-h2 toc-link data-titleFull Auto flow>Full Auto flow/a>                  /li>                  li>                    a href#full-auto-over-sdk classtoc-h2 toc-link data-titleFull Auto over SDK>Full Auto over SDK/a>                  /li>                  li>                    a href#full-auto-over-api classtoc-h2 toc-link data-titleFull Auto over API>Full Auto over API/a>                      ul classtoc-list-h3>                          li>                            a href#sending-the-end-user-data-via-api classtoc-h3 toc-link data-titleSending the end-user data via API>Sending the end-user data via API/a>                          /li>                      /ul>                  /li>                  li>                    a href#getting-full-auto-session-decision classtoc-h2 toc-link data-titleGetting Full Auto session decision>Getting Full Auto session decision/a>                      ul classtoc-list-h3>                          li>                            a href#full-auto-results-in-decision-webhook classtoc-h3 toc-link data-titleFull Auto results in decision webhook>Full Auto results in decision webhook/a>                          /li>                          li>                            a href#querying-the-full-auto-decision-data-via-api classtoc-h3 toc-link data-titleQuerying the Full Auto decision data via API>Querying the Full Auto decision data via API/a>                          /li>                      /ul>                  /li>              /ul>          /li>          li>            a href#biometric-authentication classtoc-h1 toc-link data-titleBiometric Authentication>Biometric Authentication/a>              ul classtoc-list-h2>                  li>                    a href#prerequisites classtoc-h2 toc-link data-titlePrerequisites>Prerequisites/a>                  /li>                  li>                    a href#how-to-set-up-a-biometric-authentication-solution classtoc-h2 toc-link data-titleHow to set up a Biometric Authentication solution?>How to set up a Biometric Authentication solution?/a>                      ul classtoc-list-h3>                          li>                            a href#set-up-the-selfie-enrollment-integration classtoc-h3 toc-link data-titleSet up the selfie enrollment integration>Set up the selfie enrollment integration/a>                          /li>                          li>                            a href#set-up-the-authentication-integration classtoc-h3 toc-link data-titleSet up the authentication integration>Set up the authentication integration/a>                          /li>                      /ul>                  /li>                  li>                    a href#how-to-use-biometric-authentication-over-the-sdk classtoc-h2 toc-link data-titleHow to use Biometric Authentication over the SDK?>How to use Biometric Authentication over the SDK?/a>                      ul classtoc-list-h3>                          li>                            a href#step-by-step-guide classtoc-h3 toc-link data-titleStep-by-step guide>Step-by-step guide/a>                          /li>                          li>                            a href#from-the-end-user-point-of-view classtoc-h3 toc-link data-titleFrom the end-user point of view>From the end-user point of view/a>                          /li>                      /ul>                  /li>                  li>                    a href#how-to-use-biometric-authentication-over-the-api classtoc-h2 toc-link data-titleHow to use Biometric Authentication over the API?>How to use Biometric Authentication over the API?/a>                      ul classtoc-list-h3>                          li>                            a href#step-by-step-guide classtoc-h3 toc-link data-titleStep-by-step guide>Step-by-step guide/a>                          /li>                      /ul>                  /li>                  li>                    a href#how-to-get-the-verification-results classtoc-h2 toc-link data-titleHow to get the verification results?>How to get the verification results?/a>                      ul classtoc-list-h3>                          li>                            a href#request-properties classtoc-h3 toc-link data-titleRequest properties>Request properties/a>                          /li>                          li>                            a href#sample-request-properties classtoc-h3 toc-link data-titleSample request properties>Sample request properties/a>                          /li>                      /ul>                  /li>                  li>                    a href#how-to-handle-authentication-integration-statuses-and-decisions classtoc-h2 toc-link data-titleHow to handle authentication integration statuses and decisions?>How to handle authentication integration statuses and decisions?/a>                      ul classtoc-list-h3>                          li>                            a href#biometric-authentication-session-status-and-status-code classtoc-h3 toc-link data-titleBiometric authentication session status and status code>Biometric authentication session status and status code/a>                          /li>                          li>                            a href#biometric-authentication-session-decision-reason-and-reason-codes classtoc-h3 toc-link data-titleBiometric authentication session decision reason and reason codes>Biometric authentication session decision reason and reason codes/a>                          /li>                      /ul>                  /li>              /ul>          /li>          li>            a href#aml-screening classtoc-h1 toc-link data-titleAML Screening>AML Screening/a>              ul classtoc-list-h2>                  li>                    a href#pep-amp-sanction-screening-with-idv classtoc-h2 toc-link data-titlePEP & Sanction screening with IDV>PEP & Sanction screening with IDV/a>                  /li>                  li>                    a href#pep-amp-sanction-screening-without-idv classtoc-h2 toc-link data-titlePEP & Sanction screening without IDV>PEP & Sanction screening without IDV/a>                  /li>              /ul>          /li>          li>            a href#uk-diatf classtoc-h1 toc-link data-titleUK DIATF>UK DIATF/a>              ul classtoc-list-h2>                  li>                    a href#ukdiatf-certified-identity-verification-m1a classtoc-h2 toc-link data-titleUKDIATF Certified Identity Verification (M1A)>UKDIATF Certified Identity Verification (M1A)/a>                  /li>                  li>                    a href#ukdiatf-certified-identity-verification-m1b classtoc-h2 toc-link data-titleUKDIATF Certified Identity Verification (M1B)>UKDIATF Certified Identity Verification (M1B)/a>                  /li>                  li>                    a href#ukdiatf-certified-identity-verification-l1b classtoc-h2 toc-link data-titleUKDIATF Certified Identity Verification (L1B)>UKDIATF Certified Identity Verification (L1B)/a>                  /li>              /ul>          /li>          li>            a href#age-estimation classtoc-h1 toc-link data-titleAge Estimation>Age Estimation/a>              ul classtoc-list-h2>                  li>                    a href#age-estimation-process-overview classtoc-h2 toc-link data-titleAge Estimation process overview>Age Estimation process overview/a>                      ul classtoc-list-h3>                          li>                            a href#age-estimation-via-veriff-39-s-verification-flow classtoc-h3 toc-link data-titleAge Estimation via Veriffs verification flow>Age Estimation via Veriffs verification flow/a>                          /li>                          li>                            a href#age-estimation-over-the-api classtoc-h3 toc-link data-titleAge Estimation over the API>Age Estimation over the API/a>                          /li>                      /ul>                  /li>                  li>                    a href#age-estimation-session-decisions classtoc-h2 toc-link data-titleAge Estimation session decisions>Age Estimation session decisions/a>                  /li>                  li>                    a href#end-user-in-the-age-estimation-flow-diagram classtoc-h2 toc-link data-titleEnd-user in the Age Estimation flow (diagram)>End-user in the Age Estimation flow (diagram)/a>                  /li>              /ul>          /li>          li>            a href#proof-of-address-capture classtoc-h1 toc-link data-titleProof of Address Capture>Proof of Address Capture/a>          /li>          li>            a href#proof-of-address-extraction classtoc-h1 toc-link data-titleProof of Address Extraction>Proof of Address Extraction/a>              ul classtoc-list-h2>                  li>                    a href#brief-overview-of-the-poa-extraction-flow classtoc-h2 toc-link data-titleBrief overview of the PoA Extraction flow>Brief overview of the PoA Extraction flow/a>                  /li>                  li>                    a href#step-by-step-overview-of-the-poa-extraction-flow classtoc-h2 toc-link data-titleStep-by-step overview of the PoA Extraction flow>Step-by-step overview of the PoA Extraction flow/a>                      ul classtoc-list-h3>                          li>                            a href#poa-extraction-step-1-submit-a-session-using-the-post-sessions-endpoint classtoc-h3 toc-link data-titlePoA Extraction step 1: submit a session using the POST /sessions endpoint>PoA Extraction step 1: submit a session using the POST /sessions endpoint/a>                          /li>                          li>                            a href#poa-extraction-step-2-make-a-post-sessions-sessionid-media-request classtoc-h3 toc-link data-titlePoA Extraction step 2: make a POST /sessions/{sessionId}/media request>PoA Extraction step 2: make a POST /sessions/{sessionId}/media request/a>                          /li>                          li>                            a href#poa-extraction-step-3-update-the-session-status-to-quot-submitted-quot classtoc-h3 toc-link data-titlePoA Extraction step 3: update the session status to submitted>PoA Extraction step 3: update the session status to submitted/a>                          /li>                          li>                            a href#poa-extraction-step-4-wait-for-session-approval-and-decision-webhook-response classtoc-h3 toc-link data-titlePoA Extraction step 4: wait for session approval and decision webhook response>PoA Extraction step 4: wait for session approval and decision webhook response/a>                          /li>                          li>                            a href#poa-extraction-step-5-use-endpoints-to-query-poa-document-info classtoc-h3 toc-link data-titlePoA Extraction step 5: use endpoints to query PoA document info>PoA Extraction step 5: use endpoints to query PoA document info/a>                          /li>                      /ul>                  /li>                  li>                    a href#optional-proof-of-address-name-match-check classtoc-h2 toc-link data-titleOptional Proof of Address name match check>Optional Proof of Address name match check/a>                  /li>              /ul>          /li>          li>            a href#ine-biometric-database-verification classtoc-h1 toc-link data-titleINE Biometric Database Verification>INE Biometric Database Verification/a>              ul classtoc-list-h2>                  li>                    a href#ine-biometric-validation-prerequisites classtoc-h2 toc-link data-titleINE Biometric Validation prerequisites>INE Biometric Validation prerequisites/a>                  /li>                  li>                    a href#ine-biometric-validation-flow classtoc-h2 toc-link data-titleINE Biometric Validation flow>INE Biometric Validation flow/a>                  /li>                  li>                    a href#how-to-add-the-consent-to-the-session classtoc-h2 toc-link data-titleHow to add the consent to the session?>How to add the consent to the session?/a>                  /li>                  li>                    a href#how-to-find-results-in-the-decision-webhook classtoc-h2 toc-link data-titleHow to find  results in the decision webhook?>How to find  results in the decision webhook?/a>                  /li>                  li>                    a href#how-to-find-results-in-the-get-decisions-response classtoc-h2 toc-link data-titleHow to find results in the GET /decisions response?>How to find results in the GET /decisions response?/a>                  /li>              /ul>          /li>          li>            a href#reference-info-codes-tables classtoc-h1 toc-link data-titleReference Info, Codes, Tables>Reference Info, Codes, Tables/a>              ul classtoc-list-h2>                  li>                    a href#verification-session-status-and-decision-codes classtoc-h2 toc-link data-titleVerification session status and decision codes>Verification session status and decision codes/a>                      ul classtoc-list-h3>                          li>                            a href#session-status classtoc-h3 toc-link data-titleSession status>Session status/a>                          /li>                          li>                            a href#verification-decision-declined classtoc-h3 toc-link data-titleVerification decision: declined>Verification decision: declined/a>                          /li>                          li>                            a href#verification-decision-resubmission-required classtoc-h3 toc-link data-titleVerification decision: resubmission required>Verification decision: resubmission required/a>                          /li>                      /ul>                  /li>                  li>                    a href#common-http-status-codes classtoc-h2 toc-link data-titleCommon HTTP status codes>Common HTTP status codes/a>                  /li>                  li>                    a href#credentials-and-authorization-codes classtoc-h2 toc-link data-titleCredentials and authorization codes>Credentials and authorization codes/a>                  /li>                  li>                    a href#some-troubleshooting-codes classtoc-h2 toc-link data-titleSome troubleshooting codes>Some troubleshooting codes/a>                  /li>                  li>                    a href#granular-reason-codes classtoc-h2 toc-link data-titleGranular reason codes>Granular reason codes/a>                      ul classtoc-list-h3>                          li>                            a href#grc-verification-decision-declined classtoc-h3 toc-link data-titleGRC verification decision: declined>GRC verification decision: declined/a>                          /li>                          li>                            a href#grc-verification-decision-resubmit classtoc-h3 toc-link data-titleGRC verification decision: resubmit>GRC verification decision: resubmit/a>                          /li>                      /ul>                  /li>                  li>                    a href#image-context-types classtoc-h2 toc-link data-titleImage context types>Image context types/a>                      ul classtoc-list-h3>                          li>                            a href#identity-verification-process classtoc-h3 toc-link data-titleIdentity verification process>Identity verification process/a>                          /li>                          li>                            a href#proof-of-address-verification-process classtoc-h3 toc-link data-titleProof of Address verification process>Proof of Address verification process/a>                          /li>                      /ul>                  /li>                  li>                    a href#video-context-types classtoc-h2 toc-link data-titleVideo context types>Video context types/a>                  /li>                  li>                    a href#supported-document-types-for-idv classtoc-h2 toc-link data-titleSupported document types for IDV>Supported document types for IDV/a>                  /li>                  li>                    a href#document-data-fields classtoc-h2 toc-link data-titleDocument data fields>Document data fields/a>                  /li>                  li>                    a href#media-file-mimetypes classtoc-h2 toc-link data-titleMedia file mimetypes>Media file mimetypes/a>                  /li>                  li>                    a href#reasons-for-different-types-of-decisions classtoc-h2 toc-link data-titleReasons for different types of decisions>Reasons for different types of decisions/a>                      ul classtoc-list-h3>                          li>                            a href#preconditions-for-approval-decisions classtoc-h3 toc-link data-titlePreconditions for approval decisions>Preconditions for approval decisions/a>                          /li>                          li>                            a href#reasons-for-negative-conclusive-decisions classtoc-h3 toc-link data-titleReasons for negative conclusive decisions>Reasons for negative conclusive decisions/a>                          /li>                          li>                            a href#reasons-for-inconclusive-decisions classtoc-h3 toc-link data-titleReasons for inconclusive decisions>Reasons for inconclusive decisions/a>                          /li>                          li>                            a href#final-decisions classtoc-h3 toc-link data-titleFinal decisions>Final decisions/a>                          /li>                      /ul>                  /li>                  li>                    a href#storing-verification-media classtoc-h2 toc-link data-titleStoring verification media>Storing verification media/a>                      ul classtoc-list-h3>                          li>                            a href#downloading-the-photo-and-video-files classtoc-h3 toc-link data-titleDownloading the photo and video files>Downloading the photo and video files/a>                          /li>                      /ul>                  /li>              /ul>          /li>          li>            a href#glossary classtoc-h1 toc-link data-titleGlossary>Glossary/a>          /li>      /ul>        ul classtoc-footer>            li>a hrefhttps://www.veriff.com/>Veriff Home/a>/li>            li>a hrefhttps://www.veriff.com/privacy-notice>Veriff Privacy Notice/a>/li>            li>a hrefhttps://www.veriff.com/data-collection-purposes>Info about Data Collection in Mobile SDKs/a>/li>        /ul>    /div>    div classpage-wrapper>      div classcontent>        h1 idintroduction>Introduction/h1>p>Welcome to Veriff's developers documentation!/p>p>If you have any questions, use the strong>Intercom/strong> button at the bottom of the screenor write to support@veriff.com to get in contact with us./p>aside classnotice>In a nutshell, in order to use Veriff to verify your end-users, you need to do the following:ol>    li>Sign up and log in to b>the Veriff environment/b>    li>Find and open your b>integration/b> from the list on the b>Integrations/b> page/li>    li>Create b>a verification session/b> with the a href#post-sessions>POST /sessions/a> call or        in the Veriff environment/li>    li>Decide if you want to use an a href#sdk-guide>SDK/a> to  pass end-user data, or do it via the        a href#api-reference>API/a>/li>    li>Configure a href#webhooks>webhooks/a> to get replies from Veriff/li>/ol>/aside>h1 idgetting-started-with-veriff>Getting Started With Veriff/h1>h2 idsigning-up>Signing up/h2>p>Fill in the form at a hrefhttps://www.veriff.com/>veriff.com/a> ↗ and a confirmation email with further instructionsis sent to you./p>h2 idlogging-in>Logging in/h2>p>To log in to strong>the Veriff environment/strong>, please strong>use the link sent/strong> in the confirmation email and follow the instructions./p>h3 idnew-user-accounts>New user accounts/h3>p>Once you have logged in and wish to create new user accounts for other members of your team, navigate to the strong>Team/strong> page.You must have the strong>Administrator/strong> rights to do it. Check out a hrefhttps://help.veriff.com/en/articles/3430318-how-can-my-coworker-get-access>this article/a>↗ in the Knowledge Base for more info (requires a login to strong>the Veriff environment/strong>)./p>h2 idcreating-an-integration>Creating an integration/h2>p>strong>Integration/strong> is a collection of settings and is distinguished by the strong>API keys/strong>. In short, it means thatan integration is a way to exchange data with Veriff./p>p>Integrations are created in strong>the Veriff environment/strong>. In case it has not already been created for you,or you would like to create another one, follow these steps./p>ol>li>Log in via the link sent to you in your signup email/li>li>Navigate to strong>Integrations/strong> tab on the top-bar menu/li>li>Click on the strong>Add integration/strong> button/li>li>Choose a suitable name and environment for the integration (either strong>Test/strong> or strong>Live/strong>)/li>/ol>h3 idtest-integrations>Test integrations/h3>p>These are used for development. Verification sessions done in the test integrations do not count towards paid usage.Stress testing without prior agreement with Veriff is not allowed./p>p>Veriff does not provide decisions for sessions created in the test integration, you need to trigger the decisions yourself./p>p>One option is to do it in the strong>Veriff environment/strong>. See the article a hrefhttps://help.veriff.com/en/articles/3492920-forcing-the-status-and-data-of-the-verification-session-when-testing>here/a>↗ about how to do that (requires a login to strong>the Veriff environment/strong>)./p>p>The other is to generate a session using the POST /sessions call and pass "Approve", "Decline" or "Resubmit"in the code>firstName/code> field. You can read more about it in this a hrefhttps://help.veriff.com/en/articles/3250237-getting-the-desired-test-verification-result>article/a>↗ in the Knowledge Base (requires a login to strong>the Veriff environment/strong>)./p>h3 idlive-integrations>Live integrations/h3>p>These are used for production. Sessions created will count towards paid usage and Veriff provides a decisions for those./p>p>To find more information about strong>Integrations/strong>, please see the a hrefhttps://help.veriff.com/en/collections/1900851-integration>articles/a>↗ in the Knowledge Base (requires a login to strong>the Veriff environment/strong>)./p>h2 idquick-guide-of-idv-using-the-sdks>Quick guide of IDV using the SDKs/h2>p>This section is a quick intro into doing identity verification (IDV) when using the Software Development Kits (SDKs)./p>p>You may want to opt for the SDKs when you prefer using Veriff's front-end solution and built-in verification flow,and have no plans to independently collect end-user media./p>h3 idquick-overview-of-the-steps>Quick overview of the steps/h3>ol>li>Add the relevant a href#sdk-guide>Veriff SDK/a> to your project/li>li>Create an integration (guide a href#creating-an-integration>above/a>)/li>li>Configure webhooks (guide a href#setting-up-webhooks>below/a>)/li>li>Create a verification session to get the strong>session URL/strong> (guide a href#using-the-api-to-generate-a-session-for-the-sdk>below/a>)/li>li>Pass the strong>session URL/strong> to the SDK/li>li>Direct the end-user to the verification flow, where they submit their data and media/li>li>End-user's data and media passed to Veriff/li>li>Veriff verifies the end-user/li>li>Veriff returns the decision via webhook/li>/ol>h3 idusing-the-api-to-generate-a-session-for-the-sdk>Using the API to generate a session for the SDK/h3>p>First refer to the a href#prerequisites-to-create-api-requests>Prerequisites to create API requests/a> and thea href#backwards-compatible-changes>Backwards compatible changes/a> sections to make sure you haveall you need to start sending API requests./p>ol>li>Make a a href#post-sessions>POST /sessions/a> call:ul>li>Send the object to code>https://<BaseURL>/v1/sessions/code>/li>li>Include the strong>Content-Type/strong> code>application/json/code> header/li>li>Include the strong>X-AUTH-CLIENT/strong> header containing your integration's strong>API key/strong>/li>li>Include the strong>callback URL/strong> in code>verification.callback/code> for Redirect end-users/li>li>Include the code>vendorData/code> parameter (optional, but strongly recommended)/li>/ul>/li>li>From the response you need to take:ul>li>The unique strong>session ID/strong> in code>verification.id/code>, important for webhooks and for identifying the session later on/li>li>The unique strong>session URL/strong> in code>verification.url/code>, required to bring the end-user into the flow/li>li>Also, we recommend storing the unique code>vendorData/code> parameter, which is important for improved fraud detection,webhooks, and for identifying the session later on/li>/ul>/li>/ol>p>strong>Request example/strong>/p>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>verification/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>       /span>span classs2>callback/span>span classp>:/span>span classw> /span>span classs2>https://veriff.com/span>span classp>,/span>span classw>       /span>span classs2>vendorData/span>span classp>:/span>span classw> /span>span classs2>2bf528f7-4b9c-44f0-b928-fdc7afc5ca1b/span>span classw>  /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>p>strong>Response example/strong>/p>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>    /span>span classs2>verification/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>b27afb60-1455-4927-afb6-fc27a60e1455/span>span classp>,/span>span classw>        /span>span classs2>url/span>span classp>:/span>span classw> /span>span classs2>https://..../span>span classp>,/span>span classw>        /span>span classs2>vendorData/span>span classp>:/span>span classw> /span>span classs2>2bf528f7-4b9c-44f0-b928-fdc7afc5ca1b/span>span classp>,/span>span classw>        /span>span classs2>host/span>span classp>:/span>span classw> /span>span classs2>https://....veriff.com/span>span classp>,/span>span classw>        /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>created/span>span classp>,/span>span classw>        /span>span classs2>sessionToken/span>span classp>:/span>span classw> /span>span classs2>eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...../span>span classw>    /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h3 idwhat-happens-after-the-end-user-leaves-the-verification-flow>What happens after the end-user leaves the verification flow?/h3>p>When the end-user leaves the verification flow, the following scenarios apply./p>h4 idandroid-ios-flutter-and-react-native>Android, iOS, Flutter and React Native/h4>p>When a session is canceled or finished, the Veriff SDK is closed. The end-user is taken back to your application./p>p>Also, the strong>end-user flow completion status/strong> is returned to the host application via callback or delegate method,depending on the SDK type. Note that this status shows strong>whether the end-user was able to complete all the stepsin the verification flow or not/strong>. It is not the verification session status./p>p>Refer to each SDK for more info about the callback or delegate methods:/p>ul>li>Android:  the code>onActivityResult()/code> callback, see a href#getting-the-verification-status>here/a>/li>li>iOS: the code>func sessionDidEndWithResult(_ result: Veriff.Result)/code> delegate method, see a href#handling-result-codes-from-sdk>here/a>/li>li>Flutter: the code>start/code> method, see a href#handling-the-results-from-plugin>here/a>/li>li>React Native: the code>launchVeriff/code> method, see a href#handling-the-result-from-the-sdk>here/a>/li>/ul>h4 idincontext-js-iframe-and-embedded>InContext JS (Iframe and Embedded)/h4>p>When a session is canceled or finished, the InContext SDK emits the code>CANCELED/code> or code>FINISHED/code> events. It is up to youto decide what happens (close, redirect) in the SDK when the events are triggered. /p>p>See a href#listening-for-events>here/a> for more info about the code>onEvent/code> callback that will return thestrong>end-user flow completion status/strong>./p>h4 idredirect>Redirect/h4>p>When a session is canceled or finished, we try to redirect the end-user to the strong>callback URL/strong>, or close the browserif the strong>callback URL/strong> is not present./p>h3 idsdk-sessions-lifecycle-diagram>SDK sessions lifecycle diagram/h3>p>br/>/p>p>img srcimages/SDK_sessions_lifecycle_diagram.png altSDK sessions lifecycle diagram />/p>h2 idquick-guide-of-the-idv-using-the-api>Quick guide of the IDV using the API/h2>p>This section is a quick intro into doing identity verification (IDV) when using the Application Programming Interface(API) calls./p>p>In case of using the API, you are collecting the end-user's data and/or media yourself via your own solution, and thenuse Veriff's API endpoints to pass us relevant data for verification./p>p>The most important prerequisite to send end-user's data to Veriff is the strong>session ID/strong> aka the value in thePOST /sessions response code>verification.id/code> field. This is used in all the calls made for the specific session(refer to the a href#endpoints>Endpoints/a>), and it is used to get the a href#webhooks>webhook/a> responses for the session./p>h3 idquick-overview-of-the-steps-2>Quick overview of the steps/h3>ol>li>Create an integration (guide a href#creating-an-integration>above/a>)/li>li>Configure webhooks (guide a href#setting-up-webhooks>below/a>)/li>li>Create a verification session to get the strong>session ID/strong> (guide a href#using-the-api-to-generate-a-session-for-api>below/a>)/li>li>Using the strong>session ID/strong>, pass end-user's media via a href#post-sessions-sessionid-media>POST sessions/{sessionId}/media/a>/li>li>Patch the session to code>submitted/code> using a href#patch-sessions-sessionid>PATCH sessions/{sessionId}/a>/li>li>Veriff verifies the end-user/li>li>Veriff returns the decision via webhook/li>/ol>p>Note that collecting end-user's data beforehand or during the flow is strong>optional/strong>, as Veriff can extract this datafrom the media sent to us./p>h3 idusing-the-api-to-generate-a-session-for-api>Using the API to generate a session for API/h3>p>First refer to the a href#prerequisites-to-create-api-requests>Prerequisites to create API requests/a> and thea href#backwards-compatible-changes>Backwards compatible changes/a> sections to make sure you haveall you need to start sending API requests./p>ol>li>Make a a href#post-sessions>POST /sessions/a> call:ul>li>Send the object to code>https://<BaseURL>/v1/sessions/code> (required)/li>li>Include the strong>Content-Type/strong> code>application/json/code> header (required)/li>li>Include the strong>X-AUTH-CLIENT/strong> header containing your integration's strong>API key/strong> (required)/li>li>Include the end-user's data/media you have collected (refer to the strong>Request properties explained/strong>in a href#post-sessions>POST /sessions/a>) (optional)/li>li>Include the code>vendorData/code> parameter (optional, but strongly recommended)/li>/ul>/li>li>In the response, you will receive a JSON with:ul>li>The unique strong>session ID/strong> in code>verification.id/code>, important for webhooks and for identifying the session later on/li>/ul>/li>/ol>p>strong>Request example/strong>/p>pre classhighlight json tab-json>code>span classp>{/span>span classw>     /span>span classs2>verification/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>          /span>span classs2>person/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>               /span>span classs2>firstName/span>span classp>:/span>span classw> /span>span classs2>John/span>span classp>,/span>span classw>               /span>span classs2>lastName/span>span classp>:/span>span classw> /span>span classs2>Smith/span>span classp>,/span>span classw>               /span>span classs2>idNumber/span>span classp>:/span>span classw> /span>span classs2>12-03-1989/span>span classw>            /span>span classp>},/span>span classw>          /span>span classs2>document/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>               /span>span classs2>number/span>span classp>:/span>span classw> /span>span classs2>B01234567/span>span classp>,/span>span classw>               /span>span classs2>type/span>span classp>:/span>span classw> /span>span classs2>PASSPORT/span>span classp>,/span>span classw>               /span>span classs2>country/span>span classp>:/span>span classw> /span>span classs2>EE/span>span classw>            /span>span classp>},/span>span classw>          /span>span classs2>address/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>               /span>span classs2>fullAddress/span>span classp>:/span>span classw> /span>span classs2>Lorem Ipsum 30, 12345 Tallinn, Estonia/span>span classw>            /span>span classp>},/span>span classw>         /span>span classs2>vendorData/span>span classp>:/span>span classw> /span>span classs2>2bf528f7-4b9c-44f0-b928-fdc7afc5ca1b/span>span classw>  /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>p>strong>Response example/strong>/p>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>    /span>span classs2>verification/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>b27afb60-1455-4927-b155-0260ffe0947a/span>span classp>,/span>span classw>        /span>span classs2>url/span>span classp>:/span>span classw> /span>span classs2>https://..../span>span classp>,/span>span classw>        /span>span classs2>vendorData/span>span classp>:/span>span classw> /span>span classs2>2bf528f7-4b9c-44f0-b928-fdc7afc5ca1b/span>span classp>,/span>span classw>        /span>span classs2>host/span>span classp>:/span>span classw> /span>span classs2>https://....veriff.com/span>span classp>,/span>span classw>        /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>created/span>span classp>,/span>span classw>        /span>span classs2>sessionToken/span>span classp>:/span>span classw> /span>span classs2>eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...../span>span classw>    /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h3 idapi-sessions-lifecycle-diagram>API sessions lifecycle diagram/h3>p>br/>/p>p>img srcimages/API_sessions_lifecycle_diagram2.png altAPI sessions lifecycle diagram />/p>h2 idgenerating-session-manually>Generating session manually/h2>p>It is possible to manually generate a verification session in strong>the Veriff environment/strong>. This option can be usedto test or debug sessions, or as a manual fallback option./p>p>Using this option, you can generate a link and a QR code, and share them with the end-user./p>ol>li>Go to strong>the Veriff environment/strong>/li>li>Click on the strong>Verifications/strong> on the top menu/li>li>Click on the strong>Add Verification/strong> button/li>li>Find and open the relevant integration/li>li>Fill in the first name, last name/li>li>Click strong>Generate Verification/strong>/li>li>Click on strong>Share/strong> to copy the URL or QR image onto a clipboard/li>/ol>p>img srcimages/create_verification_in_environment.png alt />/p>p>img srcimages/verification_in_environment_created.png alt />/p>h2 idsetting-up-webhooks>Setting up webhooks/h2>p>In order to receive responses from Veriff services, you need to configure webhooks.Refer to the a href#webhooks>Webhooks/a> section for a thorough overview./p>p>To configure the webhook endpoint:/p>ol>li>Go to strong>the Veriff environment/strong>/li>li>Click on the strong>Integrations/strong> on the top menu/li>li>Find and open the relevant integration/li>li>Navigate to the  strong>Settings/strong> tab on the integration's page/li>li>Fill in the webhook URL input field with the URL where your endpoint is accepting payloads from Veriff/li>/ol>p>There are a href#different-webhook-types>several types of webhooks/a>. Veriff will post payloads to respective webhook URLs./p>p>Note that the strong>image below/strong> does strong>not contain all the possible webhook URLs/strong>. The list available depends on your integration./p>p>img srcimages/configure_webhooks_in_Vff_environment.png alt />/p>aside classnotice>Make sure to check out the a href/#backwards-compatible-changes>Backwards compatible changes/a>section and ensure that your systems can handle these changes./aside>h2 idverification-session-statuses>Verification session statuses/h2>p>Once the end-user has gone through the flow, we return the session status and the status code./p>h3 idsession-statuses-explained>Session statuses explained/h3>p>Identity verification session status is one of:/p>ul>li>code>approved/code>/li>li>code>resubmission_requested/code>/li>li>code>declined/code>/li>li>code>expired/code>/li>li>code>abandoned/code>/li>li>code>review/code>/li>/ul>p>For the aforementioned verification statuses, the status code is one of 9001, 9102, 9103, 9104, 9121. All codes andexplanations can be found in the a href#verification-session-status-and-decision-codes>Verification session decision codes/a>table./p>p>Responses 9001, 9102, 9121 and 9104 are strong>conclusive responses/strong>. The session is closed and the URL is not available for the end-user./p>p>Response 9103 is an strong>inconclusive response/strong>. The session remains open until you receive one of the above conclusiveresponses. The session is re-opened for the end-user, accepting a new attempt./p>aside classnotice>When the verifications that are sent over the API receive a code>resubmission requested/code> status from Veriff,it is strongly advised that you inform the end-user about the reasons for the verification failure and providesuggestions on how to improve their next attempt. This communication can be conducted through email, SMS, and/orwithin your platform to ensure better visibility.br/>For resubmitted verification attempts where certain elements were missing or the qualityof the submission was subpar, a new attempt is generated and made available through the same session URL.It is important to use the same session URL for verification attempts made by the same end-user./aside>aside classnotice>The code>review/code> status means that somebody from your end should take a look at the session and decideto approve or decline the end-user. Also, this status is not available by default for all integrations.  /aside>h3 idfetching-the-session-statuses>Fetching the session statuses/h3>p>The session status is available in the code>verification.status/code> parameter in:/p>ul>li>a href#decision-webhook>Decision webhook/a> payload/li>li>a href#post-sessions>POST /sessions/a> response/li>li>a href#get-sessions-sessionid-attempts>GET /sessions/{sessionId}/attempts/a> response/li>li>a href#get-sessions-sessionid-decision>GET /sessions/{sessionId}/decision/a> response/li>/ul>h2 idverification-decisions>Verification decisions/h2>p>Once the end-user has gone through the verification flow and the verification process is complete,the session receives a decision. The end user is strong>approved/strong>, strong>declined/strong>, or asked to strong>resubmit/strong>./p>h3 iddecisions-explained>Decisions explained/h3>p>We share with you the reasons why the end-user was strong>declined/strong> or asked to strong>resubmit/strong>:/p>ul>li>Common decision reason codes table can be found a href#verification-decision-declined>here/a>/li>li>More granular decision reason codes table can be found a href#granular-reason-codes>here/a>/li>/ul>h3 idtriggering-decisions-manually-for-testing>Triggering decisions manually for testing/h3>aside classnotice>This is applicable only for b>test integrations/b>./aside>p>There are two ways to trigger decisions for strong>test integration/strong> sessions./p>ol>li>p>In the strong>Veriff environment/strong>. Refer to this a hrefhttps://help.veriff.com/en/articles/3492920-forcing-the-status-and-data-of-the-verification-session-when-testing>article/a>↗ in the Knowledge Base (requires a login to strong>the Veriff environment/strong>)./p>/li>li>p>Generate a session using the POST /sessions call and pass "Approve", "Decline" or "Resubmit"in the code>firstName/code> field. Refer to this a hrefhttps://help.veriff.com/en/articles/3250237-getting-the-desired-test-verification-result>article/a>↗ in the Knowledge Base (requires a login to strong>the Veriff environment/strong>)./p>/li>/ol>h3 idfetching-the-decision>Fetching the decision/h3>p>There are several options to fetch the decision(s) of a verification session:/p>ul>li>strong>Manually/strong>: the strong>Verifications/strong> page in strong>the Veriff environment/strong> displays sessions' details, including the decisions made/li>li>Use the a href/#decision-webhook>strong>decision webhook/strong>/a>, for which you need toa href#configuring-the-webhook-endpoint>specify the strong>Webhook URL/strong>/a> in strong>the Veriff environment/strong> and implement a listener/li>li>Query the a href#get-sessions-sessionid-decision>strong>GET /sessions/{sessionId}/decision/strong>/a> endpoint/li>li>For strong>Full Auto/strong> integrations, use the a href#querying-the-decision-data-via-api>strong>GET /sessions/{sessionId}/decision/fullauto/strong>/a>endpoint or the a href#full-auto-webhook>strong>Full Auto webhook/strong>/a>, but note that in this case, the "decision" is thesystem's suggestion about what to do with the session/li>/ul>h2 idverification-session-events>Verification session events/h2>p>Event statuses and codes are sent to strong>notify/strong> you about the strong>progress of the data gathering process/strong> during theverification session. For more info, see the a href#event-webhook>Event webhook/a> section./p>h2 idbackwards-compatible-changes>Backwards compatible changes/h2>p>All the changes listed below are considered to be backwards compatible by Veriff. Make sure to set up your systems insuch flexible manner that it is able to handle these changes./p>ul>li>Adding new properties (e.g., strings, objects, arrays) to existing API responses/li>li>Changing the order* of properties in existing API responses, i.e., the order of strings, objects, arrays/li>li>Adding new API resources, e.g., adding new API endpoints/li>li>Adding new optional request parameters to existing API endpoints/li>li>Changing the length or format of opaque** strings, such as error messages, object IDs, etc./li>li>Adding new event types to webhooks/li>li>Adding new properties (e.g., strings, objects, arrays) to webhook payloads/li>li>Webhook listener should gracefully handle unfamiliar event types/li>/ul>p>*As a general note on the order of properties in the responses, keep in mind that the order is not static. This meansthat the order you see in your API call responses may differ from the order you see in Veriff documentation./p>p>**This means data that your system should be able to just transmit or store, not interpret./p>h2 idtry-our-demos>Try our demos/h2>p>strong>Web/strong>/p>p>To try out the end-user facing verification flow, navigate to a hrefhttps://demo.veriff.me/>Veriff Demo/a> ↗. Opening thelink will start the verification flow in your browser./p>p>strong>Mobile SDKs/strong>/p>p>Our mobile SDKs can be tested by downloading the demo versions:a hrefhttps://apps.apple.com/us/app/veriff/id1467907532?ls1>iOS/a> / a hrefhttps://play.google.com/store/apps/details?idcom.veriff.demo>Android/a> ↗/p>p>strong>Review Verifications/strong>/p>p>To review the submitted verification and its results, visit strong>the Veriff environment/strong> and open the individual verificationsession to see the details./p>h2 idbrowser-support-for-verification-flow>Browser support for verification flow/h2>h3 idsupported-browsers>Supported browsers/h3>h4 iddesktop>Desktop/h4>ul>li>Google Chrome/li>li>Mozilla Firefox/li>li>Safari/li>li>Microsoft Edge (Chromium based)/li>li>Opera/li>li>Yandex Browser/li>/ul>p>In addition to the listed browsers other Chromium based browsers may work./p>h4 idios>iOS/h4>ul>li>Safari/li>li>On iOS 14.3 and newer iOS versions all browsers are supported./li>/ul>h4 idandroid>Android/h4>ul>li>Google Chrome/li>li>Mozilla Firefox/li>li>Samsung Browser/li>li>Opera/li>/ul>p>In addition to the listed browsers other Chromium based browsers may work./p>h3 idnot-supported-browsers>Not supported browsers/h3>p>A list of browsers which are not supported currently and that we can not support unless there are browser side changesimplemented by the browser provider:/p>h4 idandroid-2>Android/h4>ul>li>Xiaomi browser/li>li>UC Browser/li>li>Facebook webview/li>/ul>h4 idios-2>iOS/h4>ul>li>All Non-Safari iOS browsers on iOS versions prior to 14.3./li>/ul>h2 idallowlisted-urls-and-ip-addresses>Allowlisted URLs and IP addresses/h2>p>To ensure uninterrupted access to our services, it is important that your network firewall configurations permitcommunication with our servers. This involves allowing specific IP addresses and URLs to establish a secure andreliable connection./p>h3 idallowlisted-urls>Allowlisted URLs/h3>p>To facilitate smooth service operations, we request allowing all traffic coming from the following domains:/p>ul>li>code>*.veriff.me/code>/li>li>code>*.veriff.com/code>/li>/ul>h3 idallowlisted-ip-addresses>Allowlisted IP addresses/h3>h4 idips-for-us-zone>IPs for US zone/h4>p>code>100.20.120.34/code>/br>code>52.25.243.218/code>/br>code>54.148.105.103/code>/br>code>54.218.205.80/code>/br>/p>h4 idips-for-eu-zone>IPs for EU zone/h4>p>code>34.254.42.181/code>/br>code>34.242.213.89/code>/br>code>52.19.226.239/code>/br>/p>h4 idfloating-ips-range>Floating IPs range/h4>p>code>3.251.215.160/27/code>/p>p>That means the range to be allowed is: code>3.251.215.160/code> to code>3.251.215.191/code>/p>h2 idtest-the-api-collection-in-postman>Test the API Collection in Postman/h2>p>It is possible to test the strong>Veriff API v1.0 Collection/strong> in strong>Postman/strong>. Click on the button belowto get started./p>div classpostman-btn-wrapper>    a hrefhttps://postman.veriff.com target_blank classpostman-btn>      span classpostman-txt>Try in Postman/span>       span classpostman-arrow>▸/span>    /a>/div>h1 idintegrations-test-guide>Integrations Test Guide/h1>p>You will have strong>one Test integration/strong> pre-created for you in the strong>Veriff environment/strong>. You can create more test integrations if needed.The test integration will be used by you to test the communication between Veriff's and your system and to see how theresponses are handled. /p>aside classnotice>Verification sessions generated for test integrations are not billed and not verified by Veriff./aside>p>em>To check the quality of Veriff's responses, and you are already set up with Veriff, please talk to you solutions engineer. If not,please select plan and subscribe to a free trial on a hrefhttps://www.veriff.com/plans>Plans/a> ↗ page (requires a login to theVeriff Environment). The free trial will allow to create Live integrations./em>/p>h2 idtesting-verification-sessions-checklist>Testing verification sessions checklist/h2>ul>li>New session link is generated/li>li>Session data is saved with your record/li>li>Sessions with odd names can be started/li>li>Sessions with code>vendorData/code> - do you get them back and do you perform actions on them/li>li>Sessions with code>endUserId/code> - do you get them back and do you perform actions on them/li>li>End-user is granted access to your platform after receiving an code>Approved/code> decision/li>li>End-user is notified about verification failure after receiving code>Resubmission/code> or code>Declined/code> decision/li>li>End-user is prompted to try again after receiving code>Resubmission/code> decision. Note that the end-user has 9 resubmissionattempts, the 10sup>th/sup> attempt is an automatic decline. See the note a href#verification-decision-resubmission-required>here/a>for more info./li>li>In case of resubmitted session, end-user is directed to same code>sessionURL/code>/li>li>In case of disrupted session (browser close, end-user logout, etc.,), the end-user should be directed back to earlier session/li>li>In case generated session is over 7 days old (and thus in code>Expired/code> or code>Abandonded/code> status), a new session is generated/li>li>At end of verification, code>callbackURL/code> redirects back to the correct place in your platform/li>/ul>p>Also see our support article for a hrefhttps://help.veriff.com/en/articles/3492920-forcing-the-status-and-data-of-the-verification-session-when-testing>getting the desired test verification result/a> ↗/p>h2 idtesting-security>Testing security/h2>ul>li>A webhook with wrong API key should not be accepted/li>li>A webhook with mismatched X-HMAC-SIGNATURE should not be accepted/li>li>A webhook with invalid JSON should not break or crash your server/li>/ul>h2 idtesting-responses>Testing responses/h2>p>Each type of response should be accepted:/p>ul>li>Approved (Decision endpoint)/li>li>Declined (Decision endpoint)/li>li>Resubmission (Decision endpoint)/li>li>Review (Decision endpoint)/li>li>Expired (Decision endpoint)/li>li>Abandoned (Decision endpoint)/li>/ul>p>Explanations and availability of these have been listed in the a href#verification-session-status-and-decision-codes>session status and decision codes/a> tables >decision codes 9001 to 9121./p>h2 idtesting-process-in-your-app>Testing process in your app/h2>p>You should test the handling of best cases as well as edge cases:/p>ul>li>Approved end-users handled or notified as appropriate/li>li>Declined end-users handled as appropriate, your back office notified if necessary/li>li>In case of resubmission request, end-user is invited back to try KYC again using the same code>sessionURL/code>/li>li>In case of code>Expired/code> or code>Abandoned/code> session (after 7 days), end-user is not offered to continue from same session,new code>sessionURL/code> is created/li>/ul>h2 idmobile-testing>Mobile testing/h2>p>Test our demo app by downloading it in the app store. a hrefhttps://apps.apple.com/us/app/veriff/id1467907532?ls1>iOS/a> / a hrefhttps://play.google.com/store/apps/details?idcom.veriff.demo>Android/a> ↗/p>h2 idapi-upload-testing>API Upload testing/h2>p>strong>Required tools/strong>/p>ul>li>Veriff's integration demo: a hrefhttps://github.com/Veriff/js-integration-demo/archive/master.zip>js-integration-demo-master.zip/a> (clicking the link will start the download)/li>li>Node.js (download from a hrefhttps://nodejs.org/en/download/>Node.js org/a> ↗)/li>li>Notepad/TextEdit (default in Windows/Mac) or Notepad++ (download from a hrefhttps://notepad-plus-plus.org/>Notepad++/a> ↗)/li>/ul>p>strong>Step by step/strong>/p>ol>li>Download and install Node.js/li>li>Download and extract js-integration-demo-master.zip/li>li>Open Command (Windows) or Terminal (Mac) on your local computer./li>li>Navigate to js-integration-demo-master foldercode>cd C:\Users\User\Desktop\Veriff API)./code>/li>li>Run command >npm install/li>li>Open app.js with your text editing app (Notepad/TextEdit) and update 'API-Public-Key' and 'API-Private-Key' to the values in your Backoffice account (Management -> Vendor). Tokens must be in single quotes. Save the file./li>/ol>pre classhighlight javascript tab-javascript>code>span classkr>const/span> span classnx>API_TOKEN/span> span classo>/span> span classnx>process/span>span classp>./span>span classnx>env/span>span classp>./span>span classnx>API_TOKEN/span> span classo>||/span> span classs1>API-Public-Key/span>span classp>;/span>span classkr>const/span> span classnx>API_SECRET/span> span classo>/span> span classnx>process/span>span classp>./span>span classnx>env/span>span classp>./span>span classnx>API_SECRET/span> span classo>||/span> span classs1>API-Private-Key/span>span classp>;/span>span classkr>const/span> span classnx>API_URL/span> span classo>/span> span classnx>process/span>span classp>./span>span classnx>env/span>span classp>./span>span classnx>API_URL/span> span classo>||/span> span classs1>https://api.staging.vrff.io/v1/span>span classp>;/span>span classkr>const/span> span classnx>WEBHOOK_PORT/span> span classo>/span> span classnx>process/span>span classp>./span>span classnx>env/span>span classp>./span>span classnx>WEBHOOK_PORT/span> span classo>||/span> span classmi>3002/span>span classp>;/span>span classkr>const/span> span classnx>IMAGE_DIR/span> span classo>/span> span classnx>process/span>span classp>./span>span classnx>env/span>span classp>./span>span classnx>IMAGE_DIR/span> span classo>||/span> span classs1>documents/span>/code>/pre>p>strong>Run the app.js/strong>code>node app.js/code>/p>p>Now the verification session is created and it is being processed. Check your Backoffice dashboard to review the data extracted and decision made by Veriff./p>h2 idbatch-testing>Batch testing/h2>p>Batch upload tests are sometimes agreed with our onboarding team and are very use case specific.Therefore, below might be not applicable for the majority of customers.For batch tests, customers will need to prepare dataset that will be used for testing.If you have been asked for dataset, please see a href/images/batch_upload_tool_guide_for_clients.pdf target“_blank” >batch test data preparation guide/a> ↗./p>h2 idend-user-in-the-flow>End-User In The Flow/h2>p>img srcimages/user-flow.jpg altFlow Diagram />/p>h2 idsession-status-diagram>Session Status Diagram/h2>p>img srcimages/verification-session.jpg altSession Status />/p>h1 idsdk-guide>SDK Guide/h1>h2 idwhy-use-the-sdk>Why use the SDK?/h2>p>Veriff Software Development Kits (SDKs) can be opted for if you prefer leveraging Veriff's front-end solution,wish to maximize the benefits of our built-in verification flow, and have no plans to independently collectend-user media. /p>p>SDKs are quite straightforward to integrate with, as they have pre-built components and libraries. Veriff handles SDKs'updates and maintenance, to ensure improvements and bug fixes. /p>p>SDKs allow gathering lots of different data, thus supporting enhanced fraud detection abilities. Examples here arevideo recording and liveness checks./p>p>Once integrated into your project, the SDK allows you to customize the solution's appearance byadding your unique branding elements and colors./p>p>strong>Veriff supports the following SDKs/strong>/p>p>strong>Native/strong>/p>ul>li>a href#android-sdk>Android SDK/a>/li>li>a href#ios-sdk>iOS SDK/a>/li>li>a href#flutter-plugin>Flutter Plugin/a>/li>li>a href#react-native-sdk>React Native SDK/a>/li>li>a href#cordova-plugin>Cordova Plugin/a>/li>/ul>p>strong>Web/strong>/p>ul>li>a href#javascript-sdk>JS SDK/a>/li>li>a href#incontext-javascript-sdk>InContext SDK/a>/li>li>a href#integrate-by-redirection>Redirecting/a>/li>/ul>h3 idsdk-customization-guides>SDK customization guides/h3>p>It is possible to change the look of the end-user flow in both native SDKs and the web flow to be more alignedwith your brand./p>p>See the a href/images/Veriff-SDK-Customization.pdf target“_blank” >Veriff Native SDKs customization guide/a> ↗ documentto see the options, and read the customization guide in each SDKs section for further info./p>p>See the a href/images/Veriff-Web-Customization-Guide.pdf target“_blank” >Veriff Web SDKs customization guide/a> ↗document to see the options./p>h2 idprerequisites-to-use-the-sdks>Prerequisites to use the SDKs/h2>p>Before you can launch the verification flow for your end-users, make sure you have:/p>ul>li>Added the SDK to your project (see below for detailed descriptions of each SDK integration)/li>li>Created the integration in strong>the Veriff environment/strong> (guide a href#creating-an-integration>above/a>)/li>li>Configured the webhooks (guide a href#configuring-the-webhook-endpoint>below/a>)/li>li>Created a verification session to get the unique strong>session URL/strong> (see the a href#using-the-api-to-generate-a-session-for-the-sdk>SDKs getting started section/a>for instructions)/li>li>Made sure that you are able to handle the a href#backwards-compatible-changes>backwards compatible changes/a>/li>li>Familiarized yourself with and adhere to the requirements to declare a hrefhttps://www.veriff.com/data-collection-purposes>data collection purposes/a>↗ in your applications/li>/ul>h2 idandroid-sdk>Android SDK/h2>h3 idandroid-sdk-requirements>Android SDK Requirements/h3>ul>li>Veriff Android SDK needs your code>minSdkVersion/code> to be of 26 or above./li>li>Your project must have code>Java 8/code> enabled and use code>AndroidX/code> instead of older support libraries./li>li>code>android-gradle-plugin/code> version must be code>4.0.0/code> or above./li>li>code>Proguard/code> version must be code>6.2.2/code> or above. In case R8 is enabled no other updates are needed./li>li>code>kotlin-gradle-plugin/code> version must be code>1.4.0/code> or above./li>li>SDK versions starting from 6.14.0 are depending on Kotlin 1.7.21/li>/ul>p>Please check the migration guides below if you need any guidance for updating these dependencies./p>h3 idadding-the-android-sdk>Adding the Android SDK/h3>p>Open the root code>build.gradle/code> file and add a new maven destination to the repositories in the allprojects section:/p>pre classhighlight groovy tab-groovy>code>span classn>allprojects/span> span classo>{/span>    span classn>repositories/span> span classo>{/span>        span classn>maven/span> span classo>{/span> span classn>url/span> span classs2>https://cdn.veriff.me/android//span> span classo>}/span>        span classn>google/span>span classo>()/span>        span classn>mavenCentral/span>span classo>()/span>    span classo>}/span>span classo>}/span>/code>/pre>p>Alternatively, when using Gradle 7+, add the Maven repository to your code>settings.gradle/code> file:/p>pre classhighlight groovy tab-groovy>code>span classn>dependencyResolutionManagement/span> span classo>{/span>    span classn>repositories/span> span classo>{/span>        span classn>maven/span> span classo>{/span> span classn>url/span> span classs2>https://cdn.veriff.me/android//span> span classo>}/span>        span classn>google/span>span classo>()/span>        span classn>mavenCentral/span>span classo>()/span>    span classo>}/span>span classo>}/span>/code>/pre>p>Add the Veriff SDK dependency to the application code>build.gradle/code> file:/p>pre classhighlight groovy tab-groovy>code>span classn>implementation/span> span classs1>com.veriff:veriff-library:6.+/span>/code>/pre>h3 idpermissions>Permissions/h3>p>The SDK will request all the permissions it needs, please make sure that the strong>CAMERA/strong>, strong>RECORD_AUDIO/strong> permissions are not explicitly removed using code>tools:node"remove"/code> in your app`s manifest file. Ignore this if you are not explicitly removing any permissions./p>h4 iddeclare-foreground-service-sync-for-google-play>Declare foreground service sync for Google Play/h4>p>The SDK declares and uses the code>FOREGROUND_SERVICE_DATA_SYNC/code>. If you distribute your application on Google Play,then you must a hrefhttps://support.google.com/googleplay/android-developer/answer/13392821?hlen#declare>declare the foreground service information in Play Console/a> ↗./p>p>The information required by Play Console is (as listed on the Google Play link above):/p>ol>li>strong>Provide a description of the app functionality that is using each foreground service type./strong>ul>li>The Veriff SDK uses the foreground service to upload end-user data to Veriff's servers for verification purposes./li>/ul>/li>li>strong>Describe the user impact if the task is deferred by the system (does not start immediately), and/or the task is interrupted by the system (paused and/or restarted)./strong>ul>li>If the task is deferred or interrupted by the system, the end-user verification will be delayed./li>/ul>/li>li>strong>Include a link to a video demonstrating each foreground service feature. The video should demonstrate the steps the user needs to take in your app in order to trigger the feature./strong>ul>li>Please record a video of your app's Veriff SDK integration./li>/ul>/li>li>strong>Choose your specific use case for each foreground service type./strong>ul>li>"Network transfer: Upload or download / Other"/li>/ul>/li>/ol>p>See also Veriff's note on a hrefhttps://www.veriff.com/data-collection-purposes>data collection purposes in your app/a> ↗/p>h3 idstarting-the-verification-flow>Starting the verification flow/h3>p>The verification flow must be launched from the vendor Activity class with a unique session. A session is valid for 7 days and expires automatically after that./p>pre classhighlight java tab-java>code>span classkn>import/span> span classnn>com.veriff.Sdk/span>span classo>;/span>span classn>Intent/span> span classn>intent/span> span classo>/span> span classn>Sdk/span>span classo>./span>span classna>createLaunchIntent/span>span classo>(/span>span classn>activity/span>span classo>,/span> span classn>sessionUrl/span>span classo>);/span>span classn>startActivityForResult/span>span classo>(/span>span classn>intent/span>span classo>,/span> span classn>REQUEST_CODE/span>span classo>);/span>/code>/pre>p>Parameters are defined as below;/p>table>thead>tr>th>Parameters/th>th>Description/th>/tr>/thead>tbody>tr>td>code>sessionUrl/code>/td>td>Required parameter. code>sessionUrl/code> can be received from your backend implementation. code>sessionUrl/code> should be unique for each call. Check code>/sessions/code> endpoint in the API documentation a href#post-sessions>here/a> to learn how to generate one./td>/tr>tr>td>code>REQUEST_CODE/code>/td>td>Define an integer constant code>REQUEST_CODE/code> in your activity which can be used to compare in code>onActivityResult/code>/td>/tr>/tbody>/table>h3 idcustomizing-the-sdk>Customizing the SDK/h3>h4 idsetting-a-theme-optional>Setting a theme (Optional)/h4>p>You can customize the look and feel of the SDK flow by passing a code>Branding/code> object via code>Configuration/code> to code>createLaunchIntent/code> as shown in the example below./p>pre classhighlight java tab-java>code>span classn>Branding/span> span classn>branding/span> span classo>/span> span classk>new/span> span classn>Branding/span>span classo>./span>span classna>Builder/span>span classo>()/span>        span classo>./span>span classna>logo/span>span classo>(/span>span classn>R/span>span classo>./span>span classna>drawable/span>span classo>./span>span classna>logo/span>span classo>)/span>        span classc1>// Screen and dialog background color/span>        span classo>./span>span classna>background/span>span classo>(/span>span classn>getResources/span>span classo>()./span>span classna>getColor/span>span classo>(/span>span classn>R/span>span classo>./span>span classna>color/span>span classo>./span>span classna>background_color/span>span classo>))/span>        span classc1>// Non-surface content (such as text, icons) displayed on `background`./span>        span classc1>// Accessibility: Must have a contrast ratio of at least 4.5:1 vs `background`/span>        span classo>./span>span classna>onBackground/span>span classo>(/span>span classn>getResources/span>span classo>()./span>span classna>getColor/span>span classo>(/span>span classn>R/span>span classo>./span>span classna>color/span>span classo>./span>span classna>on_background_color/span>span classo>))/span>        span classc1>// Secondary non-surface content (such as text) displayed on `background`./span>        span classc1>// Accessibility: Must have a contrast ratio of at least 4.5:1 vs `background`/span>        span classo>./span>span classna>onBackgroundSecondary/span>span classo>(/span>span classn>getResources/span>span classo>()./span>span classna>getColor/span>span classo>(/span>span classn>R/span>span classo>./span>span classna>color/span>span classo>./span>span classna>on_background_secondary_color/span>span classo>))/span>        span classc1>// Tertiary non-surface content (such as text) displayed on `background`./span>        span classc1>// Accessibility: Must have a contrast ratio of at least 4.5:1 vs `background`/span>        span classo>./span>span classna>onBackgroundTertiary/span>span classo>(/span>span classn>getResources/span>span classo>()./span>span classna>getColor/span>span classo>(/span>span classn>R/span>span classo>./span>span classna>color/span>span classo>./span>span classna>on_background_tertiary_color/span>span classo>))/span>        span classc1>// Primary surfaces (such as buttons) displayed on `background`./span>        span classc1>// Accessibility: Must have a contrast ratio of at least 3:1 vs `background`/span>        span classo>./span>span classna>primary/span>span classo>(/span>span classn>getResources/span>span classo>()./span>span classna>getColor/span>span classo>(/span>span classn>R/span>span classo>./span>span classna>color/span>span classo>./span>span classna>primary_color/span>span classo>))/span>        span classc1>// Non-surface content (such as text) displayed on `primary` surfaces./span>        span classc1>// Accessibility: Must have a contrast ratio of at least 4.5:1 vs `primary`/span>        span classo>./span>span classna>onPrimary/span>span classo>(/span>span classn>getResources/span>span classo>()./span>span classna>getColor/span>span classo>(/span>span classn>R/span>span classo>./span>span classna>color/span>span classo>./span>span classna>on_primary_color/span>span classo>))/span>        span classc1>// Secondary surfaces (such as bullet points and illustrations) displayed on `background`./span>        span classc1>// Accessibility: Must have a contrast ratio of at least 3:1 vs `background`/span>        span classo>./span>span classna>secondary/span>span classo>(/span>span classn>getResources/span>span classo>()./span>span classna>getColor/span>span classo>(/span>span classn>R/span>span classo>./span>span classna>color/span>span classo>./span>span classna>secondary_color/span>span classo>))/span>        span classc1>// Non-surface content (such as text) displayed on `secondary` surfaces./span>        span classc1>// Accessibility: Must have a contrast ratio of at least 4.5:1 vs `secondary`/span>        span classo>./span>span classna>onSecondary/span>span classo>(/span>span classn>getResources/span>span classo>()./span>span classna>getColor/span>span classo>(/span>span classn>R/span>span classo>./span>span classna>color/span>span classo>./span>span classna>on_secondary_color/span>span classo>))/span>        span classc1>// Backgroung color of the overlay area on all the screens with camera/span>        span classo>./span>span classna>cameraOverlay/span>span classo>(/span>span classn>getResources/span>span classo>()./span>span classna>getColor/span>span classo>(/span>span classn>R/span>span classo>./span>span classna>color/span>span classo>./span>span classna>camera_overlay_color/span>span classo>))/span>        span classc1>// All UI elements on all the screens with camera on top of camera overlay/span>        span classc1>// Accessibility: Must have a contrast ratio of at least 4.5:1 vs `cameraOverlay`/span>        span classo>./span>span classna>onCameraOverlay/span>span classo>(/span>span classn>getResources/span>span classo>()./span>span classna>getColor/span>span classo>(/span>span classn>R/span>span classo>./span>span classna>color/span>span classo>./span>span classna>on_camera_overlay_color/span>span classo>))/span>        span classc1>// Color used for various outlines and boundaries of UI elements/span>        span classo>./span>span classna>outline/span>span classo>(/span>span classn>getResources/span>span classo>()./span>span classna>getColor/span>span classo>(/span>span classn>R/span>span classo>./span>span classna>color/span>span classo>./span>span classna>outline_color/span>span classo>))/span>        span classc1>// Error indicators (such as text, borders, icons) displayed on `background`/span>        span classc1>// Accessibility: Must have a contrast ratio of at least 4.5:1 vs `background`/span>        span classo>./span>span classna>success/span>span classo>(/span>span classn>getResources/span>span classo>()./span>span classna>getColor/span>span classo>(/span>span classn>R/span>span classo>./span>span classna>color/span>span classo>./span>span classna>success_color/span>span classo>))/span>        span classc1>// Success indicators (such as borders, icons) displayed on `background`/span>        span classc1>// Accessibility: Must have a contrast ratio of at least 3:1 vs `background`/span>        span classo>./span>span classna>error/span>span classo>(/span>span classn>getResources/span>span classo>()./span>span classna>getColor/span>span classo>(/span>span classn>R/span>span classo>./span>span classna>color/span>span classo>./span>span classna>error_color/span>span classo>))/span>        span classc1>// Button corner radius, in `dp`/span>        span classo>./span>span classna>buttonRadius/span>span classo>(/span>span classmi>48/span>span classn>f/span>span classo>)/span>        span classo>./span>span classna>build/span>span classo>();/span>span classn>Configuration/span> span classn>configuration/span> span classo>/span> span classk>new/span> span classn>Configuration/span>span classo>./span>span classna>Builder/span>span classo>()/span>        span classo>./span>span classna>branding/span>span classo>(/span>span classn>branding/span>span classo>)/span>        span classo>./span>span classna>build/span>span classo>();/span>span classn>Intent/span> span classn>intent/span> span classo>/span> span classn>Sdk/span>span classo>./span>span classna>createLaunchIntent/span>span classo>(/span>span classn>activity/span>span classo>,/span> span classn>sessionUrl/span>span classo>,/span> span classn>configuration/span>span classo>);/span>span classn>startActivityForResult/span>span classo>(/span>span classn>intent/span>span classo>,/span> span classn>REQUEST_CODE/span>span classo>);/span>/code>/pre>p>All custom values for branding are optional. If a value is not provided for them the default Veriff color or icon will be used./p>h3 idmore-customization-options>More customization options/h3>h4 idcustomizing-the-font>Customizing the font/h4>p>You can customize the fonts used in the SDK by passing the resource IDs of the fonts you want to use. Make sure that you have added the font files to the code>font/code> resource folder in your app.A custom font can be set by passing a code>com.veriff.Font/code> object to the code>font/code> method of code>Branding/code> builder. The code>com.veriff.Font/code> builder accepts 3 types of fonts via the code>setRegular/code> code>setMedium/code> and code>setBold/code> methods./p>pre classhighlight java tab-java>code>span classn>brandingBuilder/span>span classo>./span>span classna>font/span>span classo>(/span>    span classk>new/span> span classn>com/span>span classo>./span>span classna>veriff/span>span classo>./span>span classna>Font/span>span classo>./span>span classna>Builder/span>span classo>()/span>        span classo>./span>span classna>setRegular/span>span classo>(/span>span classn>R/span>span classo>./span>span classna>font/span>span classo>./span>span classna>comic_neue_regular/span>span classo>)/span>        span classo>./span>span classna>setMedium/span>span classo>(/span>span classn>R/span>span classo>./span>span classna>font/span>span classo>./span>span classna>comic_neue_medium/span>span classo>)/span>        span classo>./span>span classna>setBold/span>span classo>(/span>span classn>R/span>span classo>./span>span classna>font/span>span classo>./span>span classna>comic_neue_bold/span>span classo>)/span>        span classo>./span>span classna>build/span>span classo>()/span>span classo>);/span>/code>/pre>h4 idcustom-intro-screen>Custom intro screen/h4>p>Veriff supports replacing introduction screen with a custom client developed introduction screen for eligible customers. First, please ask about this possibility from your solutions engineer. In case we can offer it for you then removal process is following:/p>ul>li>You agree your own introduction screen visuals and copy with our solutions engineer and get relevant legal documents signed in case they are needed./li>li>After that Veriff will enable custom introduction screen from backend for your integrations./li>li>After you have implemented your own introduction screen you can change the configuration option specified below./li>/ul>pre classhighlight java tab-java>code>span classn>Configuration/span> span classn>configuration/span> span classo>/span> span classk>new/span> span classn>Configuration/span>span classo>./span>span classna>Builder/span>span classo>()/span>        span classo>./span>span classna>customIntroScreen/span>span classo>(/span>span classkc>true/span>span classo>)/span>        span classo>./span>span classna>build/span>span classo>();/span>/code>/pre>p>strong>Note:/strong> Adding the configuration alone in your app is not enough to enable the custom intro screen. Make sure to contact your solutions engineer so they can enable the feature for your integration./p>h4 idsetting-a-locale-for-the-sdk-optional>Setting a locale for the SDK (Optional)/h4>p>You can set a locale(code>java.util.Locale/code>) for the SDK from the app itself./p>pre classhighlight java tab-java>code>span classn>Locale/span> span classn>appLocale/span> span classo>/span> span classn>Locale/span>span classo>./span>span classna>ENGLISH/span>span classo>;/span>span classn>Configuration/span> span classn>configuration/span> span classo>/span> span classk>new/span> span classn>Configuration/span>span classo>./span>span classna>Builder/span>span classo>()/span>        span classo>./span>span classna>locale/span>span classo>(/span>span classn>appLocale/span>span classo>)/span>        span classo>./span>span classna>build/span>span classo>();/span>span classn>Intent/span> span classn>intent/span> span classo>/span> span classn>Sdk/span>span classo>./span>span classna>createLaunchIntent/span>span classo>(/span>span classn>activity/span>span classo>,/span> span classn>sessionUrl/span>span classo>,/span> span classn>configuration/span>span classo>);/span>span classn>startActivityForResult/span>span classo>(/span>span classn>intent/span>span classo>,/span> span classn>REQUEST_CODE/span>span classo>);/span>/code>/pre>h3 idadding-vendor-data>Adding vendor data/h3>p>Veriff supports the option to override vendor data. Please check with your strong>Solutions Engineer/strong> to confirm if this feature can be enabled for your integration. If it is possible, follow these steps:/p>ol>li>Veriff will enable vendor data overriding from the backend for your integrations./li>li>Modify the configuration option as specified below./li>/ol>pre classhighlight java tab-java>code>span classn>Configuration/span> span classn>configuration/span> span classo>/span> span classk>new/span> span classn>Configuration/span>span classo>./span>span classna>Builder/span>span classo>()/span>        span classo>./span>span classna>vendorData/span>span classo>(/span>span classs>Vendor Data/span>span classo>)/span>        span classo>./span>span classna>build/span>span classo>();/span>/code>/pre>p>strong>Note:/strong> Enabling this feature alone will not be sufficient to override the vendor data. Ensure that you contact your strong>Solutions Engineer/strong> to have the feature enabled for your integration./p>h3 idgetting-the-verification-status>Getting the verification status/h3>p>Veriff SDK sends callbacks to your mobile application. To capture the result override the code>onActivityResult/code> method in your activity that started the verification flow./p>p>Note that this is the strong>end-user flow completion status/strong>, meaning that it shows strong>whether the end-user was able tocomplete all the steps in the verification flow or not/strong>. It is not the verification session status./p>pre classhighlight java tab-java>code>span classnd>@Override/span>span classkd>protected/span> span classkt>void/span> span classnf>onActivityResult/span>span classo>(/span>span classkt>int/span> span classn>requestCode/span>span classo>,/span> span classkt>int/span> span classn>resultCode/span>span classo>,/span> span classn>Intent/span> span classn>data/span>span classo>)/span> span classo>{/span>    span classk>if/span> span classo>(/span>span classn>requestCode/span> span classo>/span> span classn>REQUEST_CODE/span>span classo>)/span> span classo>{/span>        span classn>Result/span> span classn>result/span> span classo>/span> span classn>Result/span>span classo>./span>span classna>fromResultIntent/span>span classo>(/span>span classn>data/span>span classo>);/span>        span classk>if/span> span classo>(/span>span classn>result/span> span classo>!/span> span classkc>null/span>span classo>)/span> span classo>{/span>            span classn>handleResult/span>span classo>(/span>span classn>result/span>span classo>);/span> span classc1>//see below for handling the result/span>        span classo>}/span>    span classo>}/span>    span classkd>super/span>span classo>./span>span classna>onActivityResult/span>span classo>(/span>span classn>requestCode/span>span classo>,/span> span classn>resultCode/span>span classo>,/span> span classn>data/span>span classo>);/span>span classo>}/span>span classkd>public/span> span classkt>void/span> span classnf>handleResult/span>span classo>(/span>span classn>Result/span> span classn>result/span>span classo>)/span> span classo>{/span>    span classk>switch/span> span classo>(/span>span classn>result/span>span classo>./span>span classna>getStatus/span>span classo>())/span> span classo>{/span>    span classk>case/span> span classnl>DONE:/span>        span classc1>// Session is completed from the end-users perspective/span>        span classk>break/span>span classo>;/span>    span classk>case/span> span classnl>CANCELED:/span>        span classc1>// End-user cancelled the session/span>        span classk>break/span>span classo>;/span>    span classk>case/span> span classnl>ERROR:/span>        span classc1>// An error occurred during the flow, Veriff has already shown UI, no need to display/span>        span classc1>// a separate error message here/span>        span classn>Log/span>span classo>./span>span classna>w/span>span classo>(/span>span classn>TAG/span>span classo>,/span> span classs>Verification error occurred: /span> span classo>+/span> span classn>result/span>span classo>./span>span classna>getError/span>span classo>());/span>        span classk>break/span>span classo>;/span>    span classo>}/span>span classo>}/span>/code>/pre>h3 idadding-error-logging>Adding error logging/h3>p>To turn on logging, simply add your logging implementation instance (instance of code>com.veriff.Logger/code> class) to the SDK before launching the SDK as shown./p>pre classhighlight java tab-java>code>span classn>Sdk/span>span classo>./span>span classna>setLogger/span>span classo>(/span>span classn>myLoggerImplementation/span>span classo>);/span>span classn>Intent/span> span classn>intent/span> span classo>/span> span classn>Sdk/span>span classo>./span>span classna>createLaunchIntent/span>span classo>(/span>span classn>activity/span>span classo>,/span> span classn>sessionUrl/span>span classo>);/span>span classn>startActivityForResult/span>span classo>(/span>span classn>intent/span>span classo>,/span> span classn>REQUEST_CODE/span>span classo>);/span>/code>/pre>h3 idexcluding-ml-kit-support>Excluding ML Kit support/h3>p>Veriff Android SDK uses a hrefhttps://developers.google.com/ml-kit>ML Kit/a> ↗ for things like face detection,barcode scanning or text recognition to improve the end-user experience. It uses on-device models that arepre-downloaded by Play services. If your app cannot use Play services at all then you can exclude thetransitive code>mlkit/code> dependency - this will remove any dependencies on ML Kit and disable the use of these ML modulesat runtime:/p>pre classhighlight groovy tab-groovy>code>span classn>implementation/span>span classo>(/span>span classs1>com.veriff:veriff-library:6.+/span>span classo>)/span> span classo>{/span>    span classn>exclude/span> span classnl>group:/span> span classs1>com.veriff/span>span classo>,/span> span classnl>module:/span> span classs1>mlkit/span>span classo>}/span>/code>/pre>h3 idandroid-sdk-changelog>Android SDK Changelog/h3>p>Please refer to a hrefhttps://www.veriff.com/release-notes>release notes/a> ↗./p>h3 idmigrating-veriff-android-sdk-from-5-x-x-to-6-0-0>Migrating Veriff Android SDK from 5.x.x to 6.0.0/h3>p>strong>SDK integration/strong>/p>p>The following APIs were removed:/p>ul>li>code>Branding.Builder.themeColor(color)/code> - this was split into two different attributes: code>Branding.Builder.primary(color)/code> & code>Branding.Builder.secondary(color)/code>/li>li>code>Branding.Builder.logomark(drawable)/code>/li>li>code>Branding.Builder.primaryButtonBackgroundColor(color)/code> - the button background will be set based on the new code>Branding.Builder.onPrimary(color)/code> attribute/li>li>code>Branding.Builder.bulletPoint(color)/code> - bullet point color can be controlled by the new code>Branding.Builder.secondary(color)/code> & code>Branding.Builder.onSecondary(color)/code> attributes/li>li>code>Branding.Builder.notificationIcon(color)/code>/li>/ul>p>The following APIs were renamed:/p>ul>li>code>Branding.Builder.toolbarIcon(drawable)/code> - renamed to code>Branding.Builder.logo(drawable)/code>/li>li>code>Branding.Builder.backgroundColor(color)/code> - renamed to code>Branding.Builder.background(color)/code>/li>li>code>Branding.Builder.primaryTextColor(color)/code> - renamed to code>Branding.Builder.onBackground(color)/code>/li>li>code>Branding.Builder.secondaryTextColor(color)/code> - renamed to code>Branding.Builder.onBackgroundSecondary(color)/code>/li>li>code>Branding.Builder.buttonCornerRadius(cornerRadius)/code> - renamed to code>Branding.Builder.buttonRadius(cornerRadius)/code>/li>/ul>p>The following APIs were added:/p>ul>li>code>Branding.Builder.onBackgroundTertiary(color)/code>/li>li>code>Branding.Builder.primary(color)/code>/li>li>code>Branding.Builder.onPrimary(color)/code>/li>li>code>Branding.Builder.secondary(color)/code>/li>li>code>Branding.Builder.onSecondary(color)/code>/li>li>code>Branding.Builder.outline(color)/code>/li>li>code>Branding.Builder.error(color)/code>/li>li>code>Branding.Builder.success(color)/code>/li>/ul>h3 idmigrating-veriff-android-sdk-from-4-x-x-to-5-0-0>Migrating Veriff Android SDK from 4.x.x to 5.0.0/h3>p>strong>SDK integration/strong>/p>p>The following APIs were removed:/p>ul>li>code>Branding.Builder.buttonHeight(height)/code> - buttons are now always with a code>60dp/code> height/li>li>code>Branding.Builder.statusBarColor(color)/code> - the status bar is now using the code>backgroundColor/code> attribute instead/li>li>code>Branding.Builder.externalResources(externalResources)/code> - resources can be customized via code>toolbarIconProvider()/code>, code>toolbarIcon()/code> and the new code>logomark()/code> method./li>li>code>Font.Builder.setNormalAndBold(normal, bold)/code> - this was split into separate setters for font weights/li>/ul>p>The following APIs were added:/p>ul>li>code>Branding.Builder.logomark(drawable)/code> - Sets a drawable to use in UI elements where a square logo is needed. (Defaults to the Veriff logomark when this attribute is not set)/li>li>code>Font.Builder.setRegular(regularFont)/code> - Sets regular weight font/li>li>code>Font.Builder.setMedium(mediumFont)/code> - Sets medium weight font/li>li>code>Font.Builder.setBold(boldFont)/code> - Sets bold weight font/li>/ul>h3 idmigrating-veriff-android-sdk-from-3-x-x-to-4-0-0>Migrating Veriff Android SDK from 3.x.x to 4.0.0/h3>p>Follow these steps to migrate from SDK code>3.x.x/code> to code>4.0.0/code>/p>p>strong>Android Gradle Plugin/strong>Open the root code>build.gradle/code> file and change the code>classpath/code> dependency in the code>buldscript/code> section if that needed.code>groovybuildscript {    repositories {      ...    }    dependencies {        classpath 'com.android.tools.build:gradle:3.4.1' // and above        ...    }}/code>/p>p>strong>Kotlin/strong>Open the root code>build.gradle/code> file and change the code>classpath/code> dependency in the code>buldscript/code> section if that needed./p>pre classhighlight groovy tab-groovy>code>span classn>buildscript/span> span classo>{/span>    span classn>ext/span>span classo>./span>span classna>kotlinVersion/span> span classo>/span> span classs1>1.4.0/span> span classc1>// and above/span>    span classn>repositories/span> span classo>{/span>      span classo>.../span>    span classo>}/span>    span classn>dependencies/span> span classo>{/span>        span classo>.../span>        span classn>classpath/span> span classs2>org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion/span>        span classo>.../span>    span classo>}/span>span classo>}/span>/code>/pre>p>strong>Proguard/strong>Open the root code>build.gradle/code> file and add the code>force update/code> to the code>buildscript/code> section if that needed.code>groovybuildscript {    ...    configurations.all {        resolutionStrategy {            force 'net.sf.proguard:proguard-gradle:6.2.2'        }    }}/code>/p>p>strong>SDK integration/strong>Nothing changed in SDK except the public API types, please update the imports tocode>javaimport com.veriff.Branding;import com.veriff.Configuration;import com.veriff.Font;import com.veriff.Result;import com.veriff.Sdk;/code>and change types fromcode>VeriffBranding/code> to code>Branding/code>code>VeriffConfiguration/code> to code>Configuration/code>code>VeriffFont/code> to code>Font/code>code>VeriffResult/code> to code>Result/code>/p>h3 idmigrating-veriff-android-sdk-from-2-x-x-to-3-0-0>Migrating Veriff Android SDK from 2.x.x to 3.0.0/h3>p>Follow these steps to migrate from SDK 2.x.x to 3.0.0/p>p>strong>Switch to AndroidX/strong>/p>p>Veriff SDK 3.0.0 requires AndroidX 1.0.0 or later. If you haven't switched to AndroidX in your app yet then follow a hrefhttps://developer.android.com/jetpack/androidx/migrate>this guide/a> ↗./p>p>strong>Enable Java 8/strong>/p>p>Veriff SDK 3.0.0 requires Java 8 language features to be enabled in your project. If you don't have this enabled already then add this to your code>app/build.gradle/code> file under the code>android {}/code> section:/p>pre classhighlight groovy tab-groovy>code>span classn>compileOptions/span> span classo>{/span>    span classn>sourceCompatibility/span> span classn>JavaVersion/span>span classo>./span>span classna>VERSION_1_8/span>    span classn>targetCompatibility/span> span classn>JavaVersion/span>span classo>./span>span classna>VERSION_1_8/span>span classo>}/span>/code>/pre>p>See more a hrefhttps://developer.android.com/studio/write/java8-support#supported_features>here/a> ↗./p>p>strong>Switch from code>baseUrl/code> and code>sessionToken/code> to code>sessionUrl/code>/strong>/p>p>The new 3.0.0 SDK requires a single code>sessionUrl/code> parameter instead of code>baseUrl/code> and code>sessionToken/code>. See the documentation a hrefhttps://developers.veriff.com/#post-sessions>here/a>. As a backwards compatibility measure, if a code>sessionToken/code> value is passed into the code>sessionUrl/code> parameter then it will still work with an assumed code>baseUrl/code> of code>magic.veriff.com/code>./p>p>strong>Use code>com.veriff.*/code> classes instead of code>mobi.lab.veriff.data.*/code> ones/strong>/p>p>The name and location of the main SDK entry class has changed from code>mobi.lab.veriff.data.Veriff/code> to code>com.veriff.VeriffSdk/code>. The API is largely similar - instead of code>Veriff.Builder/code> there's a code>VeriffSdk.createLaunchIntent/code> method that returns an code>Intent/code> which you can then use to launch veriff. See example a hrefhttps://developers.veriff.com/#starting-the-verification-flow>here/a>./p>p>If you are using code>Branding/code> to customize the look and feel of the SDK then it has a new name - code>VeriffBranding/code>. The builder interface has been streamlined by removing the code>set*/code> prefixes from all the methods. Read more about customization a hrefhttps://developers.veriff.com/#customize-user-interface-optional>here/a>./p>p>strong>Use code>com.veriff.VeriffResult/code> instead of reading return code>Intent/code> directly/strong>/p>p>Starting with 3.0.0 there's a new way to handle the result of the verification flow. Instead of reading code>INTENT_EXTRA_STATUS/code> directly from the returned code>data/code> intent, use code>VeriffResult.fromResultIntent(data)/code> to get a result object with a code>status/code> field and an optional code>error/code> field. We've reduced code>status/code> to just three - code>CANCELED, ERROR, DONE/code>. In case of code>ERROR/code> the code>error/code> field contains more information. See the example a hrefhttps://developers.veriff.com/#getting-the-verification-status>here/a>./p>p>strong>Remove usage of deprecated types/strong>/p>p>While the old SDK entrypoints are still present for backwards compatibility they will be removed in the future. Please remove usage of any SDK type marked with code>@Deprecated/code> - the easiest way to discover these is to look at your Gradle build log with Java/Kotlin compilation warnings turned on./p>p>Here's a list of old deprecated classes due to be removed in a future release:/p>pre classhighlight plaintext>code>mobi.lab.veriff.data.Veriffmobi.lab.veriff.data.Veriff.Buildermobi.lab.veriff.data.VeriffConstantsmobi.lab.veriff.data.Brandingmobi.lab.veriff.data.Branding.Buildermobi.lab.veriff.data.DrawableProvidermobi.lab.veriff.util.LogAccessmobi.lab.veriff.util.LogAccess.LogLevelmobi.lab.veriff.util.LogcatLogAccessmobi.lab.veriff.service.VeriffStatusUpdatesService/code>/pre>h2 idios-sdk>iOS SDK/h2>h3 idios-sdk-requirements>iOS SDK Requirements/h3>p>Integration Veriff iOS SDK requires at least iOS version 13.0/p>h3 idadding-the-sdk-to-the-project>Adding the SDK to the project/h3>p>VeriffSDK requires the latest stable version of Xcode available at the time the release is made. If you would like to use versions that are independent of Swift versions, please integrate code>.xcframework/code>./p>h4 idusing-swift-package-manager>Using Swift Package Manager/h4>p>To integrate Veriff SDK with Swift Package Manager, open strong>File > Swift Packages > Add Package Dependency/strong> and add the Veriff iOS SDK Swift Package repository url as stated below;/p>pre classhighlight plaintext>code>https://github.com/Veriff/veriff-ios-spm//code>/pre>h4 idusing-cocoapods>Using Cocoapods/h4>p>To integrate Veriff SDK with Cocoapods, please add the line below to your strong>Podfile/strong> and run code>pod install/code>.New to Cocoapods? a hrefhttps://guides.cocoapods.org/using/using-cocoapods>Learn more here/a> ↗./p>pre classhighlight plaintext>code>pod VeriffSDK/code>/pre>p>After installation is done, use the newly created code>.xcworkspace/code> file of your project./p>h4 idusing-carthage>Using Carthage/h4>p>To integrate VeriffSDK into your Xcode project using Carthage, specify the required libraries below in your code>Cartfile/code>./p>pre classhighlight plaintext>code>binary https://cdn.veriff.me/ios/carthage/VeriffSDK.json/code>/pre>p>Run code>carthage update --use-xcframeworks/code> and then drag and drop Veriff.xcframework from code>Carthage/Build/code> folder to the em>Frameworks, Libraries,and Embedded Content/em> section on your app target's em>General/em> settings tab./p>h4 idusing-xcframework>Using XCFramework/h4>p>To integrate Veriff SDK into your project manually, please download a hrefhttps://cdn.veriff.me/ios/com/veriff/veriffsdk/latest/veriffsdk.zip>VeriffSDK/a> ↗./p>p>After the download finishes, drag and drop the unzipped Veriff.xcframework to the em>Frameworks, Libraries,and Embedded Content/em> section on your app target's em>General/em> settings tab./p>h3 idadding-permissions>Adding permissions/h3>h4 idadd-usage-descriptions-to-application-info-plist>Add usage descriptions to application Info.plist/h4>blockquote>p>Not adding these usage descriptions causes system to kill application when it requests the permissions when needed./p>/blockquote>p>Veriff iOS SDK requires camera, microphone, photo library and optionally NFC reader permissions for capturing photos,video and scanning passport during identification. Your application is responsible to describe the reason why camera,microphone, photo library and NFC reader is used. You must add 3 descriptions listed below to code>Info.plist/code> of yourapplication with the explanation of the usage./p>ul>li>code>NSCameraUsageDescription/code>/li>li>code>NSMicrophoneUsageDescription/code>/li>li>code>NSPhotoLibraryUsageDescription/code>/li>/ul>h4 idadd-required-steps-for-nfc-scanning>Add required steps for NFC scanning/h4>ol>li>Add code>NFCReaderUsageDescription/code> description to code>Info.plist/code>./li>li>The application needs to define the list of application IDs or AIDs it can connect to, in the Info.plist file./li>li>p>The AID is a way of uniquely identifying an application on a ISO 7816 tag, which is usually defined by a standard./p>pre classhighlight plaintext>code><key>com.apple.developer.nfc.readersession.iso7816.select-identifiers</key><array>  <string>A0000002471001</string>  <string>A0000002472001</string>  <string>00000000000000</string></array>/code>/pre>/li>li>p>Introduce a new entitlement for NFC scanning. Xcode automatically adds this entitlement when you activatethe Near Field Communication Tag Reading feature in the target Signing & Capabilities. Following the activationof this feature, the *.entitlements file should include the TAG format./p>pre classhighlight plaintext>code><key>com.apple.developer.nfc.readersession.formats</key><array>    <string>TAG</string></array>/code>/pre>/li>/ol>p>strong>Note:/strong> due to Apple's policies, you may be required to strong>record and share a proof video of using the NFC/strong>. You candownload and use this a hrefvideos/Veriff_nfc_used_iOs.zip>pre-recorded video/a> ↓. If this does not solve the issue,please contact our support team./p>h4 iddeclare-the-purposes-of-data-collection-in-your-app>Declare the purposes of data collection in your app/h4>p>See Veriff's note on a hrefhttps://www.veriff.com/data-collection-purposes>data collection purposes/a> ↗/p>h3 idstarting-verification-flow>Starting verification flow/h3>h4 idimport-veriff-in-your-code>Import Veriff in your code/h4>pre classhighlight swift tab-swift>code>span classc1>// Swift/span>span classkd>import/span> span classkt>Veriff/span>span classc1>// Objective-C/span>span classkd>@import/span> span classkt>Veriff/span>span classp>;/span>/code>/pre>p>In order to use Veriff SDK, please import it to your class that will use the SDK./p>h4 idstart-the-verification-flow>Start the verification flow/h4>p>In order to start the verification flow please call the method below with the defined parameters./p>pre classhighlight swift tab-swift>code>span classc1>// SwiftUI/span>span classk>let/span> span classnv>veriff/span> span classo>/span> span classkt>VeriffSdk/span>span classo>./span>span classn>shared/span>span classn>veriff/span>span classo>./span>span classnf>startAuthentication/span>span classp>(/span>span classnv>sessionUrl/span>span classp>:/span> span classn>sessionUrl/span>span classp>)/span>span classc1>// Swift/span>span classk>let/span> span classnv>veriff/span> span classo>/span> span classkt>VeriffSdk/span>span classo>./span>span classn>shared/span>span classn>veriff/span>span classo>./span>span classnf>startAuthentication/span>span classp>(/span>span classnv>sessionUrl/span>span classp>:/span> span classn>sessionUrl/span>span classp>,/span> span classnv>presentingFrom/span>span classp>:/span> span classn>yourViewController/span>span classp>)/span>span classc1>// Objective-C/span>span classkt>VeriffSdk/span> span classo>*/span>span classn>veriff/span> span classo>/span> span classp>/span>span classkt>VeriffSdk/span> span classn>shared/span>span classp>;/span>span classp>/span>span classn>veriff/span> span classnv>startAuthenticationWithSessionUrl/span>span classp>:/span>span classn>sessionUrl/span> span classnv>presentingFrom/span>span classp>:/span>span classn>yourViewController/span>span classp>;/span>/code>/pre>p>Parameters are defined as below;/p>table>thead>tr>th>Parameters/th>th>Description/th>/tr>/thead>tbody>tr>td>code>sessionUrl/code>/td>td>Required parameter. code>sessionUrl/code> can be received from your backend implementation. code>sessionUrl/code> should be unique for each call. Check code>/sessions/code> endpoint in the API documentation a href/#post-sessions>here/a> to learn how to generate one./td>/tr>tr>td>code>configuration/code>/td>td>Optional code>VeriffConfiguration/code> object. Refer to a href/#customize-user-interface-optional>Customize user interface (Optional)/a> for how to use it./td>/tr>tr>td>code>presentingFrom/code>/td>td>Your app's view controller from which our UI will be presented modally. It's optional and shouldn't be used in SwiftUI projects./td>/tr>/tbody>/table>h3 idcustomize-user-interface-optional>Customize user interface (Optional)/h3>h4 idsetting-theme-color-font-and-logo>Setting theme color, font and logo/h4>p>You can customize the Veriff user interface through your own application, by letting the SDK know of your brand's main color, font and logo. The code>Branding/code> class allows customization of the navigation bar title image, button corner radius, font and following colors:/p>ul>li>code>background/code> - screen and dialog background/li>li>code>onBackground/code> - non-surface content (such as text, icons) displayed on the code>background/code> color/li>li>code>onBackgroundSecondary/code> - secondary non-surface content (such as text) displayed on the code>background/code> color/li>li>code>onBackgroundTertiary/code> - tertiary non-surface content (such as text) displayed on the code>background/code> color/li>li>code>primary/code> - primary surfaces (such as buttons) displayed on the code>background/code> color/li>li>code>onPrimary/code> - non-surface content (such as text) displayed on code>primary/code> surfaces/li>li>code>secondary/code> - secondary surfaces (such as bullet points and illustrations) displayed on the code>background/code> color/li>li>code>onSecondary/code> - non-surface content (such as text) displayed on code>secondary/code> surfaces/li>li>code>cameraOverlay/code> - overlay surface color on top of the camera preview screen/li>li>code>onCameraOverlay/code> - non-surface content (such as text, icons) displayed on code>cameraOverlay/code>/li>li>code>outline/code> - outlines and boundaries of UI elements (such as text inputs)/li>li>code>error/code> - error indicators (such as text, borders, icons) displayed on code>background/code> color/li>li>code>success/code> - success indicators (such as borders, icons) displayed on code>background/code> color/li>/ul>p>In order to use customization set the code>branding/code> property of code>VeriffConfiguration/code> before you start the verification./p>p>See the a href/images/Veriff-SDK-Customization.pdf target“_blank” >Veriff SDK customization guide/a> ↗ document to see what it looks like./p>pre classhighlight swift tab-swift>code>span classc1>// Swift/span>span classk>let/span> span classnv>branding/span> span classo>/span> span classkt>VeriffSdk/span>span classo>./span>span classkt>Branding/span>span classp>()/span>span classn>branding/span>span classo>./span>span classn>logo/span> span classo>/span> span classkt>UIImage/span>span classp>(/span>span classnv>named/span>span classp>:/span> span classs>logo.png/span>span classp>)/span>span classn>branding/span>span classo>./span>span classn>background/span> span classo>/span> span classkt>UIColor/span>span classo>./span>span classn>background/span>span classn>branding/span>span classo>./span>span classn>onBackground/span> span classo>/span> span classkt>UIColor/span>span classo>./span>span classn>onBackground/span>span classn>branding/span>span classo>./span>span classn>onBackgroundSecondary/span> span classo>/span> span classkt>UIColor/span>span classo>./span>span classn>onBackgroundSecondary/span>span classn>branding/span>span classo>./span>span classn>onBackgroundTertiary/span> span classo>/span> span classkt>UIColor/span>span classo>./span>span classn>onBackgroundTertiary/span>span classn>branding/span>span classo>./span>span classn>primary/span> span classo>/span> span classkt>UIColor/span>span classo>./span>span classn>primary/span>span classn>branding/span>span classo>./span>span classn>onPrimary/span> span classo>/span> span classkt>UIColor/span>span classo>./span>span classn>onPrimary/span>span classn>branding/span>span classo>./span>span classn>secondary/span> span classo>/span> span classkt>UIColor/span>span classo>./span>span classn>secondary/span>span classn>branding/span>span classo>./span>span classn>onSecondary/span> span classo>/span> span classkt>UIColor/span>span classo>./span>span classn>onSecondary/span>span classn>branding/span>span classo>./span>span classn>cameraOverlay/span> span classo>/span> span classkt>UIColor/span>span classo>./span>span classn>cameraOverlay/span>span classn>branding/span>span classo>./span>span classn>onCameraOverlay/span> span classo>/span> span classkt>UIColor/span>span classo>./span>span classn>onCameraOverlay/span>span classn>branding/span>span classo>./span>span classn>outline/span> span classo>/span> span classkt>UIColor/span>span classo>./span>span classn>outline/span>span classn>branding/span>span classo>./span>span classn>error/span> span classo>/span> span classkt>UIColor/span>span classo>./span>span classn>error/span>span classn>branding/span>span classo>./span>span classn>success/span> span classo>/span> span classkt>UIColor/span>span classo>./span>span classn>success/span>span classn>branding/span>span classo>./span>span classn>buttonRadius/span> span classo>/span> span classkt>CGFloat/span>span classo>./span>span classn>cornerRadius/span>span classn>branding/span>span classo>./span>span classn>font/span> span classo>/span> span classkt>VeriffSdk/span>span classo>./span>span classkt>Branding/span>span classo>./span>span classkt>Font/span>span classp>(/span>span classnv>regular/span>span classp>:/span> span classs>Font/span>span classp>,/span> span classnv>medium/span>span classp>:/span> span classs>Font-Medium/span>span classp>,/span> span classnv>bold/span>span classp>:/span> span classs>Font-Bold/span>span classp>)/span>span classc1>// Objective-C/span>span classkt>VeriffBranding/span> span classo>*/span>span classn>branding/span> span classo>/span> span classp>/span>span classkt>VeriffBranding/span> span classn>alloc/span>span classp>/span> span classkd>init/span>span classp>;/span>span classn>branding/span>span classo>./span>span classn>logo/span> span classo>/span> span classp>/span>span classkt>UIImage/span> span classnv>imageNamed/span>span classp>:/span>span classs>@logo.png/span>span classp>;/span>span classn>branding/span>span classo>./span>span classn>background/span> span classo>/span> span classp>/span>span classkt>UIColor/span> span classn>background/span>span classp>;/span>span classn>branding/span>span classo>./span>span classn>onBackground/span> span classo>/span> span classp>/span>span classkt>UIColor/span> span classn>onBackground/span>span classp>;/span>span classn>branding/span>span classo>./span>span classn>onBackgroundSecondary/span> span classo>/span> span classp>/span>span classkt>UIColor/span> span classn>onBackgroundSecondary/span>span classp>;/span>span classn>branding/span>span classo>./span>span classn>onBackgroundTertiary/span> span classo>/span> span classp>/span>span classkt>UIColor/span> span classn>onBackgroundTertiary/span>span classp>;/span>span classn>branding/span>span classo>./span>span classn>primary/span> span classo>/span> span classp>/span>span classkt>UIColor/span> span classn>primary/span>span classp>;/span>span classn>branding/span>span classo>./span>span classn>onPrimary/span> span classo>/span> span classp>/span>span classkt>UIColor/span> span classn>onPrimary/span>span classp>;/span>span classn>branding/span>span classo>./span>span classn>secondary/span> span classo>/span> span classp>/span>span classkt>UIColor/span> span classn>secondary/span>span classp>;/span>span classn>branding/span>span classo>./span>span classn>onSecondary/span> span classo>/span> span classp>/span>span classkt>UIColor/span> span classn>onSecondary/span>span classp>;/span>span classn>branding/span>span classo>./span>span classn>cameraOverlay/span> span classo>/span> span classp>/span>span classkt>UIColor/span> span classn>cameraOverlay/span>span classp>;/span>span classn>branding/span>span classo>./span>span classn>onCameraOverlay/span> span classo>/span> span classp>/span>span classkt>UIColor/span> span classn>onCameraOverlay/span>span classp>;/span>span classn>branding/span>span classo>./span>span classn>outline/span> span classo>/span> span classp>/span>span classkt>UIColor/span> span classn>outline/span>span classp>;/span>span classn>branding/span>span classo>./span>span classn>error/span> span classo>/span> span classp>/span>span classkt>UIColor/span> span classn>error/span>span classp>;/span>span classn>branding/span>span classo>./span>span classn>success/span> span classo>/span> span classp>/span>span classkt>UIColor/span> span classn>success/span>span classp>;/span>span classn>branding/span>span classo>./span>span classn>buttonRadius/span> span classo>/span> span classmi>5/span>span classp>;/span>span classn>branding/span>span classo>./span>span classn>font/span> span classo>/span> span classp>/span>span classkt>VeriffBrandingFont/span> span classn>alloc/span>span classp>/span> span classnv>initWithRegular/span>span classp>:/span> span classs>@Font/span> span classnv>medium/span>span classp>:/span> span classs>@Font-Medium/span> span classnv>bold/span>span classp>:/span> span classs>@Font-Bold/span>span classp>;/span>/code>/pre>p>For optimal results, we recommend that the height of your custom logo image be kept under 40 points, and the width under 90 points. If your logo exceeds these dimensions, it will be compressed while preserving its original aspect ratio./p>h4 idsetting-the-user-interface-language>Setting the user interface language/h4>p>The Veriff iOS SDK allows setting the language of the SDK. In order to use this language, please set the code>languageLocale/code> property of code>VeriffSdk.Configuration/code> before you start the verification./p>pre classhighlight swift tab-swift>code>span classc1>// Swift/span>span classk>let/span> span classnv>locale/span> span classo>/span> span classkt>Locale/span>span classp>(/span>span classnv>identifier/span>span classp>:/span> span classs>et/span>span classp>)/span>span classc1>// Objective-C/span>span classkt>NSLocale/span> span classo>*/span>span classn>locale/span> span classo>/span> span classp>/span>span classkt>NSLocale/span> span classn>alloc/span>span classp>/span> span classnv>initWithLocaleIdentifier/span>span classp>:/span>span classs>@et/span>span classp>;/span>/code>/pre>h4 idcreate-the-configuration-object>Create the configuration object/h4>pre classhighlight swift tab-swift>code>span classc1>// Swift/span>span classk>let/span> span classnv>configuration/span> span classo>/span> span classkt>VeriffSdk/span>span classo>./span>span classkt>Configuration/span>span classp>(/span>span classnv>branding/span>span classp>:/span> span classn>branding/span>span classp>,/span> span classnv>languageLocale/span>span classp>:/span> span classn>locale/span>span classp>)/span>span classc1>// Objective-C/span>span classkt>VeriffConfiguration/span> span classo>*/span>span classn>configuration/span> span classo>/span> span classp>/span>span classkt>VeriffConfiguration/span> span classn>alloc/span>span classp>/span> span classnv>initWithBranding/span>span classp>:/span>span classn>branding/span> span classnv>languageLocale/span>span classp>:/span>span classn>locale/span>span classp>;/span>/code>/pre>h4 idcustom-intro-screen>Custom intro screen/h4>p>Veriff supports replacing introduction screen with a custom client developed introduction screen for eligible customers. First, please ask about this possibility from your strong>Solutions Engineer/strong>. In case we can offer it for you then removal process is following:/p>ul>li>You agree your own introduction screen visuals and copy with our strong>Solutions Engineer/strong> and get relevant legal documents signed in case their needed./li>li>After that Veriff will enable custom introduction screen from backend for your integrations./li>li>After you have implemented your own introduction screen you can change the configuration option specified below./li>/ul>pre classhighlight swift tab-swift>code>span classn>configuration/span>span classo>./span>span classn>customIntroScreen/span> span classo>/span> span classkc>true/span>/code>/pre>p>strong>Note:/strong> This step alone is not enough to enable the custom intro screen. Make sure to contact your strong>Solutions Engineer/strong> so they can enable the feature for your integration./p>h3 idvendor-data>Vendor data/h3>p>Veriff supports the option to override vendor data. Please check with your strong>Solutions Engineer/strong> to confirm if this feature can be enabled for your integration. If it is possible, follow these steps:/p>ol>li>Veriff will enable vendor data overriding from the backend for your integrations./li>li>Modify the configuration option as specified below./li>/ol>pre classhighlight swift tab-swift>code>span classn>configuration/span>span classo>./span>span classn>vendorData/span> span classo>/span> span classs>Vendor Data/span>/code>/pre>p>strong>Note:/strong> Enabling this feature alone will not be sufficient to override the vendor data. Ensure that you contact your strong>Solutions Engineer/strong> to have the feature enabled for your integration./p>h3 idstart-the-verification-flow-by-using-the-configuration>Start the verification flow by using the configuration/h3>pre classhighlight swift tab-swift>code>span classc1>// Swift/span>span classk>let/span> span classnv>veriff/span> span classo>/span> span classkt>VeriffSdk/span>span classo>./span>span classn>shared/span>span classn>veriff/span>span classo>./span>span classnf>startAuthentication/span>span classp>(/span>span classnv>sessionUrl/span>span classp>:/span> span classn>sessionUrl/span>span classp>,/span> span classnv>configuration/span>span classp>:/span> span classn>configuration/span>span classp>,/span> span classnv>presentingFrom/span>span classp>:/span> span classn>yourViewController/span>span classp>)/span>span classc1>// Objective-C/span>span classkt>VeriffSdk/span> span classo>*/span>span classn>veriff/span> span classo>/span> span classp>/span>span classkt>VeriffSdk/span> span classn>shared/span>span classp>;/span>span classp>/span>span classn>veriff/span> span classnv>startAuthenticationWithSessionUrl/span>span classp>:/span>span classn>sessionUrl/span> span classnv>configuration/span>span classp>:/span>span classn>configuration/span> span classnv>presentingFrom/span>span classp>:/span>span classn>yourViewController/span>span classp>;/span>/code>/pre>h3 idhandling-result-codes-from-sdk>Handling result codes from SDK/h3>p>To receive session results, you must implement the code>VeriffSdkDelegate/code> protocol and assign a delegateto the code>VeriffSdk/code> instance./p>p>Note that this is the strong>end-user flow completion status/strong>, meaning that it shows strong>whether the end-user was able tocomplete all the steps in the verification flow or not/strong>. It is not the verification session status./p>pre classhighlight swift tab-swift>code>span classn>veriff/span>span classo>./span>span classn>delegate/span> span classo>/span> span classk>self/span>/code>/pre>p>The Veriff SDK returns a number of result codes that your application can handle./p>pre classhighlight swift tab-swift>code>span classc1>// Swift/span>span classkd>extension/span> span classkt>VerificationService/span>span classp>:/span> span classkt>VeriffSdkDelegate/span> span classp>{/span>    span classkd>func/span> span classnf>sessionDidEndWithResult/span>span classp>(/span>span classn>_/span> span classnv>result/span>span classp>:/span> span classkt>Veriff/span>span classo>./span>span classkt>Result/span>span classp>)/span> span classp>{/span>        span classk>switch/span> span classn>result/span>span classo>./span>span classn>status/span> span classp>{/span>        span classk>case/span> span classo>./span>span classnv>done/span>span classp>:/span>            span classc1>// The end-user successfully submitted the session/span>            span classk>break/span>        span classk>case/span> span classo>./span>span classnv>canceled/span>span classp>:/span>            span classc1>// The end-user canceled the verification process./span>            span classk>break/span>        span classk>case/span> span classo>./span>span classnf>error/span>span classp>(/span>span classk>let/span> span classnv>error/span>span classp>):/span>            span classk>switch/span> span classn>error/span> span classp>{/span>                span classc1>// .../span>            span classp>}/span>        span classp>}/span>    span classp>}/span>span classp>}/span>span classc1>// Objective-C/span>span classo>-/span> span classp>(/span>span classn>void/span>span classp>)/span>span classnv>sessionDidEndWithResult/span>span classp>:(/span>span classkt>VeriffResult/span> span classo>*/span>span classp>)/span>span classn>result/span> span classp>{/span>    span classk>switch/span> span classp>(/span>span classn>result/span>span classo>./span>span classn>status/span>span classp>)/span> span classp>{/span>    span classk>case/span> span classkt>VeriffStatusDone/span>span classp>:/span>        span classc1>// The end-user successfully submitted the session/span>        span classk>break/span>span classp>;/span>    span classk>case/span> span classkt>VeriffStatusCanceled/span>span classp>:/span>        span classc1>// The end-user canceled the verification process./span>        span classk>break/span>span classp>;/span>    span classk>case/span> span classkt>VeriffStatusError/span>span classp>:/span>        span classk>if/span> span classp>(/span>span classn>result/span>span classo>./span>span classn>error/span> span classo>/span> span classkc>nil/span>span classp>)/span> span classp>{/span> span classk>break/span>span classp>;/span> span classp>}/span>        span classk>switch/span> span classp>(/span>span classn>result/span>span classo>./span>span classn>error/span>span classo>./span>span classn>code/span>span classp>)/span> span classp>{/span>            span classc1>// .../span>        span classp>}/span>    span classp>}/span>span classp>}/span>/code>/pre>p>You can find the description of status codes below:/p>ul>li>code>done/code> The session status is finished from clients perspective/li>li>code>canceled/code> The end-user canceled the verification process/li>li>code>error/code> An error occurred. To see the error reason:ul>li>In Swift: check the associated value (code>Veriff.Error/code>) passed by error status./li>li>In Objective-C: check code>result.error.code/code> (code>VeriffErrorCode/code>)./li>/ul>/li>/ul>h3 idnotes>Notes/h3>ul>li>The Veriff SDK always shows an error screen itself. The errors returned by the session are to inform your application./li>/ul>h3 idmigrating-to-veriff-ios-3-0-0>Migrating to Veriff iOS 3.0.0/h3>h4 idswitch-from-baseurl-and-sessiontoken-to-sessionurl>Switch from code>baseUrl/code> and code>sessionToken/code> to code>sessionUrl/code>/h4>p>The code>Veriff/code> object in the SDK 3.0.0 takes a required code>sessionUrl/code> and an optional code>VeriffConfiguration/code> instance as parameters into initialisation. The code>sessionUrl/code> is received from your backend implementation (see the documentation a hrefhttps://developers.veriff.com/#post-sessions>here/a>), it is composed of the code>baseUrl/code> and code>sessionToken/code> sent to the code>VeriffConfiguration/code> object in earlier versions./p>h4 idupdated-veriffconfiguration-object>Updated code>VeriffConfiguration/code> object/h4>p>The code>VeriffConfiguration/code> struct now takes in code>branding/code> and code>languageLocale/code> as initialisation parameters./p>h4 idthe-new-veriffdelegate-method>The new code>VeriffDelegate/code> method/h4>p>You can now receive session results via code>func sessionDidEndWithResult(_ result: Veriff.Result)/code> instead of the obsolete code>func onSession(result: VeriffResult, sessionToken: String)/code>. The code>sessionToken/code> is included in the code>Veriff.Result/code> as an instance variable./p>h4 iduse-veriff-result-instead-of-veriffresult>Use code>Veriff.Result/code> instead of code>VeriffResult/code>/h4>p>The new code>Veriff.Result/code> struct comprises code>status: Status/code> and code>sessionToken: String?/code> instance variables. The code>Status/code> enum can be of three  types: code>done/code>, code>canceled/code>, code>error/code>. The code>description/code> variable on the code>Veriff.Result/code> returns additional information as a string./p>h3 idmigrating-to-veriff-ios-4-0-0>Migrating to Veriff iOS 4.0.0/h3>h4 idrename-veriff-instances-to-veriffsdk>Rename code>Veriff/code> instances to code>VeriffSdk/code>/h4>p>The name code>Veriff/code> was used both for our module and public class name. However this blocked us from supporting Swift Package Manager due to a hrefhttps://bugs.swift.org/browse/SR-898>Swift compiler bug/a> ↗. We renamed our public class name to code>VeriffSdk/code>./p>h4 idveriffconfiguration-is-now-veriffsdk-configuration>code>VeriffConfiguration/code> is now code>VeriffSdk.Configuration/code>/h4>p>VeriffConfiguration struct is moved under code>VeriffSdk/code>. Please replace the occurrences of code>VeriffConfiguration/code> with code>VeriffSdk.Configuration/code>./p>h4 idbranding-is-now-veriffsdk-branding>code>Branding/code> is now code>VeriffSdk.Branding/code>/h4>p>Branding struct is moved under code>VeriffSdk/code>. Please replace the occurrences of code>Branding/code> with code>VeriffSdk.Branding/code>./p>h4 idrename-veriffdelegate-to-veriffsdkdelegate>Rename code>VeriffDelegate/code> to code>VeriffSdkDelegate/code>/h4>p>Please replace the occurrences of code>VeriffDelegate/code> with code>VeriffSdkDelegate/code>./p>h4 idveriffsdk-result-description-made-non-optional>code>VeriffSdk.Result.description/code> made non-optional/h4>p>If you were dealing with unwrapping it, feel free to remove it./p>h4 idveriffsdk-result-sessiontoken-removed-and-veriffsdk-result-sessionurl-added-instead>code>VeriffSdk.Result.sessionToken/code> removed and code>VeriffSdk.Result.sessionUrl/code> added instead/h4>p>Please remove the occurrences of code>sessionToken/code>. You can now use code>sessionUrl/code> to get the full code>sessionUrl/code> including token./p>h3 idmigrating-to-veriff-ios-5-0-0>Migrating to Veriff iOS 5.0.0/h3>h4 idincreased-min-ios-supported-version>Increased min iOS supported version/h4>p>Now min version is iOS 11.0./p>h4 idupdated-veriffsdk-branding-object>Updated code>VeriffSdk.Branding/code> object/h4>p>Following configurations are removed:/p>ul>li>code>buttonHeight/code>/li>li>code>statusBarColor/code>/li>li>code>secondaryTextColor/code>/li>li>code>isTextUppercase/code>/li>/ul>p>Fonts API changes:/p>ul>li>code>lightFontName/code> is removed/li>li>code>regularFontName/code>, code>semiBoldFontName/code> and code>boldFontName/code> are renamed to code>regular/code>, code>medium/code> and code>bold/code>./li>/ul>p>code>logomark/code> customization is added./p>h3 idmigrating-to-veriff-ios-6-0-0>Migrating to Veriff iOS 6.0.0/h3>h4 idupdated-veriffsdk-branding-object-2>Updated code>VeriffSdk.Branding/code> object/h4>p>Following configurations are added:/p>ul>li>code>background/code>/li>li>code>onBackground/code>/li>li>code>onBackgroundSecondary/code>/li>li>code>onBackgroundTertiary/code>/li>li>code>primary/code>/li>li>code>onPrimary/code>/li>li>code>secondary/code>/li>li>code>onSecondary/code>/li>li>code>outline/code>/li>li>code>error/code>/li>li>code>success/code>/li>/ul>p>Following configurations are removed:/p>ul>li>code>themeColor/code>/li>li>code>backgroundColor/code>/li>li>code>primaryTextColor/code>/li>li>code>primaryButtonBackgroundColor/code>/li>li>code>bulletPoint/code>/li>/ul>p>Following configurations are deprecated:/p>ul>li>code>logomark/code> not used anymore/li>/ul>p>Following configurations are renamed:/p>ul>li>code>buttonCornerRadius/code> -> code>buttonRadius/code>/li>/ul>h3 idmigrating-to-veriff-ios-7-0-0>Migrating to Veriff iOS 7.0.0/h3>h4 idset-deployment-target-to-ios-13>Set deployment target to iOS 13/h4>h3 idios-sdk-changelog>iOS SDK Changelog/h3>p>Please refer to a hrefhttps://www.veriff.com/release-notes>release notes/a> ↗./p>h2 idflutter-plugin>Flutter Plugin/h2>h3 idrequirements>Requirements/h3>p>Integration with Veriff Flutter Plugin requires the project to target at least iOS version 13.0 andAndroid version 8.0 (API 26) or higher./p>h3 idinstall-the-plugin-to-your-project>Install the plugin to your project/h3>p>Follow instructions a hrefhttps://pub.dev/packages/veriff_flutter/install>here/a> ↗ to install the plugin./p>h3 iddeclare-foreground-service-sync-for-google-play>Declare foreground service sync for Google Play/h3>p>The SDK declares and uses the code>FOREGROUND_SERVICE_DATA_SYNC/code>. If you distribute your application on Google Play,then you must a hrefhttps://support.google.com/googleplay/android-developer/answer/13392821?hlen#declare>declare the foreground service information in Play Console/a> ↗./p>p>The information required by Play Console is (as listed on the Google Play link above):/p>ol>li>strong>Provide a description of the app functionality that is using each foreground service type./strong>ul>li>The Veriff SDK uses the foreground service to upload end-user data to Veriff's servers for verification purposes./li>/ul>/li>li>strong>Describe the user impact if the task is deferred by the system (does not start immediately), and/or the task is interrupted by the system (paused and/or restarted)./strong>ul>li>If the task is deferred or interrupted by the system, the end-user verification will be delayed./li>/ul>/li>li>strong>Include a link to a video demonstrating each foreground service feature. The video should demonstrate the steps the user needs to take in your app in order to trigger the feature./strong>ul>li>Please record a video of your app's Veriff SDK integration./li>/ul>/li>li>strong>Choose your specific use case for each foreground service type./strong>ul>li>"Network transfer: Upload or download / Other"/li>/ul>/li>/ol>p>See also Veriff's note on a hrefhttps://www.veriff.com/data-collection-purposes>data collection purposes in your app/a> ↗/p>h3 idios-specific-configuration>iOS specific configuration/h3>h4 idadd-usage-descriptions-to-application-info-plist>Add usage descriptions to application Info.plist/h4>blockquote>p>Not adding these usage descriptions causes system to kill application when it requests the permissions when needed./p>/blockquote>p>Veriff requires camera, microphone, photo library and optionally NFC reader permissions for capturing photos, video and scanning passport during identification. Your application is responsible to describe the reason why camera, microphone, photo library and NFC reader is used. You must add 3 descriptions listed below to code>Info.plist/code> of your application with the explanation of the usage./p>ul>li>code>NSCameraUsageDescription/code>/li>li>code>NSMicrophoneUsageDescription/code>/li>li>code>NSPhotoLibraryUsageDescription/code>/li>/ul>h4 idadd-required-steps-for-nfc-scanning>Add required steps for NFC scanning/h4>ol>li>Add code>NFCReaderUsageDescription/code> description to code>Info.plist/code>./li>li>p>The application needs to define the list of application IDs or AIDs it can connect to, in the Info.plist file. The AID is a way of uniquely identifying an application on a ISO 7816 tag, which is usually defined by a standard./p>pre classhighlight plaintext>code><key>com.apple.developer.nfc.readersession.iso7816.select-identifiers</key><array>  <string>A0000002471001</string>  <string>A0000002472001</string>  <string>00000000000000</string></array>/code>/pre>/li>li>p>Introduce a new entitlement for NFC scanning, a feature made available from iOS 13 onwards. Xcode automatically adds this entitlement when you activate the Near Field Communication Tag Reading feature in the target Signing & Capabilities. Following the activation of this feature, the *.entitlements file should include the TAG format./p>pre classhighlight plaintext>code><key>com.apple.developer.nfc.readersession.formats</key><array>    <string>TAG</string></array>/code>/pre>/li>/ol>h4 idset-the-ios-target-in-xcode>Set the iOS target in Xcode/h4>p>Make sure that the 'iOS Deployment Target' in Xcode (under Project > target > Info > Deployment Target) is set to iOS code>13.0/code> or later./p>h3 idlaunching-the-verification-flow>Launching the verification flow/h3>h4 idimport-plugin-in-your-code>Import plugin in your code/h4>p>In order to use Veriff plugin, please import it to your class that will use it.code>import 'package:veriff_flutter/veriff_flutter.dart'/code>/p>h4 idstart-verification-flow>Start verification flow/h4>p>In order to start the verification flow please create a configuration with defined parameters below./p>p>Parameters are defined as below;/p>table>thead>tr>th>Parameters/th>th>Description/th>/tr>/thead>tbody>tr>td>code>sessionUrl/code>/td>td>Required parameter. code>sessionUrl/code> can be received from your backend implementation. code>sessionUrl/code> should be unique for each call. Check code>/sessions/code> endpoint in the API documentation a href/#post-sessions>here/a> to learn how to generate one./td>/tr>/tbody>/table>pre classhighlight plaintext>code>Configuration config  Configuration(sessionUrl);/code>/pre>p>Then pass the configuration to Veriff object and start the verification flow;/p>pre classhighlight plaintext>code>Veriff veriff  Veriff();try {      Result result  await veriff.start(config);      print(result.status);      print(result.error);    } on PlatformException {      // handle exception    }/code>/pre>h3 idcustomize-user-interface-optional>Customize user interface (Optional)/h3>p>You can customize Veriff SDK user interface in your application by defining your brand's colors, font and logo./p>p>See the a href/images/Veriff-SDK-Customization.pdf target“_blank” >Veriff SDK customization guide/a> ↗ document to see what it looks like./p>p>Veriff Flutter plugin allows the customization of your brand's colors, font and logo in the SDK flow by passing the optional parameters when launching Veriff:/p>pre classhighlight plaintext>code>String regularFontPath  fonts/Regular.otf;String mediumFontPath  fonts/Medium.otf;String boldFontPath  fonts/Bold.otf;Fonts fonts  Fonts(    regularFontPath: regularFontPath,     mediumFontPath: mediumFontPath,     boldFontPath: boldFontPath);Branding branding  Branding(    logo: AssetImage(path_of_image),    background: #f2ff00,    onBackground: #ff00ff,    onBackgroundSecondary: #52b35c,    onBackgroundTertiary: #3a593d,    primary: #123abc,    onPrimary: #ff00ff,    secondary: #f2ff00,    onSecondary: #ff7700,    cameraOverlay: #59496a,    onCameraOverlay: #e27e23,    outline: #ff00ff,    error: #ff0000,    success: #00ff00,    buttonRadius: 5,    fonts: fonts);/code>/pre>p>And pass the branding object with configuration for starting the verification flow:/p>pre classhighlight plaintext>code>Configuration config  Configuration(sessionUrl, branding: branding);/code>/pre>p>When a color isn't defined, the default Veriff theme color is used./p>h4 idsetting-the-user-interface-language>Setting the user interface language/h4>p>Veriff Flutter plugin supports setting the language of the UI. In order to use this feature, please pass the locale identifier as in example below;/p>pre classhighlight plaintext>code>Configuration config  Configuration(sessionUrl, branding: branding, languageLocale: et);/code>/pre>h4 idcustom-intro-screen>Custom intro screen/h4>p>Veriff supports replacing introduction screen with a custom client developed introduction screen for eligible customers. First, please ask about this possibility from your solutions engineer. In case we can offer it for you then removal process is following:/p>ul>li>You agree your own introduction screen visuals and copy with our solutions engineer and get relevant legal documents signed in case their needed./li>li>After that Veriff will enable custom introduction screen from backend for your integrations./li>li>After you have implemented your own introduction screen you can change the configuration option specified below./li>/ul>pre classhighlight plaintext>code>config.useCustomIntroScreen  true;/code>/pre>h3 idvendor-data>Vendor data/h3>p>Veriff supports the option to override vendor data. Please check with your strong>Solutions Engineer/strong> to confirm if this feature can be enabled for your integration. If it is possible, follow these steps:/p>ol>li>Veriff will enable vendor data overriding from the backend for your integrations./li>li>Modify the configuration option as specified below./li>/ol>pre classhighlight plaintext>code>config.vendorData  Vendor Data;/code>/pre>h3 idhandling-the-results-from-plugin>Handling the results from plugin/h3>p>The Result returned by start method will have a status that is one of code>Status.done/code>, code>Status.canceled/code> and code>Status.error/code>./p>p>Note that this is the strong>end-user flow completion status/strong>, meaning that it shows strong>whether the end-user was able tocomplete all the steps in the verification flow or not/strong>. It is not the verification session status./p>p>In case Status.error is received, you will also have an error description that is one of the list below:/p>ul>li>Error.cameraUnavailable/li>li>Error.microphoneUnavailable/li>li>Error.networkError/li>li>Error.sessionError/li>li>Error.deprecatedSDKVersion/li>li>Error.unknown/li>li>Error.nfcError/li>li>Error.setupError/li>li>Error.none/li>/ul>p>You can check the statuses and errors using switch-case as in example below;/p>pre classhighlight plaintext>code>switch (result.status) {        case Status.done:          print(Session is completed.);          break;        case Status.canceled:          print(Session is canceled by the end-user.);          break;        case Status.error:          switch (result.error) {            case Error.cameraUnavailable:              print(User did not give permission for the camera);              break;            case Error.microphoneUnavailable:              print(User did not give permission for the microphone.);              break;            case Error.networkError:              print(Network error occurred.);              break;            case Error.sessionError:              print(A local error happened before submitting the session.);              break;            case Error.deprecatedSDKVersion:              print(                  Version of Veriff SDK used in plugin has been deprecated. Please update to the latest version.);              break;            case Error.unknown:              print(Uknown error occurred.);              break;            case Error.nfcError:              print(Error with NFC);              break;            case Error.setupError:              print(Error with setup);              break;            case Error.none:              print(No error.);              break;            default:              break;          }          break;        default:          break;}/code>/pre>h2 idreact-native-sdk>React Native SDK/h2>h3 idreact-native-sdk-requirements>React Native SDK requirements/h3>p>Integration with Veriff React Native SDK requires the project to target at least iOS version 13.4 andAndroid version 8.0 (API 26) or higher./p>p>strong>Note:/strong> strong>If you have created your react native app using expo, you will have to eject out of expo at this point(if you have not ejected out already) since expo does not support native modules/strong>Check the Caveats section a hrefhttps://reactnative.dev/docs/environment-setup>here/a> ↗ for more info on that./p>h3 idadd-the-sdk-to-a-project>Add the SDK to a project/h3>p>Add the Veriff React Native SDK to your code>package.json/code> file:/p>pre classhighlight shell>code>npx yarn add @veriff/react-native-sdk/code>/pre>p>Or if using code>npm/code>:/p>pre classhighlight shell>code>npm install @veriff/react-native-sdk --save/code>/pre>h3 idupdate-android-build-gradle-file>Update Android code>build.gradle/code> file/h3>p>Open the root code>build.gradle/code> file in the code>android/code> folder and add a new maven destination to the repositories in the code>allprojects/code> section. The best place is right after the local code>node_modules/code> repositories and before the code>google()/code> repository./p>pre classhighlight java tab-java>code>span classn>allprojects/span> span classo>{/span>    span classn>repositories/span> span classo>{/span>        span classc1>// ... local react native repos/span>        span classn>maven/span> span classo>{/span> span classn>url/span> span classs>https://cdn.veriff.me/android//span> span classo>}/span> span classc1>//veriff/span>        span classn>google/span>span classo>()/span>        span classn>jcenter/span>span classo>()/span>    span classo>}/span>span classo>}/span>/code>/pre>h3 iddeclare-foreground-service-sync-for-google-play>Declare foreground service sync for Google Play/h3>p>The SDK declares and uses the code>FOREGROUND_SERVICE_DATA_SYNC/code>. If you distribute your application on Google Play,then you must a hrefhttps://support.google.com/googleplay/android-developer/answer/13392821?hlen#declare>declare the foreground service information in Play Console/a> ↗./p>p>The information required by Play Console is (as listed on the Google Play link above):/p>ol>li>strong>Provide a description of the app functionality that is using each foreground service type./strong>ul>li>The Veriff SDK uses the foreground service to upload end-user data to Veriff's servers for verification purposes./li>/ul>/li>li>strong>Describe the user impact if the task is deferred by the system (does not start immediately), and/or the task is interrupted by the system (paused and/or restarted)./strong>ul>li>If the task is deferred or interrupted by the system, the end-user verification will be delayed./li>/ul>/li>li>strong>Include a link to a video demonstrating each foreground service feature. The video should demonstrate the steps the user needs to take in your app in order to trigger the feature./strong>ul>li>Please record a video of your app's Veriff SDK integration./li>/ul>/li>li>strong>Choose your specific use case for each foreground service type./strong>ul>li>"Network transfer: Upload or download / Other"/li>/ul>/li>/ol>p>See also Veriff's note on a hrefhttps://www.veriff.com/data-collection-purposes>data collection purposes in your app/a> ↗/p>h3 idios-specific-setup>iOS Specific setup/h3>h4 idadd-swift-to-the-ios-module>Add Swift to the ios module/h4>p>Veriff SDK requires your ios module to have some Swift code. If you don't have any Swift code yet then add a new code>empty.swift/code> file in Xcode. If Xcode offers to add a bridging header then add it./p>h4 idupdate-ios-podfile>Update iOS code>Podfile/code>/h4>p>Open code>Podfile/code> in the code>ios/code> folder and make sure that code>platform/code> is 13.4 or higher:/p>pre classhighlight ruby tab-ruby>code>span classn>platform/span> span classss>:ios/span>span classp>,/span> span classs1>13.4/span>/code>/pre>p>Also make sure your main target in the code>Podfile/code> contains code>use_native_modules!/code> directive:/p>pre classhighlight ruby tab-ruby>code>span classn>target/span> span classs1>MyApp/span> span classk>do/span>  span classc1># pod foo.../span>  span classn>config/span> span classo>/span> span classn>use_native_modules!/span>span classk>end/span>/code>/pre>h4 idadd-usage-descriptions-to-application-info-plist>Add usage descriptions to application Info.plist/h4>blockquote>p>Not adding these usage descriptions causes system to kill application when it requests the permissions when needed./p>/blockquote>p>Veriff requires camera, microphone, photo library and optionally NFC reader permissions for capturing photos, video and scanning passport during identification. Your application is responsible to describe the reason why camera, microphone, photo library and NFC reader is used. You must add 3 descriptions listed below to code>Info.plist/code> of your application with the explanation of the usage./p>ul>li>code>NSCameraUsageDescription/code>/li>li>code>NSMicrophoneUsageDescription/code>/li>li>code>NSPhotoLibraryUsageDescription/code>/li>/ul>h4 idadd-required-steps-for-nfc-scanning>Add required steps for NFC scanning/h4>ol>li>Add code>NFCReaderUsageDescription/code> description to code>Info.plist/code>./li>li>p>The application needs to define the list of application IDs or AIDs it can connect to, in the Info.plist file. The AID is a way of uniquely identifying an application on a ISO 7816 tag, which is usually defined by a standard./p>pre classhighlight plaintext>code><key>com.apple.developer.nfc.readersession.iso7816.select-identifiers</key><array>  <string>A0000002471001</string>  <string>A0000002472001</string>  <string>00000000000000</string></array>/code>/pre>/li>li>p>Introduce a new entitlement for NFC scanning, a feature made available from iOS 13 onwards. Xcode automatically adds this entitlement when you activate the Near Field Communication Tag Reading feature in the target Signing & Capabilities. Following the activation of this feature, the *.entitlements file should include the TAG format./p>pre classhighlight plaintext>code><key>com.apple.developer.nfc.readersession.formats</key><array>    <string>TAG</string></array>/code>/pre>/li>/ol>h4 idset-the-ios-target-in-xcode>Set the iOS target in Xcode/h4>p>Make sure that the 'iOS Deployment Target' in Xcode (under Project > target > Info > Deployment Target) is set to iOS 13.4 or later./p>h3 idusing-the-veriff-react-native-sdk>Using the Veriff React Native SDK/h3>h4 idstarting-the-verification-flow>Starting the verification flow/h4>p>In order to use Veriff SDK, please import it to the file that will use the SDK./p>pre classhighlight javascript tab-javascript>code>span classkr>import/span> span classnx>VeriffSdk/span> span classnx>from/span> span classs1>@veriff/react-native-sdk/span>span classp>;/span>/code>/pre>p>Parameters are defined as below;/p>table>thead>tr>th>Parameters/th>th>Description/th>/tr>/thead>tbody>tr>td>code>sessionUrl/code>/td>td>Required parameter. code>sessionUrl/code> can be received from your backend implementation. code>sessionUrl/code> should be unique for each call. Check code>/sessions/code> endpoint in the API documentation a href#post-sessions>here/a> to learn how to generate one./td>/tr>/tbody>/table>p>Once you have the code>sessionUrl/code> you can launch Veriff using code>VeriffSdk/code> imported earlier:/p>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>result/span> span classo>/span> span classnx>await/span> span classnx>VeriffSdk/span>span classp>./span>span classnx>launchVeriff/span>span classp>({/span> span classna>sessionUrl/span>span classp>:/span> span classnx>SESSION_URL/span> span classp>});/span>/code>/pre>h3 iduser-interface-customization>User Interface customization/h3>p>You can customize Veriff SDK user interface in your application by defining your brand's colors, font and logo./p>p>See a href/images/Veriff-SDK-Customization.pdf target“_blank” >Veriff SDK customization guide/a> ↗ document on how it looks./p>p>Veriff React Native SDK allows the customization of your brand's colors, font and logo in the SDK flow by passing in these optional properties when launching Veriff:/p>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>result/span> span classo>/span> span classnx>await/span> span classnx>VeriffSdk/span>span classp>./span>span classnx>launchVeriff/span>span classp>({/span>    span classna>sessionUrl/span>span classp>:/span> span classnx>SESSION_URL/span>span classp>,/span>    span classna>branding/span>span classp>:/span> span classp>{/span>      span classna>logo/span>span classp>:/span> span classs1>parrot/span>span classp>,/span> span classc1>// see alternative options for logo below/span>      span classna>background/span>span classp>:/span> span classs1>#ff00ff/span>span classp>,/span>      span classna>onBackground/span>span classp>:/span> span classs1>#ffffff/span>span classp>,/span>      span classna>onBackgroundSecondary/span>span classp>:/span> span classs1>#ff00ff/span>span classp>,/span>      span classna>onBackgroundTertiary/span>span classp>:/span> span classs1>#000000/span>span classp>,/span>      span classna>primary/span>span classp>:/span> span classs1>#333333/span>span classp>,/span>      span classna>onPrimary/span>span classp>:/span> span classs1>#444444/span>span classp>,/span>      span classna>secondary/span>span classp>:/span> span classs1>#333333/span>span classp>,/span>      span classna>onSecondary/span>span classp>:/span> span classs1>#444444/span>span classp>,/span>      span classna>outline/span>span classp>:/span> span classs1>#444444/span>span classp>,/span>      span classna>cameraOverlay/span>span classp>:/span> span classs1>#59496a/span>span classp>,/span>      span classna>onCameraOverlay/span>span classp>:/span> span classs1>#e27e23/span>span classp>,/span>      span classna>error/span>span classp>:/span> span classs1>#333333/span>span classp>,/span>      span classna>success/span>span classp>:/span> span classs1>#444444/span>span classp>,/span>      span classna>buttonRadius/span>span classp>:/span> span classmi>28/span>span classp>,/span>      span classna>iOSFont/span>span classp>:/span> span classp>{/span>        span classna>regular/span>span classp>:/span> span classs1>Font-Regular/span>span classp>,/span>        span classna>medium/span>span classp>:/span> span classs1>Font-Medium/span>span classp>,/span>        span classna>bold/span>span classp>:/span> span classs1>Font-Bold/span>span classp>,/span>      span classp>},/span>      span classna>androidFont/span>span classp>:/span> span classp>{/span>        span classna>regular/span>span classp>:/span> span classs1>font_regular/span>span classp>,/span>        span classna>medium/span>span classp>:/span> span classs1>font-medium/span>span classp>,/span>        span classna>bold/span>span classp>:/span> span classs1>font_bold/span>span classp>,/span>      span classp>}/span>    span classp>},/span>  span classp>});/span>/code>/pre>p>When a color or a font isn't defined the default Veriff color or font is used. Same applies to the logo - when it isn't defined the default is used. The image assets need to be added into Xcode assets in the iOS project and into drawable folders in the Android project. In the example above you would need to add an image asset named 'parrot' into Xcode assets and 'parrot.png' to Android drawable folders in code>android/src/main/res/code>./p>h4 idalternative-ways-to-provide-the-logo>Alternative ways to provide the logo/h4>p>Instead of using platform-specific image assets you can provide a URI to an image which will then be used:/p>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>result/span> span classo>/span> span classnx>await/span> span classnx>VeriffSdk/span>span classp>./span>span classnx>launchVeriff/span>span classp>({/span>    span classna>sessionUrl/span>span classp>:/span> span classnx>SESSION_URL/span>span classp>,/span>    span classna>branding/span>span classp>:/span> span classp>{/span>      span classna>logo/span>span classp>:/span> span classp>{/span> span classna>uri/span>span classp>:/span> span classs1>http://example.com/logo/parrot.jpg/span> span classp>},/span>    span classp>},/span>  span classp>});/span>/code>/pre>p>React Native assets are also supported through code>resolveAssetSource/code>:/p>pre classhighlight javascript tab-javascript>code>span classkr>const/span> span classnx>resolveAssetSource/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>react-native/Libraries/Image/resolveAssetSource/span>span classp>);/span>span classkr>const/span> span classnx>parrot/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>./img/parrot.png/span>span classp>);/span>span classkd>var/span> span classnx>result/span> span classo>/span> span classnx>await/span> span classnx>VeriffSdk/span>span classp>./span>span classnx>launchVeriff/span>span classp>({/span>    span classna>sessionUrl/span>span classp>:/span> span classnx>SESSION_URL/span>span classp>,/span>    span classna>branding/span>span classp>:/span> span classp>{/span>      span classna>logo/span>span classp>:/span> span classnx>resolveAssetSource/span>span classp>(/span>span classnx>parrot/span>span classp>),/span>    span classp>},/span>  span classp>});/span>/code>/pre>h4 idsetting-the-user-interface-language>Setting the user interface language/h4>p>The Veriff RN SDK allows setting the language of the SDK. In order to use this language, please pass the locale as in example below;/p>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>result/span> span classo>/span> span classnx>await/span> span classnx>VeriffSdk/span>span classp>./span>span classnx>launchVeriff/span>span classp>({/span>    span classna>sessionUrl/span>span classp>:/span> span classnx>SESSION_URL/span>span classp>,/span>    span classna>locale/span>span classp>:/span> span classs1>et/span>  span classp>});/span>/code>/pre>h4 idcustom-intro-screen>Custom intro screen/h4>p>Veriff supports replacing introduction screen with a custom client developed introduction screen for eligible customers. Please request this from your solutions engineer. The removal process is following:/p>ul>li>Agree your own introduction screen visuals and copy with our solutions engineer and get relevant legal documents signed;/li>li>Veriff will enable custom introduction screen for your integrations;/li>li>After you have implemented your own introduction screen you can change the configuration option as specified below;/li>/ul>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>result/span> span classo>/span> span classnx>await/span> span classnx>VeriffSdk/span>span classp>./span>span classnx>launchVeriff/span>span classp>({/span>    span classna>sessionUrl/span>span classp>:/span> span classnx>SESSION_URL/span>span classp>,/span>    span classna>locale/span>span classp>:/span> span classs1>et/span>span classp>,/span>    span classna>customIntroScreen/span>span classp>:/span> span classkc>true/span>  span classp>});/span>/code>/pre>h4 idvendor-data>Vendor data/h4>p>Veriff supports the option to override vendor data. Please check with your strong>Solutions Engineer/strong> to confirm if this feature can be enabled for your integration. If it is possible, follow these steps:/p>ol>li>Veriff will enable vendor data overriding from the backend for your integrations./li>li>Modify the configuration option as specified below./li>/ol>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>result/span> span classo>/span> span classnx>await/span> span classnx>VeriffSdk/span>span classp>./span>span classnx>launchVeriff/span>span classp>({/span>    span classna>sessionUrl/span>span classp>:/span> span classnx>SESSION_URL/span>span classp>,/span>    span classna>locale/span>span classp>:/span> span classs1>et/span>span classp>,/span>    span classna>vendorData/span>span classp>:/span> span classs2>Vendor Data/span>  span classp>});/span>/code>/pre>h3 idhandling-the-result-from-the-sdk>Handling the result from the SDK/h3>p>The code>result/code> returned by code>launchVeriff/code> will have a code>status/code> field that is one of either code>VeriffSdk.statusDone/code>,code>VeriffSdk.statusCanceled/code> or code>VeriffSdk.statusError/code>. /p>p>Note that this is the strong>end-user flow completion status/strong>, meaning that it shows strong>whether the end-user was able tocomplete all the steps in the verification flow or not/strong>. It is not the verification session status./p>p>In case of code>statusError/code> there will be a error code (not human-readable) in the code>error/code> field./p>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>result/span> span classo>/span> span classnx>await/span> span classnx>VeriffSdk/span>span classp>./span>span classnx>launchVeriff/span>span classp>({/span> span classna>sessionUrl/span>span classp>:/span> span classnx>SESSION_URL/span> span classp>});/span>span classk>switch/span> span classp>(/span>span classnx>result/span>span classp>./span>span classnx>status/span>span classp>)/span> span classp>{/span>  span classk>case/span> span classnx>VeriffSdk/span>span classp>./span>span classnx>statusDone/span>span classp>:/span>    span classc1>// end-user submitted the images and completed the flow/span>    span classc1>// note that this does not mean a final decision yet/span>    span classk>break/span>span classp>;/span>  span classk>case/span> span classnx>VeriffSdk/span>span classp>./span>span classnx>statusCanceled/span>span classp>:/span>    span classc1>// end-user canceled the flow before completing/span>    span classk>break/span>span classp>;/span>  span classk>case/span> span classnx>VeriffSdk/span>span classp>./span>span classnx>statusError/span>span classp>:/span>    span classc1>// the flow could not be completed due to an error/span>    span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs2>Veriff verification failed with error/span> span classo>+/span> span classnx>result/span>span classp>./span>span classnx>error/span>span classp>);/span>    span classk>break/span>span classp>;/span>span classp>}/span>/code>/pre>h3 idmigrating-to-react-native-sdk-3-0-0>Migrating to React Native SDK 3.0.0/h3>p>Follow these steps to migrate to React Native SDK 3.0.0 API/p>h4 idupdated-branding-api>Updated Branding API/h4>p>Following configurations are added:/p>ul>li>background/li>li>onBackground/li>li>onBackgroundSecondary/li>li>onBackgroundTertiary/li>li>primary/li>li>onPrimary/li>li>secondary/li>li>onSecondary/li>li>outline/li>li>error/li>li>success/li>/ul>p>Following configurations are removed:/p>ul>li>themeColor/li>li>backgroundColor/li>li>primaryTextColor/li>li>primaryButtonBackgroundColor/li>li>bulletPoint/li>/ul>p>Following configurations are renamed:/p>p>buttonCornerRadius -> buttonRadius/p>h3 idmigrating-to-react-native-sdk-2-0-0>Migrating to React Native SDK 2.0.0/h3>p>Follow these steps to migrate to React Native SDK 2.0.0 API/p>h4 iduse-new-parameter-sessionurl>Use new parameter code>sessionUrl/code>/h4>p>New API uses code>sessionUrl/code> instead of a code>sessionToken/code>. code>sessionUrl/code> is a combination of base URL and session token./p>h4 idrename-parameter-navigationbarimage-to-logo>Rename parameter code>navigationBarImage/code> to code>logo/code>/h4>p>We renamed the code>navigationBarImage/code> parameter in configuration to code>logo/code>./p>h3 idreact-native-sdk-changelog>React Native SDK Changelog/h3>p>Below is a summary of changes introduced with each version of the React Native SDK. Expand the list by clicking on "Versions" and then on each release version to see the summary./p>div classexpandable>    details>        summary classexpandable-title>            span classicon>▸/span>Versions        /summary>        div idexpandable-content classexpandable-content>            ul>                details>summary>Release 7.2.0/summary>                    ul>                      li>Migrated Android SDK to version 7.1.0/li>                      li>Migrated iOS SDK to version 7.6.0/li>                    /ul>                /details>                details>summary>Release 7.1.0/summary>                    ul>                      li>Migrated Android SDK to version 7.0.1/li>                    /ul>                /details>                details>summary>Release 7.0.0/summary>                    ul>                      li>Updated react native to 0.74 version/li>                      li>Set Android minSdkVersion to 26/li>                      li>Migrated Android SDK to version 7.0.0/li>                      li>Migrated iOS SDK to version 7.4.0/li>                    /ul>                /details>                details>summary>Release 6.2.0/summary>                    ul>                      li>Migrated Android SDK to version 6.15.0/li>                      li>Migrated iOS SDK to version 6.32.0/li>                    /ul>                /details>                details>summary>Release 6.1.0/summary>                    ul>                      li>Migrated Android SDK to version 6.14.0/li>                      li>Migrated iOS SDK to version 6.31.0/li>                    /ul>                /details>                details>summary>Release 6.0.0/summary>                    ul>                      li>Updated react native to 0.73 version/li>                      li>Updated minimum iOS supported version to 13.4/li>                      li>Migrated Android SDK to version 6.13.0/li>                      li>Migrated iOS SDK to version 6.23.0/li>                    /ul>                /details>                details>summary>Release 5.2.0/summary>                    ul>                      li>Migrated Android SDK to version 6.12.0/li>                      li>Added latest Expo support/li>                    /ul>                /details>                details>summary>Release 5.1.0/summary>                    ul>                      li>Migrated iOS SDK to version 6.22.0/li>                    /ul>                /details>                details>summary>Release 5.0.0/summary>                    ul>                      li>Updated react native to 0.72 version/li>                      li>Fixed iOS wrapper error result status mapping/li>                    /ul>                /details>                details>summary>Release 4.6.0/summary>                    ul>                      li>Migrated iOS SDK to version 6.17.0/li>                      li>Migrated Android SDK to version 6.11.0/li>                    /ul>                /details>                details>summary>Release 4.5.0/summary>                    ul>                      li>Migrated iOS SDK to version 6.14.0/li>                      li>Migrated Android SDK to version 6.10.0/li>                    /ul>                /details>                details>summary>Release 4.4.0/summary>                    ul>                      li>Migrated iOS SDK to version 6.12.0/li>                      li>Migrated Android SDK to version 6.9.1/li>                    /ul>                /details>                details>summary>Release 4.3.0/summary>                    ul>                      li>Migrated iOS SDK to version 6.9.0/li>                      li>Migrated Android SDK to version 6.8.0/li>                    /ul>                /details>                details>summary>Release 4.2.0/summary>                    ul>                      li>Migrated iOS SDK to version 6.8.0/li>                      li>Migrated Android SDK to version 6.6.0/li>                    /ul>                /details>                details>summary>Release 4.1.0/summary>                    ul>                      li>Introduce cameraOverlay and onCameraOverlay branding customization/li>                      li>Migrated iOS SDK to version 6.7.0/li>                      li>Migrated Android SDK to version 6.5.0/li>                    /ul>                /details>                details>summary>Release 4.0.0/summary>                    ul>                      li>Updated react native to 0.71 version/li>                      li>Updated minimum iOS supported version to 12.4/li>                      li>Migrated iOS SDK to version 6.5.0/li>                      li>Migrated Android SDK to version 6.3.0/li>                    /ul>                /details>                                details>summary>Release 3.1.0/summary>                    ul>                      li>Migrated iOS SDK to version 6.3.0/li>                      li>Migrated Android SDK to version 6.1.0/li>                    /ul>                /details>                                details>summary>Release 3.0.0/summary>                    ul>                      li>Updated Branding API./li>                    /ul>                /details>                                details>summary>Release 2.5.0/summary>                    ul>                      li>Added new customization option to provide background color for primary button./li>                    /ul>                /details>                                details>summary>Release 2.4.0/summary>                    ul>                      li>Added implmentation type parameter./li>                    /ul>                /details>                                details>summary>Release 2.3.2/summary>                    ul>                      li>Updated public readme of the package in npmjs, no functional changes./li>                    /ul>                /details>                                details>summary>Release 2.3.1/summary>                    ul>                      li>Updated public readme of the package in npmjs, no functional changes./li>                    /ul>                /details>                                details>summary>Release 2.3.0/summary>                    ul>                      li>Added new customization options to provide background, status bar and text colors./li>                      li>Added an option to customize primary button corner radius./li>                    /ul>                /details>                                details>summary>Release 2.2.0/summary>                    ul>                      li>The logo customization option now supports URLs and RN assets./li>                    /ul>                /details>                                details>summary>Release 2.1.0/summary>                    ul>                      li>Updated the iOS native module to use Veriff iOS SDK 4.+/li>                    /ul>                /details>                                details>summary>Release 2.0.0/summary>                    ul>                      li>New public API for the React Native SDK./li>                      li>Updated the iOS native module to use Veriff iOS SDK 3.+/li>                    /ul>                /details>                                details>summary>Release 1.1.0/summary>                    ul>                      li>Updated the Android native module to use Veriff Android SDK 3.+/li>                      li>Enabled Java 8 support for Android./li>                      li>Added more granular error messages for NFC related errors./li>                    /ul>                /details>                                details>summary>Release 1.0.1/summary>                    ul>                      li>Fixed a NoSuchKeyException: branding error on Android if no customization was applied/li>                    /ul>                /details>                                details>summary>Release 1.0.0/summary>                    ul>                      li>Added support for UI customization/li>                    /ul>                /details>                                details>summary>Release 0.9.1/summary>                    ul>                      li>Updated README in npmjs.com/li>                    /ul>                /details>                                details>summary>Release 0.9.0/summary>                    ul>                      li>Initial React Native SDK release/li>                    /ul>                /details>                            /ul>        /div>    /details>/div>h2 idcordova-plugin>Cordova Plugin/h2>h3 idcordova-requirements>Cordova requirements/h3>p>Integration with Cordova plugin requires the project to target at least iOS version 11.0 and Android version 5.0 (API level 21) or higher./p>h3 idadd-the-plugin-to-a-project>Add the plugin to a project/h3>p>Add the Veriff Cordova plugin to your project:/p>pre classhighlight shell>code>cordova plugin add @veriff/cordova-plugin-veriff/code>/pre>p>Adding this plugin will make the code>window.cordova.plugins.Veriff/code> global object available once the code>deviceready/code> event propagates./p>h3 iddeclare-foreground-service-sync-for-google-play>Declare foreground service sync for Google Play/h3>p>The SDK declares and uses the code>FOREGROUND_SERVICE_DATA_SYNC/code>. If you distribute your application on Google Play,then you must a hrefhttps://support.google.com/googleplay/android-developer/answer/13392821?hlen#declare>declare the foreground service information in Play Console/a> ↗./p>p>The information required by Play Console is (as listed on the Google Play link above):/p>ol>li>strong>Provide a description of the app functionality that is using each foreground service type./strong>ul>li>The Veriff SDK uses the foreground service to upload end-user data to Veriff's servers for verification purposes./li>/ul>/li>li>strong>Describe the user impact if the task is deferred by the system (does not start immediately), and/or the task is interrupted by the system (paused and/or restarted)./strong>ul>li>If the task is deferred or interrupted by the system, the end-user verification will be delayed./li>/ul>/li>li>strong>Include a link to a video demonstrating each foreground service feature. The video should demonstrate the steps the user needs to take in your app in order to trigger the feature./strong>ul>li>Please record a video of your app's Veriff SDK integration./li>/ul>/li>li>strong>Choose your specific use case for each foreground service type./strong>ul>li>"Network transfer: Upload or download / Other"/li>/ul>/li>/ol>p>See also Veriff's note on a hrefhttps://www.veriff.com/data-collection-purposes>data collection purposes in your app/a> ↗/p>h3 idios-specific-setup>iOS Specific setup/h3>h4 idadd-usage-descriptions-to-application-info-plist>Add usage descriptions to application Info.plist/h4>blockquote>p>Not adding these usage descriptions causes system to kill application when it requests the permissions when needed./p>/blockquote>p>Veriff requires camera, microphone, photo library and optionally NFC reader permissions for capturing photos, video and scanning passport during identification. Your application is responsible to describe the reason why camera, microphone, photo library and NFC reader is used. You must add 3 descriptions listed below to ios platform in code>config.xml/code> of your application with the explanation of the usage./p>ul>li>code>NSCameraUsageDescription/code>/li>li>code>NSMicrophoneUsageDescription/code>/li>li>code>NSPhotoLibraryUsageDescription/code>/li>/ul>pre classhighlight xml tab-xml>code>        span classnt><config-file/span> span classna>target/span>span classs>*-Info.plist/span> span classna>parent/span>span classs>NSCameraUsageDescription/span>span classnt>>/span>            span classnt><string>/span>Access to camera is needed for user identification purposesspan classnt></string>/span>        span classnt></config-file>/span>        span classnt><config-file/span> span classna>target/span>span classs>*-Info.plist/span> span classna>parent/span>span classs>NSMicrophoneUsageDescription/span>span classnt>>/span>            span classnt><string>/span>Access to microphone is needed for video identificationspan classnt></string>/span>        span classnt></config-file>/span>        span classnt><config-file/span> span classna>target/span>span classs>*-Info.plist/span> span classna>parent/span>span classs>NSPhotoLibraryUsageDescription/span>span classnt>>/span>            span classnt><string>/span>Access to photo library is needed uploading proof of address documentsspan classnt></string>/span>        span classnt></config-file>/span>/code>/pre>h4 idadd-required-steps-for-nfc-scanning>Add required steps for NFC scanning/h4>ol>li>Add code>NFCReaderUsageDescription/code> description to ios platform inside code>config.xml/code>./li>/ol>pre classhighlight xml tab-xml>code>        span classnt><config-file/span> span classna>target/span>span classs>*-Info.plist/span> span classna>parent/span>span classs>NFCReaderUsageDescription/span>span classnt>>/span>            span classnt><string>/span>Access to NFC is needed for user identification purposesspan classnt></string>/span>        span classnt></config-file>/span>/code>/pre>ol>li>p>The application needs to define the list of application IDs or AIDs it can connect to, in the Info.plist file. The AID is a way of uniquely identifying an application on a ISO 7816 tag, which is usually defined by a standard./p>pre classhighlight plaintext>code><config-file target*-Info.plist parentcom.apple.developer.nfc.readersession.iso7816.select-identifiers>    <array>        <string>A0000002471001</string>        <string>A0000002472001</string>        <string>00000000000000</string>    </array></config-file>/code>/pre>/li>li>p>Introduce a new entitlement for NFC scanning, a feature made available from iOS 13 onwards. Xcode automatically adds this entitlement when you activate the Near Field Communication Tag Reading feature in the target Signing & Capabilities. Following the activation of this feature, the *.entitlements file should include the TAG format. If your application is intended to support iOS versions prior to iOS 13, the NDEF format is mandatory. However, for applications targeting iOS 13 and later, there is no need to add the NDEF format to the entitlements./p>pre classhighlight plaintext>code><config-file target**/Entitlements.plist parentcom.apple.developer.nfc.readersession.formats>    <array>        <string>TAG</string>        <string>NDEF</string>    </array></config-file>/code>/pre>/li>/ol>h4 idset-the-ios-target-in-xcode>Set the iOS target in Xcode/h4>p>Make sure that the 'iOS Deployment Target' in Xcode (under Project > target > Info > Deployment Target) is set to iOS 12.4 or later./p>h3 idusing-the-veriff-cordova-plugin>Using the Veriff Cordova plugin/h3>h4 idstarting-the-verification-flow>Starting the verification flow/h4>p>The Veriff Plugin has a single function to start a verification attempt: code>start(callback, sessionUrl, configuration)/code>/p>ul>li>code>callback/code> (required) - a callback that will be invoked with the verification attempt result. The callback includes the result object which will have a code>status/code> field that is one of either code>Veriff.STATUS_DONE/code>, code>Veriff.STATUS_CANCELED/code> or code>Veriff.STATUS_ERROR/code>.br>Note that this is the strong>end-user flow completion status/strong>, meaning that it shows strong>whether the end-user was able to complete all the steps in the verification flow or not/strong>. It is not the verification session status.br>In case the code>status/code> is code>Veriff.STATUS_ERROR/code> there will be a error code (not human-readable) in the code>error/code> field./li>li>code>sessionUrl/code> (required) -  code>sessionUrl/code> can be received from your backend implementation. code>sessionUrl/code> should be unique for each call. Check code>/sessions/code> endpoint in the API documentation a hrefhttps://developers.veriff.com/#post-sessions>here/a> to learn how to generate one./li>li>code>configuration/code> (optional) - an object that allows the customization of the Veriff Plugin, including your brand's colors, font and logo. The supported properties are:ul>li>code>branding/code> (optional) - customize various branding options./li>li>code>locale/code> (optional) - override the user interface language (default: device language)./li>li>code>customIntroScreen/code> (optional) - Veriff supports replacing introduction screen with a custom client developed introduction screen for eligible customers./li>li>code>vendorData/code> (optional) - Veriff supports the option to override vendor data./li>/ul>/li>/ul>h3 iduser-interface-customization>User Interface customization/h3>p>You can customize Veriff SDK user interface in your application by defining your brand's colors, font and logo./p>p>See a href/images/Veriff-SDK-Customization.pdf target“_blank”>Veriff SDK customization guide/a> ↗ document on how it looks./p>p>Veriff Cordova plugin allows the customization of your brand's colors, font and logo in the SDK flow by passing in these optional properties when launching Veriff:/p>pre classhighlight javascript tab-javascript>code>span classnb>window/span>span classp>./span>span classnx>cordova/span>span classp>./span>span classnx>plugins/span>span classp>./span>span classnx>Veriff/span>span classp>./span>span classnx>start/span>span classp>(/span>    span classkd>function/span> span classp>(/span>span classnx>result/span>span classp>)/span> span classp>{/span>        span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs2>Veriff SDK result: status: /span> span classo>+/span> span classnx>result/span>span classp>./span>span classnx>status/span> span classo>+/span> span classs2>, error: /span> span classo>+/span> span classnx>result/span>span classp>./span>span classnx>error/span>span classp>);/span>    span classp>},/span>    span classnx>sessionUrl/span>span classp>,/span>    span classp>{/span>        span classna>branding/span>span classp>:/span> span classp>{/span>            span classna>logo/span>span classp>:/span> span classs1>parrot/span>span classp>,/span>            span classna>background/span>span classp>:/span> span classs1>#ff00ff/span>span classp>,/span>            span classna>onBackground/span>span classp>:/span> span classs1>#ffffff/span>span classp>,/span>            span classna>onBackgroundSecondary/span>span classp>:/span> span classs1>#ff00ff/span>span classp>,/span>            span classna>onBackgroundTertiary/span>span classp>:/span> span classs1>#000000/span>span classp>,/span>            span classna>primary/span>span classp>:/span> span classs1>#333333/span>span classp>,/span>            span classna>onPrimary/span>span classp>:/span> span classs1>#444444/span>span classp>,/span>            span classna>secondary/span>span classp>:/span> span classs1>#333333/span>span classp>,/span>            span classna>onSecondary/span>span classp>:/span> span classs1>#444444/span>span classp>,/span>            span classna>outline/span>span classp>:/span> span classs1>#444444/span>span classp>,/span>            span classna>cameraOverlay/span>span classp>:/span> span classs1>#59496a/span>span classp>,/span>            span classna>onCameraOverlay/span>span classp>:/span> span classs1>#e27e23/span>span classp>,/span>            span classna>error/span>span classp>:/span> span classs1>#333333/span>span classp>,/span>            span classna>success/span>span classp>:/span> span classs1>#444444/span>span classp>,/span>            span classna>buttonRadius/span>span classp>:/span> span classmi>28/span>span classp>,/span>            span classna>iOSFont/span>span classp>:/span> span classp>{/span>                span classna>regular/span>span classp>:/span> span classs1>Font-Regular/span>span classp>,/span>                span classna>medium/span>span classp>:/span> span classs1>Font-Medium/span>span classp>,/span>                span classna>bold/span>span classp>:/span> span classs1>Font-Bold/span>span classp>,/span>            span classp>},/span>            span classna>androidFont/span>span classp>:/span> span classp>{/span>                span classna>regular/span>span classp>:/span> span classs1>font_regular.ttf/span>span classp>,/span>                span classna>medium/span>span classp>:/span> span classs1>font-medium.ttf/span>span classp>,/span>                span classna>bold/span>span classp>:/span> span classs1>font_bold.ttf/span>span classp>,/span>            span classp>}/span>        span classp>}/span>    span classp>},/span>span classp>);/span>/code>/pre>p>When a color or a font isn't defined the default Veriff color or font is used. Same applies to the logo - when it isn't defined the default is used. The image assets need to be added into Xcode assets in the iOS project and into drawable folders in the Android project. In the example above you would need to add an image asset named 'parrot' into Xcode assets and 'parrot.png' to Android drawable folders in code>android/src/main/res/code>./p>h4 idsetting-the-user-interface-language>Setting the user interface language/h4>p>The Veriff Cordova plugin allows setting the language of the SDK. In order to use this language, please pass the locale as in example below;/p>pre classhighlight javascript tab-javascript>code>span classnb>window/span>span classp>./span>span classnx>cordova/span>span classp>./span>span classnx>plugins/span>span classp>./span>span classnx>Veriff/span>span classp>./span>span classnx>start/span>span classp>(/span>    span classkd>function/span> span classp>(/span>span classnx>result/span>span classp>)/span> span classp>{/span>        span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs2>Veriff SDK result: status: /span> span classo>+/span> span classnx>result/span>span classp>./span>span classnx>status/span> span classo>+/span> span classs2>, error: /span> span classo>+/span> span classnx>result/span>span classp>./span>span classnx>error/span>span classp>);/span>    span classp>},/span>    span classnx>sessionUrl/span>span classp>,/span>    span classp>{/span>        span classna>locale/span>span classp>:/span> span classs1>et/span>    span classp>}/span>span classp>);/span>/code>/pre>h4 idcustom-intro-screen>Custom intro screen/h4>p>Veriff supports replacing introduction screen with a custom client developed introduction screen for eligible customers. Please request this from your solutions engineer. The removal process is following:/p>ul>li>Agree your own introduction screen visuals and copy with our solutions engineer and get relevant legal documents signed;/li>li>Veriff will enable custom introduction screen for your integrations;/li>li>After you have implemented your own introduction screen you can change the configuration option as specified below;/li>/ul>pre classhighlight javascript tab-javascript>code>span classnb>window/span>span classp>./span>span classnx>cordova/span>span classp>./span>span classnx>plugins/span>span classp>./span>span classnx>Veriff/span>span classp>./span>span classnx>start/span>span classp>(/span>    span classkd>function/span> span classp>(/span>span classnx>result/span>span classp>)/span> span classp>{/span>        span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs2>Veriff SDK result: status: /span> span classo>+/span> span classnx>result/span>span classp>./span>span classnx>status/span> span classo>+/span> span classs2>, error: /span> span classo>+/span> span classnx>result/span>span classp>./span>span classnx>error/span>span classp>);/span>    span classp>},/span>    span classnx>sessionUrl/span>span classp>,/span>    span classp>{/span>        span classna>customIntroScreen/span>span classp>:/span> span classkc>true/span>    span classp>}/span>span classp>);/span>/code>/pre>h4 idvendor-data>Vendor data/h4>p>Veriff supports the option to override vendor data. Please check with your strong>Solutions Engineer/strong> to confirm if this feature can be enabled for your integration. If it is possible, follow these steps:/p>ol>li>Veriff will enable vendor data overriding from the backend for your integrations./li>li>Modify the configuration option as specified below./li>/ol>pre classhighlight javascript tab-javascript>code>span classnb>window/span>span classp>./span>span classnx>cordova/span>span classp>./span>span classnx>plugins/span>span classp>./span>span classnx>Veriff/span>span classp>./span>span classnx>start/span>span classp>(/span>    span classkd>function/span> span classp>(/span>span classnx>result/span>span classp>)/span> span classp>{/span>        span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs2>Veriff SDK result: status: /span> span classo>+/span> span classnx>result/span>span classp>./span>span classnx>status/span> span classo>+/span> span classs2>, error: /span> span classo>+/span> span classnx>result/span>span classp>./span>span classnx>error/span>span classp>);/span>    span classp>},/span>    span classnx>sessionUrl/span>span classp>,/span>    span classp>{/span>        span classna>vendorData/span>span classp>:/span> span classs1>Vendor Data/span>span classp>,/span>    span classp>}/span>span classp>);/span>/code>/pre>h3 idhandling-the-result-from-the-sdk>Handling the result from the SDK/h3>p>The code>result/code> returned by code>Veriff.start/code> will have a code>status/code> field that is one of either code>Veriff.STATUS_DONE/code>, code>Veriff.STATUS_CANCELED/code> or code>Veriff.STATUS_ERROR/code>./p>p>Note that this is the strong>end-user flow completion status/strong>, meaning that it shows strong>whether the end-user was able tocomplete all the steps in the verification flow or not/strong>. It is not the verification session status./p>p>In case of code>Veriff.STATUS_ERROR/code> there will be a error code (not human-readable) in the code>error/code> field./p>pre classhighlight javascript tab-javascript>code>span classnb>window/span>span classp>./span>span classnx>cordova/span>span classp>./span>span classnx>plugins/span>span classp>./span>span classnx>Veriff/span>span classp>./span>span classnx>start/span>span classp>(/span>    span classkd>function/span> span classp>(/span>span classnx>result/span>span classp>)/span> span classp>{/span>        span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs2>Veriff SDK result: status: /span> span classo>+/span> span classnx>result/span>span classp>./span>span classnx>status/span> span classo>+/span> span classs2>, error: /span> span classo>+/span> span classnx>result/span>span classp>./span>span classnx>error/span>span classp>);/span>        span classk>switch/span> span classp>(/span>span classnx>result/span>span classp>./span>span classnx>status/span>span classp>)/span> span classp>{/span>            span classk>case/span> span classnx>STATUS_DONE/span>span classp>:/span>                span classc1>// end-user submitted the images and completed the flow/span>                span classc1>// note that this does not mean a final decision yet/span>                span classk>break/span>span classp>;/span>            span classk>case/span> span classnx>STATUS_CANCELED/span>span classp>:/span>                span classc1>// end-user canceled the flow before completing/span>                span classk>break/span>span classp>;/span>            span classk>case/span> span classnx>STATUS_ERROR/span>span classp>:/span>                span classc1>// the flow could not be completed due to an error/span>                span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs2>Veriff verification failed with error/span> span classo>+/span> span classnx>result/span>span classp>./span>span classnx>error/span>span classp>);/span>                span classk>switch/span> span classp>(/span>span classnx>result/span>span classp>./span>span classnx>error/span>span classp>)/span> span classp>{/span>                    span classk>case/span> span classnx>UNABLE_TO_ACCESS_CAMERA/span>span classp>:/span>                        span classc1>// unable to access camera, likely due to no permission/span>                        span classk>break/span>span classp>;/span>                    span classk>case/span> span classnx>UNABLE_TO_ACCESS_MICROPHONE/span>span classp>:/span>                        span classc1>// unable to access camera, likely due to no permission/span>                        span classk>break/span>span classp>;/span>                    span classk>case/span> span classnx>NETWORK_ERROR/span>span classp>:/span>                        span classk>break/span>span classp>;/span>                    span classk>case/span> span classnx>SESSION_ERROR/span>span classp>:/span>                        span classk>break/span>span classp>;/span>                    span classk>case/span> span classnx>UNKNOWN_ERROR/span>span classp>:/span>                        span classk>break/span>span classp>;/span>                    span classk>case/span> span classnx>UNSUPPORTED_SDK_VERSION/span>span classp>:/span>                        span classk>break/span>span classp>;/span>                span classp>}/span>                span classk>break/span>span classp>;/span>        span classp>}/span>    span classp>},/span>    span classnx>sessionUrl/span>span classp>);/span>/code>/pre>h2 idjavascript-sdk>Javascript SDK/h2>p>Veriff JS SDK is a simple and customizable library, making it a convenient way to include Veriff's web flow to yoursolution./p>p>The purpose of the JS SDK is to strong>create the session URL/strong> for your end-user's verification session./p>p>Once you have the URL, you have two options to direct the user to the verification flow:/p>ul>li>Use the a href/#integrate-by-redirection>redirect/a> solution/li>li>Trigger the a href/#integrate-by-redirection>InContext SDK/a> solution/li>/ul>h3 idinstall-js-sdk>Install JS SDK/h3>p>Include as a script tag:/p>pre classhighlight html tab-html>code>span classnt><script /span>span classna>src/span>span classs>https://cdn.veriff.me/sdk/js/1.5/veriff.min.js/span>span classnt>></script>/span>/code>/pre>p>or install it via a package manager/p>pre classhighlight shell>code>  span classnv>$ /span>npm install --save @veriff/js-sdk/code>/pre>pre classhighlight javascript tab-javascript>code>   span classc1>// CommonJS/span>  span classkr>const/span> span classnx>Veriff/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@veriff/js-sdk/span>span classp>);/span>  span classc1>// ES6 style import/span>  span classkr>import/span> span classp>{/span> span classnx>Veriff/span> span classp>}/span> span classnx>from/span> span classs1>@veriff/js-sdk/span>span classp>;/span>/code>/pre>h3 idadding-js-sdk>Adding JS SDK/h3>p>Veriff JS SDK requires one parent element in HTML:/p>pre classhighlight html tab-html>code>span classnt><div/span> span classna>id/span>span classs>veriff-root/span>span classnt>></div>/span>/code>/pre>p>It is possible to set the width of js-sdk form through style attribute:/p>pre classhighlight html tab-html>code>span classnt><div/span> span classna>id/span>span classs>veriff-root/span> span classna>style/span>span classs>width:400px/span>span classnt>></div>/span>/code>/pre>p>In order to initialize the library, em>API Key/em>, em>parentId/em> and em>onSession/em> callback function is required.Parameters are defined as below:/p>table>thead>tr>th>Parameters/th>th>Description/th>/tr>/thead>tbody>tr>td>code>apiKey/code>/td>td>Required parameter. See how to find your API keys a href/#prerequisites-to-create-api-requests>here/a> to learn how to generate one./td>/tr>tr>td>code>parentId/code>/td>td>Required parameter. 'veriff-root'/td>/tr>tr>td>code>onSession/code>/td>td>Required parameter. The end-user can be redirected either to the verification url or a href/#incontext-javascript-sdk>incontext SDK/a> can be triggered/td>/tr>/tbody>/table>pre classhighlight javascript tab-javascript>code>  span classkr>const/span> span classnx>veriff/span> span classo>/span> span classnx>Veriff/span>span classp>({/span>    span classna>apiKey/span>span classp>:/span> span classs1>API_KEY/span>span classp>,/span>    span classna>parentId/span>span classp>:/span> span classs1>veriff-root/span>span classp>,/span>    span classna>onSession/span>span classp>:/span> span classkd>function/span>span classp>(/span>span classnx>err/span>span classp>,/span> span classnx>response/span>span classp>)/span> span classp>{/span>      span classc1>// received the response, verification can be started / triggered now/span>      span classc1>// redirect/span>      span classnb>window/span>span classp>./span>span classnx>location/span>span classp>./span>span classnx>href/span> span classo>/span> span classnx>response/span>span classp>./span>span classnx>verification/span>span classp>./span>span classnx>url/span>span classp>;/span>      span classc1>// incontext sdk/span>      span classnx>createVeriffFrame/span>span classp>({/span>span classna>url/span>span classp>:/span> span classnx>response/span>span classp>./span>span classnx>verification/span>span classp>./span>span classnx>url/span>span classp>});/span>    span classp>}/span>  span classp>});/span>  span classnx>veriff/span>span classp>./span>span classnx>mount/span>span classp>();/span>/code>/pre>p>Read more about a href#incontext-javascript-sdk>incontext sdk method/a> or a href#integrate-by-redirection>redirection/a>./p>p>By default, the following form will be rendered:/p>p>img srcimages/jssdk-default-sample.png altJSSDKDEFAULT />/p>p>em>onSession/em> function is executed after the em>response/em> is received from the API, response body contains a verification object with following schema:/p>pre classhighlight json tab-json>code>span classw>    /span>span classp>{/span>span classw>      /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>      /span>span classs2>verification/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>          /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>UUID V4 Identifying the verification/span>span classp>,/span>span classw>          /span>span classs2>url/span>span classp>:/span>span classw> /span>span classs2>full url to which a person should be redirected in order to proceed with verification flow/span>span classp>,/span>span classw>          /span>span classs2>host/span>span classp>:/span>span classw> /span>span classs2>hostname/span>span classp>,/span>span classw>          /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>status of the verification/span>span classp>,/span>span classw>          /span>span classs2>sessionToken/span>span classp>:/span>span classw> /span>span classs2>JWT encoded verification token/span>span classw>      /span>span classp>}/span>span classw>  /span>span classp>}/span>span classw>/span>/code>/pre>p>code>vendorData/code>: string - customer-specific data string, max 1000 characters long, will be sent back unmodified using webhooks.We require only non-semantic data to be submitted (UUID-s etc., that can not be resolved or used outside the customer's domain).In case the Given name / Last name / Vendor Data or all of them are known, they can be passed to the SDK, therefore text input fields will not be rendered./p>pre classhighlight javascript tab-javascript>code>  span classkr>const/span> span classnx>veriff/span> span classo>/span> span classnx>Veriff/span>span classp>({/span>    span classna>apiKey/span>span classp>:/span> span classs1>API_KEY/span>span classp>,/span>    span classna>parentId/span>span classp>:/span> span classs1>veriff-root/span>span classp>,/span>    span classna>onSession/span>span classp>:/span> span classkd>function/span>span classp>(/span>span classnx>err/span>span classp>,/span> span classnx>response/span>span classp>)/span> span classp>{/span>      span classc1>// received the response, verification can be started now/span>    span classp>}/span>  span classp>});/span>  span classnx>veriff/span>span classp>./span>span classnx>setParams/span>span classp>({/span>    span classna>person/span>span classp>:/span> span classp>{/span>      span classna>givenName/span>span classp>:/span> span classs1>Foo/span>span classp>,/span>      span classna>lastName/span>span classp>:/span> span classs1>Bar/span>    span classp>},/span>    span classna>vendorData/span>span classp>:/span> span classs1>7eb19312-79d6-11ec-90d6-0242ac120003/span>  span classp>});/span>  span classnx>veriff/span>span classp>./span>span classnx>mount/span>span classp>({/span>    span classna>submitBtnText/span>span classp>:/span> span classs1>Get verified/span>  span classp>});/span>/code>/pre>p>img srcimages/jssdk-only-button-sample.png altJSSDKONLYBUTTON />/p>p>It is possible to disable fields rendering without passing any data by not including anything in corresponding value:/p>pre classhighlight javascript tab-javascript>code>  span classkr>const/span> span classnx>veriff/span> span classo>/span> span classnx>Veriff/span>span classp>({/span>    span classna>apiKey/span>span classp>:/span> span classs1>API_KEY/span>span classp>,/span>    span classna>parentId/span>span classp>:/span> span classs1>veriff-root/span>span classp>,/span>    span classna>onSession/span>span classp>:/span> span classkd>function/span>span classp>(/span>span classnx>err/span>span classp>,/span> span classnx>response/span>span classp>)/span> span classp>{/span>      span classc1>// received the response, verification can be started now/span>    span classp>}/span>  span classp>});/span>  span classnx>veriff/span>span classp>./span>span classnx>setParams/span>span classp>({/span>    span classna>person/span>span classp>:/span> span classp>{/span>      span classna>givenName/span>span classp>:/span> span classs1> /span>span classp>,/span>      span classna>lastName/span>span classp>:/span> span classs1> /span>    span classp>},/span>    span classna>vendorData/span>span classp>:/span> span classs1> /span>  span classp>});/span>  span classnx>veriff/span>span classp>./span>span classnx>mount/span>span classp>({/span>    span classna>submitBtnText/span>span classp>:/span> span classs1>Get verified/span>  span classp>});/span>/code>/pre>p>Additionally the input placeholder and button text value can be customised./p>pre classhighlight javascript tab-javascript>code>  span classkr>const/span> span classnx>veriff/span> span classo>/span> span classnx>Veriff/span>span classp>({/span>    span classna>apiKey/span>span classp>:/span> span classs1>API_KEY/span>span classp>,/span>    span classna>parentId/span>span classp>:/span> span classs1>veriff-root/span>span classp>,/span>    span classna>onSession/span>span classp>:/span> span classkd>function/span>span classp>(/span>span classnx>err/span>span classp>,/span> span classnx>response/span>span classp>)/span> span classp>{/span>      span classc1>// received the response, verification can be started now/span>    span classp>}/span>  span classp>});/span>  span classnx>veriff/span>span classp>./span>span classnx>mount/span>span classp>({/span>    span classna>formLabel/span>span classp>:/span> span classp>{/span>      span classna>givenName/span>span classp>:/span> span classs1>First name/span>span classp>,/span>      span classna>lastName/span>span classp>:/span> span classs1>Family name/span>span classp>,/span>      span classna>vendorData/span>span classp>:/span> span classs1>Unique id of an end-user/span>    span classp>},/span>    span classna>submitBtnText/span>span classp>:/span> span classs1>Get verified/span>span classp>,/span>    span classna>loadingText/span>span classp>:/span> span classs1>Please wait.../span>  span classp>});/span>/code>/pre>p>img srcimages/jssdk-custom-sample.png altJSSDKCUSTOM />/p>h3 idadding-viewport-meta-tag>Adding viewport meta tag/h3>p>The strong>viewport meta tag/strong> is crucial for proper rendering and layout on mobile devices. If this meta tag is missing,the website may be rendered too small on mobile devices./p>p>Make sure to add the following tag to mitigate such issues:/p>pre classhighlight plaintext>code><meta nameviewport contentwidthdevice-width, initial-scale1.0>/code>/pre>h2 idincontext-javascript-sdk>InContext Javascript SDK/h2>p>Use this if you would like to use incontext UI./p>h3 idinstall-incontext-js-sdk>Install InContext JS SDK/h3>pre classhighlight shell>code>npm install @veriff/incontext-sdk/code>/pre>h3 idadding-incontext-js-sdk>Adding InContext JS SDK/h3>p>You need to have a Veriff session URL generated before initializing the SDK.Please see a href#using-the-api-to-generate-a-session-for-the-sdk>our documentation/a> to learn how to generate one, or use oura href#javascript-sdk>JavaScript SDK/a> to create it./p>pre classhighlight javascript tab-javascript>code>span classc1>// ES6/span>span classkr>import/span> span classp>{/span> span classnx>createVeriffFrame/span> span classp>}/span> span classnx>from/span> span classs1>@veriff/incontext-sdk/span>span classp>;/span>span classc1>// CommonJS/span>span classkr>const/span> span classp>{/span> span classnx>createVeriffFrame/span> span classp>}/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@veriff/incontext-sdk/span>span classp>);/span>span classkr>const/span> span classnx>veriffFrame/span> span classo>/span> span classnx>createVeriffFrame/span>span classp>({/span> span classna>url/span>span classp>:/span> span classnx>VERIFF_SESSION_URL/span> span classp>})/span>/code>/pre>p>This will render a modal with adapted Veriff application in iframe./p>p>code>createVeriffFrame()/code> returns an object that controls the modal./p>h3 idlistening-for-events>Listening for events/h3>p>Pass code>onEvent/code> callback function when initializing SDK/p>pre classhighlight javascript tab-javascript>code>span classkr>import/span> span classp>{/span> span classnx>createVeriffFrame/span>span classp>,/span> span classnx>MESSAGES/span> span classp>}/span> span classnx>from/span> span classs1>@veriff/incontext-sdk/span>span classp>;/span>span classnx>createVeriffFrame/span>span classp>({/span>  span classnx>url/span>span classp>,/span>  span classna>onEvent/span>span classp>:/span> span classkd>function/span>span classp>(/span>span classnx>msg/span>span classp>)/span> span classp>{/span>    span classk>switch/span>span classp>(/span>span classnx>msg/span>span classp>)/span> span classp>{/span>      span classk>case/span> span classnx>MESSAGES/span>span classp>./span>span classna>CANCELED/span>span classp>:/span>        span classc1>///span>        span classk>break/span>span classp>;/span>    span classp>}/span>  span classp>}/span>span classp>})/span>/code>/pre>ul>li>code>msg/code>:ul>li>code>STARTED/code> - session status changed to 'started'/li>li>code>CANCELED/code> - end-user closed the modal/li>li>code>FINISHED/code> - end-user finished verification flow/li>/ul>/li>/ul>p>Note that this sends you the strong>end-user flow completion status/strong>, meaning that it shows strong>whether the end-user was able tocomplete all the steps in the verification flow or not/strong>. It does not send the verification session status./p>h3 idusing-with-inline-script>Using with inline script/h3>p>Include a script tag:/p>pre classhighlight html tab-html>code>span classnt><script /span>span classna>src/span>span classs>https://cdn.veriff.me/incontext/js/v1/veriff.js/span>span classnt>></script>/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classnb>window/span>span classp>./span>span classnx>veriffSDK/span>span classp>./span>span classnx>createVeriffFrame/span>span classp>({/span> span classna>url/span>span classp>:/span> span classnx>VERIFF_SESSION_URL/span> span classp>});/span>/code>/pre>h3 idoptions>Options/h3>pre classhighlight javascript tab-javascript>code>span classnx>createVeriffFrame/span>span classp>(/span>span classnx>options/span>span classp>)/span>/code>/pre>ul>li>code>options/code> - Configuration object:ul>li>code>url/code> - Veriff session URL/li>li>code>lang/code> - Override user interface a href#supported-languages>language/a>/li>li>code>onEvent/code> - Event callback function/li>li>code>onReload/code> - Reload request callback - handle reloading the webpage and reopening the SDK/li>/ul>/li>/ul>h3 idclose-veriff-modal>Close Veriff modal/h3>p>Normally modal will be closed due to end-user input, but if you want to control it(e.g. timeout), please use this function./p>pre classhighlight javascript tab-javascript>code>span classnx>veriffFrame/span>span classp>./span>span classnx>close/span>span classp>();/span>/code>/pre>h3 idonreload>onReload/h3>p>This callback can be called on some browsers when the end-user has denied camera access and to re-request access the host page has to be reloaded./p>p>For best UX we recommend reloading the webpage & reopening Veriff InContext SDK automatically./p>p>Example:/p>pre classhighlight javascript tab-javascript>code>span classkr>const/span> span classnx>url/span> span classo>/span> span classnx>sessionStorage/span>span classp>./span>span classnx>getItem/span>span classp>(/span>span classs1>@veriff-session-url/span>span classp>)/span> span classo>||/span> span classnx>getSessionUrl/span>span classp>()/span>span classnx>veriffSDK/span>span classp>./span>span classnx>createVeriffFrame/span>span classp>({/span>  span classnx>url/span>span classp>,/span>  span classna>onReload/span>span classp>:/span> span classp>()/span> span classo>>/span> span classp>{/span>    span classc1>// Logic to re-open Veriff SDK after page reload/span>    span classc1>// e.g. sessionStorage.setItem(@veriff-session-url, url);/span>    span classnb>window/span>span classp>./span>span classnx>location/span>span classp>./span>span classnx>reload/span>span classp>();/span>  span classp>},/span>span classp>});/span>/code>/pre>h3 idadding-content-security-policy-to-incontext-sdk>Adding Content Security Policy to InContext SDK/h3>p>In order to improve the security, add the following CSP directives headers to em>index.html/em> file, under the code><meta>/code> tag:/p>pre classhighlight html tab-html>code>Content-Security-Policy default-src self *.veriff.me *.veriff.com;script-src self *.veriff.me *.veriff.com *.hotjar.com *.probity.io;img-src blob: self *.probity.io;frame-src self *.hotjar.com;connect-src self *.veriff.com *.veriff.me *.probity.io;style-src self *.veriff.com *.veriff.me;/code>/pre>p>For example:/p>p>pre classhighlight html tab-html>code>span classcp><!DOCTYPE html>/span>span classnt><html/span> span classna>lang/span>span classs>"en"/span>span classnt>>/span>span classnt><head>/span>span classnt><meta/span> span classna>http-equiv/span>span classs>"content-security-policy"/span> span classna>content/span>span classs>"default-src 'self' *.veriff.me *.veriff.com;script-src 'self' *.veriff.me *.veriff.com *.hotjar.com *.probity.io;img-src blob: 'self' *.probity.io;frame-src 'self' *.hotjar.com;connect-src 'self' *.veriff.com *.veriff.me *.probity.io;style-src 'self' *.veriff.com *.veriff.me;"/span>span classnt>>/span>span classnt></head>/span>/code>/pre>h3 idallow-camera-requests-in-your-permissions-policy>Allow camera requests in your Permissions Policy/h3>p>To avoid any issues, make sure that you allow Veriff to request camera access. If your Permissions Policy denies camera requests by default, you may encounter issues when using the InContext SDK.For more information, please read the a hrefhttps://github.com/w3c/webappsec-permissions-policy/blob/main/permissions-policy-explainer.md>W3C Permissions Policy Explainer/a> ↗./p>/p>h2 idintegrate-by-redirection>Integrate by Redirection/h2>p>In case you would like to opt out of modal based approach by using our a href#incontext-javascript-sdk>incontext sdk/a>you can instead redirect end-users to the verification flow./p>h3 idusing-redirection>Using redirection/h3>p>You need to have a Veriff session URL generated before redirecting the end-user to the flow. See a href#using-the-api-to-generate-a-session-for-the-sdk>our documentation/a> to learn how to generate one, or use oura href#javascript-sdk>JavaScript SDK/a> to create it./p>p>pre classhighlight javascript tab-javascript>code>span classc1>// After receiving the url you could redirect end-users there by using following/span>span classnb>window/span>span classp>./span>span classnx>location/span>span classp>./span>span classnx>href/span> span classo>/span> span classnx>url/span>span classp>;/span>/code>/pre>h3 idquery-parameters>Query parameters/h3>p>Available parameters that can be changed;/p>/p>table>thead>tr>th>Parameters/th>th>Description/th>/tr>/thead>tbody>tr>td>code>lang/code>/td>td>Optional parameter. code>lang/code> can be used to override the end-user interface's a href#supported-languages>language/a>./td>/tr>/tbody>/table>h2 idsdk-support-policy>SDK Support Policy/h2>p>strong>Support Policy for Veriff SDKs/strong>/p>p>Identity verification software, practices, and regulations move fast. To keep our software user-friendly, and maintain high conversion rates for our customers, our development team needs to be faster. To deliver an increasingly smarter, better and safer product, it's important to drop backward compatibility layers and update SDKs strong>at least once every three months/strong>. Our SDKs are strong>updated every two weeks/strong>, and downloading new releases will keep your verification process smooth and error-free. All releases are fully tested by our team and before being deployed, and come with the support from our team in the form of: /p>ul>li>p>SDK support for 6 months after release, including:/p>ul>li>Fixing all reported bugs in the upcoming SDK release/li>li>Fixing critical bugs in any final version before a major release for strong>three months/strong>/li>li>In case an SDK release requires major implementation efforts, then the old version will be supported for strong>one year/strong>/li>/ul>/li>li>p>Notifications before major changes to SDK support such as:/p>ul>li>Dropping support for an SDK version, where we will inform you via email one month in advance/li>li>The end of the one-month grace period, after which Veriff will block future use of a specified SDK version/li>li>When end-users engage with outdated SDKs, they will receive a prompt to upgrade the host application/li>/ul>/li>/ul>p>strong>SDK release versioning/strong>To help you keep track of SDK releases, Veriff uses three numbers to represent the scale of the updates. Each release is assigned either X, Y, or Z according to the following descriptions:/p>ul>li>strong>Major Release (X)/strong> - These releases may require addtional development efforts, and often come with large-scale improvements to the SDK/li>li>strong>Minor Release (Y)/strong> - These do not come with any mandatory development efforts on your end, but may include new functionalities that require development efforts to be activated/li>li>strong>Bug-fix Release (Z)/strong> - These resolve issues from the previous release and do not introduce any new features or improvements/li>/ul>h2 idsupported-languages>Supported languages/h2>p>Supported languages are as below;/p>table>thead>tr>th>Language Code/th>th>Name/th>/tr>/thead>tbody>tr>td>code>ar/code>/td>td>العربية/td>/tr>tr>td>code>bg/code>/td>td>Български/td>/tr>tr>td>code>bn/code>/td>td>বাংলা/td>/tr>tr>td>code>ca/code>/td>td>Català/td>/tr>tr>td>code>cs/code>/td>td>Čeština/td>/tr>tr>td>code>da/code>/td>td>Dansk/td>/tr>tr>td>code>de/code>/td>td>Deutsch/td>/tr>tr>td>code>el/code>/td>td>Ελληνικά/td>/tr>tr>td>code>et/code>/td>td>Eesti/td>/tr>tr>td>code>en/code>/td>td>English/td>/tr>tr>td>code>es/code>/td>td>Español (España)/td>/tr>tr>td>code>es-latam/code>/td>td>Español (Latinoamérica)/td>/tr>tr>td>code>es-mx/code>/td>td>Español (México)/td>/tr>tr>td>code>fi/code>/td>td>Suomi/td>/tr>tr>td>code>fil/code>/td>td>Filipino/td>/tr>tr>td>code>fr/code>/td>td>Français/td>/tr>tr>td>code>hi/code>/td>td>हिंदी/td>/tr>tr>td>code>hr/code>/td>td>Hrvatski/td>/tr>tr>td>code>hu/code>/td>td>Magyar/td>/tr>tr>td>code>id/code>/td>td>Bahasa Indonesia/td>/tr>tr>td>code>it/code>/td>td>Italiano/td>/tr>tr>td>code>ja/code>/td>td>日本語/td>/tr>tr>td>code>ka/code>/td>td>ქართული/td>/tr>tr>td>code>ko/code>/td>td>한국어/td>/tr>tr>td>code>lv/code>/td>td>Latviešu/td>/tr>tr>td>code>lt/code>/td>td>Lietuvių/td>/tr>tr>td>code>mk/code>/td>td>Македонски/td>/tr>tr>td>code>ms/code>/td>td>Bahasa Melayu/td>/tr>tr>td>code>nb/code>/td>td>Norsk (Bokmål)/td>/tr>tr>td>code>nl/code>/td>td>Nederlands/td>/tr>tr>td>code>pl/code>/td>td>Polski/td>/tr>tr>td>code>pt/code>/td>td>Português (Brasil)/td>/tr>tr>td>code>pt-pt/code>/td>td>Português (Portugal)/td>/tr>tr>td>code>ro/code>/td>td>Română/td>/tr>tr>td>code>ru/code>/td>td>Русский/td>/tr>tr>td>code>si/code>/td>td>සිංහල/td>/tr>tr>td>code>sk/code>/td>td>Slovenčina/td>/tr>tr>td>code>sl/code>/td>td>Slovenski/td>/tr>tr>td>code>so/code>/td>td>Af-soomaali/td>/tr>tr>td>code>sr/code>/td>td>Srpski/td>/tr>tr>td>code>sv/code>/td>td>Svenska/td>/tr>tr>td>code>tr/code>/td>td>Türkçe/td>/tr>tr>td>code>th/code>/td>td>ไทย/td>/tr>tr>td>code>uk/code>/td>td>Українська/td>/tr>tr>td>code>vi/code>/td>td>Tiếng Việt/td>/tr>tr>td>code>zh/code>/td>td>简体中文/td>/tr>tr>td>code>zh-hant/code>/td>td>繁體中文/td>/tr>tr>td>code>hy/code>/td>td>հայերեն/td>/tr>/tbody>/table>h2 idsessions-lifecycle-diagram-sdk>Sessions lifecycle diagram (SDK)/h2>p>img srcimages/SDK_sessions_lifecycle_diagram.png altSDK sessions lifecycle diagram />/p>h1 idapi-guide>API Guide/h1>h2 idwhy-use-the-api>Why use the API?/h2>p>There are a few scenarios where you may not wish to use Veriff's native or web SDKs to verify yourend-users. For example:/p>ul>li>You wish to completely implement your own front-end/li>li>You plan to collect end-users' media yourself/li>li>You wish to do an offline bulk audit of previously verified end-users/li>/ul>p>In those cases, you can do the whole process using our API and you will not show any Veriff front-end to yourend-users./p>h2 idcustomer-39-s-api-flow-in-a-nutshell>Customer's API flow in a nutshell/h2>p>strong>Create a verification session/strong>/p>p>The goal here is to create a new object (a verification session) that contains one verification, nested inside thesession object in the response. Also, you will receive the strong>session ID/strong>, which you need for the next step.(Guide: a href#using-the-api-to-generate-a-session-for-api>Using the API to generate a session for API/a>)/p>p>strong>Send end-user's media/strong>/p>p>Using the strong>session ID/strong>, pass the end-user's media (face, document front, document back, etc.) by uploading all images(and video if applicable) one by one using the POST request to a href#post-sessions-sessionid-media>sessions/{sessionId}/media/a>endpoint. The goal here is to upload the required photos and associate them with the strong>verification/strong> created in step 1./p>p>strong>Take advantage of the additional collected data/strong>/p>p>In order to further improve the IDV process, we strongly recommend you collect some additional end-user dataand send it to us via a href#post-sessions-sessionid-collected-data>POST /sessions/{sessionId}/collected-data/a>. This stepis not mandatory, but it is highly recommended./p>p>strong>Submit session for review/strong>/p>p>Once all the media and additional data has been uploaded, you then submit the verification session by sending the PATCH request toa href#patch-sessions-sessionid>PATCH /sessions/{sessionId}/a> and marking the strong>verification/strong> to code>submitted/code> status.Make sure that all the media has been submitted prior to triggering the PATCH request./p>p>strong>Wait for Veriff to verify the end-user/strong>/p>p>After these three steps, you have done your part, and the verification will then be taken care of by us./p>p>strong>Wait for webhook response/strong>/p>p>Veriff sends different types of webhooks for different event types using the POST method. For IDV, we send:/p>ul>li>The a href#event-webhook>event webhook/a> to notify you about the progress of the verification flow (events)/li>li>The a href#decision-webhook>decision webhook/a> with the verification session decision. It contains more data, includingthe verified identity information./li>/ul>h2 idprerequisites-to-use-the-api>Prerequisites to use the API/h2>p>In order to start sending media over the API, make sure that you:/p>ul>li>Created the integration in strong>the Veriff environment/strong> (guide a href#creating-an-integration>above/a>)/li>li>Configured the webhooks (guide a href#configuring-the-webhook-endpoint>below/a>)/li>li>Have all the necessary API keys, API URL and Headers at hand (guides below a href#prerequisites-to-create-api-requests>here/a>and a href#api-url-and-headers>here/a>)/li>li>You have made sure that you are able to handle the a href#backwards-compatible-changes>backwards compatible changes/a>/li>/ul>h2 idprerequisites-to-create-api-requests>Prerequisites to create API requests/h2>h3 idapi-keys>API keys/h3>p>Log in to Veriff's environment via the link in your sign-up email. Navigate to strong>Integrations/strong> page via the top menu andopen the strong>Integration/strong> you need. From there you need to take:/p>ul>li>the strong>API key/strong>, to use it as the strong>X-AUTH-CLIENT/strong> value in the strong>Header/strong>/li>li>the strong>shared secret key/strong>, to a href#generate-an-x-hmac-signature>create the strong>X-HMAC-SIGNATURE/strong> value/a> for the strong>Header/strong>/li>li>the strong>BaseURL/strong>, to create the strong>API URL/strong> for the request/li>/ul>p>img src../images/find_API_keys.png>/p>h3 idshared-secret-key-rotation>Shared secret key rotation/h3>p>It is possible to manage your strong>shared secret keys/strong> in strong>the Veriff environment/strong>. You can add and delete keys,and set the strong>master signature key/strong>./p>aside classnotice>The b>master signature key/b> is used to sign all webhooks sent by Veriff. The API responses will continue to beauthenticated with the same key used to initiate the request./aside>p>You can have up to 5 strong>shared secret keys/strong>./p>p>To manage the keys:/p>ol>li>Log in to strong>the Veriff environment/strong>/li>li>Click on the strong>Integrations/strong> on the top menu/li>li>Find and open the relevant integration/li>li>All the keys are displayed on the main page, under the strong>shared secret keys/strong> field/li>li>You can add a key using the strong>+ Add key/strong> button/li>li>Use the kebab menu button next to the key to promote it to the strong>master signature key/strong>, or to delete it/li>/ol>aside classnotice>If any of your keys has been compromised, you must delete it. If it is the b>master signature key/b>, first setanother key as the new master key, and then delete the compromised key./aside>h2 idapi-url-and-headers>API URL and Headers/h2>p>To create the strong>API URL/strong>, add code>v1/code> to the strong>Base URL/strong> value:/p>p>code>https://<Base-URL>/v1//code>/p>p>The list below shows basic strong>Headers/strong>. These are often needed to send requests, or are returned in responses:/p>pre classhighlight plaintext>code>X-AUTH-CLIENT: string (required) - API keyCONTENT-TYPE: string (required) - Media type of the resource (application/json)X-HMAC-SIGNATURE: string (required) - HMAC-SHA256 hex encoded keyed hash using your shared secret key/code>/pre>h2 idbackwards-compatible-changes>Backwards compatible changes/h2>p>All the changes listed below are considered to be backwards compatible by Veriff. Make sure to set up your systems insuch flexible manner that it is able to handle these changes./p>ul>li>Adding new properties (e.g., strings, objects, arrays) to existing API responses/li>li>Changing the order* of properties in existing API responses, i.e., the order of strings, objects, arrays/li>li>Adding new API resources, e.g., adding new API endpoints/li>li>Adding new optional request parameters to existing API endpoints/li>li>Changing the length or format of opaque** strings, such as error messages, object IDs, etc./li>li>Adding new event types to webhooks/li>li>Adding new properties (e.g., strings, objects, arrays) to webhook payloads/li>li>Webhook listener should gracefully handle unfamiliar event types/li>/ul>p>*As a general note on the order of properties in the responses, keep in mind that the order is not static. This meansthat the order you see in your API call responses may differ from the order you see in Veriff documentation./p>p>**This means data that your system should be able to just transmit or store, not interpret./p>h2 idapi-reference>API Reference/h2>h3 idendpoints>Endpoints/h3>!--- The following is a short list of endpoints, with links to their relevant sections -->p>strong>Available endpoints and methods:/strong>/p>ul>li> POST a href#post-sessions>/sessions/a>ul>li>POST a href#post-sessions-sessionid-media>/sessions/{sessionId}/media/a>/li>li>POST a href/#post-sessions-sessionid-collected-data>/sessions/{sessionId}/collected data/a>/li>li>PATCH a href#patch-sessions-sessionid>/sessions/{sessionId}/a>/li>li>GET a href#get-sessions-sessionid-attempts>/sessions/{sessionId}/attempts/a>/li>li>GET a href#get-sessions-sessionid-decision>/sessions/{sessionId}/decision/a>/li>li>GET a href#get-sessions-sessionid-person>/sessions/{sessionId}/person/a>/li>li>GET a href#get-sessions-sessionid-media>/sessions/{sessionId}/media/a>/li>li>GET a href#get-sessions-sessionid-watchlist-screening>/sessions/{sessionId}/watchlist-screening/a>/li>li>DELETE a href#delete-sessions-sessionid>/sessions/{sessionId}/a>/li>/ul>/li>li>GET a href#get-attempts-attemptid-media>/attempts/{attemptId}/media/a>/li>li>GET a href#get-media-mediaid>/media/{mediaId}/a>/li>li>GET a href#get-address-addressid-media>/address/{addressId}/media/a>/li>li>GET a href#get-address-media-mediaid>/address-media/{mediaId}/a>/li>li>POST a href#post-validate-registry>/validate-registry/a>/li>li>POST a href#post-sync-api-veriff-me-v1-validate-registry>/validate-registry-sync-api-v1/a>/li>li>POST a href/#post-sessions-sessionid-consents>/sessions/{sessionId}/consents/a>/li>li>GET a href#get-sessions-sessionid-decision-ine-registry>/sessions/{sessionId}/decision/ine-registry/a>/li>li>GET a href#get-sessions-sessionid-decision-ine-registry>/sessions/{sessionId}/decision/curp-registry/a>/li>li>GET a href#get-sessions-sessionid-decision-curp-registry>/sessions/{sessionId}/decision/combined-ine-curp-registr/a>/li>/ul>!--- The following is a list of endpoints in separate files --> h3 idpost-sessions>span classmethod method-post> POST /span> /sessions/h3>p>Creates a session with the data specified in the request strong>body/strong>./p>p>The customer sends end-user's data to Veriff, and in return receives a unique code>sessionId/code> and a unique code>sessionToken/code>that are related to the verification session initiated for the specific end-user./p>p>The strong>response/strong> also returns the strong>session URL/strong> value (required in the SDK integrations). You can find this in thecode>verification.url/code> parameter./p>p>You can find the sample implementation for Javascript at code>https://github.com/Veriff/js-integration-demo/code>/p>h4 idrequest>Request/h4>p>strong>Request method: POST/strong>br/>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers:/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>Content-Type: application/json/code>/p>h5 idrequest-properties-explained>Request properties explained/h5>ul>li>code>verification/code> : code>object/code> Verification objectul>li>code>callback/code>: code>string/code> The code>callbackUrl/code> to where the end-user is redirected after the verification session iscompleted. Default is visible in the Veriff environment > Settings. Changing the value in this request body willoverwrite the default code>callbackUrl/code>, but it will not change the code>callbackUrl/code> that  is visible in the Veriffenvironment./li>li>code>person/code>: code>object/code> Person to be verifiedul>li>code>firstName/code>: code>string/code> First name/li>li>code>lastName/code>: code>string/code> Last name/li>li>code>idNumber/code>: code>string/code> National identification number/li>li>code>gender/code>: code>string/code> Gender/li>li>code>dateOfBirth/code>: code>string/code> (YYYY-MM-DD) Date of birth/li>/ul>/li>li>code>document/code>: code>object/code> Document of a person to be verifiedul>li>code>number/code>: code>string/code> Document number, a-zA-Z0-9 characters only/li>li>code>country/code>: code>ISO-2/code> String Issuing country of the document/li>li>code>type/code>: code>string/code> (PASSPORT, ID_CARD, RESIDENCE_PERMIT, DRIVERS_LICENSE, VISA) Document type. a href#supported-document-types-for-idv>See the document types/a>/li>/ul>/li>li>code>address/code>: code>object/code> Address of a person to be verified. ul>li>code>fullAddress/code>: code>string/code> Full address (mandatory only for UK DIATF Medium profile flow)/li>/ul>/li>li>code>vendorData/code>: code>string/code> End-user-specific data string, max 1000 characters long, created by the customer. Sent backunmodified via API responses and webhooks, or as code>null/code> if not provided. We require only non-semantic data to be submitted(UUID-s etc.,) that can be user or resolved only inside your environments). Although it can have several use-cases,this is a recommended field to improve fraud mitigation./li>li>code>endUserId/code>: code>uuid | null/code> End-user-specific UUID created by the customer to identify the end-user. Returnedunmodified in webhooks and public API calls, or as code>null/code> if not provided. Recommended field for BiometricAuthentication, and a great alternative to code>vendorData/code>, especially if using the UUID format to createunique end-user identifiers./li>li>code>consents/code>: code>array/code> Array of objects listing the type of consent given. Optional, should be only included for featuresthat require consent (currently, only the a href#ine-biometric-database-verification>INE Biometric Database Verification/a>)ul>li>code>type/code>: code>string/code> Indicates the feature for which the consent is given/li>li>code>approved/code>: code>boolean/code> If code>true/code>, indicates that the consent has been given. code>true/code> is mandatory to startthe INE Biometric Database Verification. If code>false/code> or missing, the session is not created./li>/ul>/li>/ul>/li>/ul>aside classnotice>Customers who use Veriffs a href#pep-amp-sanction-screening-without-idv> b>PEP and Sanctions services without IDV/b>/a> over API must also include into request payload b>firstName/b>, b>lastName/b> and b>dateOfBirth/b>fields for session creation.br/>b>PEP and Sanctions/b> over API and b>Proof of Address/b> capture services need configuration fromyour solutions engineer./aside>aside classnotice>In the b>UK DIATF Certified Identity Verification Solution (Medium Level)/b> flow, thecode>verification.address.fullAddress/code> parameter is b>mandatory/b>.See a href#uk-diatf-certified-idv-medium-profile>here/a> for more info./aside>aside classnotice>b> Recommended code>vendorData/code> field/b>: when generating an IDV session, you are strongly recommended to include the code>vendorData/code> into the request payload to improve fraud mitigation. Veriff uses thecode>vendorData/code> field for a hrefhttps://help.veriff.com/en/articles/3410712-risk-labels-and-crosslinks>b>Cross Links/b>/a> ↗ and a hrefhttps://help.veriff.com/en/articles/4334413-velocity-abuse>b>Velocity Checks/b>/a> ↗. This helps Veriff identify if there is an existing session from the same user as well as if the same user is submitting multiple sessions./aside>aside classnotice>strong>The code>endUserId/code> parameter/strong>: this is a unique code>uuid/code> created by the customer fortheir end-user, and should be usable only inside the customers environments and only in relation to that specificend-user. It is always retruned unmodified in webhooks and public API calls, or as code>null/code> if not provided./br>It is recommended for Biometric Authentication solution, but can be used for other solutions as well.It should be preferred over code>vendorData/code>, especially in new integrations./aside>h5 idsample-request>Sample Request/h5>h6 idcurl>curl/h6>pre classhighlight plaintext>code>curl -X POST \  --url /v1/sessions/ \  -H Content-Type: application/json \  -H X-AUTH-CLIENT: API-PUBLIC-KEY \  -d {    verification: {        callback: https://veriff.com,        person: {            firstName: John,            lastName: Smith,            idNumber: 123456789        },        document: {            number: B01234567,            type: PASSPORT,            country: EE        },        address: {            fullAddress: Lorem Ipsum 30, 13612 Tallinn, Estonia        },        vendorData: 11111111,        endUserId: fa820aba-019f-455a-ae81-cfca8075bc3f,        consents:             {                type: ine,                approved: true            }            }}/code>/pre>h6 idnode-js>Node.js/h6>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>request/span>span classp>);/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>POST/span>span classp>,/span>  span classna>url/span>span classp>:/span> span classs1>/v1/sessions//span>span classp>,/span>  span classna>headers/span>span classp>:/span>   span classp>{/span> span classs1>Content-Type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span>     span classs1>X-AUTH-CLIENT/span>span classp>:/span> span classs1>API-PUBLIC-KEY/span> span classp>},/span>  span classna>body/span>span classp>:/span>   span classp>{/span> span classna>verification/span>span classp>:/span>      span classp>{/span> span classna>callback/span>span classp>:/span> span classs1>https://veriff.com/span>span classp>,/span>        span classna>person/span>span classp>:/span>         span classp>{/span> span classna>firstName/span>span classp>:/span> span classs1>John/span>span classp>,/span>           span classna>lastName/span>span classp>:/span> span classs1>Smith/span>span classp>,/span>           span classna>idNumber/span>span classp>:/span> span classs1>123456789/span> span classp>},/span>        span classna>document/span>span classp>:/span> span classp>{/span> span classna>number/span>span classp>:/span> span classs1>B01234567/span>span classp>,/span> span classna>type/span>span classp>:/span> span classs1>PASSPORT/span>span classp>,/span> span classna>country/span>span classp>:/span> span classs1>EE/span> span classp>},/span>        span classna>vendorData/span>span classp>:/span> span classs1>11111111/span>span classp>,/span>        span classna>endUserId/span>span classp>:/span> span classs1>fa820aba-019f-455a-ae81-cfca8075bc3f/span>span classp>,/span>        span classna>consents/span>span classp>:/span> span classp>/span>         span classp>{/span>           span classna>type/span>span classp>:/span> span classs1>ine/span>span classp>,/span>           span classna>approved/span>span classp>:/span> span classkc>true/span>         span classp>}/span>        span classp>/span>      span classp>}/span>   span classp>},/span>  span classna>json/span>span classp>:/span> span classkc>true/span> span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span>  span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span>  span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span>span classp>});/span>/code>/pre>h6 idpython3>Python3/h6>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>pprint/span>span classkn>import/span> span classnn>json/span>span classn>url/span> span classo>/span> span classs>/v1/sessions//span>span classn>payload/span> span classo>/span> span classn>json/span>span classo>./span>span classn>dumps/span>span classp>({/span>    span classs>verification/span>span classp>:/span> span classp>{/span>        span classs>callback/span>span classp>:/span> span classs>https://veriff.com/span>span classp>,/span>        span classs>person/span>span classp>:/span> span classp>{/span>          span classs>firstName/span>span classp>:/span> span classs>John/span>span classp>,/span>          span classs>lastName/span>span classp>:/span> span classs>Smith/span>span classp>,/span>          span classs>idNumber/span>span classp>:/span> span classs>123456789/span>        span classp>},/span>        span classs>document/span>span classp>:/span> span classp>{/span>          span classs>number/span>span classp>:/span> span classs>B01234567/span>span classp>,/span>          span classs>type/span>span classp>:/span> span classs>PASSPORT/span>span classp>,/span>          span classs>country/span>span classp>:/span> span classs>EE/span>        span classp>},/span>        span classs>vendorData/span>span classp>:/span> span classs>11111111/span>span classp>,/span>        span classs>endUserId/span>span classp>:/span> span classs>fa820aba-019f-455a-ae81-cfca8075bc3f/span>span classp>,/span>        span classs>features/span>span classp>:/span> span classp>/span>          span classs>selfid/span>        span classp>,/span>        span classs>consents/span>span classp>:/span> span classp>/span>          span classp>{/span>            span classs>type/span>span classp>:/span> span classs>ine/span>span classp>,/span>            span classs>approved/span>span classp>:/span> span classn>true/span>          span classp>}/span>        span classp>/span>    span classp>}/span>span classp>})/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>X-AUTH-CLIENT/span>span classp>:/span> span classs>API-PUBLIC-KEY/span>span classp>,/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>POST/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>payload/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classn>pprint/span>span classo>./span>span classn>pprint/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>json/span>span classp>())/span>/code>/pre>h4 idresponse>Response/h4>p>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers:/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  Request body signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idresponse-properties-explained>Response properties explained/h5>ul>li>code>status/code>: code>string/code> Request status/li>li>code>verification/code>: code>object/code> Verification objectul>li>code>id/code>: code>UUID/code>-v4 String UUID v4 which identifies the verification session/li>li>code>url/code>: code>string/code> URL of the verification to which the person is redirected (Combination of the code>baseUrl/code> and code>sessionToken/code>)/li>li>code>vendorData/code>: code>string | null/code> End-user-specific data string, max 1000 characters long, created by the customer.Sent back unmodified via API responses and webhooks, or as code>null/code> if not provided/li>li>code>endUserId/code>: code>uuid | null/code> End-user-specific UUID created by the customer to identify the end-user. Returnedunmodified in webhooks and public API calls, or as code>null/code> if not provided/li>li>code>host/code>: code>string/code> The base url the sessionToken can be used for/li>li>code>status/code>: code>string/code> Verification session status/li>li>code>sessionToken/code>: code>string/code> Session-specific token of the verification/li>/ul>/li>/ul>h5 idsample-response>Sample response/h5>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>  /span>span classs2>verification/span>span classp>:{/span>span classw>    /span>span classs2>id/span>span classp>:/span>span classs2>f04bdb47-d3be-4b28-b028-a652feb060b5/span>span classp>,/span>span classw>    /span>span classs2>url/span>span classp>:/span>span classw> /span>span classs2>https://alchemy.veriff.com/v/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdXRoX3Rva2VuIjoiOThiYzdjMjEtZTQ0Yy00MTZiLTkxOTMtMTU5ZGZkMzBmMDg4Iiwic2Vzc2lvbl9pZCI6Ijc2ODhmMzYzLTAyZjctNDE1My1iMzM1LWE0ODQ3OTRkMzZmNyIsImlhdCI6MTUwMTIyODI1MSwiZXhwIjoxNTAxODMzMDUxfQ.bMEF37E6-zT2Aa6Q8UXK3B_ZL51w6D_lxnGgQvhj214/span>span classp>,/span>span classw>    /span>span classs2>vendorData/span>span classp>:/span>span classw> /span>span classs2>11111111/span>span classp>,/span>span classw>    /span>span classs2>endUserId/span>span classp>:/span>span classw> /span>span classs2>fa820aba-019f-455a-ae81-cfca8075bc3f/span>span classp>,/span>span classw>    /span>span classs2>host/span>span classp>:/span>span classw> /span>span classs2>https://alchemy.veriff.com/span>span classp>,/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>created/span>span classp>,/span>span classw>    /span>span classs2>sessionToken/span>span classp>:/span>span classw> /span>span classs2>eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdXRoX3Rva2VuIjoiOThiYzdjMjEtZTQ0Yy00MTZiLTkxOTMtMTU5ZGZkMzBmMDg4Iiwic2Vzc2lvbl9pZCI6Ijc2ODhmMzYzLTAyZjctNDE1My1iMzM1LWE0ODQ3OTRkMzZmNyIsImlhdCI6MTUwMTIyODI1MSwiZXhwIjoxNTAxODMzMDUxfQ.bMEF37E6-zT2Aa6Q8UXK3B_ZL51w6D_lxnGgQvhj214/span>span classw>  /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h3 idpost-sessions-sessionid-media>span classmethod method-post>POST/span> /sessions/{sessionId}/media/h3>p>Uploads an image (and specifies the type of the image that's being uploaded) for a specific code>sessionId/code>./p>ul>li>Only one image file can be uploaded with one request/li>li>Veriff supports .jpg, .jpeg, .png, .heif, .heic, .webp and .pdf file formats in uploads/li>li>The image file is defined as base64 encoded image string inside a JSON body object/li>li>To avoid issues with upload, keep the image smaller than:ul>li>Image files: strong>24MB/strong> in base64 encoding (approx 17MB in image files format)/li>li>PDFs: strong>20 MB/strong> in pdf format/li>/ul>/li>/ul>aside classnotice>Make sure that you b>upload all the images before setting the status to submitted/b> using thea href#patch-sessions-sessionid>PATCH /sessions/{sessionId}/a> endpoint. If you try to b>upload media afteryou have submitted the session/b>, you may encounter the b>code>409 - conflict/code> error/b>./aside>h4 idinformation-about-pdf-support>Information about PDF support/h4>p>Veriff supports PDF file uploads for strong>Identity Verification (IDV) documents/strong> and strong>Proof of Address (PoA) documents/strong>./p>h5 ididentity-verification-feature>Identity Verification Feature/h5>aside classnotice>Please contact your solutions engineer before starting to upload PDF files for Identity Verification./aside>p>In IDV, document images can be uploaded in following configurations:/p>ul>li>Two PDF files, where one file contains document front image and the other file contains document back image/li>li>Single PDF file, which has both document sides on different pages/li>li>Single PDF file, which has both document sides on single page/li>/ul>p>Veriff processes first 5 pages of uploaded PDF file. System removes empty pages from the PDF./p>h5 idproof-of-address-feature>Proof of Address Feature/h5>p>The file that is uploaded for Proof of Address flow must contain only one PoA document. If you need to send severalPoA documents, upload them one-by-one in separate PDF files./p>p>For PoA, documents can be uploaded in following configurations:/p>ul>li>Single PDF file, where the document data is on one page/li>li>Single PDF file, where the document data spans over several pages/li>/ul>p>Veriff processes first 5 pages of uploaded PDF file. System removes empty pages from the PDF./p>h4 idrequest>Request/h4>p>strong>Request method: POST/strong>br/>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers:/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  Request body signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idrequest-properties-explained>Request properties explained/h5>ul>li>code>image/code>: code>object/code> (required)ul>li>code>context/code>: code>string/code> (required) Context type of the document (one of code>face/code>, code>document-front/code>, code>document-back/code>)/li>li>code>content/code>: code>string/code> (required) base64 encoded image (.jpg, .jpeg, .png, .heif, .heic, .webp and .pdf formatsare supported)ul>li>em>Example/em> code>data:image/png;base64,R0lGODlhAQABAAAAACw/code>/li>/ul>/li>/ul>/li>/ul>h5 idsample-request>Sample request/h5>h6 idcurl>curl/h6>pre classhighlight plaintext>code>curl -X POST \  --url /v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/media \  -H Content-Type: application/json \  -H X-AUTH-CLIENT: API-PUBLIC-KEY \  -H X-HMAC-SIGNATURE: 034c6da2bb31fd9e6892516c6d7b90ebe10f79b47cfb3d155d77b4d9b66e1d53 \  -d {    image: {    context: document-front,      content: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA+.../9fgAEAKcxisFjVfn0AAAAASUVORK5CYII    }}/code>/pre>h6 idnode-js>Node.js/h6>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>request/span>span classp>);/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>POST/span>span classp>,/span>  span classna>url/span>span classp>:/span> span classs1>/v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/media/span>span classp>,/span>  span classna>headers/span>span classp>:/span>   span classp>{/span> span classs1>Content-Type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span>     span classs1>X-HMAC-SIGNATURE/span>span classp>:/span> span classs1>034c6da2bb31fd9e6892516c6d7b90ebe10f79b47cfb3d155d77b4d9b66e1d53/span>span classp>,/span>     span classs1>X-AUTH-CLIENT/span>span classp>:/span> span classs1>API-PUBLIC-KEY/span> span classp>},/span>  span classna>body/span>span classp>:/span>   span classp>{/span> span classna>image/span>span classp>:/span>      span classp>{/span> span classna>context/span>span classp>:/span> span classs1>document-front/span>span classp>,/span>        span classna>content/span>span classp>:/span> span classs1>data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA+.../9fgAEAKcxisFjVfn0AAAAASUVORK5CYII/span> span classp>}/span> span classp>},/span>  span classna>json/span>span classp>:/span> span classkc>true/span> span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span>  span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span>  span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span>span classp>});/span>/code>/pre>h6 idpython3-py>Python3.py/h6>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>json/span>span classkn>import/span> span classnn>pprint/span>span classn>url/span>span classo>/span>span classs>/v1/sessions/{sessionId}/media/span>span classn>payload/span> span classo>/span> span classn>json/span>span classo>./span>span classn>dumps/span>span classp>({/span>    span classs>image/span>span classp>:/span> span classp>{/span>    span classs>context/span>span classp>:/span> span classs>document-front/span>span classp>,/span>      span classs>content/span>span classp>:/span> span classs>data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA+.../9fgAEAKcxisFjVfn0AAAAASUVORK5CYII/span>    span classp>}/span>span classp>})/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>X-AUTH-CLIENT/span>span classp>:/span> span classs>API-PUBLIC-KEY/span>span classp>,/span>    span classs>X-HMAC-SIGNATURE/span>span classp>:/span> span classs>034c6da2bb31fd9e6892516c6d7b90ebe10f79b47cfb3d155d77b4d9b66e1d53/span>span classp>,/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>POST/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>payload/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classn>pprint/span>span classo>./span>span classn>pprint/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>json/span>span classp>())/span>/code>/pre>h4 idresponse>Response/h4>p>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  Request body signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idresponse-properties-explained>Response properties explained/h5>ul>li>code>status/code>: code>string/code> Request status/li>li>code>image/code>: code>object/code> Image objectul>li>code>context/code>: code>string/code> Context type of the image/li>li>code>id/code>: code>UUID-v4/code> String UUID v4 which identifies the image/li>li>code>name/code>: code>string/code> File name that identifies the image/li>li>em>code>timestamp/code>: code>object/code> (Deprecated) Timestamp object, will return null/None/em>/li>li>code>size/code>: code>integer/code> Size for the image/li>li>code>mimetype/code>: code>string/code> Format of the media file. See a href#media-file-mimetypes>Mimetypes table/a> for more info/li>li>code>url/code>: code>string/code> URL for the image/li>/ul>/li>/ul>h5 idsample-response>Sample response/h5>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>  /span>span classs2>image/span>span classp>:{/span>span classw>     /span>span classs2>context/span>span classp>:/span>span classw> /span>span classs2>document-back/span>span classp>,/span>span classw>     /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>39388f8d-c6d6-4e9b-92c6-6978b2e8d664/span>span classp>,/span>span classw>     /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>document-back/span>span classp>,/span>span classw>     /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classerr>(Deprecated)/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>     /span>span classs2>size/span>span classp>:/span>span classw> /span>span classmi>52268/span>span classp>,/span>span classw>     /span>span classs2>mimetype/span>span classp>:/span>span classw> /span>span classs2>image/png/span>span classp>,/span>span classw>     /span>span classs2>url/span>span classp>:/span>span classw> /span>span classs2>/v1/media/39388f8d-c6d6-4e9b-92c6-6978b2e8d664/span>span classw>   /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h3 idpost-sessions-sessionid-collected-data>span classmethod method-post> POST /span> /sessions/{sessionId}/collected-data/h3>p>Uploads information that has been collected for improved IDV process. The session must be either incode>created/code> or code>started/code> status./p>aside classnotice>In this request, only the following fields are b>mandatory/b>:    ul>        li>code>providerName/code>: code>string/code> Name of the fingerprinting service provider, max 255 characters/li>        li>code>network.ip/code>: code>string/code> Either IPv4 or IPv6 data needs be present /li>        li>code>device.fingerprint/code>: code>string/code> Device fingerprint, max 255 characters/li>    /ul>The rest of the parameters listed below are optional. If there is no data to provide, the parameter should notbe included in the payload./aside>h4 idrequest>Request/h4>p>strong>Request method: POST/strong>br/>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  Request body signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idrequest-properties-explained>Request properties explained/h5>ul>li>code>providerName/code>: code>string/code> Name of the fingerprinting service provider, max 255 characters/li>li>code>person/code>: code>object/code> Information about the person. Optional fieldul>li>code>email/code>: code>string/code> Person's e-mail address entered during the validation. Optional field/li>li>code>phoneNumber/code>: code>string/code> Person's phone number, can include numbers, whitespaces and the "+" sign in front.Optional field/li>/ul>/li>li>code>network/code>: code>object/code> Network related dataul>li>code>mobileCarrier/code>: code>string/code> Name of the service provider. Optional field/li>li>code>ssid/code>: code>string/code> Service Set Identifier (SSID) value. Optional field/li>li>code>hostname/code>: code>string/code> Service host name. Optional field/li>li>code>location/code>: code>object/code> Location data. Optional fieldul>li>code>countryCode/code>: code>string/code> ISO 3166-1 Alpha-2 country code. Optional field/li>li>code>continentCode/code>: code>string/code> (EU, NA, AS, SA, AF, OC) Two-letter code of the continent. Optional field/li>li>code>city/code>: code>string/code> City name, in English. Optional field/li>li>code>region/code>: code>string/code> Region code or name, in English. Optional field/li>li>code>timezone/code>: code>string/code> Timezone abbreviation as listed in the Timezones Database. Optional field/li>/ul>/li>li>code>ip/code>: code>object/code> IP info. At least one is mandatory!ul>li>code>addressV4/code>: code>string/code> IPv4 info. Optional if IPv6 info is included/li>li>code>addressV6/code>: code>string/code> IPv6 info. Optional if IPv4 info is included/li>/ul>/li>li>code>asn/code>: code>object/code> ASN info. Optional fieldul>li>code>number/code>: code>string/code> Autonomous System Number (ASN). Optional field/li>li>code>organisation/code>: code>string/code> Name of the organization owning the ASN. Optional field/li>/ul>/li>/ul>/li>li>code>device/code>: code>object/code> End-user's device related dataul>li>code>fingerprint/code>: code>string/code> Device fingerprint, max 255 characters/li>li>code>androidId/code>: code>string/code> The Android unique device ID is a combination of 8 digits and letters, followed by a dash and threesets of 4 digits and letters, all letters are lowercase. Optional field/li>li>code>idfv/code>: code>string/code> The Identifier for Vendors (IDFV) code, example F325G3GB-12FC-352F-C6C3-DZ52F0F690D8. Optional field/li>li>code>model/code>: code>string/code> Device model. Optional field/li>li>code>vendor/code>: code>string/code> Device supplier. Optional field/li>li>code>type/code>: code>string/code> (desktop, mobile, tablet, other) Device type. Optional field/li>li>code>browser/code>: code>object/code> Browser data. Optional fieldul>li>code>languages/code>: code>array/code> IETF language tag, for example: "es-419", "en-gb", "pl". Optional field/li>li>code>userAgent/code>: code>string/code> Browser user agent,  max 255 characters. Optional field/li>li>code>timezoneOffsetMinutes/code>: code>number/code> An integer number for the time offset from the UTC, in minutes (range from -1440 to +1440 minutes) Optional field/li>li>code>isIncognito/code>: code>boolean/code> Data about whether the incognito mode is on. Optional field/li>/ul>/li>li>code>audio/code>: code>object/code> Device audio info. Optional fieldul>li>code>devices/code>: {code>name/code>: code>string/code>} Array of objects. Optional field/li>/ul>/li>li>code>screen/code>: code>object/code> Data about device screen. Optional fieldul>li>code>heightPixels/code>: code>number/code> An integer number in range of 1–100000. Optional field/li>li>code>widthPixels/code>: code>number/code> An integer number in range of 1–100000. Optional field/li>li>code>dpi/code>: code>number/code> An integer number in range of 1–100000. Optional field/li>/ul>/li>li>code>battery/code>: code>object/code> Device battery related info. Optional fieldul>li>code>level/code>: code>number/code> A float in range of 0.0–1.0. Optional field/li>li>code>charging/code>: code>boolean/code> Data about whether the device is charging. Optional field/li>/ul>/li>li>code>os/code>: code>object/code> Device operating system (OS) data. Optional fieldul>li>code>family/code>: code>string/code> OS family. Optional field/li>li>code>name/code>: code>string/code> OS name. Optional field/li>li>code>platform/code>: code>string/code> OS platform type, for example "x64", "ARM", "OS/390". Optional field/li>li>code>version/code>: code>string/code> OS version. Optional field/li>/ul>/li>/ul>/li>/ul>h5 idsample-request>Sample Request/h5>h6 idcurl>curl/h6>pre classhighlight plaintext>code>curl -X POST \ --url /v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/collected-data \  -H Content-Type: application/json \  -H X-AUTH-CLIENT: API key \  -H X-HMAC-SIGNATURE: 034c6da2bb31fd9e6892516c6d7b90ebe10f79b47cfb3d155d77b4d9b66e1d53 \   -d {        providerName: SampleName,        person: {            email: firstname.lastname@domain.com,            phoneNumber: +11 222 333 44        },        network: {            mobileCarrier: RandomTeleCom Inc,            ssid: 12345,            hostname: examplehostname.amazonaws.com,            location: {                countryCode: US,                continentCode: NA,                city: New York,                region: New York,                timezone: EDT            },            ip: {                addressV4: 192.168.XXX.XXX            },            asn: {                number: AS12345,                organisation: AWS            }        },        device: {            fingerprint: 123456asdfg7890hijkl123456asdfg7890hijkl123456asdfg7890hijkl,            androidId: ab1357cd-a1b2-c3d4-f5g6,            idfv: F325G3GB-12FC-352F-C6C3-DZ52F0F690D8,            model: Samsung Galaxy S23 Ultra,            vendor: Samsung,            type: mobile,            browser: {                languages: en-gb,                timezoneOffsetMinutes: -240,                isIncognito: false            },            screen: {                heightPixels: 3088,                widthPixels: 1440,                dpi: 500            },            battery: {                level: 0.43,                charging: true            },            os: {                family: Android,                name: Android,                version: 13            }        }    }/code>/pre>h5 idnode-js>Node.js/h5>pre classhighlight plaintext>code>var request  require(request);var options  {  url: /v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/collected-data,  method: POST,  headers: {    Content-Type: application/json    X-AUTH-CLIENT: API key \    X-HMAC-SIGNATURE: 034c6da2bb31fd9e6892516c6d7b90ebe10f79b47cfb3d155d77b4d9b66e1d53  },  body: {    providerName: SampleName,    person: {      email: firstname.lastname@domain.com,      phoneNumber: +11 222 333 44    },    network: {      mobileCarrier: RandomTeleCom Inc,      ssid: 12345,      hostname: examplehostname.amazonaws.com,      location: {        countryCode: US,        continentCode: NA,        city: New York,        region: New York,        timezone: EDT      },      ip: {        addressV4: 192.168.XXX.XXX      },      asn: {        number: AS12345,        organisation: AWS      }    },    device: {      fingerprint: 123456asdfg7890hijkl123456asdfg7890hijkl123456asdfg7890hijkl,      androidId: ab1357cd-a1b2-c3d4-f5g6,      idfv: F325G3GB-12FC-352F-C6C3-DZ52F0F690D8,      model: Samsung Galaxy S23 Ultra,      vendor: Samsung,      type: mobile,      browser: {        languages: en-gb,        timezoneOffsetMinutes: -240,        isIncognito: false      },      screen: {        heightPixels: 3088,        widthPixels: 1440,        dpi: 500      },      battery: {        level: 0.43,        charging: true      },      os: {        family: Android,        name: Android,        version: 13      }    }  }},json: true };request(options, function (error, response, body) {  if (error) {    console.error(Error:, error);  } else {    console.log(Response:, body);  }});/code>/pre>h4 idresponse>Response/h4>p>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers:/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  Request body signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idresponse-properties-explained>Response properties explained/h5>ul>li>code>status/code>: code>string/code> Status of the request/li>li>code>sessionId/code>: code>string/code> UUID v4 which identifies the verification session/li>li>code>attemptId/code>: code>string/code> UUID v4 which identifies the attempt/li>/ul>h6 idsample-response>Sample response/h6>pre classhighlight json tab-json>code>span classp>{/span>span classw>  /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>  /span>span classs2>sessionId/span>span classp>:/span>span classw> /span>span classs2>f04bdb47-d3be-4b28-b028-a652feb060b5/span>span classp>,/span>span classw>  /span>span classs2>attemptId/span>span classp>:/span>span classw> /span>span classs2>f5c68aea-7f4d-478d-80ab-ca9356074f69/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h3 idpatch-sessions-sessionid>PATCH /sessions/{sessionId}/h3>p>Changes the status of the verification to "submitted"./p>aside classnotice>Make sure that you have b>uploaded all the images/b> using the a href#post-sessions-sessionid-media>POST/sessions/{sessionId}/media/a>request b>before setting the status to submitted/b>. If you try to b>upload media after you have submitted thesession/b>, you may encounter the b>code>409 - conflict/code> error/b>./aside>h4 idrequest>Request/h4>p>strong>Request method: PATCH/strong>br/>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers:/strong>br/>code>X-AUTH-CLIENT: string (required)/code>   strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  Request body signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idrequest-properties-explained>Request properties explained/h5>ul>li>code>verification/code>: code>object/code> (required)/li>li>code>status/code>: code>string/code> (required) Status of a verification ("submitted")/li>/ul>h5 idsample-request>Sample request/h5>h5 idcurl>curl/h5>pre classhighlight plaintext>code>curl -X PATCH \  --url /v1/sessions/fd5c1563-1d23-4b1a-ae46-7ba429927ed8 \  -H Content-Type: application/json \  -H X-AUTH-CLIENT: API-PUBLIC-KEY \  -H X-HMAC-SIGNATURE: dd994f70b1150ae012f9c1d6d20adf7ed69780044835d39de20b00ffae0660a0 \  -d {    verification: {      status: submitted    }}/code>/pre>h6 idnode-js>Node.js/h6>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>request/span>span classp>);/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>PATCH/span>span classp>,/span>  span classna>url/span>span classp>:/span> span classs1>/v1/sessions/fd5c1563-1d23-4b1a-ae46-7ba429927ed8/span>span classp>,/span>  span classna>headers/span>span classp>:/span>   span classp>{/span> span classs1>Content-Type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span>     span classs1>X-HMAC-SIGNATURE/span>span classp>:/span> span classs1>dd994f70b1150ae012f9c1d6d20adf7ed69780044835d39de20b00ffae0660a0/span>span classp>,/span>     span classs1>X-AUTH-CLIENT/span>span classp>:/span> span classs1>API-PUBLIC-KEY/span> span classp>},/span>  span classna>body/span>span classp>:/span>   span classp>{/span> span classna>verification/span>span classp>:/span>      span classp>{/span> span classna>status/span>span classp>:/span> span classs1>submitted/span> span classp>}/span> span classp>},/span>  span classna>json/span>span classp>:/span> span classkc>true/span> span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span>  span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span>  span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span>span classp>});/span>/code>/pre>h6 idpython3-py>Python3.py/h6>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>json/span>span classkn>import/span> span classnn>pprint/span>span classn>url/span> span classo>/span> span classs>/v1/sessions/{sessionId}/span>span classn>payload/span> span classo>/span> span classn>json/span>span classo>./span>span classn>dumps/span>span classp>({/span>    span classs>verification/span>span classp>:/span> span classp>{/span>      span classs>status/span>span classp>:/span> span classs>submitted/span>    span classp>}/span>span classp>})/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>X-AUTH-CLIENT/span>span classp>:/span> span classs>API-PUBLIC-KEY/span>span classp>,/span>    span classs>X-HMAC-SIGNATURE/span>span classp>:/span> span classs>dd994f70b1150ae012f9c1d6d20adf7ed69780044835d39de20b00ffae0660a0/span>span classp>,/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>PATCH/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>payload/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classn>pprint/span>span classo>./span>span classn>pprint/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>json/span>span classp>())/span>/code>/pre>h4 idresponse>Response/h4>p>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers:/strong>br/>code>X-AUTH-CLIENT: string (required)/code>   strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  Request body signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idresponse-properties-explained>Response properties explained/h5>ul>li>code>status/code>: code>string/code> Request status/li>li>code>verification/code>: code>object/code> Verification objectul>li>code>id/code>: code>UUID-v4/code> String UUID v4 which identifies the verification session/li>li>code>url/code>: code>string/code> URL for the timestamp/li>li>code>vendorData/code>: code>string/code> End-user-specific data string, max 1000 characters long, created by the customer. Sent backunmodified via API responses and webhooks, or as code>null/code> if not provided/li>li>code>endUserId/code>: code>uuid | null/code> End-user-specific UUID created by the customer to identify the end-user. Returnedunmodified in webhooks and public API calls, or as code>null/code> if not provided/li>li>code>host/code>: code>string/code> Host URI/li>li>code>status/code>: code>string/code> Status of the verification/li>li>code>sessionToken/code>: code>string/code> Session specific token of the verification/li>/ul>/li>/ul>h5 idsample-response>Sample response/h5>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>    /span>span classs2>verification/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>fd5c1563-1d23-4b1a-ae46-7ba429927ed8/span>span classp>,/span>span classw>        /span>span classs2>url/span>span classp>:/span>span classw> /span>span classs2>https://alchemy.veriff.com/v/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZXNzaW9uX2lkIjoiZmQ1YzE1NjMtMWQyMy00YjFhLWFlNDYtN2JhNDI5OTI3ZWQ4IiwiaWF0IjoxNTcyMzM4MDIwfQ.3HbNq0YWKAfFrH-P658_WXMwcUMubyC1aXAMo-umfCU/span>span classp>,/span>span classw>        /span>span classs2>vendorData/span>span classp>:/span>span classw> /span>span classs2>11111111/span>span classp>,/span>span classw>        /span>span classs2>endUserId/span>span classp>:/span>span classw> /span>span classs2>fa820aba-019f-455a-ae81-cfca8075bc3f/span>span classp>,/span>span classw>        /span>span classs2>host/span>span classp>:/span>span classw> /span>span classs2>https://alchemy.veriff.com/span>span classp>,/span>span classw>        /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>submitted/span>span classp>,/span>span classw>        /span>span classs2>sessionToken/span>span classp>:/span>span classw> /span>span classs2>eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZXNzaW9uX2lkIjoiZmQ1YzE1NjMtMWQyMy00YjFhLWFlNDYtN2JhNDI5OTI3ZWQ4IiwiaWF0IjoxNTcyMzM4MDIwfQ.3HbNq0YWKAfFrH-P658_WXMwcUMubyC1aXAMo-umfCU/span>span classw>    /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h3 idget-sessions-sessionid-attempts>span classmethod method-get>GET/span> /sessions/{sessionId}/attempts/h3>p>Returns the list of attempt objects with sessionId  {sessionId}/p>p>Returns the strong>user-defined statuses/strong> data if those have been set in the Veriff environment./p>h4 idrequest>Request/h4>p>strong>Request method: GET/strong>br/>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  code>sessionId/code> signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idsample-request>Sample request/h5>h6 idcurl>curl/h6>pre classhighlight plaintext>code>curl -X GET \  --url /v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/attempts \  -H Content-Type: application/json \  -H X-AUTH-CLIENT: API-PUBLIC-KEY \  -H X-HMAC-SIGNATURE: 334141f052e317fde6668de54dc6640b4a5c47582ad86a8bed63afe566f17b14 \/code>/pre>h6 idnode-js>Node.js/h6>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>request/span>span classp>);/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>GET/span>span classp>,/span>  span classna>url/span>span classp>:/span> span classs1>/v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/attempts/span>span classp>,/span>  span classna>headers/span>span classp>:/span>   span classp>{/span> span classs1>Content-Type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span>     span classs1>X-HMAC-SIGNATURE/span>span classp>:/span> span classs1>334141f052e317fde6668de54dc6640b4a5c47582ad86a8bed63afe566f17b14/span>span classp>,/span>     span classs1>X-AUTH-CLIENT/span>span classp>:/span> span classs1>API-PUBLIC-KEY/span> span classp>}/span> span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span>  span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span>  span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span>span classp>});/span>/code>/pre>h6 idpython3-py>Python3.py/h6>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>json/span>span classkn>import/span> span classnn>pprint/span>span classn>url/span> span classo>/span> span classs>/v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/attempts/span>span classn>headers/span> span classo>/span> span classp>{/span>span classn>Response/span>    span classs>X-AUTH-CLIENT/span>span classp>:/span> span classs>API-PUBLIC-KEY/span>span classp>,/span>    span classs>X-HMAC-SIGNATURE/span>span classp>:/span> span classs>334141f052e317fde6668de54dc6640b4a5c47582ad86a8bed63afe566f17b14/span>span classp>,/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>GET/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classn>pprint/span>span classo>./span>span classn>pprint/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>json/span>span classp>())/span>/code>/pre>h4 idresponse>Response/h4>p>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  Request body signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idresponse-properties-explained>Response properties explained/h5>ul>li>code>status/code>: code>string/code> Status of the request/li>li>code>verifications/code>: code>array/code> Array of JSON objects identifying the attemptsul>li>code>id/code>: code>UUID/code>-v4 of the attempt/li>li>code>status/code>: code>string/code> Status of the attempt. It can be one of code>created/code>, code>started/code>, code>abandoned/code>, code>expired/code>,code>submitted/code>, code>approved/code>, code>resubmission_requested/code>, code>declined/code>, code>inflow_completed/code> , code>review/code>./li>li>code>userDefinedData/code>: code>array/code> Array of objects describing the custom statuses defined by the user. Instructions how toadd statuses can be found a hrefhttps://help.veriff.com/en/articles/8480053-adding-user-defined-statuses-to-sessions>here ↗/a>(requires a login to the Veriff environment).ul>li>code>status/code>: code>string/code> Name of the custom status as set in the Veriff environment/li>li>code>statusCode/code>: code>string/code> Autogenerated code for the custom status/li>li>code>reason/code>: code>string/code> Name of the custom reason as set in the Veriff environment. If the user has selectedthe "Custom" reason for the status and typed an explanation to the text box, then the explanationis sent in this field./li>li>code>reasonCode/code>: code>string | null/code> Autogenerated code for the reason. It is code>null/code> when the user has selectedthe "Custom" reason for the status and typed an explanation to the text box. This explanation is sentin the code>reason/code> parameter./li>li>code>createdAt/code>: code>string/code> Timestamp of when the custom status was added. Combined ISO 8601 date and time inUTC YYYY-MM-DDTHH:MM:SSS+Timezone Offset/li>/ul>/li>li>code>createdTime/code>: code>string/code> Timestamp of when the attempt was created. Combined ISO 8601 date and time inUTC YYYY-MM-DDTHH:MM:SSS+Timezone Offset/li>/ul>/li>/ul>h5 idsample-response-simple>Sample Response (simple)/h5>pre classhighlight json tab-json>code>span classp>{/span>span classw>  /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>  /span>span classs2>verifications/span>span classp>:/span>span classw> /span>span classp>/span>span classw>    /span>span classp>{/span>span classw>      /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>f5c68aea-7f4d-478d-80ab-ca9356074f69/span>span classp>,/span>span classw>      /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>approved/span>span classw>    /span>span classp>},/span>span classw>    /span>span classp>{/span>span classw>      /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>f2270684-8c51-4d03-88eb-dafd43e8b486/span>span classp>,/span>span classw>      /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>resubmission_requested/span>span classw>    /span>span classp>}/span>span classw>  /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h5 idsample-response-user-defined-statuses-added>Sample Response (user-defined statuses added)/h5>p>In the sample below the user has added a status for the attempt in the Veriff environment, but has not enabled the"Custom" option for the status./p>pre classhighlight json tab-json>code>span classp>{/span>span classw>  /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>  /span>span classs2>verifications/span>span classp>:/span>span classw> /span>span classp>/span>span classw>      /span>span classp>{/span>span classw>        /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>a1c68aea-7f4d-478d-80ab-ca9356074f69/span>span classp>,/span>span classw>        /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>approved/span>span classp>,/span>span classw>        /span>span classs2>userDefinedData/span>span classp>:/span>span classw>          /span>span classp>{/span>span classw>            /span>span classs2>status/span>span classp>:/span>span classs2>Custom status for suspicious attempt/span>span classp>,/span>span classw>            /span>span classs2>statusCode/span>span classp>:/span>span classs2>custom_status_for_suspicious_attempt/span>span classp>,/span>span classw>            /span>span classs2>reason/span>span classp>:/span>span classs2>Looks like velocity abuse/span>span classp>,/span>span classw>            /span>span classs2>reasonCode/span>span classp>:/span>span classs2>looks_like_velocity_abuse/span>span classp>,/span>span classw>            /span>span classs2>createdAt/span>span classp>:/span>span classs2>2023-09-18T08:41:41.606636Z/span>span classw>          /span>span classp>}/span>span classw>        /span>span classp>,/span>span classw>        /span>span classs2>createdTime/span>span classp>:/span>span classs2>2023-09-18T08:33:30.047935Z/span>span classw>      /span>span classp>},/span>span classw>      /span>span classp>{/span>span classw>        /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>f2270684-8c51-4d03-88eb-dafd43e8b486/span>span classp>,/span>span classw>        /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>resubmission_requested/span>span classw>      /span>span classp>}/span>span classw>  /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>p>In the sample below the user has added a status for the attempt in the Veriff environment, has enabled the"Custom" option for the status and added an explanation to the text box./p>pre classhighlight json tab-json>code>span classp>{/span>span classw>  /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>  /span>span classs2>verifications/span>span classp>:/span>span classw> /span>span classp>/span>span classw>      /span>span classp>{/span>span classw>        /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>a1c68aea-7f4d-478d-80ab-ca9356074f69/span>span classp>,/span>span classw>        /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>approved/span>span classp>,/span>span classw>        /span>span classs2>userDefinedData/span>span classp>:/span>span classw>          /span>span classp>{/span>span classw>            /span>span classs2>status/span>span classp>:/span>span classs2>Custom status for suspicious attempt/span>span classp>,/span>span classw>            /span>span classs2>statusCode/span>span classp>:/span>span classs2>custom_status_for_suspicious_attempt/span>span classp>,/span>span classw>            /span>span classs2>reason/span>span classp>:/span>span classs2>The document used in this attempt is clearly a cut-out/span>span classp>,/span>span classw>            /span>span classs2>reasonCode/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>createdAt/span>span classp>:/span>span classs2>2023-09-18T08:41:41.606636Z/span>span classw>          /span>span classp>}/span>span classw>        /span>span classp>,/span>span classw>        /span>span classs2>createdTime/span>span classp>:/span>span classs2>2023-09-18T08:33:30.047935Z/span>span classw>      /span>span classp>},/span>span classw>      /span>span classp>{/span>span classw>        /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>f2270684-8c51-4d03-88eb-dafd43e8b486/span>span classp>,/span>span classw>        /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>resubmission_requested/span>span classw>      /span>span classp>}/span>span classw>  /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h3 idget-sessions-sessionid-decision>span classmethod method-get>GET/span> /sessions/{sessionId}/decision/h3>p>Returns the session decision with sessionId  {sessionId}/p>p>In order to receive the decision payload from us: /p>ol>li>the strong>Integration/strong> needs to have the strong>Webhook decisions URL/strong> configured/li>li>the session related to the code>sessionId/code> needs to have one of a href#verification-session-status-and-decision-codes>9000-code statuses/a>,otherwise you will see code>Decision not available/code> in the response payload/li>/ol>p>strong>Test integrations/strong>/p>p>For test integrations, the strong>Webhook decision URL/strong> is added strong>automatically/strong>./p>p>But you need to strong>manually set the session's status/strong> in strong>the Veriff Environment/strong>:/p>ul>li>Open the verification session on strong>Verifications/strong> page /li>li>Press the strong>Update status/strong> button/li>li>Select a status/li>/ul>p>strong>Live integrations/strong>/p>p>For live integrations, you need to define the strong>Webhook decisions URL/strong>:/p>ul>li>Go to the strong>Integrations/strong> page/li>li>Open the strong>relevant integration/strong>/li>li>Navigate to strong>Integration Settings/strong>/li>li>Add your URL to the strong>Webhook decisions URL/strong> field/li>/ul>p>In live integrations, the strong>session statuses/strong> are set strong>automatically/strong>./p>h4 idrequest>Request/h4>p>strong>Request method: GET/strong>br/>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  code>sessionId/code> signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h6 idsample-request>Sample request/h6>h6 idcurl>curl/h6>pre classhighlight plaintext>code>curl -X GET \  --url /v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/decision \  -H Content-Type: application/json \  -H X-AUTH-CLIENT: API-PUBLIC-KEY \  -H X-HMAC-SIGNATURE: 334141f052e317fde6668de54dc6640b4a5c47582ad86a8bed63afe566f17b14 \/code>/pre>h6 idnode-js>Node.js/h6>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>request/span>span classp>);/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>GET/span>span classp>,/span>  span classna>url/span>span classp>:/span> span classs1>https://<Base-URL>/v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/decision/span>span classp>,/span>  span classna>headers/span>span classp>:/span>   span classp>{/span> span classs1>Content-Type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span>     span classs1>X-HMAC-SIGNATURE/span>span classp>:/span> span classs1>334141f052e317fde6668de54dc6640b4a5c47582ad86a8bed63afe566f17b14/span>span classp>,/span>     span classs1>X-AUTH-CLIENT/span>span classp>:/span> span classs1>API-PUBLIC-KEY/span> span classp>}/span> span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span>  span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span>  span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span>span classp>});/span>/code>/pre>h6 idpython3-py>Python3.py/h6>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>json/span>span classkn>import/span> span classnn>pprint/span>span classn>url/span> span classo>/span> span classs>https://<Base-URL>/v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a/decision/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>X-AUTH-CLIENT/span>span classp>:/span> span classs>API-PUBLIC-KEY/span>span classp>,/span>    span classs>X-HMAC-SIGNATURE/span>span classp>:/span> span classs>334141f052e317fde6668de54dc6640b4a5c47582ad86a8bed63afe566f17b14/span>span classp>,/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>GET/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classn>pprint/span>span classo>./span>span classn>pprint/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>json/span>span classp>())/span>/code>/pre>h4 idresponse>Response/h4>p>strong>Headers/strong>br/>/p>p>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  Response body signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idresponse-properties-explained>Response properties explained/h5>ul>li>code>status/code>: code>string/code> Status of the response/li>li>code>verification/code>: code>object/code> Verification request decision object. Null if decision is not available yetul>li>code>id/code>: code>string/code> UUID v4 which identifies the verification session/li>li>code>code/code>: code>integer/code> (one of 9001, 9102, 9103, 9104, 9121)Verification response code. a href#verification-session-status-and-decision-codes>More information about decision codes/a>/li>li>code>person/code>: code>object/code> Verified personul>li>code>gender/code>: code>string | null/code> (M, F or Null) Gender/li>li>code>idNumber/code>: code>string | null/code> National identification number/li>li>code>lastName/code>: code>string | null/code> Last name/li>li>code>firstName/code>: code>string | null/code> First name/li>li>code>citizenship/code>: code>(Deprecated)/code> code>null/code>/li>li>code>dateOfBirth/code>: code>string/code> (YYYY-MM-DD) Date of birth/li>li>code>nationality/code>: code>string | null/code> Nationality/li>li>code>yearOfBirth/code>: code>string | null/code> (YYYY) Year of birth/li>li>code>placeOfBirth/code>: code>string | null/code> Place of birth/li>li>code>pepSanctionMatch/code>: code>string | null/code> PEP check result. Optional, depending on integration./li>li>code>occupation/code>: code>string | null/code> Occupation data from the document. Optional, depending on integration./li>li>code>employer/code>: code>string | null/code> Employer's name from the document. Optional, depending on integration./li>li>code>foreginerStatus/code>: code>string | null/code>) Foreigner status field from the document. Optional, depending on integration./li>li>code>extraNames/code>: code>string/code> Additional name from the document. Optional, depending on integration./li>li>code>addresses/code>: code>array/code> Address data from the document. Optional, depending on integration.ul>li>code>fullAddress/code>: code>string/code> Address as single string./li>li>code>parsedAddress/code>: code>object/code> Object with parsed code>fullAddress/code>. It is optional, depending on integration.ul>li>code>city/code>: code>string | null/code> Any human settlement, including cities, towns, villages, hamlets, localities, etc./li>li>code>unit/code>: code>string | null/code> An apartment, unit, office, lot, or other secondary unit designator/li>li>code>state/code>: code>string | null/code> A first-level administrative division. For example, Scotland,Northern Ireland, Wales, and England in the UK are mapped to "state" as well (convention used inOSM, GeoPlanet, etc.)/li>li>code>street/code>: code>string | null/code> Name of the street/li>li>code>country/code>: code>string | null/code> Sovereign nations and their dependent territories, anything with an ISO-3166 code/li>li>code>postcode/code>: code>string | null/code> Postal codes used for mail sorting/li>li>code>houseNumber/code>: code>string | null/code> External (street-facing) building number/li>/ul>/li>/ul>/li>/ul>/li>li>code>reason/code>: code>string | null/code> Reason of failed Verification/li>li>code>status/code>: code>approved/code> (one of approved, resubmission_requested, review, declined, expired, abandoned) Verification status/li>li>code>comments/code>: code>array/code> em>(Deprecated)/em> /li>li>code>document/code>: code>object/code> Verified documentul>li>code>type/code>: code>string/code> (PASSPORT, ID_CARD, RESIDENCE_PERMIT, DRIVERS_LICENSE, VISA, OTHER) Document type. a href#supported-document-types-for-idv>See the document types/a>/li>li>code>number/code>: code>string | null/code> Document number, a-zA-Z0-9 characters only/li>li>code>country/code>: code>string | null/code> Document issuing country, as ISO 3166 alpha-2 code/li>li>code>remarks/code>: code>string/code> Data extracted from the document's remarks field/li>li>code>state/code>: code>string | null/code> Document issuing state, as ISO 3166 alpha-2 or alpha-3 code. code>null/code> when the state data is not present on the document/li>li>code>validFrom/code>: code>string | null/code> Document is valid from date/li>li>code>validUntil/code>: code>string |  null/code> Document is valid until date/li>li>code>placeOfIssue/code>: code>string | null/code> Place where document was issued. Optional field, depending on integration./li>li>code>firstIssue/code>: code>string | null/code> Date of document first issue in YYYY-MM-DD format. Optional field, depending on integration./li>li>code>issueNumber/code>: code>string | null/code> Document issue number. Optional field, depending on integration./li>li>code>issuedBy/code>: code>string | null/code> Document issuing authority. Optional field, depending on integration./li>li>code>nfcValidated/code>: code>boolean/code> Biometric document data has been successfully decoded. Optional field, depending on integration./li>li>code>residencePermitType/code>: code>string/code> Type of the residence permit type from the document. Optional, depending on integration./li>li>code>portraitIsVisible/code>: code>boolean/code> Indicates that the portrait image is visible in the session and its quality issufficient to perform verification. Optional, depending on the integration/li>li>code>signatureIsVisible/code>: code>boolean/code> Indicates that the signature is present on the document and readable to performthe verification. Optional, depending on the integration/li>/ul>/li>li>code>reasonCode/code>: code>integer | null/code> Reason code of failed Verification a href#reference-info-codes-tables>See Response and error codes/a>/li>li>code>vendorData/code>: code>string/code> End-user-specific data string, max 1000 characters long, created by the customer. Sent backunmodified via API responses and webhooks, or as code>null/code> if not provided/li>li>code>endUserId/code>: code>uuid | null/code> End-user-specific UUID created by the customer to identify the end-user. Returnedunmodified in webhooks and public API calls, or as code>null/code> if not provided/li>li>code>decisionTime/code>: code>string/code> Timestamp of the decision. Combined ISO 8601 date and time in UTC YYYY-MM-DDTHH:MM:SSS+Timezone Offset/li>li>code>acceptanceTime/code>: code>string/code> Timestamp of the session generation. Combined ISO 8601 date and time in UTC YYYY-MM-DDTHH:MM:SSS+Timezone Offset/li>li>em>code>highRisk/code>: code>boolean/code> (Deprecated) If session is considered high risk or not. Optional, depending on integration./em>/li>li>code>additionalVerifiedData/code>: code>object/code> Data which has been optionally verified for session.ul>li>code>driversLicenseCategory/code>: code>object/code> Optional, depending on integration.ul>li>code>B/code>: code>boolean | null/code>/li>/ul>/li>li>code>driversLicenseCategoryFrom/code>: code>object/code> Date when the driving license category was obtained. Optional, depending on integration.ul>li>code>B/code>: code>string | null/code> Category is valid from date in YYYY-MM-DD format/li>/ul>/li>li>code>driversLicenseCategoryUntil/code>: code>object/code> Driving license category expiry date. Optional, depending on integration.ul>li>code>B/code>: code>string | null/code> Category is valid until date in YYYY-MM-DD format/li>/ul>/li>li>code>estimatedAge/code>: code>number/code> An integer number representing the estimated age. Optional, depending on integration./li>li>code>estimatedGender/code>: code>number/code> A float representing the estimated gender. Optional, depending on integration. Values closer to 0.0 indicate 'male', values closer to 1.0 indicate 'female'./li>li>code>processNumber/code>: code>string/code> Process number (e.g., "Trámite №") from the document. Optional, depending on integration./li>li>code>driversLicenseNumber/code>: code>string/code> Number of the driver's license. Optional, depending on integration./li>li>code>cpfValidation/code>: code>object | null/code> Brazilian individual taxpayer registry (CPF) validation check object. Optional, depending on integrationul>li>code>status/code>:  code>string | null/code> Status of the entry in the registry (one of CPF is validated, CPF is suspended, CPF holder is deceased, CPF ispending regularization, CPF is cancelled em>(was a duplicate)/em>, Cancelled craft em>(meaning that it was cancelleddue to reasons other than being a duplicate)/em>)/li>li>code>cpfNumber/code>: code>string | null/code> Brazilian individual taxpayer registry (CPF) number of the person/li>li>code>name/code>: code>string | null/code> Person's name in the CPF/li>li>code>dateOfBirth/code>: code>string | null/code> Person's date of birth in the CPF as YYYY-MM-DD/li>li>code>yearOfDeath/code>: code>string | null/code> Person's year of death in the CPF as YYYY/li>/ul>/li>li>code>ineBiometricRegistryValidation/code>: code>object/code> INE Biometric Database Verification check object. Optional, availableonly when the INE Biometric Validation check has been enabled for the integrationul>li>code>faceMatch/code>: code>boolean | null/code> Indicates if the person's selfie image is a match with their image in theregistry. This decision is made based on the value returned in code>faceMatchPercentage/code> (see below). code>null/code>if the check could not be completed/li>li>code>faceMatchPercentage/code>: code>integer | null/code> Indicates the level of similarity the system thinks the matched images have,in the range of 0-100. Values ≥85 indicate a match; values <85 indicate that images do not match. code>null/code> if the check could not be completed/li>li>code>responseStatus/code>: code>string | null/code> Indicates the response received from the service provider. One of code>success/code>or code>failure/code>; or code>null/code> if the check could not be completed/li>/ul>/li>/ul>/li>li>code>riskScore/code>: code>object/code> Data about the risk scoreul>li>code>score/code>: code>number/code> A float in the range of 0.0–1.0. Numerical value representing the overall risk associated with thesession. Lower score indicates more confidence in that the session is genuine. Note: in the strong>Veriff environment/strong>,the range is shown as 1–100./li>/ul>/li>li>code>riskLabels/code>: code>array/code> Optional array of risk labels related to the session. The presence of this property dependson risk labels being enabled for the integration. a hrefhttps://help.veriff.com/en/articles/3410712-risk-labels-and-crosslinks>Full list of risk labels (requires login to Veriff's environment)/a> ↗ul>li>code>label/code>: code>string/code> Name of the risk label/li>li>code>category/code>: code>string/code> (one of client_data_mismatch, cross-links, device, document, images, network, session, person)/li>li>code>sessionIds/code>: code>array of strings/code> Array of verification IDs that are referenced to the particular risk label/li>/ul>/li>li>code>biometricAuthentication/code>: code>object/code> Object containing data about the biometric authentication. Optional, availableonly when using the Biometric Authentication solutionul>li>code>matchedSessionId/code>: code>string | null/code> Refers to the verification session ID which the face matched/li>li>code>matchedSessionEndUserId/code>: code>string |  null/code> Refers to the verification session code>endUserId/code>which the face matched/li>li>code>matchedSessionVendorData/code>: code>string | null/code> Refers to the verification session code>vendorData/code> which the face matched/li>li>code>details/code>: code>object/code> Lists the results of different checks that were made to verify the end-user. If you havebeen granted access to the Veriff environment, you can find these in the a hrefhttps://help.veriff.com/en/articles/9638913-biometric-authentication-results-in-decision-webhook>detailed request explanation/a>↗./li>/ul>/li>/ul>/li>li>code>technicalData/code>: code>object/code> Technical data objectul>li>code>ip/code>: code>string | null/code> IP of the device from which the verification was made/li>/ul>/li>/ul>h5 idsample-response>Sample Response/h5>pre classhighlight json tab-json>code>span classp>{/span>span classw>  /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>  /span>span classs2>verification/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>    /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>12df6045-3846-3e45-946a-14fa6136d78b/span>span classp>,/span>span classw>    /span>span classs2>code/span>span classp>:/span>span classw> /span>span classmi>9001/span>span classp>,/span>span classw>    /span>span classs2>person/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>      /span>span classs2>gender/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>      /span>span classs2>idNumber/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>      /span>span classs2>lastName/span>span classp>:/span>span classw> /span>span classs2>MORGAN/span>span classp>,/span>span classw>      /span>span classs2>addresses/span>span classp>:/span>span classw> /span>span classp>/span>span classw>        /span>span classp>{/span>span classw>          /span>span classs2>fullAddress/span>span classp>:/span>span classw> /span>span classs2>1234 Snowy Ridge Road, Indiana, 56789 USA/span>span classp>,/span>span classw>          /span>span classs2>parsedAddress/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>city/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>unit/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>state/span>span classp>:/span>span classw> /span>span classs2>Indiana/span>span classp>,/span>span classw>            /span>span classs2>street/span>span classp>:/span>span classw> /span>span classs2>1234 Snowy Ridge Road/span>span classp>,/span>span classw>            /span>span classs2>country/span>span classp>:/span>span classw> /span>span classs2>USA/span>span classp>,/span>span classw>            /span>span classs2>postcode/span>span classp>:/span>span classw> /span>span classs2>56789/span>span classp>,/span>span classw>            /span>span classs2>houseNumber/span>span classp>:/span>span classw> /span>span classs2>null/span>span classw>          /span>span classp>}/span>span classw>        /span>span classp>}/span>span classw>      /span>span classp>,/span>span classw>      /span>span classs2>firstName/span>span classp>:/span>span classw> /span>span classs2>SARAH/span>span classp>,/span>span classw>      /span>span classs2>citizenship/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>      /span>span classs2>dateOfBirth/span>span classp>:/span>span classw> /span>span classs2>1967-03-30/span>span classp>,/span>span classw>      /span>span classs2>nationality/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>      /span>span classs2>yearOfBirth/span>span classp>:/span>span classw> /span>span classs2>1967/span>span classp>,/span>span classw>      /span>span classs2>placeOfBirth/span>span classp>:/span>span classw> /span>span classs2>MADRID/span>span classp>,/span>span classw>      /span>span classs2>occupation/span>span classp>:/span>span classw> /span>span classs2>Sales Representative/span>span classp>,/span>span classw>      /span>span classs2>employer/span>span classp>:/span>span classw> /span>span classs2>Any Company LLC/span>span classp>,/span>span classw>      /span>span classs2>foreignerStatus/span>span classp>:/span>span classw> /span>span classs2>EXTRANJERO/span>span classp>,/span>span classw>      /span>span classs2>extraNames/span>span classp>:/span>span classw> /span>span classs2>NOM DUSAGE/span>span classp>,/span>span classw>      /span>span classs2>pepSanctionMatch/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>    /span>span classp>},/span>span classw>    /span>span classs2>reason/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>approved/span>span classp>,/span>span classw>    /span>span classs2>comments/span>span classp>:/span>span classw> /span>span classp>,/span>span classw>    /span>span classs2>document/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>      /span>span classs2>type/span>span classp>:/span>span classw> /span>span classs2>DRIVERS_LICENSE/span>span classp>,/span>span classw>      /span>span classs2>number/span>span classp>:/span>span classw> /span>span classs2>MORGA753116SM9IJ/span>span classp>,/span>span classw>      /span>span classs2>country/span>span classp>:/span>span classw> /span>span classs2>US/span>span classp>,/span>span classw>      /span>span classs2>remarks/span>span classp>:/span>span classw> /span>span classs2>WORK PERMITTED/span>span classp>,/span>span classw>      /span>span classs2>state/span>span classp>:/span>span classw> /span>span classs2>NY/span>span classp>,/span>span classw>      /span>span classs2>placeOfIssue/span>span classp>:/span>span classw> /span>span classs2>NEW YORK/span>span classp>,/span>span classw>      /span>span classs2>validFrom/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>      /span>span classs2>validUntil/span>span classp>:/span>span classw> /span>span classs2>2022-04-20/span>span classp>,/span>span classw>      /span>span classs2>firstIssue/span>span classp>:/span>span classw> /span>span classs2>2015-03-21/span>span classp>,/span>span classw>      /span>span classs2>issueNumber/span>span classp>:/span>span classw> /span>span classs2>01/span>span classp>,/span>span classw>      /span>span classs2>issuedBy/span>span classp>:/span>span classw> /span>span classs2>ISSUER/span>span classp>,/span>span classw>      /span>span classs2>nfcValidated/span>span classp>:/span>span classw> /span>span classs2>true/span>span classp>,/span>span classw>      /span>span classs2>residencePermitType/span>span classp>:/span>span classw> /span>span classs2>C/span>span classp>,/span>span classw>      /span>span classs2>portraitIsVisible/span>span classp>:/span>span classw> /span>span classs2>true/span>span classp>,/span>span classw>      /span>span classs2>signatureIsVisible/span>span classp>:/span>span classw> /span>span classs2>true/span>span classw>    /span>span classp>},/span>span classw>    /span>span classs2>reasonCode/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>    /span>span classs2>vendorData/span>span classp>:/span>span classw> /span>span classs2>12345678/span>span classp>,/span>span classw>    /span>span classs2>endUserId/span>span classp>:/span>span classw> /span>span classs2>fa820aba-019f-455a-ae81-cfca8075bc3f/span>span classp>,/span>span classw>    /span>span classs2>decisionTime/span>span classp>:/span>span classw> /span>span classs2>2019-11-06T07:18:36.916Z/span>span classp>,/span>span classw>    /span>span classs2>acceptanceTime/span>span classp>:/span>span classw> /span>span classs2>2019-11-06T07:15:27.000Z/span>span classp>,/span>span classw>    /span>span classs2>additionalVerifiedData/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>      /span>span classs2>driversLicenseCategory/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classs2>B/span>span classp>:/span>span classw> /span>span classkc>true/span>span classw>      /span>span classp>},/span>span classw>      /span>span classs2>driversLicenseCategoryFrom/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classs2>B/span>span classp>:/span>span classw> /span>span classs2>2019-10-06/span>span classw>      /span>span classp>},/span>span classw>      /span>span classs2>driversLicenseCategoryUntil/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classs2>B/span>span classp>:/span>span classw> /span>span classs2>2025-10-05/span>span classw>      /span>span classp>},/span>span classw>      /span>span classs2>estimatedAge/span>span classp>:/span>span classw> /span>span classmi>32/span>span classp>,/span>span classw>      /span>span classs2>estimatedGender/span>span classp>:/span>span classw> /span>span classmf>0.613/span>span classp>,/span>span classw>      /span>span classs2>processNumber/span>span classp>:/span>span classw> /span>span classs2>12345678912 1234/span>span classp>,/span>span classw>      /span>span classs2>driversLicenseNumber/span>span classp>:/span>span classw> /span>span classs2>1234569/span>span classp>,/span>span classw>      /span>span classs2>cpfValidated/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>CPF is validated/span>span classw>        /span>span classs2>cpfNumber/span>span classp>:/span>span classw> /span>span classs2>123456789/span>span classp>,/span>span classw>        /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>SARAH MORGAN/span>span classp>,/span>span classw>        /span>span classs2>dateOfBirth/span>span classp>:/span>span classw> /span>span classs2>1967-03-30/span>span classp>,/span>span classw>        /span>span classs2>yearOfDeath/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>      /span>span classp>},/span>span classw>      /span>span classs2>ineBiometricRegistryValidation/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>          /span>span classs2>faceMatch/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw>          /span>span classs2>faceMatchPercentage/span>span classp>:/span>span classw> /span>span classmi>89/span>span classp>,/span>span classw>          /span>span classs2>responseStatus/span>span classp>:/span>span classw> /span>span classs2>success/span>span classw>      /span>span classp>}/span>span classw>    /span>span classp>},/span>span classw>    /span>span classs2>riskScore/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>      /span>span classs2>score/span>span classp>:/span>span classw> /span>span classmf>0.12/span>span classw>    /span>span classp>},/span>span classw>    /span>span classs2>riskLabels/span>span classp>:/span>span classw> /span>span classp>/span>span classw>    /span>span classp>{/span>span classw>      /span>span classs2>label/span>span classp>:/span>span classw> /span>span classs2>document_integration_level_crosslinked_with_fraud/span>span classp>,/span>span classw>      /span>span classs2>category/span>span classp>:/span>span classw> /span>span classs2>document/span>span classp>,/span>span classw>      /span>span classs2>sessionIds/span>span classp>:/span>span classw> /span>span classp>/span>span classs2>5a2358e7-fd31-4fcb-a23f-4d76651ba68a/span>span classp>/span>span classw>    /span>span classp>},/span>span classw>    /span>span classp>{/span>span classw>      /span>span classs2>label/span>span classp>:/span>span classw> /span>span classs2>document_integration_level_crosslinked_with_multiple_declines/span>span classp>,/span>span classw>      /span>span classs2>category/span>span classp>:/span>span classw> /span>span classs2>document/span>span classp>,/span>span classw>      /span>span classs2>sessionIds/span>span classp>:/span>span classw> /span>span classp>/span>span classs2>fd5c1563-1d23-4b1a-ae46-7ba429927ed8/span>span classp>/span>span classw>    /span>span classp>},/span>span classw>    /span>span classs2>biometricAuthentication/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>      /span>span classs2>matchedSessionId/span>span classp>:/span>span classw> /span>span classs2>d40edb60-6ae6-4475-be72-84b81669cce6/span>span classp>,/span>span classw>      /span>span classs2>matchedSessionEndUserId/span>span classp>:/span>span classw> /span>span classs2>a1b2c35d-eš8f7-6d5e-3cd2-a1b2c35db3d4/span>span classp>,/span>span classw>      /span>span classs2>matchedSessionVendorData/span>span classp>:/span>span classw> /span>span classs2>12345678/span>span classw>      /span>span classs2>details/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classerr>.../span>span classw>      /span>span classp>}/span>span classw>    /span>span classp>}/span>span classw>  /span>span classp>},/span>span classw>  /span>span classs2>technicalData/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>    /span>span classs2>ip/span>span classp>:/span>span classw> /span>span classs2>186.153.67.122/span>span classw>  /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h3 idget-sessions-sessionid-person>span classmethod method-get>GET/span> /sessions/{sessionId}/person/h3>p>Returns information code>objects/code> about a person (hereinafter the strong>Person/strong>) associated withthe specific code>sessionId/code>./p>h4 idrequest>Request/h4>p>strong>Request method: GET/strong>br/>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  code>sessionId/code> signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idsample-request>Sample request/h5>h6 idcurl>curl/h6>pre classhighlight plaintext>code>curl -X GET \  --url /v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/person \  -H Content-Type: application/json \  -H X-AUTH-CLIENT: API-PUBLIC-KEY \  -H X-HMAC-SIGNATURE: 334141f052e317fde6668de54dc6640b4a5c47582ad86a8bed63afe566f17b14 \/code>/pre>h6 idnode-js>Node.js/h6>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>request/span>span classp>);/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>GET/span>span classp>,/span>  span classna>url/span>span classp>:/span> span classs1>/v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/person/span>span classp>,/span>  span classna>headers/span>span classp>:/span>   span classp>{/span> span classs1>Content-Type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span>     span classs1>X-HMAC-SIGNATURE/span>span classp>:/span> span classs1>334141f052e317fde6668de54dc6640b4a5c47582ad86a8bed63afe566f17b14/span>span classp>,/span>     span classs1>X-AUTH-CLIENT/span>span classp>:/span> span classs1>API-PUBLIC-KEY/span> span classp>}/span> span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span>  span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span>  span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span>span classp>});/span>/code>/pre>h6 idpython3-py>Python3.py/h6>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>json/span>span classkn>import/span> span classnn>pprint/span>span classn>url/span> span classo>/span> span classs>/v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/person/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>X-AUTH-CLIENT/span>span classp>:/span> span classs>API-PUBLIC-KEY/span>span classp>,/span>    span classs>X-HMAC-SIGNATURE/span>span classp>:/span> span classs>334141f052e317fde6668de54dc6640b4a5c47582ad86a8bed63afe566f17b14/span>span classp>,/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>GET/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classn>pprint/span>span classo>./span>span classn>pprint/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>json/span>span classp>())/span>/code>/pre>h4 idresponse>Response/h4>p>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  Request body signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idresponse-properties-explained>Response properties explained/h5>ul>    li>code>status/code>: code>string/code> Status of the request/li>    li>code>person/code>: code>object/code> List of objects identifying the Person associated with the search term        ul>        li>code>id/code>: code>uuid/code> Unique identifier of the Person/li>        li>code>firstName/code>: code>string | null/code> Persons first name as written on the document, if present/li>        li>code>lastName/code>: code>string | null/code> Persons last name as written on the document, if present/li>        li>code>idCode/code>: code>string/code> Person's ID code/li>        li>code>dateOfBirth/code>: code>string/code> (YYYY-MM-DD) Person's date of birth/li>        li>code>gender/code>: code>string/code> (M: male, F: female, null: undefined) Person's gender/li>        li>code>nationality/code>: code>string/code> ISO 3166-1 Alpha-2 country code/li>        li>code>placeOfBirth/code>: code>string/code> Person's place of birth/li>        li>code>citizenships/code>: em>Deprecated, will return  /em>/li>        li>code>pepSanctionMatches/code>: code>array/code>Array of objects identifying the PEP and Sanction values.         The array is empty if there are no hits in the database            ul>                li>code>provider/code>: code>string/code> Name of the data provider/li>                li>code>numberOfMatches/code>: code>number/code> Total number of hits/li>                li>code>date/code>: code>string/code> Combined ISO 8601 date and time in UTC (YYYY-MM-DDTHH:MM:SS.SSS+Timezone Offset|Z, i.e., em>2018-04-18T11:02:05.261Z/em>)/li>                li>code>matches/code>: code>array/code> Array listing info about matches to the search term                    ul>                        li>code>name/code>: code>string/code> Person's name/li>                        li>code>nationality/code>: code>string/code> Person's nationality/li>                        li>code>category/code>: code>string/code> Defines the category, SIP of PEP/li>                    /ul>                /li>                li>code>hits/code>: code>array/code> Array of objects listing results that match the search term                    ul>                        li>code>doc/code>: code>object/code> List of attributes identifying the info in the document of the Person                            ul>                                li>code>id/code>: code>string/code> Document number, a-zA-Z0-9 characters only/li>                                li>code>lastUpdatedUtc/code>: Combined ISO 8601 date and time in UTC (YYYY-MM-DDTHH:MM:SS.SSS+Timezone Offset|Z, i.e., 2018-04-18T11:02:05.261Z)/li>                                li>code>createdUtc/code>: Combined ISO 8601 date and time in UTC (YYYY-MM-DDTHH:MM:S.SSS+Timezone Offset|Z, i.e., 2018-04-18T11:02:05.261Z)/li>                                li>code>fields/code>: code>array/code> Array of objects describing the document fields                                    ul>                                        li>code>name/code>: code>string/code> Name of the document field/li>                                        li>code>source/code>: code>string/code> Source of the information in the document/li>                                        li>code>value/code>: code>string/code> Value in the document field/li>                                        li>code>tag/code>: code>string/code> Tag related to the name object/li>                                        li>code>locale/code>: code>string/code> Language/li>                                    /ul>                                /li>                                li>code>types/code>: code>array/code> Array of match types names as defined by the                                 data provider (possible match types names: adverse-media, adverse-media-v2-cybercrime,                                 adverse-media-v2-financial-aml-cft, adverse-media-v2-financial-difficulty,                                 adverse-media-v2-fraud-linked, adverse-media-v2-general-aml-cft, adverse-media-v2-narcotics-aml-cft,                                 adverse-media-v2-other-minor, adverse-media-v2-other-serious, adverse-media-v2-property,                                 adverse-media-v2-terrorism, adverse-media-v2-violence-aml-cft, adverse-media-v2-violence-non-aml-cft,                                 pep, pep-class-1, pep-class-2, sanction, warning)/li>                                li>code>name/code>: code>string/code> Person's name on the document/li>                                li>code>entityType/code>: code>string/code> (person) Type of entity. em>In this GET request, it's always "person"/em>/li>                                li>code>aka/code>: code>array/code> Array of objects listing the alternative names of the Person                                    ul>                                        li>code>name/code>: code>string/code> Person's alternative name/li>                                    /ul>                                /li>                                li>code>associates/code>: code>array/code> Array of objects identifying Associates of the Person                                    ul>                                        li>code>association/code>: code>string/code> Type of association (relationship)/li>                                        li>code>name/code>: code>string/code> Associate's name/li>                                    /ul>                                /li>                                li>code>sources/code>: code>array/code> Info about the information sources/li>                                li>code>keywords/code>: code>array/code> em>Will return /em>/li>                                li>code>media/code>: code>array/code> Array of objects containing media about the Person                                    ul>                                        li>code>date/code>: code>string/code> Combined ISO 8601 date and time in UTC (YYYY-MM-DDTHH:MM:SS.SSS+Timezone Offset|Z, i.e., 2022-04-18T11:02:05.261Z)/li>                                        li>code>snippet/code>: code>string/code> Text about the Person/li>                                        li>code>title/code>: code>string/code> Title of the text about the Person/li>                                        li>code>url/code>: code>string/code> Web address to the text about the Person/li>                                    /ul>                                /li>                                li>code>assets/code>: code>array/code> Array listing the info about media sources                                    ul>                                        li>code>publicURL/code>: code>string/code> Web address/li>                                        li>code>source/code>: code>string/code> Name of the source/li>                                        li>code>type/code>: code>string/code> File format/li>                                    /ul>                                /li>                                li>code>sourceNotes/code>: code>object/code> List of attributes identifying the information source                                    ul>                                        li>code>amlTypes/code>: code>array/code> List of types as defined by the data provider/li>                                        li>code>country_codes/code>: code>array/code> List of country ISO 1366-1 Alpha-2 codes/li>                                        li>code>listingStartedUtc/code>: code>string/code> Combined ISO 8601 date and time in UTC (YYYY-MM-DDTHH:MM:SS.SSS+Timezone Offset|Z, i.e., 2022-04-18T11:02:05.261Z)/li>                                        li>code>name/code>: code>string/code> Name of the info source/li>                                        li>code>url/code>: code>string/code> Web address of the info source/li>                                    /ul>                                /li>                            /ul>                        /li>                            li>code>matchTypes/code>: code>array/code> Info about which data was matched.                                        Returns the first value that is true from the following values: name_exact,                                         aka_exact, name_fuzzy, aka_fuzzy, phonetic_name, phonetic_aka, equivalent_name,                                        equivalent_aka, unknown. If appropriate, the secondary match type is returned:                                        year_of_birth, removed_personal_title, removed_personal_suffix, removed_organisation_prefix,                                        removed_organisation_suffix, removed_clerical_mark. Please see the                                        a hrefhttps://docs.complyadvantage.com/api-docs/?json#match-types-details>data providers                                        documentation/a> ↗ for more detailed info.                            /li>                            li>code>matchTypesDetails/code>: code>object/code> List of more detailed breakdown of why a match happened                                ul>                                    li>code>matchTypes/code>: code>string/code> (matching_name, sources, aml_types,                                        name_matches, secondary_matches) More detailed info about why a hit occurred.                                        Please see the a hrefhttps://docs.complyadvantage.com/api-docs/?json#example-response-1>data providers                                        documentation/a> ↗ for more detailed info.                                    /li>                                    li>code>type/code>: code>string/code> Displays the type of the match_type that was matched/li>                                /ul>                            /li>                            li>code>matchStatus/code>: code>string/code> (no_match, false_positive, potential_match,                             true_positive, unknown, true_positive_approve, true_positive_reject) Status of the match/li>                            li>code>isWhitelisted/code>: code>boolean/code> Indicates whether an entity has been whitelisted.                             Availability depends on the configuration/li>                            li>code>score/code>: code>decimal/code> Optional field. The request results match and ranking is computed via a                             score that is included as part of the metadata. It is not an absolute ranking of the document,                             only giving some relative indication of relevance. This value comes from the data provider./li>                        /ul>                    /li>                /ul>            /li>        /ul>    /li>/ul>h5 idsample-response-from-the-data-provider>Sample response from the data provider/h5>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>    /span>span classs2>person/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>b00a203e-2524-4ded-867b-b4e281a2c96b/span>span classp>,/span>span classw>        /span>span classs2>firstName/span>span classp>:/span>span classw> /span>span classs2>MUAMMAR GADDAFI/span>span classp>,/span>span classw>        /span>span classs2>lastName/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>        /span>span classs2>idCode/span>span classp>:/span>span classw> /span>span classs2>062.449.269-94/span>span classp>,/span>span classw>        /span>span classs2>dateOfBirth/span>span classp>:/span>span classw> /span>span classs2>1942-09-22/span>span classp>,/span>span classw>        /span>span classs2>gender/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>        /span>span classs2>nationality/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>        /span>span classs2>placeOfBirth/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>        /span>span classs2>citizenships/span>span classp>:/span>span classw> /span>span classp>,/span>span classw>        /span>span classs2>pepSanctionMatches/span>span classp>:/span>span classw> /span>span classp>/span>span classw>          /span>span classp>{/span>span classw>            /span>span classs2>provider/span>span classp>:/span>span classw> /span>span classs2>Comply Advantage/span>span classp>,/span>span classw>            /span>span classs2>numberOfMatches/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw>            /span>span classs2>date/span>span classp>:/span>span classw> /span>span classs2>2022-07-12T12:42:30.573Z/span>span classp>,/span>span classw>            /span>span classs2>matches/span>span classp>:/span>span classw> /span>span classp>,/span>span classw>            /span>span classs2>hits/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                /span>span classp>{/span>span classw>                    /span>span classs2>doc/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                      /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>4KJL9THDX9ZNV4W/span>span classp>,/span>span classw>                      /span>span classs2>lastUpdatedUtc/span>span classp>:/span>span classw> /span>span classs2>2022-07-09T12:50:34Z/span>span classp>,/span>span classw>                      /span>span classs2>createdUtc/span>span classp>:/span>span classw> /span>span classs2>2020-03-17T19:32:58Z/span>span classp>,/span>span classw>                      /span>span classs2>fields/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                        /span>span classp>{/span>span classw>                          /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>Original Country Text/span>span classp>,/span>span classw>                          /span>span classs2>source/span>span classp>:/span>span classw> /span>span classs2>world-bank-star-asset-recovery-watch/span>span classp>,/span>span classw>                          /span>span classs2>value/span>span classp>:/span>span classw> /span>span classs2>European Union/span>span classw>                        /span>span classp>},/span>span classw>                        /span>span classp>{/span>span classw>                          /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>Nationality/span>span classp>,/span>span classw>                          /span>span classs2>source/span>span classp>:/span>span classw> /span>span classs2>complyadvantage/span>span classp>,/span>span classw>                          /span>span classs2>value/span>span classp>:/span>span classw> /span>span classs2>Libya/span>span classw>                        /span>span classp>},/span>span classw>                        /span>span classp>{/span>span classw>                          /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>Original Place of Birth Text/span>span classp>,/span>span classw>                          /span>span classs2>source/span>span classp>:/span>span classw> /span>span classs2>hong-kong-special-administrative-region-sanctions-issued-under-the-un-sanctions-ordinance/span>span classp>,/span>span classw>                          /span>span classs2>value/span>span classp>:/span>span classw> /span>span classs2>Sirte/span>span classw>                        /span>span classp>},/span>span classw>                        /span>span classp>{/span>span classw>                          /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>Original Country Text/span>span classp>,/span>span classw>                          /span>span classs2>source/span>span classp>:/span>span classw> /span>span classs2>complyadvantage/span>span classp>,/span>span classw>                          /span>span classs2>value/span>span classp>:/span>span classw> /span>span classs2>East Africa/span>span classw>                        /span>span classp>}/span>span classw>                      /span>span classp>,/span>span classw>                      /span>span classs2>types/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                        /span>span classs2>adverse-media/span>span classp>,/span>span classw>                        /span>span classs2>adverse-media-v2-cybercrime/span>span classp>,/span>span classw>                        /span>span classs2>adverse-media-v2-financial-aml-cft/span>span classp>,/span>span classw>                        /span>span classs2>adverse-media-v2-financial-difficulty/span>span classp>,/span>span classw>                        /span>span classs2>adverse-media-v2-fraud-linked/span>span classp>,/span>span classw>                        /span>span classs2>adverse-media-v2-general-aml-cft/span>span classp>,/span>span classw>                        /span>span classs2>adverse-media-v2-narcotics-aml-cft/span>span classp>,/span>span classw>                        /span>span classs2>adverse-media-v2-other-minor/span>span classp>,/span>span classw>                        /span>span classs2>adverse-media-v2-other-serious/span>span classp>,/span>span classw>                        /span>span classs2>adverse-media-v2-property/span>span classp>,/span>span classw>                        /span>span classs2>adverse-media-v2-terrorism/span>span classp>,/span>span classw>                        /span>span classs2>adverse-media-v2-violence-aml-cft/span>span classp>,/span>span classw>                        /span>span classs2>adverse-media-v2-violence-non-aml-cft/span>span classp>,/span>span classw>                        /span>span classs2>pep/span>span classp>,/span>span classw>                        /span>span classs2>pep-class-1/span>span classp>,/span>span classw>                        /span>span classs2>pep-class-2/span>span classp>,/span>span classw>                        /span>span classs2>sanction/span>span classp>,/span>span classw>                        /span>span classs2>warning/span>span classw>                      /span>span classp>,/span>span classw>                      /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>Mouammar Mohammed Abu Minyar Kadhafi/span>span classp>,/span>span classw>                      /span>span classs2>entityType/span>span classp>:/span>span classw> /span>span classs2>person/span>span classp>,/span>span classw>                      /span>span classs2>aka/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                        /span>span classp>{/span>span classw>                          /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>Moamarr Qaddafi/span>span classw>                        /span>span classp>},/span>span classw>                        /span>span classp>{/span>span classw>                          /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>Moammar Kaddafi/span>span classw>                        /span>span classp>},/span>span classw>                        /span>span classp>{/span>span classw>                          /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>Muammer al Gaddafi/span>span classw>                        /span>span classp>},/span>span classw>                        /span>span classp>{/span>span classw>                          /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>মোৱাম্মাৰ গাড্ডাফি/span>span classw>                        /span>span classp>},/span>span classw>                        /span>span classp>{/span>span classw>                          /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>Moammar Khadafi/span>span classw>                        /span>span classp>}/span>span classw>                      /span>span classp>,/span>span classw>                      /span>span classs2>associates/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                        /span>span classp>{/span>span classw>                          /span>span classs2>association/span>span classp>:/span>span classw> /span>span classs2>spouse/span>span classp>,/span>span classw>                          /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>Fatiha al-Nuri/span>span classw>                        /span>span classp>},/span>span classw>                        /span>span classp>{/span>span classw>                          /span>span classs2>association/span>span classp>:/span>span classw> /span>span classs2>spouse/span>span classp>,/span>span classw>                          /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>Fatiha al-Nuri Gaddafi/span>span classw>                        /span>span classp>},/span>span classw>                        /span>span classp>{/span>span classw>                          /span>span classs2>association/span>span classp>:/span>span classw> /span>span classs2>child/span>span classp>,/span>span classw>                          /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>Qadhafi Muammar Mohammed Abu Minyar/span>span classw>                        /span>span classp>},/span>span classw>                        /span>span classp>{/span>span classw>                          /span>span classs2>association/span>span classp>:/span>span classw> /span>span classs2>spouse/span>span classp>,/span>span classw>                          /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>Safia el-Brasai/span>span classw>                        /span>span classp>},/span>span classw>                        /span>span classp>{/span>span classw>                          /span>span classs2>association/span>span classp>:/span>span classw> /span>span classs2>spouse/span>span classp>,/span>span classw>                          /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>Safia el-Brasai Gaddafi/span>span classw>                        /span>span classp>}/span>span classw>                      /span>span classp>,/span>span classw>                      /span>span classs2>sources/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                        /span>span classs2>argentina-ministerio-de-relaciones-exteriores-y-culto-sanciones-de-la-onu/span>span classp>,/span>span classw>                        /span>span classs2>belarus-state-security-agency-list-of-organizations-and-individuals-involved-in-terrorist-activities/span>span classw>                      /span>span classp>,/span>span classw>                      /span>span classs2>keywords/span>span classp>:/span>span classw> /span>span classp>,/span>span classw>                      /span>span classs2>media/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                        /span>span classp>{/span>span classw>                          /span>span classs2>date/span>span classp>:/span>span classw> /span>span classs2>2021-11-16T00:00:00Z/span>span classp>,/span>span classw>                          /span>span classs2>snippet/span>span classp>:/span>span classw> /span>span classs2>Sang Tan Judges in the High Court in London have ruled that Saleh Ibrahim Mabrouk, a former aide of Libyan leader Colonel Muammar Gaddafi, was partly to blame for the murder of PC Yvonne Fletcher. The gunman/span>span classp>,/span>span classw>                          /span>span classs2>title/span>span classp>:/span>span classw> /span>span classs2>Justice at Last: Former Gaddafi Aide Found Liable for 1984 Police Officer Murder by UK High Court - 16.11.2021, Sputnik International/span>span classp>,/span>span classw>                          /span>span classs2>url/span>span classp>:/span>span classw> /span>span classs2>https://sputniknews.com/amp/20211116/justice-at-last-former-gaddafi-aide-found-liable-for-1984-police-officer-murder-by-uk-high-court-1090775876.html/span>span classw>                        /span>span classp>}/span>span classw>                      /span>span classp>,/span>span classw>                      /span>span classs2>assets/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                        /span>span classp>{/span>span classw>                          /span>span classs2>publicUrl/span>span classp>:/span>span classw> /span>span classs2>http://complyadvantage-asset.s3.amazonaws.com/76993a49-2d1e-4397-9e35-1e20f2b7dfa8.pdf/span>span classp>,/span>span classw>                          /span>span classs2>source/span>span classp>:/span>span classw> /span>span classs2>world-bank-star-asset-recovery-watch/span>span classp>,/span>span classw>                          /span>span classs2>type/span>span classp>:/span>span classw> /span>span classs2>pdf/span>span classw>                        /span>span classp>}/span>span classw>                      /span>span classp>,/span>span classw>                      /span>span classs2>sourceNotes/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                        /span>span classs2>argentinaMinisterioDeRelacionesExterioresYCultoSancionesDeLaOnu/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                          /span>span classs2>amlTypes/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                            /span>span classs2>sanction/span>span classw>                          /span>span classp>,/span>span classw>                          /span>span classs2>listingStartedUtc/span>span classp>:/span>span classw> /span>span classs2>2019-09-26T00:00:00Z/span>span classp>,/span>span classw>                          /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>Argentina Ministerio de Relaciones Exteriores y Culto Sanciones de la ONU/span>span classp>,/span>span classw>                          /span>span classs2>url/span>span classp>:/span>span classw> /span>span classs2>https://www.cancilleria.gob.ar/es/politica-exterior/seguridad-internacional/comite-de-sanciones/span>span classw>                        /span>span classp>},/span>span classw>                        /span>span classs2>belarusStateSecurityAgencyListOfOrganizationsAndIndividualsInvolvedInTerroristActivities/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                          /span>span classs2>amlTypes/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                            /span>span classs2>sanction/span>span classw>                          /span>span classp>,/span>span classw>                          /span>span classs2>listingStartedUtc/span>span classp>:/span>span classw> /span>span classs2>2019-08-28T00:00:00Z/span>span classp>,/span>span classw>                          /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>Belarus State Security Agency List of Organizations and Individuals Involved in Terrorist Activities/span>span classp>,/span>span classw>                          /span>span classs2>url/span>span classp>:/span>span classw> /span>span classs2>http://kgb.by/ru/perechen-inf-ru//span>span classw>                        /span>span classp>},/span>span classw>                        /span>span classs2>complyadvantageAdverseMedia/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                          /span>span classs2>amlTypes/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                            /span>span classs2>adverse-media/span>span classp>,/span>span classw>                            /span>span classs2>adverse-media-v2-cybercrime/span>span classp>,/span>span classw>                            /span>span classs2>adverse-media-v2-financial-aml-cft/span>span classp>,/span>span classw>                            /span>span classs2>adverse-media-v2-financial-difficulty/span>span classp>,/span>span classw>                            /span>span classs2>adverse-media-v2-fraud-linked/span>span classp>,/span>span classw>                            /span>span classs2>adverse-media-v2-general-aml-cft/span>span classp>,/span>span classw>                            /span>span classs2>adverse-media-v2-narcotics-aml-cft/span>span classp>,/span>span classw>                            /span>span classs2>adverse-media-v2-other-minor/span>span classp>,/span>span classw>                            /span>span classs2>adverse-media-v2-other-serious/span>span classp>,/span>span classw>                            /span>span classs2>adverse-media-v2-property/span>span classp>,/span>span classw>                            /span>span classs2>adverse-media-v2-terrorism/span>span classp>,/span>span classw>                            /span>span classs2>adverse-media-v2-violence-aml-cft/span>span classp>,/span>span classw>                            /span>span classs2>adverse-media-v2-violence-non-aml-cft/span>span classw>                          /span>span classp>,/span>span classw>                          /span>span classs2>countryCodes/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                            /span>span classs2>AE/span>span classp>,/span>span classw>                            /span>span classs2>AM/span>span classp>,/span>span classw>                            /span>span classs2>AR/span>span classw>                          /span>span classp>,/span>span classw>                          /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>ComplyAdvantage Adverse Media/span>span classw>                        /span>span classp>},/span>span classw>                        /span>span classs2>dfatAustraliaList/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                          /span>span classs2>amlTypes/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                            /span>span classs2>sanction/span>span classw>                          /span>span classp>,/span>span classw>                          /span>span classs2>countryCodes/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                            /span>span classs2>LY/span>span classp>,/span>span classw>                            /span>span classs2>OM/span>span classw>                          /span>span classp>,/span>span classw>                          /span>span classs2>listingStartedUtc/span>span classp>:/span>span classw> /span>span classs2>2011-02-26T00:00:00Z/span>span classp>,/span>span classw>                          /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>DFAT Australia Consolidated Sanctions List/span>span classp>,/span>span classw>                          /span>span classs2>url/span>span classp>:/span>span classw> /span>span classs2>https://www.dfat.gov.au/international-relations/security/sanctions/Pages/consolidated-list.aspx/span>span classw>                        /span>span classp>}/span>span classw>                      /span>span classp>},/span>span classw>                    /span>span classp>},/span>span classw>                  /span>span classs2>matchTypes/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                    /span>span classs2>aka_exact/span>span classp>,/span>span classw>                    /span>span classs2>year_of_birth/span>span classw>                  /span>span classp>,/span>span classw>                  /span>span classs2>matchTypesDetails/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                    /span>span classs2>gaddafiMuammar/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                      /span>span classs2>matchTypes/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                        /span>span classs2>gaddafi/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                          /span>span classs2>name_exact/span>span classw>                        /span>span classp>,/span>span classw>                        /span>span classs2>muammar/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                          /span>span classs2>name_exact/span>span classw>                        /span>span classp>/span>span classw>                      /span>span classp>},/span>span classw>                      /span>span classs2>type/span>span classp>:/span>span classw> /span>span classs2>aka/span>span classw>                    /span>span classp>},/span>span classw>                    /span>span classs2>muammarGaddafi/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                      /span>span classs2>matchTypes/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                        /span>span classs2>gaddafi/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                          /span>span classs2>name_exact/span>span classw>                        /span>span classp>,/span>span classw>                        /span>span classs2>muammar/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                          /span>span classs2>name_exact/span>span classw>                        /span>span classp>/span>span classw>                      /span>span classp>},/span>span classw>                      /span>span classs2>type/span>span classp>:/span>span classw> /span>span classs2>aka/span>span classw>                    /span>span classp>}/span>span classw>                  /span>span classp>},/span>span classw>                  /span>span classs2>matchStatus/span>span classp>:/span>span classw> /span>span classs2>potential_match/span>span classp>,/span>span classw>                  /span>span classs2>isWhitelisted/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw>                  /span>span classs2>score/span>span classp>:/span>span classw> /span>span classmf>24.46217/span>span classw>                /span>span classp>}/span>span classw>            /span>span classp>/span>span classw>         /span>span classp>}/span>span classw>      /span>span classp>/span>span classw>   /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h3 idget-sessions-sessionid-media>span classmethod method-get>GET/span> /sessions/{sessionId}/media/h3>p>Returns a list of media code>objects/code> with sessionId  {sessionId}/p>p>The list of objects are sorted based on their accuracy (e.g., does an image match the required image type) and theirquality. The order is determined by the automation system./p>p>Note that the request will return the media objects of the most strong>recent attempt/strong>. If you require the media of a certainattempt, you can call the list of code>attemptId/code>-s with a href#get-sessions-sessionid-attempts>GET sessions/{sessionId}/attempts/a>and then use the a href#get-attempts-attemptid-media>GET attempts/{attemptId}/media/a> to get the media of a specific attempt./p>h4 idrequest>Request/h4>p>strong>Request method: GET/strong>br/>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers:/strong>br/>code>X-AUTH-CLIENT: string (required)/code>   strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  code>sessionId/code> signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idsample-request>Sample request/h5>h6 idcurl>curl/h6>pre classhighlight plaintext>code>curl -X GET \  --url /v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/media \  -H Content-Type: application/json \  -H X-AUTH-CLIENT: API-PUBLIC-KEY \  -H X-HMAC-SIGNATURE: 334141f052e317fde6668de54dc6640b4a5c47582ad86a8bed63afe566f17b14/code>/pre>h6 idnode-js>Node.js/h6>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>request/span>span classp>);/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>GET/span>span classp>,/span>  span classna>url/span>span classp>:/span> span classs1>/v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/media/span>span classp>,/span>  span classna>headers/span>span classp>:/span>   span classp>{/span> span classs1>Content-Type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span>     span classs1>X-HMAC-SIGNATURE/span>span classp>:/span> span classs1>334141f052e317fde6668de54dc6640b4a5c47582ad86a8bed63afe566f17b14/span>span classp>,/span>     span classs1>X-AUTH-CLIENT/span>span classp>:/span> span classs1>API-PUBLIC-KEY/span> span classp>}/span> span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span>  span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span>  span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span>span classp>});/span>/code>/pre>h6 idpython3-py>Python3.py/h6>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>json/span>span classkn>import/span> span classnn>pprint/span>span classn>url/span> span classo>/span> span classs>/v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/media/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>X-AUTH-CLIENT/span>span classp>:/span> span classs>API-PUBLIC-KEY/span>span classp>,/span>    span classs>X-HMAC-SIGNATURE/span>span classp>:/span> span classs>334141f052e317fde6668de54dc6640b4a5c47582ad86a8bed63afe566f17b14/span>span classp>,/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>GET/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classn>pprint/span>span classo>./span>span classn>pprint/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>json/span>span classp>())/span>/code>/pre>h4 idresponse>Response/h4>p>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  Request body signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idresponse-properties-explained>Response properties explained/h5>ul>li>code>status/code>: code>string/code> Status of the request/li>li>code>videos/code>: code>array/code> Array of JSON objects identifying the videosul>li>code>context/code>: code>string/code> Context type of the video. See a href#video-context-types>here/a> for more info about the video code>context/code>./li>li>code>id/code>: code>UUID/code>-v4 Video Id/li>li>code>mimetype/code>: code>string/code> Format of the media file. See a href#media-file-mimetypes>Mimetypes table/a> for more info/li>li>code>name/code>: code>string/code> Video name/li>li>code>sessionId/code>: code>UUID/code> -v4 Session Idbr>/li>li>code>duration/code>: code>string/code> Video duration in seconds/li>li>code>url/code>: code>string/code> Video download url/li>li>code>size/code>: code>string/code> Video size in bytes/li>li>code>timestamp/code>: code>object/code> (Deprecated) Timestamp object, will return null/None/li>/ul>/li>li>code>images/code>: code>array/code> Array of JSON objects identifying the imagesul>li>code>context/code>: code>string/code> Context type of the image. See a href#image-context-types>here/a> for more info about the image code>context/code>./li>li>code>id/code>: code>UUID/code>-v4 Image Id/li>li>code>name/code>: code>string/code> Image name/li>li>code>url/code>: code>string/code> Image download url/li>li>code>sessionId/code>: code>UUID/code> -v4 Session Id/li>li>code>size/code>: code>string/code> Image size in bytes/li>li>code>mimetype/code>: code>string/code> Format of the media file. See a href#media-file-mimetypes>Mimetypes table/a> for more info/li>li>code>timestamp/code>: code>object/code> (Deprecated) Timestamp object, will return null/None/li>/ul>/li>/ul>aside classnotice>Note that when this request is done in a b>test integration/b>, it is expected behaviour that no video is returned./aside>h5 idsample-response>Sample response/h5>pre classhighlight json tab-json>code>span classp>{/span>span classw>  /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>  /span>span classs2>videos/span>span classp>:/span>span classw> /span>span classp>/span>span classw>    /span>span classp>{/span>span classw>      /span>span classs2>context/span>span classp>:/span>span classw> /span>span classs2>{VIDEO_TYPE}/span>span classp>,/span>span classw>      /span>span classs2>duration/span>span classp>:/span>span classw> /span>span classs2>{DURATION_IN_SECONDS}/span>span classp>,/span>span classw>      /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>{MEDIA_ID}/span>span classp>,/span>span classw>      /span>span classs2>mimetype/span>span classp>:/span>span classw> /span>span classs2>{MEDIA_MIME_TYPE}/span>span classp>,/span>span classw>      /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>{VIDEO_NAME}/span>span classp>,/span>span classw>      /span>span classs2>sessionId/span>span classp>:/span>span classw> /span>span classs2>{SESSIOND_ID}/span>span classp>,/span>span classw>      /span>span classs2>size/span>span classp>:/span>span classw> /span>span classs2>{SIZE_IN_B}/span>span classp>,/span>span classw>      /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classerr>(Deprecated)/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>      /span>span classs2>url/span>span classp>:/span>span classw> /span>span classs2>{MEDIA_DOWNLOAD_URL}/span>span classw>    /span>span classp>}/span>span classw>  /span>span classp>,/span>span classw>  /span>span classs2>images/span>span classp>:/span>span classw> /span>span classp>/span>span classw>    /span>span classp>{/span>span classw>      /span>span classs2>context/span>span classp>:/span>span classw> /span>span classs2>{IMAGE_TYPE}/span>span classp>,/span>span classw>      /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>{MEDIA_ID}/span>span classp>,/span>span classw>      /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>{IMAGE_NAME}/span>span classp>,/span>span classw>      /span>span classs2>url/span>span classp>:/span>span classw> /span>span classs2>{MEDIA_DOWNLOAD_URL}/span>span classp>,/span>span classw>      /span>span classs2>sessionId/span>span classp>:/span>span classw> /span>span classs2>{SESSIOND_ID}/span>span classp>,/span>span classw>      /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classerr>(Deprecated)/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>      /span>span classs2>size/span>span classp>:/span>span classw> /span>span classs2>{SIZE_IN_B}/span>span classp>,/span>span classw>      /span>span classs2>mimetype/span>span classp>:/span>span classw> /span>span classs2>{MEDIA_MIME_TYPE}/span>span classw>    /span>span classp>}/span>span classw>  /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h3 idget-sessions-sessionid-watchlist-screening>span classmethod method-get>GET/span> /sessions/{sessionId}/watchlist-screening/h3>p>Returns a list of data objects from PEP and Sanctions services for specific code>sessionId/code>./p>p>Only available for customers using the Veriff PEP and Sanctions services./p>h4 idrequest>Request/h4>p>strong>Request method: GET/strong>br/>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> object.br/>strong>Headers/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  code>session/code> signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idsample-request>Sample request/h5>h6 idcurl>curl/h6>pre classhighlight plaintext>code>curl -X GET \  --url /v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/watchlist-screening \  -H Content-Type: application/json \  -H X-AUTH-CLIENT: API-PUBLIC-KEY \  -H X-HMAC-SIGNATURE: 334141f052e317fde6668de54dc6640b4a5c47582ad86a8bed63afe566f17b14 \/code>/pre>h6 idnode-js>Node.js/h6>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>request/span>span classp>);/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>GET/span>span classp>,/span>  span classna>url/span>span classp>:/span> span classs1>/v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/watchlist-screening/span>span classp>,/span>  span classna>headers/span>span classp>:/span>   span classp>{/span> span classs1>Content-Type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span>     span classs1>X-HMAC-SIGNATURE/span>span classp>:/span> span classs1>334141f052e317fde6668de54dc6640b4a5c47582ad86a8bed63afe566f17b14/span>span classp>,/span>     span classs1>X-AUTH-CLIENT/span>span classp>:/span> span classs1>API-PUBLIC-KEY/span> span classp>}/span> span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span>  span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span>  span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span>span classp>});/span>/code>/pre>h6 idpython3-py>Python3.py/h6>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>json/span>span classkn>import/span> span classnn>pprint/span>span classn>url/span> span classo>/span> span classs>/v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/watchlist-screening/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>X-AUTH-CLIENT/span>span classp>:/span> span classs>API-PUBLIC-KEY/span>span classp>,/span>    span classs>X-HMAC-SIGNATURE/span>span classp>:/span> span classs>334141f052e317fde6668de54dc6640b4a5c47582ad86a8bed63afe566f17b14/span>span classp>,/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>GET/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classn>pprint/span>span classo>./span>span classn>pprint/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>json/span>span classp>())/span>/code>/pre>h4 idresponse>Response/h4>p>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  Request body signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idresponse-properties-explained>Response properties explained/h5>ul>li>code>status/code>: code>string/code> Status of the response/li>li>code>data/code>: code>object/code> Status of the responseul>li>code>attemptId/code>: code>string/code> UUID v4 which identifies session attempt/li>li>code>sessionId/code>: code>string/code> UUID v4 which identifies session/li>li>code>vendorData/code>: code>string/code> End-user-specific data string, max 1000 characters long, created by the customer. Sent backunmodified via API responses and webhooks, or as code>null/code> if not provided/li>li>code>endUserId/code>: code>uuid | null/code> End-user-specific UUID created by the customer to identify the end-user. Returnedunmodified in webhooks and public API calls, or as code>null/code> if not provided/li>li>code>checkType/code>: code>string/code> (one of initial_result, updated_result)/li>li>code>matchStatus/code>: code>string/code> (one of possible_match, no_match)/li>li>code>searchTerm/code>: code>object/code> Data used to perform the checkul>li>code>name/code>: code>string/code> Full name used during the check/li>li>code>year/code>: code>string/code> Birth year used during the check/li>/ul>/li>li>code>totalHits/code>: code>integer/code> Total number of hits returned from the check/li>li>code>createdAt/code>: code>string/code> Timestamp indicating when the check response was received/li>li>code>hits/code>: code>array/code> Check response hits array of matched records. Empty array if no hits were not foundul>li>code>matchedName/code>: code>string/code> The name that was matched in this hit based on the search term/li>li>code>countries/code>: code>array/code> List of countries that sources listed in relation to this hit/li>li>code>dateOfBirth/code>: code>string/code> Birth date of the person in the matched listings/li>li>code>dateOfDeath/code>: code>string/code> Death date of the person in the matched listings/li>li>code>matchTypes/code>: code>array/code> Array that shows the match type in the listings/li>li>code>aka/code>: code>array/code> Array of names that the matched person is also known as/li>li>code>associates/code>: code>array/code> Array of names that the matched person is associated with/li>li>code>listingsRelatedToMatch/code>: code>object/code> Matched listingsul>li>code>warnings/code>: code>array/code> Array of warning matches. Empty array if no warnings were foundul>li>code>sourceName/code>: code>string/code> Name of the listing/li>li>code>sourceUrl/code>: code>string/code> Url of the listing/li>li>code>date/code>: code>string | null/code> Date of the listing. Null if listing does not have a date/li>/ul>/li>li>code>sanctions/code>: code>array/code> Array of sanctions matches. Empty array if no sanctions were foundul>li>code>sourceName/code>: code>string/code> Name of the listing/li>li>code>sourceUrl/code>: code>string/code> Url of the listing/li>li>code>date/code>: code>string | null/code> Date of the listing. Null if listing does not have a date/li>/ul>/li>li>code>fitnessProbity/code>: code>array/code> Array of fitness probity matches. Empty array if no fitness probabilities were foundul>li>code>sourceName/code>: code>string/code> Name of the listing/li>li>code>sourceUrl/code>: code>string/code> Url of the listing/li>li>code>date/code>: code>string | null/code> Date of the listing. Null if listing does not have a date/li>/ul>/li>li>code>pep/code>: code>array/code> Array of PEP matches. Empty array if no PEP matches were foundul>li>code>sourceName/code>: code>string/code> Name of the listing/li>li>code>sourceUrl/code>: code>string/code> Url of the listing/li>li>code>date/code>: code>string | null/code> Date of the listing. Null if listing does not have a date/li>/ul>/li>li>code>adverseMedia/code>: code>array/code> Array of media matches. Empty array if no media were foundul>li>code>sourceName/code>: code>string/code> Name of the listing/li>li>code>sourceUrl/code>: code>string/code> Url of the listing/li>li>code>date/code>: code>string | null/code> Date of the listing. Null if listing does not have a date/li>/ul>/li>/ul>/li>/ul>/li>/ul>/li>/ul>h5 idsample-response>Sample response/h5>h6 idno-match>No match/h6>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>     /span>span classs2>data/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>         /span>span classs2>attemptId/span>span classp>:/span>span classw> /span>span classs2>aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/span>span classp>,/span>span classw>         /span>span classs2>sessionId/span>span classp>:/span>span classw> /span>span classs2>f04bdb47-d3be-4b28-b028-a652feb060b5/span>span classp>,/span>span classw>         /span>span classs2>vendorData/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>         /span>span classs2>endUserId/span>span classp>:/span>span classw> /span>span classs2>fa820aba-019f-455a-ae81-cfca8075bc3f/span>span classp>,/span>span classw>         /span>span classs2>checkType/span>span classp>:/span>span classw> /span>span classs2>initial_result/span>span classp>,/span>span classw>         /span>span classs2>matchStatus/span>span classp>:/span>span classw> /span>span classs2>no_match/span>span classp>,/span>span classw>         /span>span classs2>searchTerm/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>             /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>Juan Rico/span>span classw>         /span>span classp>},/span>span classw>         /span>span classs2>totalHits/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw>         /span>span classs2>createdAt/span>span classp>:/span>span classw> /span>span classs2>2021-06-15T08:27:33.015Z/span>span classp>,/span>span classw>         /span>span classs2>hits/span>span classp>:/span>span classw> /span>span classp>/span>span classw>     /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h6 idpossible-match>Possible match/h6>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>    /span>span classs2>data/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classs2>attemptId/span>span classp>:/span>span classw> /span>span classs2>aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/span>span classp>,/span>span classw>        /span>span classs2>sessionId/span>span classp>:/span>span classw> /span>span classs2>f04bdb47-d3be-4b28-b028-a652feb060b5/span>span classp>,/span>span classw>        /span>span classs2>vendorData/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>        /span>span classs2>endUserId/span>span classp>:/span>span classw> /span>span classs2>fa820aba-019f-455a-ae81-cfca8075bc3f/span>span classp>,/span>span classw>        /span>span classs2>checkType/span>span classp>:/span>span classw> /span>span classs2>updated_result/span>span classp>,/span>span classw>        /span>span classs2>matchStatus/span>span classp>:/span>span classw> /span>span classs2>possible_match/span>span classp>,/span>span classw>        /span>span classs2>searchTerm/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>Mirko Kokki/span>span classp>,/span>span classw>            /span>span classs2>year/span>span classp>:/span>span classw> /span>span classs2>1960/span>span classw>        /span>span classp>},/span>span classw>        /span>span classs2>totalHits/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw>        /span>span classs2>createdAt/span>span classp>:/span>span classw> /span>span classs2>2021-07-05T13:23:59.851Z/span>span classp>,/span>span classw>        /span>span classs2>hits/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>matchedName/span>span classp>:/span>span classw> /span>span classs2>Miro kokkino/span>span classp>,/span>span classw>            /span>span classs2>countries/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                /span>span classs2>Australia/span>span classp>,/span>span classw>                /span>span classs2>Brazil/span>span classw>            /span>span classp>,/span>span classw>            /span>span classs2>dateOfBirth/span>span classp>:/span>span classw> /span>span classs2>1963/span>span classp>,/span>span classw>            /span>span classs2>dateOfDeath/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>matchTypes/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                /span>span classs2>aka_exact/span>span classp>,/span>span classw>                /span>span classs2>year_of_birth/span>span classw>            /span>span classp>,/span>span classw>            /span>span classs2>aka/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                /span>span classs2>Mirkoni kokki/span>span classp>,/span>span classw>                /span>span classs2>Mirkor Kokki/span>span classw>            /span>span classp>,/span>span classw>            /span>span classs2>associates/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                /span>span classs2>Desmon Lamela/span>span classp>,/span>span classw>                /span>span classs2>Fred Austin/span>span classw>            /span>span classp>,/span>span classw>            /span>span classs2>listingsRelatedToMatch/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                /span>span classs2>warnings/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                    /span>span classs2>sourceName/span>span classp>:/span>span classw> /span>span classs2>FBI Most Wanted/span>span classp>,/span>span classw>                    /span>span classs2>sourceUrl/span>span classp>:/span>span classw> /span>span classs2>http://www.fbi.gov/wanted/span>span classp>,/span>span classw>                    /span>span classs2>date/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>                /span>span classp>},/span>span classw>                /span>span classs2>sanctions/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                    /span>span classs2>sourceName/span>span classp>:/span>span classw> /span>span classs2>Argentina Ministerio de Relaciones Exteriores y Culto Sanciones de la ONU/span>span classp>,/span>span classw>                    /span>span classs2>sourceUrl/span>span classp>:/span>span classw> /span>span classs2>https://www.cancilleria.gob.ar/es/politica-exterior/seguridad-internacional/comite-de-sanciones/span>span classp>,/span>span classw>                    /span>span classs2>date/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>                /span>span classp>},/span>span classw>                /span>span classs2>fitnessProbity/span>span classp>:/span>span classw> /span>span classp>,/span>span classw>                /span>span classs2>pep/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                    /span>span classs2>sourceName/span>span classp>:/span>span classw> /span>span classs2>United Kingdom Insolvency Service Disqualified Directors/span>span classp>,/span>span classw>                    /span>span classs2>sourceUrl/span>span classp>:/span>span classw> /span>span classs2>https://www.insolvencydirect.bis.gov.uk/IESdatabase/viewdirectorsummary-new.asp/span>span classp>,/span>span classw>                    /span>span classs2>date/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>                /span>span classp>},/span>span classw>                /span>span classs2>adverseMedia/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                    /span>span classs2>sourceName/span>span classp>:/span>span classw> /span>span classs2>SNAs Old Salt Award Passed to Adm. Davidson/span>span classp>,/span>span classw>                    /span>span classs2>sourceUrl/span>span classp>:/span>span classw> /span>span classs2>https://www.marinelink.com/amp/news/snas-old-salt-award-passed-adm-davidson-443093/span>span classp>,/span>span classw>                    /span>span classs2>date/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>                /span>span classp>}/span>span classw>            /span>span classp>}/span>span classw>        /span>span classp>}/span>span classw>    /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h6 idfailed-response>Failed response/h6>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>fail/span>span classp>,/span>span classw>    /span>span classs2>code/span>span classp>:/span>span classw> /span>span classs2>1818/span>span classp>,/span>span classw>    /span>span classs2>message/span>span classp>:/span>span classw> /span>span classs2>Signature /span>span classse>\/span>span classs2>334141f052e317fde6668de54dc6640b4a5c47582ad86a8bed63afe566f17b14/span>span classse>\/span>span classs2> does not match the HMAC-SHA256 of query ID and integration API secret./span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h3 iddelete-sessions-sessionid>span classmethod method-delete>DELETE/span> /sessions/{sessionId}/h3>p>Method to request deletion of a session, a session is eligible for deletion on code>created/code>, code>started/code>, code>abandoned/code>,code>expired/code>, code>approved/code>, code>resubmission_requested/code>, code>declined/code>, code>inflow_completed/code>, code>review/code> statuses. Attempting todelete the session in other statuses will respond with the code>Session is not in a completed status./code> error message.The availability of this feature is optional, depending on integration./p>p>If session status is one of the following code>created/code>, code>started/code> or code>resubmission_requested/code> a decision webhook withcode>expired/abandoned/code> status will be sent. After successful request, session will immediately become unavailablein Station and API. Data will be deleted within 12 hours./p>p>Rate-limit is: 10 sessions per 24 hours and 5 sessions per 1 hour./p>aside classnotice>Please ask your b>solutions engineer/b> to configure the feature for your integration./aside>h4 idrequest>Request/h4>p>strong>Request method: DELETE/strong>br/>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers:/strong>br/>code>X-AUTH-CLIENT: string (required)/code>   strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  code>sessionId/code> signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idsample-request>Sample request/h5>h6 idcurl>curl/h6>pre classhighlight plaintext>code>curl -X DELETE \  --url /v1/sessions/fd5c1563-1d23-4b1a-ae46-7ba429927ed8 \  -H Content-Type: application/json \  -H X-AUTH-CLIENT: API-PUBLIC-KEY \  -H X-HMAC-SIGNATURE: dd994f70b1150ae012f9c1d6d20adf7ed69780044835d39de20b00ffae0660a0/code>/pre>h6 idnode-js>Node.js/h6>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>request/span>span classp>);/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>DELETE/span>span classp>,/span>  span classna>url/span>span classp>:/span> span classs1>/v1/sessions/fd5c1563-1d23-4b1a-ae46-7ba429927ed8/span>span classp>,/span>  span classna>headers/span>span classp>:/span> span classp>{/span>     span classs1>Content-Type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span>     span classs1>X-HMAC-SIGNATURE/span>span classp>:/span> span classs1>dd994f70b1150ae012f9c1d6d20adf7ed69780044835d39de20b00ffae0660a0/span>span classp>,/span>     span classs1>X-AUTH-CLIENT/span>span classp>:/span> span classs1>API-PUBLIC-KEY/span>  span classp>},/span> span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span>  span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span>  span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span>span classp>});/span>/code>/pre>h6 idpython3-py>Python3.py/h6>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>json/span>span classkn>import/span> span classnn>pprint/span>span classn>url/span> span classo>/span> span classs>/v1/sessions/{sessionId}/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>X-AUTH-CLIENT/span>span classp>:/span> span classs>API-PUBLIC-KEY/span>span classp>,/span>    span classs>X-HMAC-SIGNATURE/span>span classp>:/span> span classs>dd994f70b1150ae012f9c1d6d20adf7ed69780044835d39de20b00ffae0660a0/span>span classp>,/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>DELETE/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classn>pprint/span>span classo>./span>span classn>pprint/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>json/span>span classp>())/span>/code>/pre>h4 idresponse>Response/h4>p>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers:/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  Request body signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idsuccessful-response>Successful response/h5>p>strong>Response HTTP status code/strong>: 202 Acceptedbr>strong>Response body/strong>:/p>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>    /span>span classs2>verification/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>fd5c1563-1d23-4b1a-ae46-7ba429927ed8/span>span classw>    /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h5 idfailed-responses>Failed responses/h5>p>strong>Response HTTP status code/strong>: 400 Bad Requestbr>strong>Response body/strong>:/p>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>fail/span>span classp>,/span>span classw>    /span>span classs2>code/span>span classp>:/span>span classw> /span>span classs2>1305/span>span classp>,/span>span classw>    /span>span classs2>message/span>span classp>:/span>span classw> /span>span classs2>Session is not in a completed status./span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>p>strong>Response HTTP status code/strong>: 400 Bad Requestbr>strong>Response body/strong>:/p>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>fail/span>span classp>,/span>span classw>    /span>span classs2>code/span>span classp>:/span>span classw> /span>span classs2>1306/span>span classp>,/span>span classw>    /span>span classs2>message/span>span classp>:/span>span classw> /span>span classs2>Session in progress./span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h5 idlimited-access-response>Limited access response/h5>p>strong>Response HTTP status code/strong>: 429 Too Many Requestsbr>strong>Response body/strong>:/p>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classmi>429/span>span classp>,/span>span classw>    /span>span classs2>code/span>span classp>:/span>span classw> /span>span classs2>1004/span>span classp>,/span>span classw>    /span>span classs2>message/span>span classp>:/span>span classw> /span>span classs2>Too many requests/span>span classp>,/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h3 idget-attempts-attemptid-media>span classmethod method-get>GET/span> /attempts/{attemptId}/media/h3>p>Returns a list of media objects with attemptId  {attemptId}/p>p>The list of objects are sorted based on their accuracy (e.g., does an image match the required image type) and theirquality. The order is determined by the automation system./p>h4 idrequest>Request/h4>p>strong>Request method: GET/strong>br/>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers:/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  code>attemptId/code> signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idsample-request>Sample request/h5>h6 idcurl>curl/h6>pre classhighlight plaintext>code>curl -X GET \  --url /v1/attempts/f5c68aea-7f4d-478d-80ab-ca9356074f69/media \  -H Content-Type: application/json \  -H X-AUTH-CLIENT: API-PUBLIC-KEY \  -H X-HMAC-SIGNATURE: acfe1cf21c986edf25cc6bc74fd769954443bbb606500019a4bed46645179b36 \/code>/pre>h6 idnode-js>Node.js/h6>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>request/span>span classp>);/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>GET/span>span classp>,/span>  span classna>url/span>span classp>:/span> span classs1>/v1/attempts/f5c68aea-7f4d-478d-80ab-ca9356074f69/media/span>span classp>,/span>  span classna>headers/span>span classp>:/span>   span classp>{/span> span classs1>Content-Type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span>     span classs1>X-HMAC-SIGNATURE/span>span classp>:/span> span classs1>acfe1cf21c986edf25cc6bc74fd769954443bbb606500019a4bed46645179b36/span>span classp>,/span>     span classs1>X-AUTH-CLIENT/span>span classp>:/span> span classs1>API-PUBLIC-KEY/span> span classp>}/span> span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span>  span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span>  span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span>span classp>});/span>/code>/pre>h6 idpython3-py>Python3.py/h6>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>json/span>span classkn>import/span> span classnn>pprint/span>span classn>url/span> span classo>/span> span classs>/v1/attempts/f5c68aea-7f4d-478d-80ab-ca9356074f69/media/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>X-AUTH-CLIENT/span>span classp>:/span> span classs>API-PUBLIC-KEY/span>span classp>,/span>    span classs>X-HMAC-SIGNATURE/span>span classp>:/span> span classs>acfe1cf21c986edf25cc6bc74fd769954443bbb606500019a4bed46645179b36/span>span classp>,/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>GET/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classn>pprint/span>span classo>./span>span classn>pprint/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>json/span>span classp>())/span>/code>/pre>h4 idresponse>Response/h4>p>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers:/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  Request body signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idresponse-properties-explained>Response properties explained/h5>ul>li>code>status/code>: code>string/code> Status of the request/li>li>code>videos/code>: code>array/code> Array of JSON objects identifying the videosul>li>code>context/code>: code>string/code> Context type of the video. See a href#video-context-types>here/a> for more info about the video code>context/code>./li>li>code>id/code>: code>UUID/code>-v4 Video Id/li>li>code>name/code>: code>string/code> Video name/li>li>code>duration/code>: code>string/code> Video duration in seconds/li>li>code>url/code>: code>string/code> Video download url/li>li>code>size/code>: code>string/code> Video size in bytes/li>li>code>timestamp/code>: code>object/code> (Deprecated) Timestamp object, will return null/None/li>li>code>mimetype/code>: code>string/code> Format of the media file. See a href#media-file-mimetypes>Mimetypes table/a> for more info/li>/ul>/li>li>code>images/code>: code>array/code> Array of JSON objects identifying the imagesul>li>code>context/code>: code>string/code> Context type of the image. See a href#image-context-types>here/a> for more info about the image code>context/code>./li>li>code>id/code>: code>UUID-v4/code> Image Id/li>li>code>name/code>: code>string/code> Image name/li>li>code>url/code>: code>string/code> Image download url/li>li>code>size/code>: code>string/code> Image size in bytes/li>li>code>timestamp/code>: code>object/code> (Deprecated) Timestamp object, will return null/None/li>li>code>mimetype/code>: code>string/code> Format of the media file. See a href#media-file-mimetypes>Mimetypes table/a> for more info/li>/ul>/li>/ul>h5 idsample-response>Sample response/h5>pre classhighlight json tab-json>code>span classp>{/span>span classw>  /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>  /span>span classs2>videos/span>span classp>:/span>span classw> /span>span classp>/span>span classw>    /span>span classp>{/span>span classw>      /span>span classs2>context/span>span classp>:/span>span classw> /span>span classs2>{VIDEO_TYPE}/span>span classp>,/span>span classw>      /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>{MEDIA_ID}/span>span classp>,/span>span classw>      /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>{VIDEO_NAME}/span>span classp>,/span>span classw>      /span>span classs2>duration/span>span classp>:/span>span classw> /span>span classs2>{DURATION_IN_SECONDS}/span>span classp>,/span>span classw>      /span>span classs2>url/span>span classp>:/span>span classw> /span>span classs2>{MEDIA_DOWNLOAD_URL}/span>span classp>,/span>span classw>      /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classerr>(Deprecated)/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>      /span>span classs2>size/span>span classp>:/span>span classw> /span>span classs2>{SIZE_IN_B}/span>span classp>,/span>span classw>      /span>span classs2>mimetype/span>span classp>:/span>span classw> /span>span classs2>{MEDIA_MIME_TYPE}/span>span classw>    /span>span classp>}/span>span classw>  /span>span classp>,/span>span classw>  /span>span classs2>images/span>span classp>:/span>span classw> /span>span classp>/span>span classw>    /span>span classp>{/span>span classw>      /span>span classs2>context/span>span classp>:/span>span classw> /span>span classs2>{IMAGE_TYPE}/span>span classp>,/span>span classw>      /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>{MEDIA_ID}/span>span classp>,/span>span classw>      /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>{IMAGE_NAME}/span>span classp>,/span>span classw>      /span>span classs2>url/span>span classp>:/span>span classw> /span>span classs2>{MEDIA_DOWNLOAD_URL}/span>span classp>,/span>span classw>      /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classerr>(Deprecated)/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>      /span>span classs2>size/span>span classp>:/span>span classw> /span>span classs2>{SIZE_IN_B}/span>span classp>,/span>span classw>      /span>span classs2>mimetype/span>span classp>:/span>span classw> /span>span classs2>{MEDIA_MIME_TYPE}/span>span classw>    /span>span classp>}/span>span classw>  /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h3 idget-media-mediaid>span classmethod method-get>GET/span> /media/{mediaId}/h3>p>Returns media file with mediaId  {mediaId}.br/>To get the code>mediaId/code> of a specific media file, request a list of media with a href#get-attempts-attemptid-media>GET attempts/{attemptId}/media/a>or a href#get-sessions-sessionid-media>sessions/{sessionId}/media/a>./p>h4 idrequest>Request/h4>p>strong>Request method: GET/strong>br/>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers:/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  code>mediaId/code> signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idsample-request>Sample request/h5>h6 idcurl>curl/h6>pre classhighlight plaintext>code>curl -X GET \  --url /v1/media/ebbf6434-3bf1-4020-8ac3-1ef51a25c673 \  -H Content-Type: application/json \  -H X-AUTH-CLIENT: API-PUBLIC-KEY \  -H X-HMAC-SIGNATURE: 452bfca0e02f8ee0f56d97373cc6971067e43149f1b7e58b681d4e57353a2f6b \/code>/pre>h6 idnode-js>Node.js/h6>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>request/span>span classp>);/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>GET/span>span classp>,/span>  span classna>url/span>span classp>:/span> span classs1>/v1/media/ebbf6434-3bf1-4020-8ac3-1ef51a25c673/span>span classp>,/span>  span classna>headers/span>span classp>:/span>   span classp>{/span> span classs1>Content-Type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span>     span classs1>X-HMAC-SIGNATURE/span>span classp>:/span> span classs1>452bfca0e02f8ee0f56d97373cc6971067e43149f1b7e58b681d4e57353a2f6b/span>span classp>,/span>     span classs1>X-AUTH-CLIENT/span>span classp>:/span> span classs1>API-PUBLIC-KEY/span> span classp>}/span> span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span>  span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span>  span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span>span classp>});/span>/code>/pre>h6 idpython3-py>Python3.py/h6>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>url/span> span classo>/span> span classs>/v1/media/ebbf6434-3bf1-4020-8ac3-1ef51a25c673/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>X-AUTH-CLIENT/span>span classp>:/span> span classs>API-PUBLIC-KEY/span>span classp>,/span>    span classs>X-HMAC-SIGNATURE/span>span classp>:/span> span classs>452bfca0e02f8ee0f56d97373cc6971067e43149f1b7e58b681d4e57353a2f6b/span>span classp>,/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>GET/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>content/span>span classp>)/span>/code>/pre>h4 idresponse>Response/h4>p>strong>Headers/strong>br/>/p>p>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  Response body signed with the strong>shared secret key/strong>br/>code>TRANSFER-ENCODING: string (required)/code> Form of encoding used to safely transfer the payload bodybr/>/p>h5 idsample-response>Sample response/h5>pre classhighlight plaintext>code>Transfer-Encoding: chunked/code>/pre>h5 idsample-chunked-data-handling-media-mediaid>Sample chunked data handling /media/{mediaId}/h5>p>Sample how to store response data to file (image or video)/p>p>strong>Headers:/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  code>mediaId/code> signed with the strong>shared secret key/strong>br/>code>mediaId: string (required)/code> code>mediaId/code> To get the code>mediaId/code> of a specific media file, request a list of media with a href#get-attempts-attemptid-media>GET attempts/{attemptId}/media/a>or a href#get-sessions-sessionid-media>sessions/{sessionId}/media/a>/p>h6 idnode-js-2>Node.js/h6>p>Here is a simple example how to download media with Node.js, it is applicable for both video and image files.Just make sure to use correct file extension which can be found from /media api response/p>pre classhighlight javascript tab-javascript>code>span classkr>const/span> span classnx>fs/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>fs/span>span classp>);/span>span classkr>const/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>request/span>span classp>);/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>GET/span>span classp>,/span>  span classna>url/span>span classp>:/span> span classs1>/v1/media/ebbf6434-3bf1-4020-8ac3-1ef51a25c673/span>span classp>,/span>  span classna>headers/span>span classp>:/span>   span classp>{/span> span classs1>Content-Type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span>     span classs1>X-HMAC-SIGNATURE/span>span classp>:/span> span classs1>452bfca0e02f8ee0f56d97373cc6971067e43149f1b7e58b681d4e57353a2f6b/span>span classp>,/span>     span classs1>X-AUTH-CLIENT/span>span classp>:/span> span classs1>API-PUBLIC-KEY/span> span classp>}/span> span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span>  span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span>span classp>})./span>span classnx>pipe/span>span classp>(/span>span classnx>fs/span>span classp>./span>span classnx>createWriteStream/span>span classp>(/span>span classnx>__dirname/span>span classo>+/span>span classs1>/myMedia.jpeg/span>span classp>));/span>/code>/pre>h6 idvideo-files-sample>Video files sample/h6>pre classhighlight python tab-python>code>span classn>media_url/span> span classo>/span> span classs>/v1/media/05cfc122-15d8-4838-bbf1-7b26a736b2d2/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>X-AUTH-CLIENT/span>span classp>:/span> span classs>API-PUBLIC-KEY/span>span classp>,/span>    span classs>X-HMAC-SIGNATURE/span>span classp>:/span> span classs>452bfca0e02f8ee0f56d97373cc6971067e43149f1b7e58b681d4e57353a2f6b/span>span classp>,/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>,/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>get/span>span classp>(/span>span classn>media_url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classk>with/span> span classnb>open/span>span classp>(/span>span classs>media_filename.webm/span>span classp>,/span> span classs>wb/span>span classp>)/span> span classk>as/span> span classn>media_file/span>span classp>:/span>    span classk>for/span> span classn>chunk/span> span classow>in/span> span classn>response/span>span classo>./span>span classn>iter_content/span>span classp>():/span>        span classn>media_file/span>span classo>./span>span classn>write/span>span classp>(/span>span classn>chunk/span>span classp>)/span>/code>/pre>h6 idimage-files-sample>Image files sample/h6>pre classhighlight python tab-python>code>span classn>media_url/span> span classo>/span> span classs>/v1/media/2b3b3a9f-d73d-445a-aabe-9b41c1c1a2ac/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>X-AUTH-CLIENT/span>span classp>:/span> span classs>API-PUBLIC-KEY/span>span classp>,/span>    span classs>X-HMAC-SIGNATURE/span>span classp>:/span> span classs>452bfca0e02f8ee0f56d97373cc6971067e43149f1b7e58b681d4e57353a2f6b/span>span classp>,/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>,/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>get/span>span classp>(/span>span classn>media_url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classk>with/span> span classnb>open/span>span classp>(/span>span classs>image_file_name.jpg/span>span classp>,/span> span classs>wb/span>span classp>)/span> span classk>as/span> span classn>write_file/span>span classp>:/span>    span classn>write_file/span>span classo>./span>span classn>write/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>content/span>span classp>)/span>/code>/pre>h3 idget-address-addressid-media>span classmethod method-get>GET/span> /address/{addressId}/media/h3>p>Returns a list of media objects with addressId  {addressId} for strong>Proof of Address/strong> sessions./p>h4 idrequest>Request/h4>p>strong>Request method: GET/strong>br/>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers:/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  code>addressId/code> signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idsample-request>Sample request/h5>h6 idcurl>curl/h6>pre classhighlight plaintext>code>curl -X GET \  --url /v1/address/f087f21f-5282-41b8-9857-6f85c28b8122/media \  -H Content-Type: application/json \  -H X-AUTH-CLIENT: API-PUBLIC-KEY \  -H X-HMAC-SIGNATURE: acfe1cf21c986edf25cc6bc74fd769954443bbb606500019a4bed46645179b36 \/code>/pre>h6 idnode-js>Node.js/h6>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>request/span>span classp>);/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>GET/span>span classp>,/span>  span classna>url/span>span classp>:/span> span classs1>/v1/address/f087f21f-5282-41b8-9857-6f85c28b8122/media/span>span classp>,/span>  span classna>headers/span>span classp>:/span>   span classp>{/span> span classs1>Content-Type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span>     span classs1>X-HMAC-SIGNATURE/span>span classp>:/span> span classs1>acfe1cf21c986edf25cc6bc74fd769954443bbb606500019a4bed46645179b36/span>span classp>,/span>     span classs1>X-AUTH-CLIENT/span>span classp>:/span> span classs1>API-PUBLIC-KEY/span> span classp>}/span> span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span>  span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span>  span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span>span classp>});/span>/code>/pre>h6 idpython3-py>Python3.py/h6>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>json/span>span classkn>import/span> span classnn>pprint/span>span classn>url/span> span classo>/span> span classs>/v1/address/f087f21f-5282-41b8-9857-6f85c28b8122/media/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>X-AUTH-CLIENT/span>span classp>:/span> span classs>API-PUBLIC-KEY/span>span classp>,/span>    span classs>X-HMAC-SIGNATURE/span>span classp>:/span> span classs>acfe1cf21c986edf25cc6bc74fd769954443bbb606500019a4bed46645179b36/span>span classp>,/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>GET/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classn>pprint/span>span classo>./span>span classn>pprint/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>json/span>span classp>())/span>/code>/pre>h4 idresponse>Response/h4>p>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers:/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  Request body signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idresponse-properties-explained>Response properties explained/h5>ul>li>code>status/code>: code>string/code> Status of the request/li>li>code>images/code>: code>array/code> Array of JSON objects identifying the imagesul>li>code>context/code>: code>string/code> Context type of the image (code>address-front/code>)/li>li>code>id/code>: code>UUID-v4/code> Image Id/li>li>code>name/code>: code>string/code> Image name/li>li>code>url/code>: code>string/code> Image download url/li>li>code>size/code>: code>string/code> Image size in bytes/li>li>code>mimetype/code>: code>string/code> Format of the media file. See a href#media-file-mimetypes>Mimetypes table/a> for more info/li>/ul>/li>/ul>h5 idsample-response>Sample response/h5>pre classhighlight json tab-json>code>span classp>{/span>span classw>  /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>  /span>span classs2>images/span>span classp>:/span>span classw> /span>span classp>/span>span classw>    /span>span classp>{/span>span classw>      /span>span classs2>context/span>span classp>:/span>span classw> /span>span classs2>{IMAGE_TYPE}/span>span classp>,/span>span classw>      /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>{MEDIA_ID}/span>span classp>,/span>span classw>      /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>{IMAGE_NAME}/span>span classp>,/span>span classw>      /span>span classs2>url/span>span classp>:/span>span classw> /span>span classs2>{MEDIA_DOWNLOAD_URL}/span>span classp>,/span>span classw>      /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>      /span>span classs2>size/span>span classp>:/span>span classw> /span>span classs2>{SIZE_IN_B}/span>span classp>,/span>span classw>      /span>span classs2>mimetype/span>span classp>:/span>span classw> /span>span classs2>{MEDIA_MIME_TYPE}/span>span classw>    /span>span classp>}/span>span classw>  /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h3 idget-address-media-mediaid>span classmethod method-get>GET/span> /address-media/{mediaId}/h3>p>Returns the media for strong>Proof of Address/strong> with mediaId  {mediaId}/p>h4 idrequest>Request/h4>p>strong>Request method: GET/strong>br/>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers:/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  code>mediaId/code> signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idsample-request>Sample request/h5>h6 idcurl>curl/h6>pre classhighlight plaintext>code>curl -X GET \  --url /v1/address-media/8d79522f-e3ad-4c1f-8e6a-4248db6935a2 \  -H Content-Type: application/json \  -H X-AUTH-CLIENT: API-PUBLIC-KEY \  -H X-HMAC-SIGNATURE: 452bfca0e02f8ee0f56d97373cc6971067e43149f1b7e58b681d4e57353a2f6b \/code>/pre>h6 idnode-js>Node.js/h6>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>request/span>span classp>);/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>GET/span>span classp>,/span>  span classna>url/span>span classp>:/span> span classs1>/v1/address-media/8d79522f-e3ad-4c1f-8e6a-4248db6935a2/span>span classp>,/span>  span classna>headers/span>span classp>:/span>   span classp>{/span> span classs1>Content-Type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span>     span classs1>X-HMAC-SIGNATURE/span>span classp>:/span> span classs1>452bfca0e02f8ee0f56d97373cc6971067e43149f1b7e58b681d4e57353a2f6b/span>span classp>,/span>     span classs1>X-AUTH-CLIENT/span>span classp>:/span> span classs1>API-PUBLIC-KEY/span> span classp>}/span> span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span>  span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span>  span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span>span classp>});/span>/code>/pre>h6 idpython3-py>Python3.py/h6>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>url/span> span classo>/span> span classs>/v1/address-media/8d79522f-e3ad-4c1f-8e6a-4248db6935a2/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>X-AUTH-CLIENT/span>span classp>:/span> span classs>API-PUBLIC-KEY/span>span classp>,/span>    span classs>X-HMAC-SIGNATURE/span>span classp>:/span> span classs>452bfca0e02f8ee0f56d97373cc6971067e43149f1b7e58b681d4e57353a2f6b/span>span classp>,/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>GET/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>content/span>span classp>)/span>/code>/pre>h4 idresponse>Response/h4>p>strong>Headers:br/>/strong>code>X-AUTH-CLIENT: string (required)/code> strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code> Response body signed with the strong>shared secret key/strong>br/>code>TRANSFER-ENCODING: string (required)/code> Form of encoding used to safely transfer the payload body.br/>/p>h5 idsample-response>Sample response/h5>pre classhighlight plaintext>code>Transfer-Encoding: chunked/code>/pre>h6 idsample-chunked-data-handling-address-media-mediaid>Sample chunked data handling /address-media/{mediaId}/h6>p>Sample how to store response data to file (image or video)/p>p>strong>Headers:br/>/strong>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  code>mediaId/code> signed with the strong>shared secret key/strong>/p>h6 idnode-js-2>Node.js/h6>p>Here is a simple example how to download address media with Node.js. Just make sure to use correct file extension,which can be found from /media api response./p>pre classhighlight javascript tab-javascript>code>span classkr>const/span> span classnx>fs/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>fs/span>span classp>);/span>span classkr>const/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>request/span>span classp>);/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span>  span classna>method/span>span classp>:/span> span classs1>GET/span>span classp>,/span>  span classna>url/span>span classp>:/span> span classs1>/v1/address-media/8d79522f-e3ad-4c1f-8e6a-4248db6935a2/span>span classp>,/span>  span classna>headers/span>span classp>:/span> span classp>{/span>    span classs1>Content-Type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span>    span classs1>X-HMAC-SIGNATURE/span>span classp>:/span> span classs1>452bfca0e02f8ee0f56d97373cc6971067e43149f1b7e58b681d4e57353a2f6b/span>span classp>,/span>    span classs1>X-AUTH-CLIENT/span>span classp>:/span> span classs1>API-PUBLIC-KEY/span>  span classp>}/span>span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span>  span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span>span classp>})./span>span classnx>pipe/span>span classp>(/span>span classnx>fs/span>span classp>./span>span classnx>createWriteStream/span>span classp>(/span>span classnx>__dirname/span> span classo>+/span> span classs1>/myMedia.jpeg/span>span classp>));/span>/code>/pre>h6 idimage-files-sample>Image files sample/h6>pre classhighlight python tab-python>code>span classn>media_url/span> span classo>/span> span classs>/v1/address-media/8d79522f-e3ad-4c1f-8e6a-4248db6935a2/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>X-AUTH-CLIENT/span>span classp>:/span> span classs>API-PUBLIC-KEY/span>span classp>,/span>    span classs>X-HMAC-SIGNATURE/span>span classp>:/span> span classs>452bfca0e02f8ee0f56d97373cc6971067e43149f1b7e58b681d4e57353a2f6b/span>span classp>,/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>,/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>get/span>span classp>(/span>span classn>media_url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classk>with/span> span classnb>open/span>span classp>(/span>span classs>image_file_name.jpg/span>span classp>,/span> span classs>wb/span>span classp>)/span> span classk>as/span> span classn>write_file/span>span classp>:/span>    span classn>write_file/span>span classo>./span>span classn>write/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>content/span>span classp>)/span>/code>/pre>h3 idpost-validate-registry>span classmethod method-post>POST/span> /validate-registry/h3>p>Validates a national ID number (e.g. social security number (SSN)) with the provided data. A verification sessionwill be automatically created and submitted after which the validation result gets sent via Webhook.Note that media upload is not used for registry verification./p>p>You will need a strong>separate integration/strong> to do this verification (i.e., the integration you have for IDV will notsuffice.)/p>p>In order to perform a social security number (SSN) validation the following fields must be provided:/p>ul>li>code>idNumber/code>/li>li>code>fullName/code> OR (code>firstName/code> + code>lastName/code>)/li>li>code>dateOfBirth/code> OR code>address/code> data.ul>li>If code>address/code> data is provided, then send EITHER code>fullAddress/code> value OR the code>street/code> + code>houseNumber/code> + code>postcode/code> values./li>/ul>/li>/ul>h4 idrequest>Request/h4>p>strong>Request method: POST/strong>br/>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string/code>  Request body signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idrequest-properties-explained>Request properties explained/h5>ul>li>code>verification/code> : code>object (required)/code> Verification objectul>li>code>callback/code>: code>string/code> Default is defined on settings. code>callbackUrl/code> to where the end-user is redirected after the verification session is completed/li>li>code>person/code>: code>object (required)/code> Person whose national ID will be validatedul>li>code>idNumber/code>: code>string (required)/code> SSN unique id/li>li>code>fullName/code>: code>string/code> Full name. Required if code>firstName/code> + code>lastName/code> is not provided/li>li>code>firstName/code>: code>string/code> First name. Required if code>fullName/code> is not provided/li>li>code>lastName/code>: code>string/code> Last name. Required if code>fullName/code> is not providedbr>/li>li>code>dateOfBirth/code>: code>string/code> (YYYY-MM-DD) Date of birth. Required, if code>address/code> is not provided/li>li>code>phoneNumber/code>: code>string/code> Phone number/li>/ul>/li>li>code>address/code>: code>object/code> Address dataul>li>code>fullAddress/code>: code>string/code> Full address. Required if code>street/code> and code>houseNumber/code> is not provided/li>li>code>street/code>: code>string/code> Street. Required if code>fullAddress/code> is not provided/li>li>code>houseNumber/code>: code>string/code> House number. Required if code>fullAddress/code> is not provided/li>li>code>postcode/code>: code>string/code> Postal code. Required if code>fullAddress/code> is not provided/li>li>code>city/code>: code>string/code> City/li>li>code>state/code>: code>string/code> State/li>li>code>unit/code>: code>string/code> Unit/li>/ul>/li>li>code>vendorData/code>: code>string/code> End-user-specific data string, max 1000 characters long, created by the customer. Sent backunmodified via API responses and webhooks, or as code>null/code> if not provided/li>li>code>endUserId/code>: code>uuid | null/code> End-user-specific UUID created by the customer to identify the end-user. Returnedunmodified in webhooks and public API calls, or as code>null/code> if not provided/li>/ul>/li>/ul>h5 idsample-request>Sample request/h5>h6 idcurl>curl/h6>pre classhighlight plaintext>code>curl -X POST \  --url /v1/validate-registry/ \  -H Content-Type: application/json \  -H X-AUTH-CLIENT: API-PUBLIC-KEY \  -d {    verification: {        callback: https://veriff.com,        person: {            firstName: John,            lastName: Smith,            idNumber: 123456789,            dateOfBirth: 1980-03-06        },        address: {            street: Street 123,            houseNumber: 456        },        vendorData: 11111111,        endUserId: fa820aba-019f-455a-ae81-cfca8075bc3f    }}/code>/pre>h6 idnode-js>Node.js/h6>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>request/span>span classp>);/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>POST/span>span classp>,/span>    span classna>url/span>span classp>:/span> span classs1>/v1/validate-registry//span>span classp>,/span>    span classna>headers/span>span classp>:/span>            span classp>{/span> span classs1>Content-Type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span>                span classs1>X-AUTH-CLIENT/span>span classp>:/span> span classs1>API-PUBLIC-KEY/span> span classp>},/span>    span classna>body/span>span classp>:/span>            span classp>{/span> span classna>verification/span>span classp>:/span>                        span classp>{/span> span classna>callback/span>span classp>:/span> span classs1>https://veriff.com/span>span classp>,/span>                            span classna>person/span>span classp>:{/span>                                span classna>firstName/span>span classp>:/span> span classs1>John/span>span classp>,/span>                                span classna>lastName/span>span classp>:/span> span classs1>Smith/span>span classp>,/span>                                span classna>idNumber/span>span classp>:/span> span classs1>123456789/span>span classp>,/span>                                span classna>dateOfBirth/span>span classp>:/span> span classs2>1980-03-06/span>                            span classp>},/span>                            span classna>address/span>span classp>:/span> span classp>{/span>                                span classna>street/span>span classp>:/span> span classs1>Street 123/span>span classp>,/span>                                span classna>houseNumber/span>span classp>:/span> span classs1>456/span>                            span classp>},/span>                            span classna>vendorData/span>span classp>:/span> span classs1>11111111/span>                            span classna>endUserId/span>span classp>:/span> span classs1>fa820aba-019f-455a-ae81-cfca8075bc3f/span> span classp>}/span> span classp>},/span>    span classna>json/span>span classp>:/span> span classkc>true/span> span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span>    span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span>    span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span>span classp>});/span>/code>/pre>h6 idpython3>Python3/h6>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>pprint/span>span classkn>import/span> span classnn>json/span>span classn>url/span> span classo>/span> span classs>/v1/validate-registry//span>span classn>payload/span> span classo>/span> span classn>json/span>span classo>./span>span classn>dumps/span>span classp>({/span>    span classs>verification/span>span classp>:/span> span classp>{/span>        span classs>callback/span>span classp>:/span> span classs>https://veriff.com/span>span classp>,/span>        span classs>person/span>span classp>:/span> span classp>{/span>            span classs>firstName/span>span classp>:/span> span classs>John/span>span classp>,/span>            span classs>lastName/span>span classp>:/span> span classs>Smith/span>span classp>,/span>            span classs>idNumber/span>span classp>:/span> span classs>123456789/span>span classp>,/span>            span classs>dateOfBirth/span>span classp>:/span> span classs>1980-03-06/span>        span classp>},/span>        span classs>address/span>span classp>:/span> span classp>{/span>            span classs>street/span>span classp>:/span> span classs>Street 123/span>span classp>,/span>            span classs>houseNumber/span>span classp>:/span> span classs>456/span>span classp>,/span>        span classp>},/span>        span classs>vendorData/span>span classp>:/span> span classs>11111111/span>span classp>,/span>        span classs>endUserId/span>span classp>:/span> span classs>fa820aba-019f-455a-ae81-cfca8075bc3f/span>span classp>,/span>        span classs>features/span>span classp>:/span> span classp>/span>          span classs>selfid/span>        span classp>/span>    span classp>}/span>span classp>})/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>X-AUTH-CLIENT/span>span classp>:/span> span classs>API-PUBLIC-KEY/span>span classp>,/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>POST/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>payload/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classn>pprint/span>span classo>./span>span classn>pprint/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>json/span>span classp>())/span>/code>/pre>h4 idresponse>Response/h4>p>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  Request body signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idresponse-properties-explained>Response properties explained/h5>ul>li>code>status/code>: code>string/code> Request status/li>li>code>verification/code>: code>object/code> Verification objectul>li>code>id/code>: code>UUID/code>-v4 String UUID v4 which identifies the verification session/li>li>code>vendorData/code>: code>string/code> End-user-specific data string, max 1000 characters long, created by the customer. Sent backunmodified via API responses and webhooks, or as code>null/code> if not provided/li>li>code>endUserId/code>: code>uuid | null/code> End-user-specific UUID created by the customer to identify the end-user. Returnedunmodified in webhooks and public API calls, or as code>null/code> if not provided/li>li>code>status/code>: code>string/code> Verification session status/li>li>code>sessionToken/code>: code>string/code> Session specific token of the verification/li>/ul>/li>/ul>h5 idsample-responses>Sample responses/h5>h6 idsuccess-values-in-the-form-match>Success, values in the form match/h6>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>    /span>span classs2>verification/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classs2>id/span>span classp>:/span>span classs2>f04bdb47-d3be-4b28-b028-a652feb060b5/span>span classp>,/span>span classw>        /span>span classs2>vendorData/span>span classp>:/span>span classw> /span>span classs2>11111111/span>span classp>,/span>span classw>        /span>span classs2>endUserId/span>span classp>:/span>span classw> /span>span classs2>fa820aba-019f-455a-ae81-cfca8075bc3f/span>span classp>,/span>span classw>        /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>submitted/span>span classp>,/span>span classw>        /span>span classs2>sessionToken/span>span classp>:/span>span classw> /span>span classs2>eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdXRoX3Rva2VuIjoiOThiYzdjMjEtZTQ0Yy00MTZiLTkxOTMtMTU5ZGZkMzBmMDg4Iiwic2Vzc2lvbl9pZCI6Ijc2ODhmMzYzLTAyZjctNDE1My1iMzM1LWE0ODQ3OTRkMzZmNyIsImlhdCI6MTUwMTIyODI1MSwiZXhwIjoxNTAxODMzMDUxfQ.bMEF37E6-zT2Aa6Q8UXK3B_ZL51w6D_lxnGgQvhj214/span>span classw>    /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h6 idstatus-400-quot-bad-request-quot-firstname-lastname-or-fullname-not-provided>Status 400 "Bad request", code>firstName/code> + code>lastName/code> OR code>fullName/code> not provided/h6>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>fail/span>span classp>,/span>span classw>    /span>span classs2>code/span>span classp>:/span>span classw> /span>span classs2>1309/span>span classp>,/span>span classw>    /span>span classs2>message/span>span classp>:/span>span classw> /span>span classs2>SSN validation requires person firstName + lastName OR fullName to be provided/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h6 idstatus-400-quot-bad-request-quot-idnumber-not-provided>Status 400 "Bad request", code>idNumber/code> not provided/h6>pre classhighlight json tab-json>code>span classp>{/span>span classw>  /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>fail/span>span classp>,/span>span classw>  /span>span classs2>code/span>span classp>:/span>span classw> /span>span classs2>1308/span>span classp>,/span>span classw>  /span>span classs2>message/span>span classp>:/span>span classw> /span>span classs2>ID number is missing./span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h6 idstatus-400-quot-bad-request-quot-dateofbirth-or-address-not-provided>Status 400 "Bad request", code>dateOfBirth/code> OR code>address/code> not provided/h6>pre classhighlight json tab-json>code>span classp>{/span>span classw>  /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>fail/span>span classp>,/span>span classw>  /span>span classs2>code/span>span classp>:/span>span classw> /span>span classs2>1310/span>span classp>,/span>span classw>  /span>span classs2>message/span>span classp>:/span>span classw> /span>span classs2>SSN validation requires person.dateOfBirth or address data to be provided./span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h3 idpost-sync-api-veriff-me-v1-validate-registry>span classmethod method-post>POST/span> sync-api.veriff.me/v1/validate-registry/h3>p>Validates a national ID number (e.g. social security number (SSN)) with the provided data. A verification sessionwill be automatically created and submitted after which the strong>validation result gets sent in the API Response/strong>.Note that media upload is not used for registry verification./p>p>You will need a strong>separate integration/strong> to do this verification (i.e., the integration you have for IDV will notsuffice.)/p>p>In order to perform a social security number (SSN) validation the strong>following fields must be provided/strong>:/p>ul>li>code>idNumber/code>/li>li>code>fullName/code> OR code>firstName/code> + code>lastName/code>/li>li>code>dateOfBirth/code> and/or code>address/code> dataul>li>If code>address/code> data is provided, then send EITHER the code>fullAddress/code> value OR code>street/code> + code>houseNumber/code> + code>postcode/code> values/li>li>Providing both code>address/code> and code>dateOfBirth/code> will improve the conversion rate/li>/ul>/li>/ul>h4 idrequest>Request/h4>p>strong>Request method: POST/strong>br/>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-API-KEY: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string/code>  Request body signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idrequest-properties-explained>Request properties explained/h5>ul>li>code>verification/code> : code>object (required)/code> Verification objectul>li>code>callback/code>: code>string/code> Default is defined on settings. code>callbackUrl/code> to where the end-user is redirected after the verification session is completed/li>li>code>person/code>: code>object (required)/code> Person whose national ID will be validatedul>li>code>idNumber/code>: code>string (required)/code> National ID to validate/li>li>code>firstName/code>: code>string/code> First name/li>li>code>lastName/code>: code>string/code> Last name/li>li>code>fullName/code>: code>string/code> Full name/li>li>code>phoneNumber/code>: code>string/code> Phone number/li>li>code>dateOfBirth/code>: code>string/code> (YYYY-MM-DD) Date of birth/li>/ul>/li>li>code>address/code>: code>object/code> Address dataul>li>code>fullAddress/code>: code>string/code> Full address/li>li>code>street/code>: code>string/code> Street/li>li>code>houseNumber/code>: code>string/code> House number/li>li>code>postcode/code>: code>string/code> Postal code/li>li>code>city/code>: code>string/code> City/li>li>code>state/code>: code>string/code> State/li>li>code>unit/code>: code>string/code> Unit/li>/ul>/li>li>code>vendorData/code>: code>string/code> End-user-specific data string, max 1000 characters long, created by the customer. Sent backunmodified via API responses and webhooks, or as code>null/code> if not provided/li>li>code>endUserId/code>: code>uuid | null/code> End-user-specific UUID created by the customer to identify the end-user. Returnedunmodified in webhooks and public API calls, or as code>null/code> if not provided/li>/ul>/li>/ul>h5 idsample-request>Sample request/h5>h6 idcurl>curl/h6>pre classhighlight plaintext>code>curl -X POST \  --url /v1/validate-registry \  -H Content-Type: application/json \  -H X-AUTH-CLIENT: API-PUBLIC-KEY \  -H X-API-KEY: API-PUBLIC-KEY \  -H X-HMAC-SIGNATURE: 4776e5fb59795da4856c8176efcdeaf6fe15d0bed6a179e75c86a5f5580a250c \  -d {    verification: {        person: {            firstName: John,            lastName: Smith,            idNumber: 123456789,            dateOfBirth: 1980-03-06        },        address: {            street: Street 123,            houseNumber: 456,            postcode: 12345        },        vendorData: 11111111,        endUserId: fa820aba-019f-455a-ae81-cfca8075bc3f    }}/code>/pre>h6 idnode-js>Node.js/h6>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>request/span>span classp>);/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span>  span classna>method/span>span classp>:/span> span classs1>POST/span>span classp>,/span>  span classna>url/span>span classp>:/span> span classs1>/v1/validate-registry//span>span classp>,/span>  span classna>headers/span>span classp>:/span> span classp>{/span>    span classs1>Content-Type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span>    span classs1>X-AUTH-CLIENT/span>span classp>:/span> span classs1>API-PUBLIC-KEY/span>span classp>,/span>    span classs1>X-API-KEY/span>span classp>:/span> span classs1>API-PUBLIC-KEY/span>span classp>,/span>    span classs1>X-HMAC-SIGNATURE/span>span classp>:/span> span classs1>4776e5fb59795da4856c8176efcdeaf6fe15d0bed6a179e75c86a5f5580a250c/span>span classp>,/span>  span classp>},/span>  span classna>body/span>span classp>:/span> span classp>{/span>    span classna>verification/span>span classp>:/span> span classp>{/span>      span classna>person/span>span classp>:/span> span classp>{/span>        span classna>firstName/span>span classp>:/span> span classs1>John/span>span classp>,/span>        span classna>lastName/span>span classp>:/span> span classs1>Smith/span>span classp>,/span>        span classna>idNumber/span>span classp>:/span> span classs1>123456789/span>span classp>,/span>        span classna>dateOfBirth/span>span classp>:/span> span classs1>1980-03-06/span>span classp>,/span>      span classp>},/span>      span classna>address/span>span classp>:/span> span classp>{/span>        span classna>street/span>span classp>:/span> span classs1>Street 123/span>span classp>,/span>        span classna>houseNumber/span>span classp>:/span> span classs1>456/span>span classp>,/span>        span classna>postcode/span>span classp>:/span> span classs1>12345/span>span classp>,/span>      span classp>},/span>      span classna>vendorData/span>span classp>:/span> span classs1>11111111/span>span classp>,/span>      span classna>endUserId/span>span classp>:/span> span classs1>fa820aba-019f-455a-ae81-cfca8075bc3f/span>    span classp>},/span>  span classp>},/span>  span classna>json/span>span classp>:/span> span classkc>true/span>span classp>,/span>span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span>  span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span>  span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span>span classp>});/span>/code>/pre>h6 idpython3>Python3/h6>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>pprint/span>span classkn>import/span> span classnn>json/span>span classn>url/span> span classo>/span> span classs>/v1/validate-registry//span>span classn>payload/span> span classo>/span> span classn>json/span>span classo>./span>span classn>dumps/span>span classp>({/span>    span classs>verification/span>span classp>:/span> span classp>{,/span>        span classs>person/span>span classp>:/span> span classp>{/span>            span classs>firstName/span>span classp>:/span> span classs>John/span>span classp>,/span>            span classs>lastName/span>span classp>:/span> span classs>Smith/span>span classp>,/span>            span classs>idNumber/span>span classp>:/span> span classs>123456789/span>span classp>,/span>            span classs>dateOfBirth/span>span classp>:/span> span classs>1980-03-06/span>        span classp>},/span>        span classs>address/span>span classp>:/span> span classp>{/span>            span classs>street/span>span classp>:/span> span classs>Street 123/span>span classp>,/span>            span classs>houseNumber/span>span classp>:/span> span classs>456/span>span classp>,/span>            span classs>postcode/span>span classp>:/span> span classs>12345/span>span classp>,/span>        span classp>},/span>        span classs>vendorData/span>span classp>:/span> span classs>11111111/span>span classp>,/span>        span classs>endUserId/span>span classp>:/span> span classs>fa820aba-019f-455a-ae81-cfca8075bc3f/span>span classp>,/span>        span classs>features/span>span classp>:/span> span classp>/span>          span classs>selfid/span>        span classp>/span>    span classp>}/span>span classp>})/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>X-AUTH-CLIENT/span>span classp>:/span> span classs>API-PUBLIC-KEY/span>span classp>,/span>    span classs>X-API-KEY/span>span classp>:/span> span classs>API-PUBLIC-KEY/span>span classp>,/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>,/span>    span classs>X-HMAC-SIGNATURE/span>span classp>:/span> span classs>4776e5fb59795da4856c8176efcdeaf6fe15d0bed6a179e75c86a5f5580a250c/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>POST/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>payload/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classn>pprint/span>span classo>./span>span classn>pprint/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>json/span>span classp>())/span>/code>/pre>h5 idfailed-request-validation-scenarios>Failed request validation scenarios/h5>p>Two types of validation is done: code>X-HMAC-SIGNATURE/code> and strong>request payload/strong> validation.Below are possible failure scenarios./p>p>strong>code>X-HMAC-SIGNATURE/code> validation failed/strong>/p>p>HTTP status code: 401br/>Message: "MissingAuthentication"/p>pre classhighlight plaintext>code>{status: fail,code: 1812,message: Signature {invalid-hmac-signature value} is not a valid SHA256 hash.}/code>/pre>p>strong>Required field code>fullName/code> or (code>firstName/code> + code>lastName/code>) not provided/strong>/p>p>HTTP status code: 400br/>Message: "InvalidRequest"/p>pre classhighlight plaintext>code>{status: fail,code: 1102,message: Request person is missing required field fullName or (firstName + lastName)}/code>/pre>p>strong>Required field code>dateOfBirth/code> or code>address/code> not provided/strong>/p>p>HTTP status code: 400br/>Message: "InvalidRequest"/p>pre classhighlight plaintext>code>{status: fail,code: 1102,message: Request is missing required field dateOfBirth or address}/code>/pre>p>strong>Required field code>fullAddress/code> or (code>street/code> + code>houseNumber/code> + code>postcode/code>) not provided/strong>/p>p>HTTP status code: 400br/>Message: "InvalidRequest"/p>pre classhighlight plaintext>code>{status: fail,code: 1102,message: Request address is missing required field fullAddress or (street + houseNumber + postcode)}/code>/pre>p>strong>Required field code>idNumber/code> not provided/strong>/p>p>HTTP status code: 400br/>Message: "InvalidRequest"/p>pre classhighlight plaintext>code>{status: fail,code: 1102,message: Request is missing required field idNumber}/code>/pre>h4 idresponse>Response/h4>p>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  Response body signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idresponse-properties-explained>Response properties explained/h5>ul>li>code>status/code>: code>string/code> Status of the response/li>li>code>verification/code>: code>object/code> Verification request decision object. Null if decision is not available yetul>li>code>id/code>: code>string/code> UUID v4 which identifies the verification session/li>li>code>code/code>: code>integer/code> (one of 9001, 9102, 9103, 9104, 9121)Verification response code. a href#verification-session-status-and-decision-codes>More information about decision codes/a>/li>li>code>person/code>: code>object/code> Verified personul>li>code>gender/code>: code>null/code> (M, F or Null) Gender. Will always be code>null/code>/li>li>code>idNumber/code>: code>string | null/code> National identification number/li>li>code>lastName/code>: code>string | null/code> Last name/li>li>code>firstName/code>: code>string | null/code> First name/li>li>code>citizenship/code>: code>(Deprecated)/code> code>null/code>/li>li>code>dateOfBirth/code>: code>string/code> (YYYY-MM-DD) Date of birth/li>li>code>nationality/code>: code>null/code> Nationality. Will always be code>null/code>/li>li>code>yearOfBirth/code>: code>null/code> (YYYY) Year of birth. Will always be code>null/code>/li>li>code>placeOfBirth/code>: code>null/code> Place of birth. Will always be code>null/code>/li>li>code>pepSanctionsMatch/code>: code>null/code> PEP check result. Will always be code>null/code>/li>/ul>/li>li>code>reason/code>: code>string | null/code> Reason of failed Verification/li>li>code>status/code>: code>string/code> (one of approved, declined) Verification status/li>li>code>comments/code>: code>array/code> em>(Deprecated)/em> /li>li>code>document/code>: code>object/code> Verified documentul>li>code>type/code>: code>null/code> Document type. Will always be code>null/code>/li>li>code>number/code>: code>null/code> Document number. Will always be code>null/code>/li>li>code>country/code>: code>null/code> ISO-2 Document country. Will always be code>null/code>/li>li>code>validFrom/code>: code>null/code> Document is valid from date. Will always be code>null/code>/li>li>code>validUntil/code>: code>null/code> Document is valid until date. Will always be code>null/code>/li>/ul>/li>li>code>reasonCode/code>: code>integer | null/code> Reason code of failed Verification a href#reference-info-codes-tables>See Response and error codes/a>/li>li>code>vendorData/code>: code>string/code> End-user-specific data string, max 1000 characters long, created by the customer. Sent backunmodified via API responses and webhooks, or as code>null/code> if not provided/li>li>code>endUserId/code>: code>uuid | null/code> End-user-specific UUID created by the customer to identify the end-user. Returnedunmodified in webhooks and public API calls, or as code>null/code> if not provided/li>li>code>decisionTime/code>: code>string/code> Timestamp of the decision. Combined ISO 8601 date and time in UTC YYYY-MM-DDTHH:MM:SSS+Timezone Offset/li>li>code>acceptanceTime/code>: code>string/code> Timestamp of the session generation. Combined ISO 8601 date and time in UTC YYYY-MM-DDTHH:MM:SSS+Timezone Offset/li>li>code>additionalVerifiedData/code>: code>object/code> Data which has been optionally verified for session.ul>li>code>failedValidation/code>: code>string/code> Message for the failed validation/li>/ul>/li>/ul>/li>li>code>technicalData/code>: code>object/code> Technical data objectul>li>code>ip/code>: code>string | null/code> IP of the device from which the verification was made/li>/ul>/li>/ul>h5 idsample-response>Sample Response/h5>h6 idapproved-decision>Approved decision/h6>pre classhighlight json tab-json>code>span classp>{/span>span classw>  /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>  /span>span classs2>verification/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>    /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>09551b48-4d7c-4a30-8437-5301223953fa/span>span classp>,/span>span classw>    /span>span classs2>code/span>span classp>:/span>span classw> /span>span classmi>9001/span>span classp>,/span>span classw>    /span>span classs2>person/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>      /span>span classs2>gender/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>      /span>span classs2>idNumber/span>span classp>:/span>span classw> /span>span classs2>123456789/span>span classp>,/span>span classw>      /span>span classs2>lastName/span>span classp>:/span>span classw> /span>span classs2>Smith/span>span classp>,/span>span classw>      /span>span classs2>firstName/span>span classp>:/span>span classw> /span>span classs2>John/span>span classp>,/span>span classw>      /span>span classs2>citizenship/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>      /span>span classs2>dateOfBirth/span>span classp>:/span>span classw> /span>span classs2>1980-03-06/span>span classp>,/span>span classw>      /span>span classs2>nationality/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>      /span>span classs2>yearOfBirth/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>      /span>span classs2>placeOfBirth/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>      /span>span classs2>pepSanctionMatch/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>    /span>span classp>},/span>span classw>    /span>span classs2>reason/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>approved/span>span classp>,/span>span classw>    /span>span classs2>comments/span>span classp>:/span>span classw> /span>span classp>,/span>span classw>    /span>span classs2>document/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>      /span>span classs2>type/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>      /span>span classs2>number/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>      /span>span classs2>country/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>      /span>span classs2>validFrom/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>      /span>span classs2>validUntil/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>    /span>span classp>},/span>span classw>    /span>span classs2>reasonCode/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>    /span>span classs2>vendorData/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>    /span>span classs2>endUserId/span>span classp>:/span>span classw> /span>span classs2>fa820aba-019f-455a-ae81-cfca8075bc3f/span>span classp>,/span>span classw>    /span>span classs2>decisionTime/span>span classp>:/span>span classw> /span>span classs2>2019-11-06T07:18:36.916Z/span>span classp>,/span>span classw>    /span>span classs2>acceptanceTime/span>span classp>:/span>span classw> /span>span classs2>2019-11-06T07:15:27.000Z/span>span classp>,/span>span classw>    /span>span classs2>additionalVerifiedData/span>span classp>:/span>span classw> /span>span classp>{}/span>span classw>  /span>span classp>},/span>span classw>  /span>span classs2>technicalData/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>    /span>span classs2>ip/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>  /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h6 iddeclined-decision>Declined decision/h6>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>    /span>span classs2>verification/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>5ca9d2b6-3708-4540-928e-4b8e82717c3f/span>span classp>,/span>span classw>        /span>span classs2>code/span>span classp>:/span>span classw> /span>span classmi>9102/span>span classp>,/span>span classw>        /span>span classs2>person/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>gender/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>idNumber/span>span classp>:/span>span classw> /span>span classs2>123456789/span>span classp>,/span>span classw>            /span>span classs2>lastName/span>span classp>:/span>span classw> /span>span classs2>Smith/span>span classp>,/span>span classw>            /span>span classs2>firstName/span>span classp>:/span>span classw> /span>span classs2>John/span>span classp>,/span>span classw>            /span>span classs2>citizenship/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>dateOfBirth/span>span classp>:/span>span classw> /span>span classs2>1980-03-06/span>span classp>,/span>span classw>            /span>span classs2>nationality/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>yearOfBirth/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>placeOfBirth/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>pepSanctionMatch/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>        /span>span classp>},/span>span classw>        /span>span classs2>reason/span>span classp>:/span>span classw> /span>span classs2>Unable to validate National Id data/span>span classp>,/span>span classw>        /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>declined/span>span classp>,/span>span classw>        /span>span classs2>comments/span>span classp>:/span>span classw> /span>span classp>,/span>span classw>        /span>span classs2>document/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>type/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>number/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>country/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>validFrom/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>validUntil/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>        /span>span classp>},/span>span classw>        /span>span classs2>reasonCode/span>span classp>:/span>span classw> /span>span classmi>529/span>span classp>,/span>span classw>        /span>span classs2>vendorData/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>        /span>span classs2>endUserId/span>span classp>:/span>span classw> /span>span classs2>fa820aba-019f-455a-ae81-cfca8075bc3f/span>span classp>,/span>span classw>        /span>span classs2>decisionTime/span>span classp>:/span>span classw> /span>span classs2>2019-11-06T07:18:36.916Z/span>span classp>,/span>span classw>        /span>span classs2>acceptanceTime/span>span classp>:/span>span classw> /span>span classs2>2019-11-06T07:15:27.000Z/span>span classp>,/span>span classw>        /span>span classs2>additionalVerifiedData/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>failedValidation/span>span classp>:/span>span classw> /span>span classs2>Neither address or date of birth matched/span>span classw>        /span>span classp>}/span>span classw>    /span>span classp>},/span>span classw>    /span>span classs2>technicalData/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classs2>ip/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>    /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h3 idpost-sessions-sessionid-consents>span classmethod method-post>POST/span> /sessions/{sessionId}/consents/h3>p>Uploads a consent (and specifies the type of the consent that is being uploaded) for a specific code>sessionId/code>./p>ul>li>Multiple consents can be uploaded per code>sessionId/code> but only the latest will be consider binding/li>/ul>h4 idrequest>Request/h4>p>strong>Request method: POST/strong>br/>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers:/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  Request body signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idrequest-properties-explained>Request properties explained/h5>ul>li>code>type/code>: code>string/code> (required) Consent type (one of code>ine/code>, code>bipa/code>, code>aadhaar/code>)/li>li>code>approved/code>: code>boolean/code> (required) Is the consent approved by the end user or not/li>li>code>text/code>: code>string/code> (required) Consent text exactly (same language) as shown to the end user/li>/ul>h5 idsample-request>Sample request/h5>h6 idcurl>curl/h6>pre classhighlight plaintext>code>curl -X POST \  --url /v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/consents \  -H Content-Type: application/json \  -H X-AUTH-CLIENT: API-PUBLIC-KEY \  -H X-HMAC-SIGNATURE: 034c6da2bb31fd9e6892516c6d7b90ebe10f79b47cfb3d155d77b4d9b66e1d53 \  -d {  type: ine,  approved: true,  text: User agrees to share their INE details,}/code>/pre>h6 idnode-js>Node.js/h6>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>request/span>span classp>);/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>POST/span>span classp>,/span>  span classna>url/span>span classp>:/span> span classs1>/v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/consents/span>span classp>,/span>  span classna>headers/span>span classp>:/span>   span classp>{/span> span classs1>Content-Type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span>     span classs1>X-HMAC-SIGNATURE/span>span classp>:/span> span classs1>034c6da2bb31fd9e6892516c6d7b90ebe10f79b47cfb3d155d77b4d9b66e1d53/span>span classp>,/span>     span classs1>X-AUTH-CLIENT/span>span classp>:/span> span classs1>API-PUBLIC-KEY/span> span classp>},/span>  span classna>body/span>span classp>:/span>   span classp>{/span> span classna>image/span>span classp>:/span>      span classp>{/span> span classna>type/span>span classp>:/span> span classs1>ine/span>span classp>,/span>        span classna>approved/span>span classp>:/span> span classkc>true/span>span classp>,/span>        span classna>text/span>span classp>:/span> span classs1>User agrees to share their INE details/span> span classp>}/span> span classp>},/span>  span classna>json/span>span classp>:/span> span classkc>true/span> span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span>  span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span>  span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span>span classp>});/span>/code>/pre>h6 idpython3-py>Python3.py/h6>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>json/span>span classkn>import/span> span classnn>pprint/span>span classn>url/span>span classo>/span>span classs>/v1/sessions/{sessionId}/consents/span>span classn>payload/span> span classo>/span> span classn>json/span>span classo>./span>span classn>dumps/span>span classp>({/span>  span classs>type/span>span classp>:/span> span classs>ine/span>span classp>,/span>  span classs>approved/span>span classp>:/span> span classbp>True/span>span classp>,/span>  span classs>text/span>span classp>:/span> span classs>User agrees to share their INE details/span>span classp>})/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>X-AUTH-CLIENT/span>span classp>:/span> span classs>API-PUBLIC-KEY/span>span classp>,/span>    span classs>X-HMAC-SIGNATURE/span>span classp>:/span> span classs>034c6da2bb31fd9e6892516c6d7b90ebe10f79b47cfb3d155d77b4d9b66e1d53/span>span classp>,/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>POST/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>payload/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classn>pprint/span>span classo>./span>span classn>pprint/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>json/span>span classp>())/span>/code>/pre>h4 idresponse>Response/h4>p>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  Request body signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idresponse-properties-explained>Response properties explained/h5>ul>li>code>id/code>: code>UUID-v4/code> String UUID v4 which identifies the consent/li>li>code>context/code>: code>string/code> always 'consent'/li>li>code>sessionId/code>: code>UUID-v4/code> String UUID v4 which identifies the session/li>/ul>h5 idsample-response>Sample response/h5>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>  /span>span classs2>image/span>span classp>:{/span>span classw>     /span>span classs2>context/span>span classp>:/span>span classw> /span>span classs2>consent/span>span classp>,/span>span classw>     /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>12551f8d-d3d6-4e9b-91b2-3978a2e7a553/span>span classp>,/span>span classw>     /span>span classs2>sessionId/span>span classp>:/span>span classw> /span>span classs2>39388f8d-c6d6-4e9b-92c6-6978b2e8d664/span>span classw>   /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h3 idget-sessions-sessionid-decision-ine-registry>span classmethod method-get>GET/span> /sessions/{sessionId}/decision/ine-registry/h3>p>Returns data about the INE identification number./p>h4 idrequest>Request/h4>h5 idrequest-properties-explained>Request properties explained/h5>p>strong>Request method: GET/strong>br/>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  code>sessionId/code> signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json (required)/code>/br>strong>Query parameters/strong>:br/>code>version: string (required)/code>  the version number of the check/p>h6 idsample-request>Sample request/h6>p>Note: the examples below are for illustrative purposes only, and are using mock data for strong>API URL/strong>and strong>X-HMAC-SIGNATURE/strong>, and a placeholder for strong>API-PUBLIC-KEY/strong>. You need to replace these with the actual valuesthat you use./p>aside classnotice>Do not to use sensitive data or expose personally identifiable information (PII) even when testing./aside>h6 idcurl>curl/h6>pre classhighlight plaintext>code>curl -X GET v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/decision/ine-registry?version1.0.0 \-H X-AUTH-CLIENT: API-PUBLIC-KEY \-H X-HMAC-SIGNATURE: 334141f052e317fde6668de54dc6640b4a5c47582ad86a8bed63afe566f17b14 \-H Content-Type: application/json \/code>/pre>h6 idnode-js>Node.js/h6>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>request/span>span classp>);/span>span classkd>var/span> span classnx>url/span> span classo>/span> span classs1>/v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/decision/ine-registry?version1.0.0/span>span classp>;/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span>    span classna>method/span>span classp>:/span> span classs1>GET/span>span classp>,/span>    span classna>url/span>span classp>:/span> span classnx>url/span>span classp>,/span>    span classna>headers/span>span classp>:/span> span classp>{/span>        span classs1>X-AUTH-CLIENT/span>span classp>:/span> span classs1>API-PUBLIC-KEY/span>span classp>,/span>        span classs1>X-HMAC-SIGNATURE/span>span classp>:/span> span classs1>334141f052e317fde6668de54dc6640b4a5c47582ad86a8bed63afe566f17b14/span>span classp>,/span>        span classs1>Content-Type/span>span classp>:/span> span classs1>application/json/span>    span classp>}/span>span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span>    span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span>        span classnx>console/span>span classp>./span>span classnx>error/span>span classp>(/span>span classs1>Error:/span>span classp>,/span> span classnx>error/span>span classp>);/span>    span classp>}/span> span classk>else/span> span classp>{/span>        span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response:/span>span classp>,/span> span classnx>body/span>span classp>);/span>    span classp>}/span>span classp>});/span>/code>/pre>h6 idpython3-py>Python3.py/h6>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>json/span>span classkn>import/span> span classnn>pprint/span>span classn>url/span> span classo>/span> span classs>/v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/decision/ine-registry/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>X-AUTH-CLIENT/span>span classp>:/span> span classs>API-PUBLIC-KEY/span>span classp>,/span>    span classs>X-HMAC-SIGNATURE/span>span classp>:/span> span classs>334141f052e317fde6668de54dc6640b4a5c47582ad86a8bed63afe566f17b14/span>span classp>,/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>}/span>span classn>params/span> span classo>/span> span classp>{/span>    span classs>version/span>span classp>:/span> span classs>1.0.0/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>get/span>span classp>(/span>span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>,/span> span classn>params/span>span classo>/span>span classn>params/span>span classp>)/span>span classk>if/span> span classn>response/span>span classo>./span>span classn>status_code/span> span classo>/span> span classmi>200/span>span classp>:/span>    span classn>data/span> span classo>/span> span classn>json/span>span classo>./span>span classn>loads/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>    span classn>pprint/span>span classo>./span>span classn>pprint/span>span classp>(/span>span classn>data/span>span classp>)/span>span classk>else/span>span classp>:/span>    span classk>print/span>span classp>(/span>span classn>f/span>span classs>Error: {response.status_code}/span>span classp>)/span>/code>/pre>h4 idresponse>Response/h4>p>strong>Headers/strong>br/>/p>p>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  payload signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idresponse-properties-explained>Response properties explained/h5>ul>li>code>active/code>: code>boolean/code> Indication of if the INE identification number is active (code>true/code>) or inactive (code>false/code>)./li>li>code>documentState/code>: code>string/code> Human readable description of the status of the query/li>/ul>p>Note: in the respective jurisdiction, an code>active  true/code> credential can be used for identification and relatedactivities; an code>active  false/code> credential could still be in the database, but it cannot be used for identificationand related activities./p>h5 idsample-response>Sample Response/h5>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>active/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw>    /span>span classs2>documentState/span>span classp>:/span>span classw> /span>span classs2>No se obtuvieron datos de la consulta con los parámetros seleccionados/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h3 idget-sessions-sessionid-decision-curp-registry>span classmethod method-get>GET/span> /sessions/{sessionId}/decision/curp-registry/h3>p>Returns the check result with CURP identification number and status./p>h4 idrequest>Request/h4>p>strong>Request method: GET/strong>br/>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  code>sessionId/code> signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json (required)/code>br/>strong>Query parameters/strong>:br/>code>version: string (required)/code>  the version number of the check/p>h5 idsample-request>Sample request/h5>p>Note: the examples below are for illustrative purposes only, and are using mock data for strong>API URL/strong>and strong>X-HMAC-SIGNATURE/strong>, and a placeholder for strong>API-PUBLIC-KEY/strong>. You need to replace these with the actual valuesthat you use./p>aside classnotice>Do not to use sensitive data or expose personally identifiable information (PII) even when testing./aside>h6 idcurl>curl/h6>pre classhighlight plaintext>code>curl -X GET v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/decision/curp-registry?version1.0.0 \-H X-AUTH-CLIENT: API-PUBLIC-KEY \-H X-HMAC-SIGNATURE: 334141f052e317fde6668de54dc6640b4a5c47582ad86a8bed63afe566f17b14 \-H Content-Type: application/json \/code>/pre>h6 idnode-js>Node.js/h6>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>request/span>span classp>);/span>span classkd>var/span> span classnx>url/span> span classo>/span> span classs1>/v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/decision/curp-registry?version1.0.0/span>span classp>;/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span>  span classna>method/span>span classp>:/span> span classs1>GET/span>span classp>,/span>  span classna>url/span>span classp>:/span> span classnx>url/span>span classp>,/span>  span classna>headers/span>span classp>:/span> span classp>{/span>    span classs1>X-AUTH-CLIENT/span>span classp>:/span> span classs1>API-PUBLIC-KEY/span>span classp>,/span>    span classs1>X-HMAC-SIGNATURE/span>span classp>:/span> span classs1>334141f052e317fde6668de54dc6640b4a5c47582ad86a8bed63afe566f17b14/span>span classp>,/span>    span classs1>Content-Type/span>span classp>:/span> span classs1>application/json/span>    span classp>}/span>span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span>  span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span>    span classnx>console/span>span classp>./span>span classnx>error/span>span classp>(/span>span classs1>Error:/span>span classp>,/span> span classnx>error/span>span classp>);/span>  span classp>}/span> span classk>else/span> span classp>{/span>    span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response:/span>span classp>,/span> span classnx>body/span>span classp>);/span>  span classp>}/span>span classp>});/span>/code>/pre>h6 idpython3-py>Python3.py/h6>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>json/span>span classkn>import/span> span classnn>pprint/span>span classn>url/span> span classo>/span> span classs>/v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/decision/curp-registry/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>X-AUTH-CLIENT/span>span classp>:/span> span classs>API-PUBLIC-KEY/span>span classp>,/span>    span classs>X-HMAC-SIGNATURE/span>span classp>:/span> span classs>334141f052e317fde6668de54dc6640b4a5c47582ad86a8bed63afe566f17b14/span>span classp>,/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>}/span>span classn>params/span> span classo>/span> span classp>{/span>    span classs>version/span>span classp>:/span> span classs>1.0.0/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>get/span>span classp>(/span>span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>,/span> span classn>params/span>span classo>/span>span classn>params/span>span classp>)/span>span classk>if/span> span classn>response/span>span classo>./span>span classn>status_code/span> span classo>/span> span classmi>200/span>span classp>:/span>    span classn>data/span> span classo>/span> span classn>json/span>span classo>./span>span classn>loads/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>    span classn>pprint/span>span classo>./span>span classn>pprint/span>span classp>(/span>span classn>data/span>span classp>)/span>span classk>else/span>span classp>:/span>    span classk>print/span>span classp>(/span>span classn>f/span>span classs>Error: {response.status_code}/span>span classp>)/span>/code>/pre>h4 idresponse>Response/h4>p>strong>Headers/strong>br/>/p>p>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  payload signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idresponse-properties-explained>Response properties explained/h5>ul>li>code>statusCurp/code>: code>string | null/code> (One of: AN, AH, CRA CU, RCN, RCC, BD, BDA, BCC, BCN) Status of the CURP data(see below for the full forms of the acronyms)/li>li>code>curp/code>: code>string/code> 18-character alphanumeric code of the person (the CURP identification number)/li>/ul>h4 idfull-forms-of-the-statuscurp-acronyms>Full forms of the code>statusCurp/code> acronyms/h4>p>strong>Active CURP/strong>: AN (Alta Normal), AH (Alta con Homonimia), CRA CU (CURP Reactivada),RCN (Registro de Cambio no Afectando a CURP), RCC (Registro de Cambio Afectando a CURP)/p>p>strong>For inactive CURP/strong>: BD (Baja por Defuncion), BDA (Baja por Duplicidad), BCC (Baja por Cambio en CURP),BCN (Baja no Afectando a CURP)/p>h5 idsample-response>Sample Response/h5>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>statusCurp/span>span classp>:/span>span classw> /span>span classs2>RCN/span>span classp>,/span>span classw>    /span>span classs2>curp/span>span classp>:/span>span classw> /span>span classs2>FOHJ920625HGTLRR06/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h3 idget-sessions-sessionid-decision-combined-ine-curp-registry>span classmethod method-get>GET/span> /sessions/{sessionId}/decision/combined-ine-curp-registry/h3>p>Returns combined result of INE/IFE and CURP./p>h4 idrequest>Request/h4>h5 idrequest-properties-explained>Request properties explained/h5>p>strong>Request method: GET/strong>br/>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  code>sessionId/code> signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json (required)/code>/br>strong>Query parameters/strong>:br/>code>version: string (required)/code>  the version number of the check/p>h6 idsample-request>Sample request/h6>p>Note: the examples below are for illustrative purposes only, and are using mock data for strong>API URL/strong>and strong>X-HMAC-SIGNATURE/strong>, and a placeholder for strong>API-PUBLIC-KEY/strong>. You need to replace these with the actual valuesthat you use./p>aside classnotice>Do not to use sensitive data or expose personally identifiable information (PII) even when testing./aside>h6 idcurl>curl/h6>pre classhighlight plaintext>code>curl -X GET v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/decision/combined-ine-curp-registry?version1.0.0 \-H X-AUTH-CLIENT: API-PUBLIC-KEY \-H X-HMAC-SIGNATURE: 334141f052e317fde6668de54dc6640b4a5c47582ad86a8bed63afe566f17b14 \-H Content-Type: application/json \/code>/pre>h6 idnode-js>Node.js/h6>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>request/span>span classp>);/span>span classkd>var/span> span classnx>url/span> span classo>/span> span classs1>/v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/decision/combined-ine-curp-registry?version1.0.0/span>span classp>;/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span>    span classna>method/span>span classp>:/span> span classs1>GET/span>span classp>,/span>    span classna>url/span>span classp>:/span> span classnx>url/span>span classp>,/span>    span classna>headers/span>span classp>:/span> span classp>{/span>        span classs1>X-AUTH-CLIENT/span>span classp>:/span> span classs1>API-PUBLIC-KEY/span>span classp>,/span>        span classs1>X-HMAC-SIGNATURE/span>span classp>:/span> span classs1>334141f052e317fde6668de54dc6640b4a5c47582ad86a8bed63afe566f17b14/span>span classp>,/span>        span classs1>Content-Type/span>span classp>:/span> span classs1>application/json/span>    span classp>}/span>span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span>    span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span>        span classnx>console/span>span classp>./span>span classnx>error/span>span classp>(/span>span classs1>Error:/span>span classp>,/span> span classnx>error/span>span classp>);/span>    span classp>}/span> span classk>else/span> span classp>{/span>        span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response:/span>span classp>,/span> span classnx>body/span>span classp>);/span>    span classp>}/span>span classp>});/span>/code>/pre>h6 idpython3-py>Python3.py/h6>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>json/span>span classkn>import/span> span classnn>pprint/span>span classn>url/span> span classo>/span> span classs>/v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/decision/combined-ine-curp-registry/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>X-AUTH-CLIENT/span>span classp>:/span> span classs>API-PUBLIC-KEY/span>span classp>,/span>    span classs>X-HMAC-SIGNATURE/span>span classp>:/span> span classs>334141f052e317fde6668de54dc6640b4a5c47582ad86a8bed63afe566f17b14/span>span classp>,/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>}/span>span classn>params/span> span classo>/span> span classp>{/span>    span classs>version/span>span classp>:/span> span classs>1.0.0/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>get/span>span classp>(/span>span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>,/span> span classn>params/span>span classo>/span>span classn>params/span>span classp>)/span>span classk>if/span> span classn>response/span>span classo>./span>span classn>status_code/span> span classo>/span> span classmi>200/span>span classp>:/span>    span classn>data/span> span classo>/span> span classn>json/span>span classo>./span>span classn>loads/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>    span classn>pprint/span>span classo>./span>span classn>pprint/span>span classp>(/span>span classn>data/span>span classp>)/span>span classk>else/span>span classp>:/span>    span classk>print/span>span classp>(/span>span classn>f/span>span classs>Error: {response.status_code}/span>span classp>)/span>/code>/pre>h4 idresponse>Response/h4>p>strong>Headers/strong>br/>/p>p>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  payload signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>h5 idresponse-properties-explained>Response properties explained/h5>ul>li>code>data/code>: code>object/code> Data related to the INE/IFE identification number and the CURP identification numberul>li>code>ine/code>: code>object/code> Details about the INE/IFE identification numberul>li>code>active/code>: code>boolean/code> Indication of if the INE identification number is active (code>true/code>) or inactive (code>false/code>)/li>li>code>status/code>: code>string/code> Explanation of the code>data.status/code> value/li>li>code>information/code>: code>string/code> Extra information about the INE identification number/li>li>code>comments/code>: code>array/code> Comments regarding the status of the identification/li>li>code>ifeIdentifier/code>: code>string | null/code> INE identification number. When this is returned, the code>ineIdentifier/code> is not present/li>li>code>ineIdentifier/code>: code>string | null/code> IFE identification number. When this is returned, the code>ifeIdentifier/code> is not present/li>/ul>/li>li>code>curp/code>: code>object/code> Details about the CURP identification numberul>li>code>curp/code>: code>string/code> CURP identification number/li>li>code>names/code>: code>string/code> Name/li>li>code>gender/code>: code>string/code> Gender (One of code>HOMBRE/code>, code>MUJER/code>)/li>li>code>regionCode/code>: code>string/code> Region code/li>li>code>statusCurp/code>: code>string | null/code> Status of the CURP data (One of: AN, AH, CRA CU, RCN, RCC, BD, BDA, BCC, BCN)/li>li>code>descriptionStatusCurp/code>: code>string/code> Explanation of the code>curp.statusCurp/code> value/li>li>code>birthRegion/code>: code>string/code> Birth region/li>li>code>dateOfBirth/code>: code>string/code> Date of birth, as code>DD/MM/YYYY/code>,/li>li>code>nationality/code>: code>string/code> Nationality/li>li>code>firstSurname/code>: code>string/code> First surname/li>li>code>secondSurname/code>: code>string/code> Last surname/li>li>code>documentEvidence/code>: code>number/code> Document evidence/li>li>code>docEvidenceData/code>: code>object/code> Details about the document evidence dataul>li>code>book/code>: code>string/code> Book/li>li>code>sheet/code>: code>string/code> Sheet/li>li>code>volume/code>: code>string/code> Volume/li>li>code>actNumber/code>: code>string/code> Act number/li>li>code>registryCity/code>: code>string/code> Registry city/li>li>code>regionRegistry/code>: code>string/code> Region registry/li>li>code>registrationYear/code>: code>string/code> Registration year/li>li>code>registryCityCode/code>: code>string/code> Registry city code/li>li>code>registryRegionCode/code>: code>string/code> Registry region code/li>/ul>/li>/ul>/li>/ul>/li>/ul>h6 idfull-forms-of-the-statuscurp-acronyms>Full forms of the code>statusCurp/code> acronyms/h6>p>strong>Active CURP/strong>: AN (Alta Normal), AH (Alta con Homonimia), CRA CU (CURP Reactivada),RCN (Registro de Cambio no Afectando a CURP), RCC (Registro de Cambio Afectando a CURP)/p>p>strong>For inactive CURP/strong>: BD (Baja por Defuncion), BDA (Baja por Duplicidad), BCC (Baja por Cambio en CURP),BCN (Baja no Afectando a CURP)/p>p>h5 idsample-response>Sample Response/h5>pre classhighlight json tab-json>code>span classp>{/span>span classw>  /span>span classs2>"type"/span>span classp>:/span>span classw> /span>span classs2>"combined-ine-curp-registry"/span>span classp>,/span>span classw>  /span>span classs2>"id"/span>span classp>:/span>span classw> /span>span classs2>"f04bdb47-d3be-4b28-b028-a652feb060b5"/span>span classp>,/span>span classw>  /span>span classs2>"vendorData"/span>span classp>:/span>span classw>  /span>span classs2>"1234567812345678"/span>span classp>,/span>span classw>  /span>span classs2>"endUserId"/span>span classp>:/span>span classw> /span>span classs2>"fa820aba-019f-455a-ae81-cfca8075bc3f"/span>span classp>,/span>span classw>  /span>span classs2>"version"/span>span classp>:/span>span classw> /span>span classs2>"1.0.0"/span>span classp>,/span>span classw>  /span>span classs2>"data"/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>      /span>span classs2>"attemptId"/span>span classp>:/span>span classw> /span>span classs2>"e30122d1-740b-4764-853f-470374a7abf4"/span>span classp>,/span>span classw>      /span>span classs2>"name"/span>span classp>:/span>span classw> /span>span classs2>"combined-ine-curp-registry"/span>span classp>,/span>span classw>      /span>span classs2>"status"/span>span classp>:/span>span classw> /span>span classs2>"found"/span>span classp>,/span>span classw>      /span>span classs2>"code"/span>span classp>:/span>span classw> /span>span classmi>200/span>span classp>,/span>span classw>      /span>span classs2>"details"/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classs2>"ine"/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>"active"/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw>            /span>span classs2>"status"/span>span classp>:/span>span classw> /span>span classs2>"La credencial esta vigente"/span>span classp>,/span>span classw>            /span>span classs2>"comments"/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                /span>span classs2>"CIC 000000000/span>span classse>\r\n/span>span classs2>Clave de elector JRLGLS00000000H000/span>span classse>\r\n/span>span classs2>Número de emisión 1/span>span classse>\r\n/span>span classs2>Distrito Federal 3/span>span classse>\r\n/span>span classs2>Distrito Local 4/span>span classse>\r\n/span>span classs2>Número OCR 0000000000000/span>span classse>\r\n/span>span classs2>Año de registro 2009/span>span classse>\r\n/span>span classs2>Año de emisión 2020"/span>span classp>,/span>span classw>                /span>span classs2>"Fecha de actualización de la información: 10 de agosto del 2023 19:48"/span>span classp>,/span>span classw>                /span>span classs2>"Fecha de consulta: 11 de agosto del 2023"/span>span classp>,/span>span classw>                /span>span classs2>"Tus datos se encuentran en el Padrón Electoral, y también en la Lista Nominal de Electores"/span>span classw>            /span>span classp>,/span>span classw>            /span>span classs2>"information"/span>span classp>:/span>span classw> /span>span classs2>"CIC 000000000/span>span classse>\r\n/span>span classs2>Clave de elector JRLGLS00000000H000/span>span classse>\r\n/span>span classs2>Número de emisión 1/span>span classse>\r\n/span>span classs2>Distrito Federal 3/span>span classse>\r\n/span>span classs2>Distrito Local 4/span>span classse>\r\n/span>span classs2>Número OCR 0000000000000/span>span classse>\r\n/span>span classs2>Año de registro 2009/span>span classse>\r\n/span>span classs2>Año de emisión 2020/span>span classse>\r\n/span>span classs2>Fecha de actualización de la información: 10 de agosto del 2023 19:48/span>span classse>\r\n/span>span classs2>Fecha de consulta: 11 de agosto del 2023/span>span classse>\r\n/span>span classs2>Esta vigente como medio de identificación y puedes votar./span>span classse>\r\n/span>span classs2>Tus datos se encuentran en el Padrón Electoral, y también en la Lista Nominal de Electores./span>span classse>\r\n/span>span classs2>Será válida hasta el 31 de diciembre de 2030"/span>span classp>,/span>span classw>            /span>span classs2>"ifeIdentifier"/span>span classp>:/span>span classw> /span>span classs2>""/span>span classp>,/span>span classw>            /span>span classs2>"ineIdentifier"/span>span classp>:/span>span classw> /span>span classs2>"000000000"/span>span classw>        /span>span classp>},/span>span classw>        /span>span classs2>"curp"/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>"curp"/span>span classp>:/span>span classw> /span>span classs2>"ABCD000000HVZRGS00"/span>span classp>,/span>span classw>            /span>span classs2>"names"/span>span classp>:/span>span classw> /span>span classs2>"LOREM IPSUM"/span>span classp>,/span>span classw>            /span>span classs2>"gender"/span>span classp>:/span>span classw> /span>span classs2>"HOMBRE"/span>span classp>,/span>span classw>            /span>span classs2>"regionCode"/span>span classp>:/span>span classw> /span>span classs2>"VZ"/span>span classp>,/span>span classw>            /span>span classs2>"statusCurp"/span>span classp>:/span>span classw> /span>span classs2>"RCN"/span>span classp>,/span>span classw>            /span>span classs2>"birthRegion"/span>span classp>:/span>span classw> /span>span classs2>"Veracruz"/span>span classp>,/span>span classw>            /span>span classs2>"dateOfBirth"/span>span classp>:/span>span classw> /span>span classs2>"06/04/1991"/span>span classp>,/span>span classw>            /span>span classs2>"nationality"/span>span classp>:/span>span classw> /span>span classs2>"MEX"/span>span classp>,/span>span classw>            /span>span classs2>"firstSurname"/span>span classp>:/span>span classw> /span>span classs2>"JUAREZ"/span>span classp>,/span>span classw>            /span>span classs2>"secondSurname"/span>span classp>:/span>span classw> /span>span classs2>"LAGUNES"/span>span classp>,/span>span classw>            /span>span classs2>"docEvidenceData"/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                /span>span classs2>"book"/span>span classp>:/span>span classw> /span>span classs2>""/span>span classp>,/span>span classw>                /span>span classs2>"sheet"/span>span classp>:/span>span classw> /span>span classs2>""/span>span classp>,/span>span classw>                /span>span classs2>"volume"/span>span classp>:/span>span classw> /span>span classs2>""/span>span classp>,/span>span classw>                /span>span classs2>"actNumber"/span>span classp>:/span>span classw> /span>span classs2>"00123"/span>span classp>,/span>span classw>                /span>span classs2>"registryCity"/span>span classp>:/span>span classw> /span>span classs2>""/span>span classp>,/span>span classw>                /span>span classs2>"regionRegistry"/span>span classp>:/span>span classw> /span>span classs2>"30"/span>span classp>,/span>span classw>                /span>span classs2>"registrationYear"/span>span classp>:/span>span classw> /span>span classs2>"1991"/span>span classp>,/span>span classw>                /span>span classs2>"registryCityCode"/span>span classp>:/span>span classw> /span>span classs2>"125"/span>span classp>,/span>span classw>                /span>span classs2>"registryRegionCode"/span>span classp>:/span>span classw> /span>span classs2>"VZ"/span>span classw>            /span>span classp>},/span>span classw>            /span>span classs2>"documentEvidence"/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw>            /span>span classs2>"descriptionStatusCurp"/span>span classp>:/span>span classw> /span>span classs2>"Registro de cambio no afectando a curp"/span>span classw>        /span>span classp>}/span>span classw>    /span>span classp>}/span>span classw>  /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/p>h2 idtest-the-requests-in-postman>Test the requests in Postman/h2>p>It is possible to test the strong>Veriff API v1.0 Collection/strong> in strong>Postman/strong>. Click on the button belowto get started./p>div classpostman-btn-wrapper>    a hrefhttps://postman.veriff.com target_blank classpostman-btn>      span classpostman-txt>Try in Postman/span>       span classpostman-arrow>▸/span>    /a>/div>h2 idapi-requests-signing-with-x-hmac-signature>API requests signing with X-HMAC-SIGNATURE/h2>p>strong>X-HMAC-SIGNATURES/strong> are a security measure, which we generate for the strong>API requests/strong> and strong>webhook listeners/strong>, to make sure that the exchanged data has not been tampered with./p>p>If you are familiar with the signing concept, jump to the a href#generate-an-x-hmac-signature>Generate X-HMAC-SIGNATURE/a>section. Here you find:/p>ul>li>A list of the a href#x-hmac-signature-prerequisites>prerequisites/a> you need to generate an strong>X-HMAC-SIGNATURE/strong>/li>li>Examples of some technical a href#options_to_generate_signature>options/a> which you can use to generate the signature/li>li>Explanation about how you can a href#validate-x-hmac-signature-locally>locally validate/a> the generated signature/li>/ul>p>If you want a conceptual overview of the feature, we recommend taking a look at thisa href#what-is-an-x-hmac-signature>What is an X-HMAC-SIGNATURE?/a> section./p>h3 idgenerate-an-x-hmac-signature>Generate an X-HMAC-SIGNATURE/h3>p>a namex-hmac-signature-prerequisites>/a>/p>h4 idprerequisites-for-live-requests-signing>Prerequisites for live requests signing/h4>p>If you want to generate the strong>X-HMAC-SIGNATURE/strong> for an strong>actual API request/strong>, have the followinginfo at hand and use these in your preferred signature generation tool:/p>ul>li>strong>API key/strong> (you can find it in strong>Station/strong>, on relevant integration’s page). You will use it asstrong>X-AUTH-CLIENT header/strong>/li>li>strong>Shared secret key/strong> (you can find it in strong>Station/strong>, on relevant integration’s page). You will use itto sign the strong>payload/strong>/li>li>strong>code>Content-Type/code> header/strong> (in Veriff’s API requests case, code>application/json/code>)/li>li>API request’s strong>payload/strong> (defined in each strong>Endpoint’s/strong> code>Headers/code> explanation)/li>/ul>p>If you are unsure which method you want to use, the a href#options_to_generate_signature>Options to generate a X-HMAC-SIGNATURE/a>section lists some options. You can use the strong>mock data/strong> a href#Mock_data_for_local_testing>here/a>to test them in strong>your local machine/strong>./p>p>a nameMock_data_for_local_testing>/a>h4>Mock data for local testing/h4>/p>p>    If you want to test the a href#options_to_generate_signature>signature generation options/a>     b>locally/b>, you can use the following b>mock shared secret/b> key and b>mock payload/b>. /p>p>    b>Mock shared secret key/b>:/p>pre>abcdef12-abcd-abcd-abcd-abcdef012345/pre>p>POST /sessions request b>mock payload/b> (as .json):/p>pre>{verification:{callback:https://veriff.com,person:{firstName:John,lastName:Smith},document:{type:PASSPORT,country:EE},vendorData:unique id of the end-user,timestamp:2016-05-19T08:30:25.597Z}}/pre>p>    If your preferred method is correct, you should get the following b>mock X-HMAC-SIGNATURE/b>:/p>pre>0dcab73ddd20062616d104231c7439657546a5c24e4691977da93bb854c31e25/pre>p>    Note: to generate an b>actual signature/b> for your b>live API requests/b>, the code>Headers/code> explanation    in each b>API request’s/b> section tells you what to use as b>payload/b> for encryption./p>p>a nameoptions_to_generate_signature>/a>/p>h4 idoptions-to-generate-a-x-hmac-signature>Options to generate a X-HMAC-SIGNATURE/h4>p>There are several ways to do that: /p>ul>li>For ease of use, go for a strong>dedicated HMAC signature generator/strong> which supports the generationof HMAC-SHA256 signatures, like OpenSLL, a hrefhttps://oauth.io/>OAuth.io/a> ↗ or Postman/li>li>If you want control and flexibility, you can create a strong>script/strong> (see a href#scripts-to-generate-signature>some mock scripts/a>here) or use a strong>command-line tool/strong> (a mock a href#openssl-to-generate-signature>openssl script/a>)/li>li>If you are familiar with a programming language, you can use strong>built-in cryptographic libraries/strong>(see a mock a href#python-library-to-generate-signature>Python example/a> here)/li>li>If you need the signature quickly and security is not a priority, you can use an strong>online tool/strong>(see an a href#online-tool-to-generate-signature>example/a> below)/li>/ul>aside classnotice>Do not to use sensitive data or expose personally identifiable information (PII) even when testing./aside>aside classnotice>Please note that generating the value may vary depending on the programming language used, e.g., some languagesinclude the hard spaces in the body, some omit them./aside>p>a namescripts-to-generate-signature>/a>/p>h4 idscripts>Scripts/h4>div classexpandable>    details>        summary classexpandable-title>            span classicon>▸/span>Javascript        /summary>        div idexpandable-content classexpandable-content>            p>Heres an example in JavaScript of how you can generate an HMAC-SHA256 hash            and the corresponding b>X-HMAC-SIGNATURE/b> using the built-in code>crypto/code> module.            Note that you may need to add this module./p>            pre>                code>const crypto  require(crypto);br/>const sharedSecretKey  abcdef12-abcd-abcd-abcd-abcdef012345;br/>const payload  {\verification\:{\callback\:\https://veriff.com\,\person\:{\firstName\:\John\,\lastName\:\Smith\},\document\:{\type\:\PASSPORT\,\country\:\EE\},\vendorData\:\unique id of the end-user\,\timestamp\:\2016-05-19T08:30:25.597Z\}};br/>                const hash  crypto    .createHmac(sha256, sharedSecretKey)    .update(payload)    .digest(hex);br/>const xHmacSignature  `sha256${hash}`;br/>console.log(xHmacSignature);                /code>            /pre>            ul>                li>                    First, set the b>shared secret key/b>. Note that the                    b>shared secret key/b> is hardcoded to the script, so you should take extra care to keep                    it secret.br/>                /li>                li>                    Next, prepare the b>payload/b> data and generate the HMAC-SHA256 hash using the                    code>crypto.createHmac()/code> method. This method takes the algorithm name (sha256) and                    the b>shared secret key/b> as arguments, and returns an HMAC object.                /li>                li>                    Call the code>update()/code> method of the HMAC object with the b>payload/b> data to                    update the HMAC with the b>payload/b> data. Then call the code>digest()/code> method with the                    argument hex to obtain the hash value in hexadecimal format.                /li>                li>                    Finally, generate the b>X-HMAC-SIGNATURE/b> by concatenating the algorithm name (sha256)                    with the hash value separated by an equals sign, and store the result in the                    code>xHmacSignature/code> variable. Then, log the b>X-HMAC-SIGNATURE/b> to the console.                /li>            /ul>        /div>    /details>/div>div classexpandable>    details>        summary classexpandable-title>            span classicon>▸/span>C#        /summary>        div idexpandable-content classexpandable-content>            p>This is an example of a script that generates an b>X-HMAC-SIGNATURE/b> using only the built-in                code>System.Text.Encoding/code> and code>System.Security.Cryptography /code>namespaces. In this example,                the b>shared secret key/b> and the b>payload/b> are hardcoded. (If you think that you do not want to                hardcode them, one option is to create a prompt using the code>Console.ReadLine()/code> or                 code>Console.ReadKey()/code> methods, which asks you to enter the b>shared secret key/b> and                b>payload/b> data.)/p>            pre>                code classlanguage-csharp>using System;using System.Text;using System.Security.Cryptography;br/>public class Program{    public static void Main()    {br/>        // Set the shared secret key and payload data        string sharedSecretKey  abcdef12-abcd-abcd-abcd-abcdef012345;        string payload  {\verification\:{\callback\:\https://veriff.com\,\person\:{\firstName\:\John\,\lastName\:\Smith\},\document\:{\type\:\PASSPORT\,\country\:\EE\},\vendorData\:\unique id of the end-user\,\timestamp\:\2016-05-19T08:30:25.597Z\}};br/>        // Convert the shared secret key and payload to byte arrays        byte sharedSecretKeyBytes  Encoding.UTF8.GetBytes(sharedSecretKey);        byte payloadBytes  Encoding.UTF8.GetBytes(payload);br/>        // Generate the HMAC-SHA256 hash        using (var hmac  new HMACSHA256(sharedSecretKeyBytes))        {            byte hash  hmac.ComputeHash(payloadBytes);br/>            // Convert the hash to a hexadecimal string and prepend the algorithm name            string xHmacSignature  sha256 + BitConverter.ToString(hash).Replace(-, ).ToLower();br/>            Console.WriteLine(xHmacSignature);        }    }}                /code>            /pre>            ul>                li>                    First set the b>shared secret key/b> and b>payload/b> data as strings.                /li>                li>                    Next, convert them to byte arrays using the code>Encoding.UTF8.GetBytes()/code> method.                /li>                li>                    Then generate the HMAC-SHA256 hash using the code>HMACSHA256/code> class, passing in the                    b>shared secret key/b> bytes as the key and the b>payload/b> bytes as the data to be hashed.                    The result is the hash value as a byte array.                /li>                li>                    Convert it to a hexadecimal string using the code>BitConverter.ToString()/code> method.                    Remove the hyphens using the code>Replace()/code> method, convert the string to lowercase using                    the code>ToLower()/code> method, and prepend the algorithm name sha256 to obtain the                    b>X-HMAC-SIGNATURE/b>.                /li>                li>                    Finally, write the b>X-HMAC-SIGNATURE/b> to the console using the code>Console.WriteLine()/code>                    method.                /li>            /ul>        /div>    /details>/div>div classexpandable>    details>        summary classexpandable-title>            span classicon>▸/span>PHP        /summary>        div idexpandable-content classexpandable-content>            p> This is an example of a script that generates an b>X-HMAC-SIGNATURE/b> using only the            built-in code>hash_hmac()/code> and code>strtolower()/code> functions./p>            pre>?phpbr/>$sharedSecretKey  abcdef12-abcd-abcd-abcd-abcdef012345;$payload  {verification:{callback:https://veriff.com,person:{firstName:John,lastName:Smith},document:{type:PASSPORT,country:EE},vendorData:unique id of the end-user,timestamp:2016-05-19T08:30:25.597Z}};br/>$signature  hash_hmac(sha256, $payload, $sharedSecretKey);$signature  strtolower($signature);br/>echo X-HMAC-SIGNATURE:  . $signature . PHP_EOL;            /pre>            ul>                li>                    Define the b>shared secret key/b> and the b>payload/b> as strings.                /li>                li>                    Generate the HMAC-SHA256 signature by calling the code>hash_hmac()/code> function, passing the hashing                    algorithm (sha256), the b>payload/b>, and the b>shared secret key/b>. Then, convert the                    signature to lowercase using the code>strtolower()/code> function.                /li>                li>                    Finally, echo the code>X-HMAC-SIGNATURE/code> to the output using the code>echo/code> statement.                /li>            /ul>        /div>    /details>/div>p>a nameopenssl-to-generate-signature>/a>/p>h4 idcommand-line-tools>Command-line tools/h4>div classexpandable>    details>        summary classexpandable-title>            span classicon>▸/span>openssl          /summary>        div idexpandable-content classexpandable-content>            p>            Below is an example of how to create the signature using b>openssl/b> command-line tool.br/>            In order to avoid hardcoding the b>shared secret key/b> and the b>payload/b> into your script or command            and thus keep it secure and prevent accidental disclosure and misuse, we have saved the two values to separate            separate files: b>secret_key.txt/b> and b>payload.txt/b>.            /p>            pre>set /p secret_key<secret_key.txt && set /p payload<payload.txt && echo | set /p dummy%payload% | openssl dgst -sha256 -hmac %secret_key% -hex            /pre>            ul>                li>Open the command-line tool and navigate to the folder where the .txt files are./li>                li>Then, run the command above in the command prompt./li>                li>The set code>/p/code> command is used to read the content of the files without adding a newline character.                 The code>echo | set /p dummy/code> part is used to output the content without a newline character./li>                li>After running the command, you should get the HMAC signature as output./li>            /ul>        /div>    /details>/div>p>a namepython-library-to-generate-signature>/a>/p>h4 idbuilt-in-crypto-libraries>Built-in crypto libraries/h4>div classexpandable>    details>        summary classexpandable-title>            span classicon>▸/span>Python cryptographic library        /summary>        div idexpandable-content classexpandable-content>            p>                Most modern programming languages have built-in cryptographic libraries that provide functions for                generating HMAC signatures. Here is a general overview of how to use built-in cryptographic libraries                to generate an HMAC signature:                ul>                    li>Choose the b>SHA-256 cryptographic algorithm/b> to generate signatures with Veriff./li>                    li>Next, get the b>payload/b> that you want to sign,                    and the b>shared secret key/b> to generate the b>X-HMAC-SIGNATURE/b>./li>                    li>Once you have the b>payload/b> and the b>shared secret key/b>, initialize                    the HMAC function in the cryptographic library. This typically involves creating an                    HMAC object or specifying the algorithm and the b>secret key/b>./li>                    li>After initializing the HMAC function, update it with the b>payload/b> you want                    to sign. This tells the function to incorporate the b>payload/b> into the HMAC signature./li>                    li>Finally, call a function in the cryptographic library to generate the HMAC signature                    based on the b>payload/b> and b>secret key/b>. This function should return the HMAC signature                    as a string or byte array, depending on the library and language you are using./li>                /ul>            p>                Here is an example of how you might generate an b>X-HMAC-SIGNATURE/b> in Python using                the built-in code>hmac/code> and code>hashlib/code> libraries:            /p>                pre>import hmacimport hashlibbr/>shared_secret_key  babcdef12-abcd-abcd-abcd-abcdef012345payload  b{verification:{callback:https://veriff.com,person:{firstName:John,lastName:Smith},document:{type:PASSPORT,country:EE},vendorData:unique id of the end-user,timestamp:2016-05-19T08:30:25.597Z}}br/>hash  hmac.new(shared_secret_key, payload, hashlib.sha256)br/>x_hmac_signature  sha256 + hash.hexdigest()br/>print(x_hmac_signature)                /pre>            ul>                li>                    The script imports the code>hmac/code> library for generating the HMAC signature and                    the code>hashlib/code> library to access the SHA256 hashing algorithm.                /li>                li>                    The b>shared secret key/b> and b>payload/b> are set as byte literals (strings with a code>b/code>                    prefix)                    to ensure proper encoding for the HMAC calculation.                /li>                li>                    The code>hmac.new()/code> function takes three arguments: the b>shared secret key/b>,                    the b>payload/b>, and the hashing algorithm (in this case, SHA256 from the code>hashlib/code>                    library). The function generates an HMAC hash using the provided b>shared secret key/b>, b>payload/b>,                    and hashing algorithm.                /li>                li>                    The code>hash.hexdigest()/code> method converts the HMAC hash into a hexadecimal string.                    The string sha256 is then prepended to the hexadecimal representation of the hash, creating the                    final b>X-HMAC-SIGNATURE/b> and the prints it to the console.                /li>            /ul>        /div>    /details>/div>p>a nameonline-tool-to-generate-signature>/a>/p>h4 idonline-tools>Online tools/h4>div classexpandable>    details>        summary classexpandable-title>            span classicon>▸/span>Online tool example        /summary>        div idexpandable-content classexpandable-content>            p>                Use your favorite HMAC-SHA256 calculator to calculate the hash, e.g.                a hrefhttps://codebeautify.org/hmac-generator>Codebeautify HMAC Generator/a> ↗            /p>            ul>                li>Select SHA256 from the algorithm dropdown/li>                li>Paste the b>shared secret key/b> to the Enter Key field/li>                li>Past the appropriate b>payload/b> to the  Enter the Plain or Cipher Text field/li>                li>Click on the b>Generate HMAC/b> button/li>                li>The result is a generated hash, which you can copy-paste to the b>X-HMAC-SIGNATURE/b>                    in your API request code>Headers/code> field./li>            /ul>        /div>    /details>/div>h3 idvalidate-x-hmac-signature-locally>Validate X-HMAC-SIGNATURE locally/h3>p>Below are few examples how to validate the generated strong>X-HMAC-SIGNATURE/strong>./p>div classexpandable>    details>        summary classexpandable-title>            span classicon>▸/span>Javascript code>isSignatureValid/code> function          /summary>        div idexpandable-content classexpandable-content>            p>The purpose of the function is to validate that the provided signature is correct for the given                b>payload/b> and b>shared secret key/b>. It does this by generating an b>X-HMAC-SIGNATURE/b> of                the b>payload/b> using the b>shared secret key/b>, and then comparing this HMAC to the provided                signature.            /p>            p>                Below is an example, where we are using the b>mock shared secret key/b>, b>signature/b> and                b>payload/b> values. You can run this in a Node.js environment to validate the signature. To                test a real signature, replace the mock values with real ones, b>but never expose PII when testing/b>!            /p>            pre>const crypto  require(crypto);br/>function isSignatureValid({ signature, shared_secret_key, payload }) {    if (payload.constructor  Object) {        payload  JSON.stringify(payload);    }br/>    if (payload.constructor ! Buffer) {        payload  Buffer.from(payload, utf8);    }br/>    const digest  crypto        .createHmac(sha256, shared_secret_key)        .update(Buffer.from(payload, utf8))        .digest(hex)        .toLowerCase();br/>    return digest  signature.toLowerCase();}br/>const signature  0dcab73ddd20062616d104231c7439657546a5c24e4691977da93bb854c31e25;const shared_secret_key  abcdef12-abcd-abcd-abcd-abcdef012345;const payload  {    verification: {        callback: https://veriff.com,        person: {            firstName: John,            lastName: Smith        },        document: {            type: PASSPORT,            country: EE        },        vendorData: unique id of the end-user,        timestamp: 2016-05-19T08:30:25.597Z    }};br/>console.log(isSignatureValid({ signature, shared_secret_key, payload }));            /pre>            p>                If both match, the function returns code>true/code>, indicating that the signature is valid,                and the payload is likely to be authentic. If they dont match, it returns code>false/code>, meaning the signature                is invalid, and the b>payloads/b> authenticity cannot be guaranteed.            /p>        /div>    /details>/div>div classexpandable>    details>        summary classexpandable-title>            span classicon>▸/span>Test validation function locally        /summary>        div idexpandable-content classexpandable-content>            p>                We recommend setting up a simple Express.js server in your local machine, to test the validation                functionality independently of our webhook or API service.br/>            /p>            p>                Below is a simple Express.js server application written in JavaScript that listens for incoming                POST requests to the code>/verification//code> endpoint. The server validates the HMAC-SHA256                signature of the b>request payload/b> using a b>shared secret key/b> and responds with the                validation status (code>true/code> or code>false/code>).            /p>            pre>const express  require(express);const bodyParser  require(body-parser);const { createHmac }  require(crypto);const { Server }  require(http);const app  express();br/>const SERVICE_PORT  3001;const SECRET_KEY  abcdef12-abcd-abcd-abcd-abcdef012345;br/>function isSignatureValid({ signature, sharedSecretKey, payload }) {if (payload.constructor  Object) {payload  JSON.stringify(payload);}br/>    if (payload.constructor ! Buffer) {        payload  new Buffer.from(payload, utf8);    }br/>    const digest  createHmac(sha256, sharedSecretKey)        .update(Buffer.from(payload, utf8))        .digest(hex)        .toLowerCase();br/>    return digest  signature.toLowerCase();}br/>app.use(bodyParser.json());let server  Server(app);app.post(/verification/, (req, res) > {    res.json({        isSignatureValid: isSignatureValid({            signature: req.get(x-hmac-signature), sharedSecretKey: SECRET_KEY, payload: req.body        })    });})server.listen(SERVICE_PORT, () > console.log(Server is UP \n Listening port:, SERVICE_PORT));            /pre>            br/>            p>                Now, post prepared data to the server you have set up.            /p>            pre>curl --request POST http://localhost:3001/verification/ -k --header accept:application/json --header x-auth-client:abcdef12-abcd-abcd-abcd-abcdef012345 --header x-hmac-signature:0dcab73ddd20062616d104231c7439657546a5c24e4691977da93bb854c31e25 --header content-type:application/json --data {\verification\:{\callback\:\https://veriff.com\,\person\:{\firstName\:\John\,\lastName\:\Smith\},\document\:{\type\:\PASSPORT\,\country\:\EE\},\vendorData\:\unique id of the end-user\,\timestamp\:\2016-05-19T08:30:25.597Z\}}            /pre>            p>This code>curl/code> above should return code>{isSignatureValid:true}/code> /p>        /div>    /details>/div>h3 idwhat-is-an-x-hmac-signature>What is an X-HMAC-SIGNATURE?/h3>p>This section aims to explain the nature and use of strong>X-HMAC-SIGNATURES/strong> and strong>webhook listeners/strong>,and describe the reasons why it is important to implement them./p>div classexpandable>    details>        summary classexpandable-title>            span classicon>▸/span>Definition of X-HMAC-SIGNATURE        /summary>        div idexpandable-content classexpandable-content>            p>                It is a signature which is calculated by performing a hash of the API request b>payload/b>                (i.e., the data being sent as part of the b>API request/b>), then encoding the resulting hash value in                hexadecimal format, and then signing the hex value using the b>shared secret key/b>.br/>The resulting                value is included in the b>API request/b> as the value for the b>X-HMAC-SIGNATURE header/b>.            /p>        /div>    /details>/div>div classexpandable>    details>        summary classexpandable-title>            span classicon>▸/span>Uses of X-HMAC-SIGNATURE        /summary>        div idexpandable-content classexpandable-content>            p>                b>X-HMAC-SIGNATURES/b> are a security measure, they provide an extra layer of security beyond standard                encryption and help verify that the data sent between the parties has not been tampered with./p>                p>An HMAC (Hash-based Message Authentication Code) is a cryptographic function that uses a secret key                to generate a unique code for a message that can be verified by the receiving party. b>X-HMAC-SIGNATURES/b> are                used to generate and verify these codes The sending party calculates the HMAC code for the message using                a secret key, and sends it along with the message. The receiving party can then calculate the HMAC code for                the received message using the same secret key, and compare it to the code sent by the sender. If the codes                match, the message is considered authentic and unmodified.            /p>        /div>    /details>/div>div classexpandable>    details>        summary classexpandable-title>            span classicon>▸/span>Definition of webhook listeners        /summary>        div idexpandable-content classexpandable-content>            p>                A b>webhook listener/b> is an b>endpoint/b> in a web application or service that waits for and receives                HTTP requests from other web applications or services. It is a web server that listens for incoming                HTTP requests sent by other applications when certain events occur./p>                p>When an event occurs in the source application, it sends a POST request to the b>webhook listener                endpoint/b>, containing information about the event. The b>webhook listener/b> then parses the request,                extracts the relevant data, and takes appropriate actions based on the content of the message.                These actions are specific to the application or service.            /p>        /div>    /details>/div>div classexpandable>    details>        summary classexpandable-title>            span classicon>▸/span>X-HMAC-SIGNATURE and webhook listeners        /summary>        div idexpandable-content classexpandable-content>            p>                b>Webhook listeners/b> and b>X-HMAC-SIGNATURES/b> are often used together to provide secure                communication between two web applications or services./p>                p>When a b>webhook listener/b> receives an incoming HTTP request from a source application, the request                typically includes an b>X-HMAC-SIGNATURE header/b>, which is a hex-encoded hashed value of the                request payload that has been signed using a secret key known to both the source application                and the b>webhook listener/b>.            /p>            p>                The b>webhook listener/b> then uses the same secret key to generate its own hash of the request payload                and compares it to the hash included in the b>X-HMAC-SIGNATURE header/b>. If the two hashes match,                the b>webhook listener/b> knows that the request has not been tampered with during transit and that                it originated from the expected source application.            /p>        /div>    /details>/div>div classexpandable>    details>        summary classexpandable-title>            span classicon>▸/span>How to secure your webhook listener        /summary>        div idexpandable-content classexpandable-content>            p>There are three ways to secure the webhook listener:/p>                ul>                    li>                        Have a secure TLS server for your b>webhook listener/b> (Veriff will call only HTTPS URLs                        which are hosted by servers with a publicly verifiable certificate)                    /li>                    li>                        Verify the b>X-AUTH-CLIENT/b> and b>X-HMAC-SIGNATURE headers/b> on the received                        b>webhooks/b> (the signature is calculated using the shared secret key that only you and Veriff know)                    /li>                    li>                        Whitelist the Veriff IP range for b>webhook listeners/b> (ask your solutions engineer for info)                    /li>                /ul>        /div>    /details>/div>h2 idsessions-lifecycle-diagram-api>Sessions lifecycle diagram (API)/h2>p>img srcimages/API_sessions_lifecycle_diagram2.png altAPI sessions lifecycle diagram />/p>h1 idwebhooks>Webhooks/h1>p>To handle the response from Veriff services, you need to implement an endpoint that accepts payloads postedby our services./p>aside classnotice>Only b>HTTPS URLs are allowed/b>./aside>aside classnotice>Veriff b>does not allow custom ports/b> to be added to the webhook URLs./aside>aside classnotice>Make sure to check out the a href/#backwards-compatible-changes>Backwards compatible changes/a>section and ensure that your systems can handle these changes./aside>h4 idwebhook-delivery-receipt-and-resending>Webhook delivery, receipt and resending/h4>p>b>Delivery order/b>: to follow the best practices, b>we do not guarantee that the webhooks are deliveredin the order in which they are generated/b>. Therefore, you should not expect to receive them in that order either,and should implement a logic to handle this accordingly./p>p>b>Delivery approach/b>: we guarantee the b>delivery of webhook at-least-once/b>. The receiving API should be idempotent./p>p>After sending the webhook, our systems expect a confirmation about receiving the webhook from your side.This strong>confirmation from your server should come within 5,000 ms/strong>, and we expect it to be in the form of asuccessful HTTP response code (a 200 code). /p>p>If the confirmation does not arrive within that timeframe, for example there is a network connectivity issueor technical issue with delivering the notification (any non-200 response code), strong>we will try to resend the failedwebhook for up to a week/strong>./p>h2 idconfiguring-the-webhook-endpoint>Configuring the webhook endpoint/h2>ol>li>Go to strong>the Veriff environment/strong>/li>li>Click on the strong>Integrations/strong> on the top menu/li>li>Find and open the relevant integration/li>li>Navigate to the  strong>Settings/strong> tab on the integration's page/li>li>Fill in the webhook URL input field with the URL where your endpoint is accepting payloads from Veriff/li>/ol>p>There are a href#different-webhook-types>several types of webhooks/a>. Veriff will post payloads to respective webhook URLs./p>p>Note that the strong>image below/strong> does strong>not contain all the possible webhook URLs/strong>. The list available depends on your integration./p>p>img srcimages/configure_webhooks_in_Vff_environment.png alt />/p>h4 idrecognizing-your-end-user>Recognizing your end-user/h4>p>When your server receives a payload from Veriff, you need to be able to reference an end-user. You can do this by usingthe Veriff strong>session ID/strong> or by using your own end-user ID./p>h5 idusing-the-veriff-session-id>Using the Veriff session ID/h5>p>The easiest way is to track the strong>session ID/strong> provided by Veriff during session creation.Some webhooks payloads refer to either strong>session ID/strong> or strong>attempt ID/strong> or both. Please see the specific webhook payloadfor exact info./p>h5 idusing-your-own-end-user-id>Using your own end-user ID/h5>p>To use your own end-user ID you need to provide your internal end-user ID to Veriff, or some other key that uniquelyidentifies your end-user. You can store your identifier in the code>vendorData/code> or code>endUserID/code> property duringthe a href/#post-sessions>session creation/a>./p>p>Note: it is technically possible for one end-user to be associated with multiple verification sessions,and this could potentially create ambiguous situations in code if you are only recognizing end-users by yourown identifier, and not Veriff's strong>session ID/strong>./p>h2 idhandling-security>Handling security/h2>p>It is important to check that the webhook responses do indeed originate from Veriff. For that we use the X-HMAC-SIGNATURE header,which value is an HMAC-SHA256 hex encoded keyed hash using your API private key./p>aside classnotice>Read more about how to secure your communication between Veriff and your service in the a href#api-requests-signing-with-x-hmac-signature>X-HMAC-SIGNATURE/a> section./aside>h2 iddifferent-webhook-types>Different webhook types/h2>p>There are several webhook types to help you to tailor your service specifically to your needs./p>ul>li>code>Webhook decisions URL/code> is where we post strong>decisions about verifications/strong> (approved, declined, resubmission_required, expired, abandoned, review), a href/#decision-webhook>see the sample payload/a>/li>li>code>Webhook events URL/code> is where we post strong>events/strong> during the lifecycle of a verification (started, submitted), a href/#verification-events>see the sample payload/a>/li>li>code>Webhook Full Auto URL/code> is where we post data related to the strong>Full Auto/strong> verification. For more detailed info, seea hrefhttps://help.veriff.com/en/articles/8523724-full-auto-webhook-properties>explaination of the webhook properties ↗/a>and a hrefhttps://help.veriff.com/en/articles/8529223-full-auto-webhook-sample>sample webhook ↗/a> (both links require alogin to strong>the Veriff environment/strong>)/li>li>code>Webhook watchlist screening URL/code> is where we post events related to both the initial and monitored resultsof the strong>PEP, sanctions, and adverse media checks/strong>, a href#watchlist-screening-webhook>see the example payload/a>/li>li>code>Webhook INE registry URL/code> is where we post data related to the strong>INE registry/strong> check after the check is completed/li>li>code>Webhook CURP registry URL/code> is where we post data related to the strong>CURP registry/strong> check after the check is completed/li>li>code>Webhook combined INE CURP registry URL/code> is where we post data related to the combined strong>INE and CURP registries/strong>check after the check is completed/li>li>code>Webhook URL for sessions statuses set in Station/code> is where we post data when a strong>user has added a status to an attempt/strong>in strong>the Veriff environment/strong>/li>/ul>h2 iddecision-webhook>Decision webhook/h2>p>This is the description of the payload sent to code>Webhook decisions URL/code>.br/>The result of the verification is sent back to the customer once the verification has been processed./p>p>In most cases we send a decision webhook instantly after a decision is made, with an exception to "resubmission_requested" status.In case resubmission is required, we allow the end-user to resubmit session data instantly without a need to exit the flow.If the end-user does not do it within 5 minutes, we will send out a webhook with the code>resubmission_requested/code> decision./p>p>strong>Driver's license categories extraction/strong>: to extract the code>validFrom/code> and code>validUntil/code> dates from a driver's license,please communicate with your solutions engineer to activate the feature./p>aside classnotice>The code>Webhook decisions URL/code> needs to be specified in Veriff Station./aside>p>strong>Request properties explained:/strong>/p>ul>li>code>status/code>: code>string/code> Status of the response/li>li>code>verification/code>: code>object/code> Verification request decision object. Null if decision is not available yetul>li>code>id/code>: code>string/code> UUID v4 which identifies the verification session/li>li>code>vendorData/code>: code>string | null/code> End-user-specific string created by the customer to identify the end-user. We requireonly non-semantic data to be submitted (UUID-s etc., that can not be resolved or used outside your environment)/li>li>code>endUserId/code>: code>UUID v4 | null/code> End-user-specific UUID v4 created by the customer to identify the end-user. Returnedunmodified in webhooks and public API calls, or as code>null/code> if not specified/li>li>code>status/code>: code>string/code> (one of approved, resubmission_requested, review, declined, expired, abandoned) Verification status/li>li>code>code/code>: code>integer/code> (one of 9001, 9102, 9103, 9104, 9121)Verification session decision code. a href#verification-session-status-and-decision-codes>More information about verification session decision code/a>./li>li>code>reason/code>: code>string | null/code> Reason of failed Verification/li>li>code>reasonCode/code>: code>integer | null/code> Reason code of failed Verification a href#reference-info-codes-tables>See Response and error codes/a>/li>li>code>decisionTime/code>: code>string/code> Timestamp of the decision. Combined ISO 8601 date and time in UTC YYYY-MM-DDTHH:MM:SS.SSS+Timezone Offset/li>li>code>acceptanceTime/code>: code>string/code> Timestamp of the session generation. Combined ISO 8601 date and time in UTC YYYY-MM-DDTHH:MM:SS.SSS+Timezone Offset/li>li>code>person/code>: code>object/code> Verified personul>li>code>firstName/code>: code>string | null/code> Person's first name as written on the document, if present/li>li>code>lastName/code>: code>string | null/code> Person's last name as written on the document, if present/li>li>code>dateOfBirth/code>: code>string/code> (YYYY-MM-DD) Date of birth/li>li>code>gender/code>: code>string | null/code> (M, F or Null) Gender/li>li>code>nationality/code>: code>string | null/code> Nationality/li>li>code>idNumber/code>: code>string | null/code> National identification number/li>li>code>yearOfBirth/code>: code>string | null/code> (YYYY) Year of birth/li>li>code>placeOfBirth/code>: code>string | null/code> Place of birth/li>li>code>citizenship/code>: code>(Deprecated)/code> code>null/code>/li>li>code>addresses/code>: code>array/code> Optional, depending on integration.ul>li>code>fullAddress/code>: code>string | null/code> Address as single string./li>li>code>parsedAddress/code>: code>object/code> Object with parsed code>fullAddress/code>. Optional, depending on integration.ul>li>code>country/code>: code>string | null/code>/li>li>code>state/code>: code>string | null/code>/li>li>code>city/code>: code>string | null/code>/li>li>code>postcode/code>: code>string | null/code>/li>li>code>street/code>: code>string | null/code>/li>li>code>houseNumber/code>: code>string | null/code>/li>li>code>unit/code>: code>string | null/code> Apartment number/li>/ul>/li>/ul>/li>li>code>fullName/code>: code>string | null/code> Full name of the person. Optional, depending on the integration (only for IndianAadhaar cards registry based verification)/li>li>code>occupation/code>: code>string/code> Occupation data from the document. Optional, depending on integration./li>li>code>employer/code>: code>string/code> Employer's name from the document. Optional, depending on integration./li>li>code>foreginerStatus/code>: code>string/code> Foreigner status field from the document. Optional, depending on integration./li>li>code>extraNames/code>: code>string/code> Additional name from the document. Optional, depending on integration./li>li>code>ifeIdentifier/code>: code>string | null/code> The voter's card identifier (OCR). Optional, depending on integration./li>li>code>ineIdentifier/code>: code>string | null/code> The citizen's identifier (Identificador del Ciudadano). Optional, depending on integration/li>li>code>pepSanctionMatch/code>: code>string | null/code> PEP check result. Optional, depending on integration./li>/ul>/li>li>code>document/code>: code>object/code> Verified documentul>li>code>number/code>: code>string | null/code> Document number, a-zA-Z0-9 characters only/li>li>code>validUntil/code>: code>string | null/code> Document is valid until date/li>li>code>validFrom/code>: code>string | null/code> Document is valid from date/li>li>code>type/code>: code>string | null/code> (one of PASSPORT, ID_CARD, RESIDENCE_PERMIT, DRIVERS_LICENSE, VISA, OTHER) Document type. See the a href#supported-document-types-for-idv>IDV document types here/a>/li>li>code>country/code>: code>string | null/code> Document issuing country, as ISO 3166 alpha-2 code/li>li>code>remarks/code>: code>string/code> Data extracted from the document's remarks field/li>li>code>state/code>: code>string | null/code> Document issuing state, as ISO 3166 alpha-2 or alpha-3 code. code>null/code> when the state data is not present on the document/li>li>code>placeOfIssue/code>: code>string | null/code> Place where document was issued. Optional, depending on integration./li>li>code>firstIssue/code>: code>string | null/code> Date of document first issue in YYYY-MM-DD format. Optional, depending on integration./li>li>code>issueNumber/code>: code>string | null/code> Document issue number. Optional, depending on integration./li>li>code>issuedBy/code>: code>string | null/code> Document issuing authority. Optional, depending on integration./li>li>code>nfcValidated/code>: code>boolean/code> Biometric document data has been successfully decoded. Optional, depending on integration./li>li>code>residencePermitType/code>: code>string/code> Type of the residence permit from the document. Optional, depending on the integration./li>li>code>portraitIsVisible/code>: code>boolean/code> Indicates that the portrait image is visible in the session and its quality issufficient to perform verification. Optional, depending on the integration./li>li>code>signatureIsVisible/code>: code>boolean/code> Indicates that the signature is present on the document and readable to performthe verification. Optional, depending on the integration./li>/ul>/li>li>code>additionalVerifiedData/code>: code>object/code> Data which has been optionally verified for session.ul>li>code>driversLicenseNumber/code>: code>string/code> Number of the driver's license. Optional, depending on integration./li>li>code>driversLicenseCategory/code>: code>object/code> Optional, depending on integration.ul>li>code>B/code>: code>Boolean | null/code>/li>/ul>/li>li>code>driversLicenseCategoryFrom/code>: code>object/code> Date when the driving license category was obtained. Optional, depending on integration.ul>li>code>B/code>: code>string | null/code> Category is valid from date in YYYY-MM-DD format/li>/ul>/li>li>code>driversLicenseCategoryUntil/code>: code>object/code> Driving license category expiry date. Optional, depending on integration.ul>li>code>B/code>: code>string | null/code> Category is valid until date in YYYY-MM-DD format/li>/ul>/li>li>code>estimatedAge/code>: code>number/code> Estimated age. Optional, depending on integration./li>li>code>estimatedGender/code>: code>number/code> Estimated gender. Optional, depending on integration. Values closer to 0.0 indicate 'male', values closer to 1.0 indicate 'female'/li>li>code>UKTFCheckResult/code>: code>array/code> Array of UK DIATF checks results. Optional, depending on the integrationul>li>code>CIFAS/code>: code>string/code> CIFAS registry check result/li>li>code>Electoral roll and Credit History UK/code>: code>string/code> UK Electoral roll and credit history check result/li>li>code>PEP/code>: code>string/code> PEP check result/li>/ul>/li>li>code>cpfValidation/code>: code>object | null/code> Brazilian individual taxpayer registry (CPF) validation check object. Optional, depending on integrationul>li>code>status/code>:  code>string | null/code> Status of the entry in the registry (one of CPF is validated, CPF is suspended, CPF holder is deceased, CPF ispending regularization, CPF is cancelled em>(was a duplicate)/em>, Cancelled craft em>(meaning that it was cancelleddue to reasons other than being a duplicate)/em>)/li>li>code>cpfNumber/code>: code>string | null/code> Brazilian individual taxpayer registry (CPF) number of the person/li>li>code>name/code>: code>string | null/code> Person's name in the CPF/li>li>code>dateOfBirth/code>: code>string | null/code> Person's date of birth in the CPF as YYYY-MM-DD/li>li>code>yearOfDeath/code>: code>string | null/code> Person's year of death in the CPF as YYYY/li>/ul>/li>li>code>processNumber/code>: code>string/code> Process number (e.g., "Trámite №") from the document. Optional, depending on integration./li>li>code>ineBiometricRegistryValidation/code>: code>object/code> INE Biometric Database Verification check object. Optional, availableonly when the INE Biometric Validation check has been enabled for the integrationul>li>code>faceMatch/code>: code>boolean | null/code> Indicates if the person's selfie image is a match with their image in theregistry. This decision is made based on the value returned in code>faceMatchPercentage/code> (see below). code>null/code>if the check could not be completed/li>li>code>faceMatchPercentage/code>: code>integer | null/code> Indicates the level of similarity the system thinks the matched images have,in the range of 0-100. Values ≥85 indicate a match; values <85 indicate that images do not match. code>null/code> if the check could not be completed/li>li>code>responseStatus/code>: code>string | null/code> Indicates the response received from the service provider. One of code>success/code>or code>failure/code>; or code>null/code> if the check could not be completed/li>/ul>/li>li>code>proofOfAddress/code>: code>object/code> Proof of address data. Optional, depending on integration.ul>li>code>nameMatch/code>: code>boolean/code> Indicates if the name on the proof of address document matches the name from the initial request data. code>null/code> if the check could not be completed./li>li>code>nameMatchPercentage/code>: code>float/code> Indicates the level of similarity the matched names have, in the range of 0.00-100.00. code>null/code> if the check could not be completed./li>/ul>/li>/ul>/li>li>code>biometricAuthentication/code>: code>object/code> Object containing data about the biometric authentication. Optional, availableonly when using the Biometric Authentication solutionul>li>code>matchedSessionId/code>: code>string | null/code> Refers to the verification session ID which the face matched/li>li>code>matchedSessionEndUserId/code>: code>string |  null/code> Refers to the verification session code>endUserId/code>which the face matched/li>li>code>matchedSessionVendorData/code>: code>string | null/code> Refers to the verification session code>vendorData/code> which the face matched/li>li>code>details/code>: code>object/code> Lists the results of different checks that were made to verify the end-user. If you havebeen granted access to the Veriff environment, you can find these in the a hrefhttps://help.veriff.com/en/articles/9638913-biometric-authentication-results-in-decision-webhook>detailed request explanation/a>↗./li>/ul>/li>li> code>riskScore/code>: code>object/code> Data about the risk scoreul>li>code>score/code>: code>number/code> A float in the range of 0.0–1.0. Numerical value representing the overall risk associated with thesession. Lower score indicates more confidence in that the session is genuine. Note: in the strong>Veriff environment/strong>,the range is shown as 1–100./li>/ul>/li>li>code>riskLabels/code>: code>array/code> Optional array of risk labels related to the session. The presence of this property depends on risk labels being enabled for the integration. a hrefhttps://help.veriff.com/en/articles/3410712-risk-labels-and-crosslinks>Full list of risk labels (requires login to Veriff environment)/a> ↗ul>li>code>label/code>: code>string/code> Name of the risk label/li>li>code>category/code>: code>string/code> (one of client_data_mismatch, crosslinks, device, document, images, network, session, person)/li>li>code>sessionIds/code>: code>array/code> Array of verification IDs that are referenced to the particular risk label./li>/ul>/li>li>em>code>comments/code>: code>array/code> (Deprecated)/em>/li>li>em>code>highRisk/code>: code>boolean/code> (Deprecated) If session is considered high risk or not. Optional, depending on integration./em>/li>/ul>/li>li>code>technicalData/code>: code>object/code> Technical data objectul>li>code>ip/code>: code>string | null/code> IP of the device from which the verification was made/li>/ul>/li>/ul>p>strong>Sample request/strong>/p>pre classhighlight json tab-json>code>span classw>  /span>span classp>{/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>    /span>span classs2>verification/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>12df6045-3846-3e45-946a-14fa6136d78b/span>span classp>,/span>span classw>              /span>span classs2>vendorData/span>span classp>:/span>span classw> /span>span classs2>12345678/span>span classp>,/span>span classw>        /span>span classs2>endUserId/span>span classp>:/span>span classw> /span>span classs2>a1b2c35d-e8f7-6d5e-3cd2-a1b2c35db3d4/span>span classp>,/span>span classw>        /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>approved/span>span classp>,/span>span classw>        /span>span classs2>code/span>span classp>:/span>span classw> /span>span classmi>9001/span>span classp>,/span>span classw>        /span>span classs2>reason/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>        /span>span classs2>reasonCode/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>        /span>span classs2>decisionTime/span>span classp>:/span>span classw> /span>span classs2>2019-11-06T07:18:36.916Z/span>span classp>,/span>span classw>        /span>span classs2>acceptanceTime/span>span classp>:/span>span classw> /span>span classs2>2019-11-06T07:15:27.000Z/span>span classp>,/span>span classw>        /span>span classs2>person/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>firstName/span>span classp>:/span>span classw> /span>span classs2>SARAH/span>span classp>,/span>span classw>            /span>span classs2>lastName/span>span classp>:/span>span classw> /span>span classs2>MORGAN/span>span classp>,/span>span classw>            /span>span classs2>dateOfBirth/span>span classp>:/span>span classw> /span>span classs2>1967-03-30/span>span classp>,/span>span classw>            /span>span classs2>gender/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>nationality/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>idNumber/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>yearOfBirth/span>span classp>:/span>span classw> /span>span classs2>1967/span>span classp>,/span>span classw>            /span>span classs2>placeOfBirth/span>span classp>:/span>span classw> /span>span classs2>MADRID/span>span classp>,/span>span classw>            /span>span classs2>citizenship/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>addresses/span>span classp>:/span>span classw> /span>span classp>/span>span classw>              /span>span classp>{/span>span classw>                /span>span classs2>fullAddress/span>span classp>:/span>span classw> /span>span classs2>1234 Snowy Ridge Road, Indiana, 56789 USA/span>span classp>,/span>span classw>                /span>span classs2>parsedAddress/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                    /span>span classs2>city/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>                    /span>span classs2>unit/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>                    /span>span classs2>state/span>span classp>:/span>span classw> /span>span classs2>Indiana/span>span classp>,/span>span classw>                    /span>span classs2>street/span>span classp>:/span>span classw> /span>span classs2>1234 Snowy Ridge Road/span>span classp>,/span>span classw>                    /span>span classs2>country/span>span classp>:/span>span classw> /span>span classs2>USA/span>span classp>,/span>span classw>                    /span>span classs2>postcode/span>span classp>:/span>span classw> /span>span classs2>56789/span>span classp>,/span>span classw>                    /span>span classs2>houseNumber/span>span classp>:/span>span classw> /span>span classs2>null/span>span classw>                /span>span classp>}/span>span classw>              /span>span classp>}/span>span classw>            /span>span classp>,/span>span classw>            /span>span classs2>fullName/span>span classp>:/span>span classw> /span>span classs2>SARAH MORGAN/span>span classp>,/span>span classw>            /span>span classs2>occupation/span>span classp>:/span>span classw> /span>span classs2>Engineer/span>span classp>,/span>span classw>            /span>span classs2>employer/span>span classp>:/span>span classw> /span>span classs2>Any Company LLC/span>span classp>,/span>span classw>            /span>span classs2>foreignerStatus/span>span classp>:/span>span classw> /span>span classs2>EXTRANJERO/span>span classp>,/span>span classw>            /span>span classs2>extraNames/span>span classp>:/span>span classw> /span>span classs2>NOM DUSAGE/span>span classp>,/span>span classw>            /span>span classs2>pepSanctionMatch/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>        /span>span classp>},/span>span classw>        /span>span classs2>document/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>number/span>span classp>:/span>span classw> /span>span classs2>MORGA753116SM9IJ/span>span classp>,/span>span classw>            /span>span classs2>validFrom/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>validUntil/span>span classp>:/span>span classw> /span>span classs2>2022-04-20/span>span classp>,/span>span classw>            /span>span classs2>type/span>span classp>:/span>span classw> /span>span classs2>DRIVERS_LICENSE/span>span classp>,/span>span classw>            /span>span classs2>country/span>span classp>:/span>span classw> /span>span classs2>US/span>span classp>,/span>span classw>            /span>span classs2>remarks/span>span classp>:/span>span classw> /span>span classs2>WORK PERMITTED/span>span classp>,/span>span classw>            /span>span classs2>state/span>span classp>:/span>span classw> /span>span classs2>NY/span>span classp>,/span>span classw>            /span>span classs2>placeOfIssue/span>span classp>:/span>span classw> /span>span classs2>NEW YORK/span>span classp>,/span>span classw>            /span>span classs2>firstIssue/span>span classp>:/span>span classw> /span>span classs2>2015-03-21/span>span classp>,/span>span classw>            /span>span classs2>issueNumber/span>span classp>:/span>span classw> /span>span classs2>01/span>span classp>,/span>span classw>            /span>span classs2>issuedBy/span>span classp>:/span>span classw> /span>span classs2>ISSUER/span>span classp>,/span>span classw>            /span>span classs2>nfcValidated/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw>            /span>span classs2>residencePermitType/span>span classp>:/span>span classw> /span>span classs2>C/span>span classp>,/span>span classw>            /span>span classs2>portraitIsVisible/span>span classp>:/span>span classw> /span>span classs2>true/span>span classp>,/span>span classw>            /span>span classs2>signatureIsVisible/span>span classp>:/span>span classw> /span>span classs2>true/span>span classw>            /span>span classp>}/span>span classw>        /span>span classp>},/span>span classw>        /span>span classs2>additionalVerifiedData/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>driversLicenseNumber/span>span classp>:/span>span classw> /span>span classs2>1234569/span>span classp>,/span>span classw>              /span>span classs2>driversLicenseCategory/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                /span>span classs2>B/span>span classp>:/span>span classw> /span>span classkc>true/span>span classw>            /span>span classp>},/span>span classw>            /span>span classs2>driversLicenseCategoryFrom/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                /span>span classs2>B/span>span classp>:/span>span classw> /span>span classs2>2019-10-06/span>span classw>            /span>span classp>},/span>span classw>            /span>span classs2>driversLicenseCategoryUntil/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                /span>span classs2>B/span>span classp>:/span>span classw> /span>span classs2>2025-10-05/span>span classw>            /span>span classp>},/span>span classw>            /span>span classs2>estimatedAge/span>span classp>:/span>span classw> /span>span classmi>32/span>span classp>,/span>span classw>            /span>span classs2>estimatedGender/span>span classp>:/span>span classw> /span>span classmf>0.613/span>span classp>,/span>span classw>            /span>span classs2>processNumber/span>span classp>:/span>span classw> /span>span classs2>12345678912 1234/span>span classp>,/span>span classw>                    /span>span classs2>cpfValidation/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>CPF is validated/span>span classp>,/span>span classw>                /span>span classs2>cpfNumber/span>span classp>:/span>span classw> /span>span classs2>123456789/span>span classp>,/span>span classw>                /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>SARAH MORGAN/span>span classp>,/span>span classw>                /span>span classs2>dateOfBirth/span>span classp>:/span>span classw> /span>span classs2>1967-03-30/span>span classp>,/span>span classw>                /span>span classs2>yearOfDeath/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>            /span>span classp>},/span>span classw>            /span>span classs2>ineBiometricRegistryValidation/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                /span>span classs2>faceMatch/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw>                /span>span classs2>faceMatchPercentage/span>span classp>:/span>span classw> /span>span classmi>89/span>span classp>,/span>span classw>                /span>span classs2>responseStatus/span>span classp>:/span>span classw> /span>span classs2>success/span>span classw>            /span>span classp>},/span>span classw>            /span>span classs2>proofOfAddress/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                /span>span classs2>nameMatch/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw>                /span>span classs2>nameMatchPercentage/span>span classp>:/span>span classw> /span>span classmf>100.00/span>span classw>            /span>span classp>},/span>span classw>        /span>span classp>},/span>span classw>        /span>span classs2>riskScore/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>score/span>span classp>:/span>span classw> /span>span classmf>0.12/span>span classw>        /span>span classp>},/span>span classw>        /span>span classs2>riskLabels/span>span classp>:/span>span classw> /span>span classp>/span>span classw>        /span>span classp>{/span>span classw>            /span>span classs2>label/span>span classp>:/span>span classw> /span>span classs2>document_integration_level_crosslinked_with_fraud/span>span classp>,/span>span classw>            /span>span classs2>category/span>span classp>:/span>span classw> /span>span classs2>document/span>span classp>,/span>span classw>            /span>span classs2>sessionIds/span>span classp>:/span>span classw> /span>span classp>/span>span classs2>5a2358e7-fd31-4fcb-a23f-4d76651ba68a/span>span classp>/span>span classw>        /span>span classp>},/span>span classw>        /span>span classp>{/span>span classw>            /span>span classs2>label/span>span classp>:/span>span classw> /span>span classs2>document_integration_level_crosslinked_with_multiple_declines/span>span classp>,/span>span classw>            /span>span classs2>category/span>span classp>:/span>span classw> /span>span classs2>document/span>span classp>,/span>span classw>            /span>span classs2>sessionIds/span>span classp>:/span>span classw> /span>span classp>/span>span classs2>fd5c1563-1d23-4b1a-ae46-7ba429927ed8/span>span classp>/span>span classw>        /span>span classp>},/span>span classw>        /span>span classs2>biometricAuthentication/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>matchedSessionId/span>span classp>:/span>span classw> /span>span classs2>d40edb60-6ae6-.../span>span classp>,/span>span classw>            /span>span classs2>matchedSessionEndUserId/span>span classp>:/span>span classw> /span>span classs2>a1b2c35d-e8f7-6d5e-3cd2-a1b2c35db3d4/span>span classp>,/span>span classw>            /span>span classs2>matchedSessionVendorData/span>span classp>:/span>span classw> /span>span classs2>12345678/span>span classp>,/span>span classw>            /span>span classs2>details/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                  /span>span classerr>.../span>span classw>            /span>span classp>}/span>span classw>        /span>span classp>},/span>span classw>        /span>span classs2>comments/span>span classp>:/span>span classw> /span>span classp>/span>span classw>    /span>span classp>},/span>span classw>    /span>span classs2>technicalData/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classs2>ip/span>span classp>:/span>span classw> /span>span classs2>186.153.67.122/span>span classw>    /span>span classp>}/span>span classw>  /span>span classp>}/span>span classw>/span>/code>/pre>h2 idevent-webhook>Event webhook/h2>p>This is the description of the payload sent to code>Webhook events URL/code>. It tracks the events happening in the identityverification process as the end-user is passing through it./p>aside classnotice>The code>Webhook events URL/code> needs to be specified in b>the Veriff environment/b>. The b>event webhook/b> informs about the b>progress of the verification data gathering/b> and b>not about the decision/b>./aside>h3 idpossible-events-over-the-webhook>Possible events over the webhook/h3>table>thead>tr>th>Webhook code/th>th>Webhook action/th>th>Description/th>th>Available/th>th>Configuration to receive events/th>th>"Waiting for decision" page enabled/th>/tr>/thead>tbody>tr>td>7001/td>td>started/td>td>The end-user arrives to Veriff verification flow and strong>starts/strong> the verification process/td>td>via API and SDK/td>td>Not needed/td>td>Not needed/td>/tr>tr>td>7002/td>td>submitted/td>td>The end-user is done with the process and strong>submits/strong> the attempt/td>td>via API and SDK/td>td>Not needed/td>td>Not needed/td>/tr>tr>td>7007/td>td>waiting_complete/td>td>The end-user strong>gets the decision/strong> on the "waiting for decision" page/td>td>Web only/td>td>Yes, required/td>td>Yes, required/td>/tr>tr>td>7008/td>td>waiting_continued/td>td>The end-user strong>clicks/strong> on the strong>Continue/strong> button on the "waiting for decision" page strong>before the decision is available/strong>. This triggers the action that you have configured for the case when the end-user finishes the flow./td>td>Web only/td>td>Yes, required/td>td>Yes, required/td>/tr>tr>td>7009/td>td>flow_finished/td>td>The end-user reached the final screen and strong>clicked/strong> on the strong>Continue/strong> button/td>td>Web only/td>td>Yes, required/td>td>Not needed/td>/tr>tr>td>7010/td>td>flow_cancelled/td>td>The end-user strong>abandons the verification/strong> flow by clicking on the strong>X/strong> in the UI and confirming the cancelling/td>td>Web only/td>td>Yes, required/td>td>Not needed/td>/tr>/tbody>/table>p>As shown in the table above, strong>7007-7010 events/strong> can be received only when you are using Veriff's web flow, andthese require some additional configuration on Veriff side./br>Contact your strong>Solutions Engineer/strong> for info and configuration./p>p>There are also events which we do not notify about. See this a hrefhttps://help.veriff.com/en/articles/3250231-meanings-of-various-verification-statuses-and-decisions>strong>Knowledge Base/strong> article/a>↗ for more info (requires a login to strong>the Veriff environment/strong>)./p>h3 idevent-webhook-payload>Event webhook payload/h3>p>strong>Request properties explained:/strong>/p>ul>li>code>id/code>: code>string/code> (required) UUID v4 which identifies the verification session/li>li>code>attemptId/code>: code>string/code> (required) UUID v4 which identifies session attempt/li>li>code>feature/code>: code>string/code> (required) Feature on which the event was triggered ("selfid" refers to the end-user flow)/li>li>code>code/code>: code>integer/code> (required) Event code (one of 7001, 7002)/li>li>code>action/code>: code>string/code> (required) Corresponding action description (one of started, submitted)/li>li>code>vendorData/code>: code>string| null/code> End-user-specific data string, max 1000 characters long, created by the customer. Sentback unmodified via API responses and webhooks, or as null if not provided/li>li>code>endUserId/code>: code>UUID v4 | null/code> End-user-specific UUID v4 created by the customer to identify the end-user. Returnedunmodified in webhooks and public API calls, or as code>null/code> if not specified/li>/ul>p>strong>Sample request/strong>/p>pre classhighlight json tab-json>code>span classp>{/span>span classw>  /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>f04bdb47-d3be-4b28-b028-a652feb060b5/span>span classp>,/span>span classw>  /span>span classs2>attemptId/span>span classp>:/span>span classw> /span>span classs2>e30122d1-740b-4764-853f-470374a7abf4/span>span classp>,/span>span classw>  /span>span classs2>feature/span>span classp>:/span>span classw> /span>span classs2>selfid/span>span classp>,/span>span classw>  /span>span classs2>code/span>span classp>:/span>span classw> /span>span classmi>7002/span>span classp>,/span>span classw>  /span>span classs2>action/span>span classp>:/span>span classw> /span>span classs2>submitted/span>span classp>,/span>span classw>  /span>span classs2>vendorData/span>span classp>:/span>span classw> /span>span classs2>QWE123/span>span classp>,/span>span classw>  /span>span classs2>endUserId/span>span classp>:/span>span classw> /span>span classs2>a1b2c35d-e8f7-6d5e-3cd2-a1b2c35db3d4/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h2 idwatchlist-screening-webhook>Watchlist screening webhook/h2>p>This is the description of the payload sent to code>Webhook watchlist screening URL/code>.br/> Only available for customersusing the a href#aml-screening>Veriff PEP and Sanctions services/a>./p>p>Depending on the types of solutions that have been enabled for your integration, different types of webhooks are usedto return the data./p>h4 idpep-amp-sanction-screening-with-idv-checks>PEP & Sanction screening with IDV checks/h4>ul>li>The strong>PEP and Sanctions/strong> checks are returned using the strong>decision webhook/strong>/li>li>If strong>optional adverse media checks/strong> are enabled, the checks are returned using the strong>watchlist-screening webhook/strong>/li>li>If strong>optional ongoing monitoring/strong> is enabled, a strong>second watchlist screening webhook/strong> is sent when the OGM checkcomes in verifying that he intial PEP and Sanctions result changed. This happens independently of the decision(or event) webhook/li>/ul>h4 idpep-amp-sanction-screening-without-idv-including-optional-adverse-media-and-ongoing-monitoring-checks>PEP & Sanction screening without IDV (including optional adverse media and ongoing monitoring checks)/h4>p>Results of strong>all the checks/strong> are returned strong>via watchlist-screening webhook/strong>. Decision webhook is not used to passthe checks' info./p>p>/br>/p>aside classnotice>The Webhook watchlist screening URL needs to be specified in Veriff Station./aside>p>strong>Request properties explained:/strong>/p>ul>li>code>checkType/code>: code>updated_result/code> (one of initial_result, updated_result)/li>li>code>attemptId/code>: code>string/code> UUID v4 which identifies session attempt/li>li>code>sessionId/code>: code>string/code> UUID v4 which identifies session/li>li>code>vendorData/code>: code>string | null/code> End-user-specific data string, max 1000 characters long, created by the customer.Sent back unmodified via API responses and webhooks, or as code>null/code> if not provided/li>li>code>endUserId/code>: code>UUID v4 | null/code> End-user-specific UUID v4 created by the customer to identify the end-user. Returnedunmodified in webhooks and public API calls, or as code>null/code> if not specified/li>li>code>matchStatus/code>: code>string/code> (one of possible_match, no_match)/li>li>code>searchTerm/code>: code>object/code> Data used to perform the checkul>li>code>name/code>: code>string/code> Full name used during the check/li>li>code>year/code>: code>string/code> Birth year used during the check/li>/ul>/li>li>code>totalHits/code>: code>integer/code> total number of hits returned from the check/li>li>code>createdAt/code>: code>string/code> Timestamp indicating when the check response was received/li>li>code>hits/code>: code>array/code> Check response hits array of matched records. Empty array if no hits were not foundul>li>code>matchedName/code>: code>string/code> The name that was matched in this hit based on the search term/li>li>code>countries/code>: code>array/code> List of countries that sources listed in relation to this hit/li>li>code>dateOfBirth/code>: code>string/code> Birth date of the person in the matched listings/li>li>code>dateOfDeath/code>: code>string/code> Death date of the person in the matched listings/li>li>code>matchTypes/code>: code>array/code> Array that shows the match type in the listings/li>li>code>aka/code>: code>array/code> Array of names that the matched person is also known as/li>li>code>associates/code>: code>array/code> Array of names that the matched person is associated with/li>li>code>listingsRelatedToMatch/code>: code>object/code> Matched listingsul>li>code>warnings/code>: code>array/code> Array of warning matches. Empty array if no warnings were foundul>li>code>sourceName/code>: code>string/code> Name of the listing/li>li>code>sourceUrl/code>: code>string/code> Url of the listing/li>li>code>date/code>: code>string | null/code> Date of the listing. Null if listing does not have a date/li>/ul>/li>li>code>sanctions/code>: code>array/code> Array of sanctions matches. Empty array if no sanctions were foundul>li>code>sourceName/code>: code>string/code> Name of the listing/li>li>code>sourceUrl/code>: code>string/code> Url of the listing/li>li>code>date/code>: code>string | null/code> Date of the listing. Null if listing does not have a date/li>/ul>/li>li>code>fitnessProbity/code>: code>array/code> Array of fitness probity matches. Empty array if no fitness probabilities were foundul>li>code>sourceName/code>: code>string/code> Name of the listing/li>li>code>sourceUrl/code>: code>string/code> Url of the listing/li>li>code>date/code>: code>string | null/code> Date of the listing. Null if listing does not have a date/li>/ul>/li>li>code>pep/code>: code>array/code> Array of PEP matches. Empty array if no PEP matches were foundul>li>code>sourceName/code>: code>string/code> Name of the listing/li>li>code>sourceUrl/code>: code>string/code> Url of the listing/li>li>code>date/code>: code>string | null/code> Date of the listing. Null if listing does not have a date/li>/ul>/li>li>code>adverseMedia/code>: code>array/code> Array of media matches. Empty array if no media were foundul>li>code>sourceName/code>: code>string/code> Name of the listing/li>li>code>sourceUrl/code>: code>string/code> Url of the listing/li>li>code>date/code>: code>string | null/code> Date of the listing. Null if listing does not have a date/li>/ul>/li>/ul>/li>/ul>/li>/ul>p>strong>Sample request/strong>/p>pre classhighlight json tab-json>code>span classp>{/span>span classw>  /span>span classs2>checkType/span>span classp>:/span>span classw> /span>span classs2>updated_result/span>span classp>,/span>span classw>  /span>span classs2>attemptId/span>span classp>:/span>span classw> /span>span classs2>54233318-f81c-4ec4-8e4c-413168a3f5e6/span>span classp>,/span>span classw>  /span>span classs2>sessionId/span>span classp>:/span>span classw> /span>span classs2>f04bdb47-d3be-4b28-b028-a652feb060b5/span>span classp>,/span>span classw>  /span>span classs2>vendorData/span>span classp>:/span>span classw> /span>span classs2>12345678/span>span classp>,/span>span classw>  /span>span classs2>endUserId/span>span classp>:/span>span classw> /span>span classs2>a1b2c35d-e8f7-6d5e-3cd2-a1b2c35db3d4/span>span classp>,/span>span classw>  /span>span classs2>matchStatus/span>span classp>:/span>span classw> /span>span classs2>possible_match/span>span classp>,/span>span classw>  /span>span classs2>searchTerm/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>    /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>Mirko Kokki/span>span classp>,/span>span classw>    /span>span classs2>year/span>span classp>:/span>span classw> /span>span classs2>1960/span>span classw>  /span>span classp>},/span>span classw>  /span>span classs2>totalHits/span>span classp>:/span>span classw> /span>span classmi>5/span>span classp>,/span>span classw>  /span>span classs2>createdAt/span>span classp>:/span>span classw> /span>span classs2>2021-06-02T11:04:00.287Z/span>span classp>,/span>span classw>  /span>span classs2>hits/span>span classp>:/span>span classw> /span>span classp>/span>span classw>    /span>span classp>{/span>span classw>      /span>span classs2>matchedName/span>span classp>:/span>span classw> /span>span classs2>Miro kokkino/span>span classp>,/span>span classw>      /span>span classs2>countries/span>span classp>:/span>span classw> /span>span classp>/span>span classw>        /span>span classs2>Australia/span>span classp>,/span>span classw>        /span>span classs2>Brazil/span>span classw>      /span>span classp>,/span>span classw>      /span>span classs2>dateOfBirth/span>span classp>:/span>span classw> /span>span classs2>1960/span>span classp>,/span>span classw>      /span>span classs2>dateOfDeath/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>      /span>span classs2>matchTypes/span>span classp>:/span>span classw> /span>span classp>/span>span classw>        /span>span classs2>aka_exact/span>span classw>      /span>span classp>,/span>span classw>      /span>span classs2>aka/span>span classp>:/span>span classw> /span>span classp>/span>span classw>        /span>span classs2>Kokki Mirko/span>span classp>,/span>span classw>        /span>span classs2>Mirko Kokki/span>span classw>      /span>span classp>,/span>span classw>      /span>span classs2>associates/span>span classp>:/span>span classw> /span>span classp>/span>span classw>        /span>span classs2>Desmon Lamela/span>span classp>,/span>span classw>        /span>span classs2>Fred Austin/span>span classw>      /span>span classp>,/span>span classw>      /span>span classs2>listingsRelatedToMatch/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classs2>warnings/span>span classp>:/span>span classw> /span>span classp>/span>span classw>          /span>span classp>{/span>span classw>            /span>span classs2>sourceName/span>span classp>:/span>span classw> /span>span classs2>FBI Most Wanted/span>span classp>,/span>span classw>            /span>span classs2>sourceUrl/span>span classp>:/span>span classw> /span>span classs2>http://www.fbi.gov/wanted/span>span classp>,/span>span classw>            /span>span classs2>date/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>          /span>span classp>}/span>span classw>        /span>span classp>,/span>span classw>        /span>span classs2>sanctions/span>span classp>:/span>span classw> /span>span classp>/span>span classw>          /span>span classp>{/span>span classw>            /span>span classs2>sourceName/span>span classp>:/span>span classw> /span>span classs2>Argentina Ministerio de Relaciones Exteriores y Culto Sanciones de la ONU/span>span classp>,/span>span classw>            /span>span classs2>sourceUrl/span>span classp>:/span>span classw> /span>span classs2>https://www.cancilleria.gob.ar/es/politica-exterior/seguridad-internacional/comite-de-sanciones/span>span classp>,/span>span classw>            /span>span classs2>date/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>          /span>span classp>},/span>span classw>          /span>span classp>{/span>span classw>            /span>span classs2>sourceName/span>span classp>:/span>span classw> /span>span classs2>Argentina Public Registry of People and Entities linked to acts of Terrorism and Terrorism Financing/span>span classp>,/span>span classw>            /span>span classs2>sourceUrl/span>span classp>:/span>span classw> /span>span classs2>https://repet.jus.gob.ar/#entidades/span>span classp>,/span>span classw>            /span>span classs2>date/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>          /span>span classp>}/span>span classw>        /span>span classp>,/span>span classw>        /span>span classs2>fitnessProbity/span>span classp>:/span>span classw> /span>span classp>/span>span classw>          /span>span classp>{/span>span classw>            /span>span classs2>sourceName/span>span classp>:/span>span classw> /span>span classs2>United Kingdom Insolvency Service Disqualified Directors/span>span classp>,/span>span classw>            /span>span classs2>sourceUrl/span>span classp>:/span>span classw> /span>span classs2>https://www.insolvencydirect.bis.gov.uk/IESdatabase/viewdirectorsummary-new.asp/span>span classw>          /span>span classp>}/span>span classw>        /span>span classp>,/span>span classw>        /span>span classs2>pep/span>span classp>:/span>span classw> /span>span classp>/span>span classw>          /span>span classp>{/span>span classw>            /span>span classs2>sourceName/span>span classp>:/span>span classw> /span>span classs2>United States Navy Leadership and Senior Military Officials/span>span classp>,/span>span classw>            /span>span classs2>sourceUrl/span>span classp>:/span>span classw> /span>span classs2>https://www.navy.mil/Leadership/Biographies//span>span classw>          /span>span classp>}/span>span classw>        /span>span classp>,/span>span classw>        /span>span classs2>adverseMedia/span>span classp>:/span>span classw> /span>span classp>/span>span classw>          /span>span classp>{/span>span classw>            /span>span classs2>date/span>span classp>:/span>span classw> /span>span classs2>2020-09-23T00:00:00Z/span>span classp>,/span>span classw>            /span>span classs2>sourceName/span>span classp>:/span>span classw> /span>span classs2>SNAs Old Salt Award Passed to Adm. Davidson/span>span classp>,/span>span classw>            /span>span classs2>sourceUrl/span>span classp>:/span>span classw> /span>span classs2>https://www.marinelink.com/amp/news/snas-old-salt-award-passed-adm-davidson-443093/span>span classw>          /span>span classp>}/span>span classw>        /span>span classp>/span>span classw>      /span>span classp>}/span>span classw>    /span>span classp>}/span>span classw>  /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h2 idine-registry-validation-webhook>INE registry validation webhook/h2>p>This is the description of the payload sent to code>Webhook INE registry URL/code>.br/>The response of the check is sent back once the check is completed./p>aside classnotice>The INE registry URL needs to be configured in the Veriff environment.br/>After logging in,go to b>Integrations/b> list, open the integration you need and navigate tothe b>Integration Settings/b> tab. Here, fill in the fields of the b>Webhook INE registry URL/b>./aside>h5 idrequest-properties-explained>Request properties explained/h5>ul>li>code>eventType/code>: code>string/code> INE registry event name/li>li>code>sessionId/code>: code>string/code> UUID for the session where this check was executed/li>li>code>attemptId/code>: code>string/code> UUID v4 which identifies session attempt/li>li>code>vendorData/code>: code>string | null/code> End-user-specific data string, max 1000 characters long, created by the customer.Sent back unmodified via API responses and webhooks, or as code>null/code> if not provided/li>li>code>endUserId/code>: code>UUID v4 | null/code> End-user-specific UUID v4 created by the customer to identify the end-user. Returnedunmodified in webhooks and public API calls, or as code>null/code> if not specified/li>li>code>version/code>: code>string/code> Version number of the check/li>li>code>time/code>: code>string/code> Timestamp of sending the webhook. Combined ISO 8601 date and time in UTC YYYY-MM-DDTHH:MM:S+Timezone Offset/li>li>code>data/code>: code>object/code> Array of data objectsul>li>code>status/code>: code>string/code> Status of the data/li>li>code>code/code>: code>number/code> An integer number of the HTTP status code. See the a href#common-http-status-codes>Common HTTP status codes table/a>for more info/li>li>code>details/code>: code>object/code> Details connected to the specific check against the registryul>li>code>active/code>: code>boolean/code> Indication of if the INE identification number is active (code>true/code>) or inactive (code>false/code>)/li>li>code>documentState/code>: code>string/code> Explanation of the code>data.status/code> value/li>/ul>/li>/ul>/li>/ul>h5 idsample-request>Sample request/h5>pre classhighlight json tab-json>code>span classp>{/span>span classw>  /span>span classs2>eventType/span>span classp>:/span>span classw> /span>span classs2>ine_registry/span>span classp>,/span>span classw>  /span>span classs2>sessionId/span>span classp>:/span>span classw> /span>span classs2>f04bdb47-d3be-4b28-b028-a652feb060b5/span>span classp>,/span>span classw>  /span>span classs2>attemptId/span>span classp>:/span>span classw> /span>span classs2>e30122d1-740b-4764-853f-470374a7abf4/span>span classp>,/span>span classw>  /span>span classs2>vendorData/span>span classp>:/span>span classw> /span>span classs2>1234567812345678/span>span classp>,/span>span classw>  /span>span classs2>endUserId/span>span classp>:/span>span classw> /span>span classs2>a1b2c35d-e8f7-6d5e-3cd2-a1b2c35db3d4/span>span classp>,/span>span classw>  /span>span classs2>version/span>span classp>:/span>span classw> /span>span classs2>1.0.0/span>span classp>,/span>span classw>  /span>span classs2>time/span>span classp>:/span>span classw> /span>span classs2>2021-06-02T11:04:00.287Z/span>span classp>,/span>span classw>  /span>span classs2>data/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>La credencial es válida/span>span classp>,/span>span classw>    /span>span classs2>code/span>span classp>:/span>span classw> /span>span classmi>200/span>span classp>,/span>span classw>    /span>span classs2>details/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>      /span>span classs2>active/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw>      /span>span classs2>documentState/span>span classp>:/span>span classw> /span>span classs2>El documento es válido./span>span classw>    /span>span classp>}/span>span classw>  /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h2 idcurp-registry-validation-webhook>CURP registry validation webhook/h2>p>This is the description of the payload sent to code>Webhook CURP registry URL/code>.br/>The response of the check is sent back once the check is completed./p>aside classnotice>The CURP registry URL needs to be configured in the Veriff environment.br/> After logging in, go tob>Integrations/b> list, open the integration you need and navigate tothe b>Integration Settings/b> tab. Here, fill in the fields of the b>Webhook CURP registry URL/b>./aside>h5 idrequest-properties-explained>Request properties explained/h5>ul>li>code>type/code>: code>string/code> CURP registry check name/li>li>code>id/code>: code>string/code> UUID for the session where this check was executed/li>li>code>vendorData/code>: code>string | null/code> End-user-specific data string, max 1000 characters long, created by the customer.Sent back unmodified via API responses and webhooks, or as code>null/code> if not provided/li>li>code>endUserId/code>: code>UUID v4 | null/code> End-user-specific UUID v4 created by the customer to identify the end-user. Returnedunmodified in webhooks and public API calls, or as code>null/code> if not specified/li>li>code>version/code>: code>string/code> Version number of the check/li>li>code>data/code>: code>object | null/code> Array of data objectsul>li>code>attemptId/code>: code>string/code> UUID v4 which identifies session attempt/li>li>code>name/code>: code>string/code> Name of the check/li>li>code>status/code>: code>string/code> (One of: found, not found) Status of the data/li>li>code>code/code>: code>number/code> An integer number of the HTTP status code. See the a href#common-http-status-codes>Common HTTP status codes table/a>for more info/li>li>code>details/code>: code>object/code> Details connected to the specific check against the registryul>li>code>statusCurp/code>: code>string | null/code> (One of: AN, AH, CRA CU, RCN, RCC, BD, BDA, BCC, BCN) Status of the CURP data/li>li>code>curp/code>: code>string/code> 18-character alphanumeric code of the person (the CURP identification number)/li>li>code>description/code>: code>string/code> Explanation of the code>details.statusCurp/code> value/li>/ul>/li>/ul>/li>/ul>h4 idfull-forms-of-the-statuscurp-acronyms>Full forms of the code>statusCurp/code> acronyms/h4>p>strong>Active CURP/strong>: AN (Alta Normal), AH (Alta con Homonimia), CRA CU (CURP Reactivada),RCN (Registro de Cambio no Afectando a CURP), RCC (Registro de Cambio Afectando a CURP)/p>p>strong>For inactive CURP/strong>: BD (Baja por Defuncion), BDA (Baja por Duplicidad), BCC (Baja por Cambio en CURP),BCN (Baja no Afectando a CURP)/p>h5 idsample-request>Sample request/h5>pre classhighlight json tab-json>code>span classp>{/span>span classw>  /span>span classs2>type/span>span classp>:/span>span classw> /span>span classs2>curp_registry/span>span classp>,/span>span classw>  /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>f04bdb47-d3be-4b28-b028-a652feb060b5/span>span classp>,/span>span classw>  /span>span classs2>vendorData/span>span classp>:/span>span classw>  /span>span classs2>1234567812345678/span>span classp>,/span>span classw>  /span>span classs2>endUserId/span>span classp>:/span>span classw> /span>span classs2>a1b2c35d-e8f7-6d5e-3cd2-a1b2c35db3d4/span>span classp>,/span>span classw>  /span>span classs2>version/span>span classp>:/span>span classw> /span>span classs2>1.0.0/span>span classp>,/span>span classw>  /span>span classs2>data/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>      /span>span classs2>attemptId/span>span classp>:/span>span classw> /span>span classs2>e30122d1-740b-4764-853f-470374a7abf4/span>span classp>,/span>span classw>      /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>curp_registry/span>span classp>,/span>span classw>      /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>found/span>span classp>,/span>span classw>      /span>span classs2>code/span>span classp>:/span>span classw> /span>span classmi>200/span>span classp>,/span>span classw>      /span>span classs2>details/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>          /span>span classs2>statusCurp/span>span classp>:/span>span classw> /span>span classs2>RCN/span>span classp>,/span>span classw>          /span>span classs2>curp/span>span classp>:/span>span classw> /span>span classs2>VISH760905HSRLNN06/span>span classp>,/span>span classw>          /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Registro de cambio no afectando a curp/span>span classw>      /span>span classp>}/span>span classw>  /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h2 idcombined-ine-curp-validation-webhook>Combined INE CURP validation webhook/h2>p>This is the description of the payload sent to code>Webhook combined INE CURP registry URL/code>.br/>The response of the check is sent back once the check is completed./p>aside classnotice>The combined INE CURP registry URL needs to be configured in the Veriff environment.br/> After logging in, go tob>Integrations/b> list, open the integration you need and navigate tothe b>Integration Settings/b> tab. Here, fill in the fields of the b>Webhook combined ine curp registry URL/b>./aside>aside classnotice>Note that code>data.details.ine/code> will return b>either code>ifeIdentifier/code> or code>ineIdentifier/code>/b>.Both are not present at the same time./aside>h5 idrequest-properties-explained>Request properties explained/h5>ul>li>code>type/code>: code>string/code> CURP registry check name/li>li>code>id/code>: code>string/code> UUID for the session where this check was executed/li>li>code>vendorData/code>: code>string | null/code> End-user-specific data string, max 1000 characters long, created by the customer.Sent back unmodified via API responses and webhooks, or as code>null/code> if not provided/li>li>code>endUserId/code>: code>UUID v4 | null/code> End-user-specific UUID v4 created by the customer to identify the end-user. Returnedunmodified in webhooks and public API calls, or as code>null/code> if not specified/li>li>code>version/code>: code>string/code> Version number of the check/li>li>code>data/code>: code>object | null/code> Array of data objectsul>li>code>attemptId/code>: code>string/code> UUID v4 which identifies session attempt/li>li>code>name/code>: code>string/code> Name of the check/li>li>code>status/code>: code>string/code> (One of: found, not found) Status of the data/li>li>code>code/code>: code>number/code> An integer number of the HTTP status code. See the a href#common-http-status-codes>Common HTTP status codes table/a>for more info/li>li>code>details/code>: code>object/code> Details connected to the specific check against the registryul>li>code>ine/code>: code>object/code> Details about the INE/IFE identification numberul>li>code>active/code>: code>boolean/code> Indication of if the INE identification number is active (code>true/code>) or inactive (code>false/code>)/li>li>code>status/code>: code>string/code> Explanation of the code>data.status/code> value/li>li>code>information/code>: code>string/code> Extra information about the INE identification number/li>li>code>comments/code>: code>array/code> Comments regarding the status of the identification/li>li>code>ifeIdentifier/code>: code>string | null/code> INE identification number. When this is returned, the code>ineIdentifier/code> is not present./li>li>code>ineIdentifier/code>: code>string | null/code> IFE identification number. When this is returned, the code>ifeIdentifier/code> is not present./li>/ul>/li>li>code>curp/code>: code>object/code> Details about the CURP identification numberul>li>code>curp/code>: code>string/code> CURP identification number/li>li>code>names/code>: code>string/code> Name/li>li>code>gender/code>: code>string/code> Gender (One of code>HOMBRE/code>, code>MUJER/code>)/li>li>code>regionCode/code>: code>string/code> Region code/li>li>code>statusCurp/code>: code>string | null/code> Status of the CURP data (One of: AN, AH, CRA CU, RCN, RCC, BD, BDA, BCC, BCN)/li>li>code>descriptionStatusCurp/code>: code>string/code> Explanation of the code>details.curp.statusCurp/code> value/li>li>code>birthRegion/code>: code>string/code> Birth region/li>li>code>dateOfBirth/code>: code>string/code> Date of birth region code>dd/mm/yyyy/code>,/li>li>code>nationality/code>: code>string/code> Nationality/li>li>code>firstSurname/code>: code>string/code> First surname/li>li>code>secondSurname/code>: code>string/code> Last surname/li>li>code>documentEvidence/code>: code>number/code> Document evidence/li>li>code>docEvidenceData/code>: code>object/code>1 Details about the document evidence dataul>li>code>book/code>: code>string/code> Book/li>li>code>sheet/code>: code>string/code> Sheet/li>li>code>volume/code>: code>string/code> Volume/li>li>code>actNumber/code>: code>string/code> Act number/li>li>code>registryCity/code>: code>string/code> Registry city/li>li>code>regionRegistry/code>: code>string/code> Region registry/li>li>code>registrationYear/code>: code>string/code> Registration year/li>li>code>registryCityCode/code>: code>string/code> Registry city code/li>li>code>registryRegionCode/code>: code>string/code> Registry region code/li>/ul>/li>/ul>/li>/ul>/li>/ul>/li>/ul>h4 idfull-forms-of-the-statuscurp-acronyms>Full forms of the code>statusCurp/code> acronyms/h4>p>strong>Active CURP/strong>: AN (Alta Normal), AH (Alta con Homonimia), CRA CU (CURP Reactivada),RCN (Registro de Cambio no Afectando a CURP), RCC (Registro de Cambio Afectando a CURP)/p>p>strong>For inactive CURP/strong>: BD (Baja por Defuncion), BDA (Baja por Duplicidad), BCC (Baja por Cambio en CURP),BCN (Baja no Afectando a CURP)/p>p>h5 idsample-request>Sample request/h5>pre classhighlight json tab-json>code>span classp>{/span>span classw>  /span>span classs2>"type"/span>span classp>:/span>span classw> /span>span classs2>"combined-ine-curp-registry"/span>span classp>,/span>span classw>  /span>span classs2>"id"/span>span classp>:/span>span classw> /span>span classs2>"f04bdb47-d3be-4b28-b028-a652feb060b5"/span>span classp>,/span>span classw>  /span>span classs2>"vendorData"/span>span classp>:/span>span classw>  /span>span classs2>"1234567812345678"/span>span classp>,/span>span classw>  /span>span classs2>"endUserId"/span>span classp>:/span>span classw> /span>span classs2>"a1b2c35d-e8f7-6d5e-3cd2-a1b2c35db3d4"/span>span classp>,/span>span classw>  /span>span classs2>"version"/span>span classp>:/span>span classw> /span>span classs2>"1.0.0"/span>span classp>,/span>span classw>  /span>span classs2>"data"/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>      /span>span classs2>"attemptId"/span>span classp>:/span>span classw> /span>span classs2>"e30122d1-740b-4764-853f-470374a7abf4"/span>span classp>,/span>span classw>      /span>span classs2>"name"/span>span classp>:/span>span classw> /span>span classs2>"combined-ine-curp-registry"/span>span classp>,/span>span classw>      /span>span classs2>"status"/span>span classp>:/span>span classw> /span>span classs2>"found"/span>span classp>,/span>span classw>      /span>span classs2>"code"/span>span classp>:/span>span classw> /span>span classmi>200/span>span classp>,/span>span classw>      /span>span classs2>"details"/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classs2>"ine"/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>"active"/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw>            /span>span classs2>"status"/span>span classp>:/span>span classw> /span>span classs2>"La credencial esta vigente"/span>span classp>,/span>span classw>            /span>span classs2>"comments"/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                /span>span classs2>"CIC 000000000/span>span classse>\r\n/span>span classs2>Clave de elector JRLGLS00000000H000/span>span classse>\r\n/span>span classs2>Número de emisión 1/span>span classse>\r\n/span>span classs2>Distrito Federal 3/span>span classse>\r\n/span>span classs2>Distrito Local 4/span>span classse>\r\n/span>span classs2>Número OCR 0000000000000/span>span classse>\r\n/span>span classs2>Año de registro 2009/span>span classse>\r\n/span>span classs2>Año de emisión 2020"/span>span classp>,/span>span classw>                /span>span classs2>"Fecha de actualización de la información: 10 de agosto del 2023 19:48"/span>span classp>,/span>span classw>                /span>span classs2>"Fecha de consulta: 11 de agosto del 2023"/span>span classp>,/span>span classw>                /span>span classs2>"Tus datos se encuentran en el Padrón Electoral, y también en la Lista Nominal de Electores"/span>span classw>            /span>span classp>,/span>span classw>            /span>span classs2>"information"/span>span classp>:/span>span classw> /span>span classs2>"CIC 000000000/span>span classse>\r\n/span>span classs2>Clave de elector JRLGLS00000000H000/span>span classse>\r\n/span>span classs2>Número de emisión 1/span>span classse>\r\n/span>span classs2>Distrito Federal 3/span>span classse>\r\n/span>span classs2>Distrito Local 4/span>span classse>\r\n/span>span classs2>Número OCR 0000000000000/span>span classse>\r\n/span>span classs2>Año de registro 2009/span>span classse>\r\n/span>span classs2>Año de emisión 2020/span>span classse>\r\n/span>span classs2>Fecha de actualización de la información: 10 de agosto del 2023 19:48/span>span classse>\r\n/span>span classs2>Fecha de consulta: 11 de agosto del 2023/span>span classse>\r\n/span>span classs2>Esta vigente como medio de identificación y puedes votar./span>span classse>\r\n/span>span classs2>Tus datos se encuentran en el Padrón Electoral, y también en la Lista Nominal de Electores./span>span classse>\r\n/span>span classs2>Será válida hasta el 31 de diciembre de 2030"/span>span classp>,/span>span classw>            /span>span classs2>"ifeIdentifier"/span>span classp>:/span>span classw> /span>span classs2>""/span>span classp>,/span>span classw>            /span>span classs2>"ineIdentifier"/span>span classp>:/span>span classw> /span>span classs2>"000000000"/span>span classw>        /span>span classp>},/span>span classw>        /span>span classs2>"curp"/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>"curp"/span>span classp>:/span>span classw> /span>span classs2>"ABCD000000HVZRGS00"/span>span classp>,/span>span classw>            /span>span classs2>"names"/span>span classp>:/span>span classw> /span>span classs2>"LOREM IPSUM"/span>span classp>,/span>span classw>            /span>span classs2>"gender"/span>span classp>:/span>span classw> /span>span classs2>"HOMBRE"/span>span classp>,/span>span classw>            /span>span classs2>"regionCode"/span>span classp>:/span>span classw> /span>span classs2>"VZ"/span>span classp>,/span>span classw>            /span>span classs2>"statusCurp"/span>span classp>:/span>span classw> /span>span classs2>"RCN"/span>span classp>,/span>span classw>            /span>span classs2>"birthRegion"/span>span classp>:/span>span classw> /span>span classs2>"Veracruz"/span>span classp>,/span>span classw>            /span>span classs2>"dateOfBirth"/span>span classp>:/span>span classw> /span>span classs2>"06/04/1991"/span>span classp>,/span>span classw>            /span>span classs2>"nationality"/span>span classp>:/span>span classw> /span>span classs2>"MEX"/span>span classp>,/span>span classw>            /span>span classs2>"firstSurname"/span>span classp>:/span>span classw> /span>span classs2>"JUAREZ"/span>span classp>,/span>span classw>            /span>span classs2>"secondSurname"/span>span classp>:/span>span classw> /span>span classs2>"LAGUNES"/span>span classp>,/span>span classw>            /span>span classs2>"docEvidenceData"/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                /span>span classs2>"book"/span>span classp>:/span>span classw> /span>span classs2>""/span>span classp>,/span>span classw>                /span>span classs2>"sheet"/span>span classp>:/span>span classw> /span>span classs2>""/span>span classp>,/span>span classw>                /span>span classs2>"volume"/span>span classp>:/span>span classw> /span>span classs2>""/span>span classp>,/span>span classw>                /span>span classs2>"actNumber"/span>span classp>:/span>span classw> /span>span classs2>"00123"/span>span classp>,/span>span classw>                /span>span classs2>"registryCity"/span>span classp>:/span>span classw> /span>span classs2>""/span>span classp>,/span>span classw>                /span>span classs2>"regionRegistry"/span>span classp>:/span>span classw> /span>span classs2>"30"/span>span classp>,/span>span classw>                /span>span classs2>"registrationYear"/span>span classp>:/span>span classw> /span>span classs2>"1991"/span>span classp>,/span>span classw>                /span>span classs2>"registryCityCode"/span>span classp>:/span>span classw> /span>span classs2>"125"/span>span classp>,/span>span classw>                /span>span classs2>"registryRegionCode"/span>span classp>:/span>span classw> /span>span classs2>"VZ"/span>span classw>            /span>span classp>},/span>span classw>            /span>span classs2>"documentEvidence"/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw>            /span>span classs2>"descriptionStatusCurp"/span>span classp>:/span>span classw> /span>span classs2>"Registro de cambio no afectando a curp"/span>span classw>        /span>span classp>}/span>span classw>    /span>span classp>}/span>span classw>  /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h2 iduser-defined-session-statuses-webhook>User-defined session statuses webhook/h2>p>This is the description of the payload sent to the code>Webhook URL for sessions statuses set in Station/code>./br>This webhook is sent after the user has added a status to an attempt in the Veriff environment./p>/p>p>strong>Properties explained/strong>/p>ul>li>code>data/code>: code>object/code>ul>li>code>verification/code>: code>object/code> Array of JSON objects identifying the attemptsul>li>code>id/code>: code>UUID/code> -v4 of the attempt/li>li>code>userDefinedData/code>: code>object/code> Describes the custom statuses defined by the user. Instructions how toadd statuses can be found a hrefhttps://help.veriff.com/en/articles/8480053-adding-user-defined-statuses-to-sessions>here ↗/a>(requires a login to the Veriff environment).ul>li>code>status/code>: code>string/code> Name of the custom status as set in the Veriff environment/li>li>code>statusCode/code>: code>string/code> Autogenerated code for the custom status/li>li>code>reason/code>: code>string/code> Name of the custom reason as set in the Veriff environment. If the user has selectedthe "Custom" reason for the status and typed an explanation to the text box, then the explanation is sentin this field./li>li>code>reasonCode/code>: code>string | null/code> Autogenerated code for the reason. It is code>null/code> when the user has selected the"Custom" reason for the status and typed an explanation to the text box. This explanation is sent inthe code>reason/code> parameter./li>li>code>createdAt/code>: code>string/code> Timestamp of when the custom status was added. Combined ISO 8601 date and time inUTC YYYY-MM-DDTHH:MM:SSS+Timezone Offset/li>/ul>/li>/ul>/li>/ul>/li>li>code>time/code>: code>string/code> Timestamp of when the webhook was sent. Combined ISO 8601 date and time inUTC YYYY-MM-DDTHH:MM:SSS+Timezone Offset/li>li>code>attemptId/code>: code>UUID/code> -v4 of the attempt/li>li>code>eventType/code>: code>string/code> (user-status.created) Indicates the event type/li>li>code>sessionId/code>: code>UUID/code> of the session where the attempt belongs to/li>li>code>vendorData/code>: code>string | null/code> End-user-specific data string, max 1000 characters long, created by the customer.Sent back unmodified via API responses and webhooks, or as code>null/code> if not provided/li>li>code>endUserId/code>: code>UUID v4 | null/code> End-user-specific UUID v4 created by the customer to identify the end-user. Returnedunmodified in webhooks and public API calls, or as code>null/code> if not specified/li>/ul>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>data/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classs2>verification/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>a1c68aea-7f4d-478d-80ab-ca9356074f69/span>span classp>,/span>span classw>            /span>span classs2>userDefinedData/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                /span>span classs2>reason/span>span classp>:/span>span classw> /span>span classs2>Looks like velocity abuse/span>span classp>,/span>span classw>                /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>Custom status for suspicious attempt/span>span classp>,/span>span classw>                /span>span classs2>createdAt/span>span classp>:/span>span classw> /span>span classs2>2023-10-27T09:59:15.090805Z/span>span classp>,/span>span classw>                /span>span classs2>reasonCode/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>                /span>span classs2>statusCode/span>span classp>:/span>span classw> /span>span classs2>custom_status_for_suspicious_attempt/span>span classw>            /span>span classp>}/span>span classw>        /span>span classp>}/span>span classw>    /span>span classp>},/span>span classw>    /span>span classs2>time/span>span classp>:/span>span classw> /span>span classs2>2023-10-27T10:00:02.998Z/span>span classp>,/span>span classw>    /span>span classs2>attemptId/span>span classp>:/span>span classw> /span>span classs2>f2270684-8c51-4d03-88eb-dafd43e8b486/span>span classp>,/span>span classw>    /span>span classs2>eventType/span>span classp>:/span>span classw> /span>span classs2>user-status.created/span>span classp>,/span>span classw>    /span>span classs2>sessionId/span>span classp>:/span>span classw> /span>span classs2>0b10cb53-4f3b-48af-bd74-60b85354e51f/span>span classp>,/span>span classw>    /span>span classs2>vendorData/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>    /span>span classs2>endUserId/span>span classp>:/span>span classw> /span>span classs2>a1b2c35d-e8f7-6d5e-3cd2-a1b2c35db3d4/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h2 idwebhooks-testing>Webhooks testing/h2>p>For testing purposes we provide an example payload, so you do not depend on Veriff sending the response. You can usethe Curl command below./p>p>Note that the signature will not match your API Public Key and API Private Key.To validate this example signature and payload, use API Private Key 'abcdef12-abcd-abcd-abcd-abcdef012345'./p>pre classhighlight shell>code>curl --request POST span classs1>https://your.url/span> -k span classse>\/span>--header span classs1>accept:application/json/span> span classse>\/span>--header span classs1>x-auth-client:8e4f7cd8-7a19-4d7d-971f-a076407ee03c/span> span classse>\/span>--header span classs1>x-hmac-signature:01fa3ded011bfce75672c99877a6cc1cf7aeaeda0ccb6b43fc21b60f595063c2/span> span classse>\/span>--header span classs1>content-type:application/json/span> span classse>\/span>--data span classs1>{status:success,verification:{id:12df6045-3846-3e45-946a-14fa6136d78b,code:9001,person:{gender:null,idNumber:null,lastName:MORGAN,addresses:{fullAddress:1234 Snowy Ridge Road, Indiana, 56789 USA,parsedAddress:{city:null,unit:null,state:Indiana,street:1234 Snowy Ridge Road,country:USA,postcode:56789,houseNumber:null}},firstName:SARAH,citizenship:null,dateOfBirth:1967-03-30,nationality:null,yearOfBirth:1967,placeOfBirth:MADRID,pepSanctionMatch:null},reason:null,status:approved,comments:,document:{type:DRIVERS_LICENSE,number:MORGA753116SM9IJ,country:GB,validFrom:null,validUntil:2022-04-20,placeOfIssue:MADRID,firstIssue:2015-03-21,issueNumber:01,issuedBy:ISSUER},reasonCode:null,vendorData:12345678,decisionTime:2019-11-06T07:18:36.916Z,acceptanceTime:2019-11-06T07:15:27.000Z,additionalVerifiedData:{driversLicenseCategory:{B:true},driversLicenseCategoryFrom:{B:2019-10-06},driversLicenseCategoryUntil:{B:2025-10-05},estimatedAge:32,estimatedGender:0.613},riskLabels:{label:document_integration_level_crosslinked_with_fraud,category:document,sessionIds:5a2358e7-fd31-4fcb-a23f-4d76651ba68a},{label:document_integration_level_crosslinked_with_multiple_declines,category:document,sessionIds:fd5c1563-1d23-4b1a-ae46-7ba429927ed8},biometricAuthentication:{matchedSessionId:d40edb60-6ae6-4475-be72-84b81669cce6,matchedSessionVendorData:User001}},technicalData:{ip:186.153.67.122}}/span>/code>/pre>h1 idfull-auto>Full Auto/h1>p>This is a strong>fully automated identity verification service/strong>, which can be integrated via SDKs and the API./p>p>There are two options for identity verification:/p>ul>li>strong>Doc only Identity Verification ("Doc only IDV")/strong>, where the end-user submits images of only their ID document(front and back)/li>li>strong>Identity Verification ("IDV")/strong>, where the end-user submits images of their ID document and themselves (documentfront and back + a selfie)/li>/ul>p>The system analyzes the images, verifies the end-user and returns the results via strong>decision webhook/strong>. All theinformation can also be a href#querying-the-full-auto-decision-data-via-api>queried/a> via GET sessions/{sessionId}/decisionendpoint./p>p>The strong>results of the verification/strong> can also be strong>viewed in the Veriff environment/strong>./p>h2 idfull-auto-prerequisites>Full Auto prerequisites/h2>aside classnotice>Sending the code>vendorData/code>/code>endUserId/code> parameter is b>optional if you want to use the standaloneFull Auto solution/b>. br/>If you wish to combine this with the b>Biometric Authentication/b> solution, sending thecode>vendorData/code>/code>endUserId/code> is b>mandatory/b>./aside>aside classnotice>When using the API, it is highly recommended to send the b>session and device/b> data for better fraud detection.This can be done after the session has been created, by using thea href#post-sessions-sessionid-collected-data>POST sessions/{sessionid}/collected-data/a>endpoint./aside>h2 idfull-auto-flow>Full Auto flow/h2>ol>li>p>strong>Create a new session/strong> using the strong>keys/strong> and the strong>baseURL/strong> of the strong>Full Auto integration/strong> (see thea href#prerequisites-to-create-api-requests>API Reference/a> about how to find these in the Veriff environment)./p>/li>li>p>Direct the strong>end-user to the verification flow/strong>./p>/li>li>p>The strong>end-user passes through the end-user flow/strong> on their device. They are required to capture the strong>front and back of theirID document/strong>, and, in case of face validation, take a strong>selfie/strong>./p>p>a. When using the strong>SDK/Web flow/strong>, the strong>session status is automatically updated/strong> to code>submitted/code> as soon as the end-userhas submitted the images./p>p>b. When using the strong>API requests/strong>, you need to strong>do this manually/strong>. See the a href#sending-the-end-user-data-via-api>Sending the end-user data via API/a>section below for more information./p>/li>li>p>a href#full-auto-results-in-decision-webhook>Receive the results/a> from Veriff via decision webhook,a href#querying-the-full-auto-decision-data-via-api>query/a> them using the GET sessions/{sessionId}/decision endpoint,or view them in the  strong>Veriff environment/strong>./p>/li>/ol>h2 idfull-auto-over-sdk>Full Auto over SDK/h2>p>If you have integrated with Veriff using the SDKs and you have set up the decision webhook URL in theVeriff environment, you are all set./p>h2 idfull-auto-over-api>Full Auto over API/h2>p>Before you start, make sure that you have a href#configuring-the-webhook-endpoint>configured/a> the a href#decision-webhook>decision webhook/a>./p>h3 idsending-the-end-user-data-via-api>Sending the end-user data via API/h3>ol>li>Start a session using the a href#post-sessions>POST /sessions/a>ul>li>If you want to use the Biometric Authentication, make sure to also pass the code>vendorData/code>/code>endUserId/code>/li>/ul>/li>li>Upload the strong>highly recommended device/session data/strong> via a href#post-sessions-sessionid-collected-data>POST sessions/{sessionid}/collected-data/a>for improved fraud detection/li>li>Upload end-user's ID document (and selfie images, if applicable) via a href#get-sessions-sessionid-media>POST sessions/{sessionId}/media/a>/li>li>Specify the code>image.context/code> as appropriate for the image (see the a href#image-context-types>context types/a> for more info)/li>li>Patch the session status to code>submitted/code> using the a href#patch-sessions-sessionid>PATCH sessions/{sessionId}/a>/li>/ol>h2 idgetting-full-auto-session-decision>Getting Full Auto session decision/h2>p>You can get the data from three sources:/p>ul>li>The decision webhook/li>li>Query the results via GET sessions/{sessionId}/decision/li>li>View the results in the Veriff Environment/li>/ul>h3 idfull-auto-results-in-decision-webhook>Full Auto results in decision webhook/h3>p>Results of the Full Auto session are returned in the decision webhook./p>p>Note that below is an explanation and a sample of a strong>decision webhook payload for a Full Auto session/strong>. The decisionwebhook is used for many purposes, to find more info about it, see the a href#decision-webhook>full decision webhook/a> section./p>p>strong>Webhook payload properties explained/strong>/p>ul>li>code>status/code>: code>string/code> Status of the response/li>li>code>verification/code>: code>object/code> Verification request decision object. code>null/code> if decision is not available yetul>li>code>id/code>: code>string/code> UUID v4 which identifies the verification session/li>li>code>code/code>: code>integer/code> Verification response code, one of 9001, 9102, 9103, 9104, 9121. More information about a href#verification-session-status-and-decision-codes>decision codes/a>/li>li>code>person/code>: code>object/code> Verified personul>li>code>gender/code>: code>string | null/code> Person's gender, one of M, F or code>null/code>/li>li>code>idNumber/code>: code>string | null/code> Person's national identification number/li>li>code>lastName/code>: code>string | null/code> Person's last name/li>li>code>firstName/code>: code>string | null/code> Person's first name/li>li>em>code>citizenship/code>: code>(Deprecated)/code> code>null/code>/em>/li>li>code>dateOfBirth/code>: code>string/code> Person's date of birth, as YYYY-MM-DD/li>li>code>nationality/code>: code>string | null/code> Person's nationality/li>li>code>yearOfBirth/code>: code>string | null/code> Person's year of birth, as YYYY/li>li>code>placeOfBirth/code>: code>string | null/code> Person's place of birth/li>li>em>code>pepSanctionMatch/code>: code>string | null/code> Legacy field for PEP and Sanctions checks, should be ignored at all times/em>/li>/ul>/li>li>code>reason/code>: code>string | null/code> Reason for failed verification/li>li>code>status/code>: code>approved/code> Verification status, one of code>approved/code>, code>resubmission_requested/code>, code>review/code>, code>declined/code>,code>expired/code>, code>abandoned/code>/li>li>em>code>comments/code>: code>array/code> (Deprecated)/em>/li>li>code>document/code>: code>object/code> Verified documentul>li>code>type/code>: code>string/code> Document type, one of code>PASSPORT/code>, code>ID_CARD/code>, code>RESIDENCE_PERMIT/code>, code>DRIVERS_LICENSE/code>, code>VISA/code>,code>OTHER/code>. A list of a href#supported-document-types-for-idv>supported document types/a>/li>li>code>number/code>: code>string | null/code> Document number, a-zA-Z0-9 characters only/li>li>code>country/code>: code>string | null/code> Document issuing country, as ISO 3166 alpha-2 code/li>li>code>state/code>: code>string | null/code> Document issuing state, as ISO 3166 alpha-2 or alpha-3 code. code>null/code> when the statedata is not present on the document/li>li>code>validFrom/code>: code>string | null/code> Document is valid from date/li>li>code>validUntil/code>: code>string |  null/code> Document is valid until date/li>/ul>/li>li>code>reasonCode/code>: code>integer | null/code> Reason code of failed verification. A table of a href#reference-info-codes-tables>response and error codes/a>/li>li>code>vendorData/code>: code>string/code> End-user-specific data string, max 1000 characters long, created by the customer. Sent backunmodified via API responses and webhooks, or as code>null/code> if not provided/li>li>code>endUserId/code>: code>uuid | null/code> End-user-specific UUID created by the customer to identify the end-user. Returnedunmodified in webhooks and public API calls, or as code>null/code> if not provided/li>li>code>decisionTime/code>: code>string/code> Timestamp of the decision. Combined ISO 8601 date and time in UTC, YYYY-MM-DDTHH:MM:SSS+Timezone Offset/li>li>code>acceptanceTime/code>: code>string/code> Timestamp of the session generation. Combined ISO 8601 date and time in UTC, YYYY-MM-DDTHH:MM:SSS+Timezone Offset/li>li>code>additionalVerifiedData/code>: code>object/code> Data which has been optionally verified for session/li>/ul>/li>li>code>technicalData/code>: code>object/code> Technical data objectul>li>code>ip/code>: code>string | null/code> IP of the device from which the verification was made/li>/ul>/li>/ul>p>strong>Sample request/strong>/p>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>    /span>span classs2>verification/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>12df6045-3846-3e45-946a-14fa6136d78b/span>span classp>,/span>span classw>        /span>span classs2>code/span>span classp>:/span>span classw> /span>span classmi>9001/span>span classp>,/span>span classw>        /span>span classs2>person/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>gender/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>idNumber/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>lastName/span>span classp>:/span>span classw> /span>span classs2>MORGAN/span>span classp>,/span>span classw>            /span>span classs2>addresses/span>span classp>:/span>span classw> /span>span classp>,/span>span classw>            /span>span classs2>firstName/span>span classp>:/span>span classw> /span>span classs2>SARAH/span>span classp>,/span>span classw>            /span>span classs2>citizenship/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>dateOfBirth/span>span classp>:/span>span classw> /span>span classs2>1990-01-09/span>span classp>,/span>span classw>            /span>span classs2>nationality/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>yearOfBirth/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>placeOfBirth/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>pepSanctionMatch/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>        /span>span classp>},/span>span classw>        /span>span classs2>reason/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>        /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>approved/span>span classp>,/span>span classw>        /span>span classs2>comments/span>span classp>:/span>span classw> /span>span classp>,/span>span classw>        /span>span classs2>document/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>type/span>span classp>:/span>span classw> /span>span classs2>DRIVERS_LICENSE/span>span classp>,/span>span classw>            /span>span classs2>state/span>span classp>:/span>span classw> /span>span classs2>NY/span>span classp>,/span>span classw>            /span>span classs2>number/span>span classp>:/span>span classw> /span>span classs2>1234569/span>span classp>,/span>span classw>            /span>span classs2>country/span>span classp>:/span>span classw> /span>span classs2>US/span>span classp>,/span>span classw>            /span>span classs2>validFrom/span>span classp>:/span>span classw> /span>span classs2>2024-04-20/span>span classp>,/span>span classw>            /span>span classs2>validUntil/span>span classp>:/span>span classw> /span>span classs2>2028-04-19/span>span classw>        /span>span classp>},/span>span classw>        /span>span classs2>endUserId/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>        /span>span classs2>reasonCode/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>        /span>span classs2>vendorData/span>span classp>:/span>span classw> /span>span classs2>12345678/span>span classp>,/span>span classw>        /span>span classs2>decisionTime/span>span classp>:/span>span classw> /span>span classs2>2024-08-15T17:57:03.376067Z/span>span classp>,/span>span classw>        /span>span classs2>acceptanceTime/span>span classp>:/span>span classw> /span>span classs2>2024-08-15T17:56:31.021837Z/span>span classp>,/span>span classw>        /span>span classs2>additionalVerifiedData/span>span classp>:/span>span classw> /span>span classp>{}/span>span classw>    /span>span classp>},/span>span classw>    /span>span classs2>technicalData/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classs2>ip/span>span classp>:/span>span classw> /span>span classs2>186.153.67.122/span>span classw>    /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h3 idquerying-the-full-auto-decision-data-via-api>Querying the Full Auto decision data via API/h3>p>You can use the strong>GET sessions/{sessionId}/decision/strong> endpoint to get the decision data./p>p>Note that below is an explanation and a sample of a GET call payload for a Full Auto session. The GET sessions/{sessionId}/decisionendpoint is used for many purposes, to find more info about it, see the a href#get-sessions-sessionid-decision>GET sessions/{sessionId}/decision/a>section./p>p>strong>API request/strong>/p>p>strong>Request method: GET/strong>br/>strong>Media type:/strong> application/jsonbr/>strong>Type:/strong> objectbr/>strong>Headers/strong>br/>code>X-AUTH-CLIENT: string (required)/code>  strong>API key/strong>br/>code>X-HMAC-SIGNATURE: string (required)/code>  code>sessionId/code> signed with the strong>shared secret key/strong>br/>code>Content-Type: application/json/code>/p>p>strong>API response properties explained/strong>/p>ul>li>code>status/code>: code>string/code> Status of the response/li>li>code>verification/code>: code>object/code> Verification request decision object. code>null/code> if decision is not available yetul>li>code>id/code>: code>string/code> UUID v4 which identifies the verification session/li>li>code>code/code>: code>integer/code> Verification response code, one of 9001, 9102, 9103, 9104, 9121. More information about a href#verification-session-status-and-decision-codes>decision codes/a>/li>li>code>person/code>: code>object/code> Verified person/li>li>code>gender/code>: code>string | null/code> Person's gender, one of M, F or code>null/code>/li>li>code>idNumber/code>: code>string | null/code> Person's national identification number/li>li>code>lastName/code>: code>string | null/code> Person's last name/li>li>code>firstName/code>: code>string | null/code> Person's first name/li>li>em>code>citizenship/code>: code>(Deprecated)/code> code>null/code>/em>/li>li>code>dateOfBirth/code>: code>string/code> Person's date of birth, as YYYY-MM-DD/li>li>code>nationality/code>: code>string | null/code> Person's nationality/li>li>code>yearOfBirth/code>: code>string | null/code> Person's year of birth, as YYYY/li>li>code>placeOfBirth/code>: code>string | null/code> Person's place of birth/li>li>em>code>pepSanctionMatch/code>: code>string | null/code> Legacy field for PEP and Sanctions checks, should be ignored at all times/em>/li>li>code>reason/code>: code>string | null/code> Reason for failed verification/li>li>code>status/code>: code>approved/code> Verification status, one of code>approved/code>, code>resubmission_requested/code>, code>review/code>, code>declined/code>,code>expired/code>, code>abandoned/code>/li>li>em>code>comments/code>: code>array/code> (Deprecated)/em>/li>li>code>document/code>: code>object/code> Verified document/li>li>code>type/code>: code>string/code> Document type, one of code>PASSPORT/code>, code>ID_CARD/code>, code>RESIDENCE_PERMIT/code>, code>DRIVERS_LICENSE/code>, code>VISA/code>,code>OTHER/code>. A list of a href#supported-document-types-for-idv>supported document types/a>/li>li>code>number/code>: code>string | null/code> Document number, a-zA-Z0-9 characters only/li>li>code>country/code>: code>string | null/code> Document issuing country, as ISO 3166 alpha-2 code/li>li>code>state/code>: code>string | null/code> Document issuing state, as ISO 3166 alpha-2 or alpha-3 code. code>null/code> when the statedata is not present on the document/li>li>code>validFrom/code>: code>string | null/code> Document is valid from date/li>li>code>validUntil/code>: code>string |  null/code> Document is valid until date/li>li>code>reasonCode/code>: code>integer | null/code> Reason code of failed verification. A table of a href#reference-info-codes-tables>response and error codes/a>/li>li>code>vendorData/code>: code>string/code> End-user-specific data string, max 1000 characters long, created by the customer. Sent backunmodified via API responses and webhooks, or as code>null/code> if not provided/li>li>code>endUserId/code>: code>uuid | null/code> End-user-specific UUID created by the customer to identify the end-user. Returnedunmodified in webhooks and public API calls, or as code>null/code> if not provided/li>li>code>decisionTime/code>: code>string/code> Timestamp of the decision. Combined ISO 8601 date and time in UTC, YYYY-MM-DDTHH:MM:SSS+Timezone Offset/li>li>code>acceptanceTime/code>: code>string/code> Timestamp of the session generation. Combined ISO 8601 date and time in UTC, YYYY-MM-DDTHH:MM:SSS+Timezone Offset/li>li>code>additionalVerifiedData/code>: code>object/code> Data which has been optionally verified for session/li>/ul>/li>li>code>technicalData/code>: code>object/code> Technical data objectul>li>code>ip/code>: code>string | null/code> IP of the device from which the verification was made/li>/ul>/li>/ul>p>strong>Sample response/strong>/p>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>    /span>span classs2>verification/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>12df6045-3846-3e45-946a-14fa6136d78b/span>span classp>,/span>span classw>        /span>span classs2>code/span>span classp>:/span>span classw> /span>span classmi>9001/span>span classp>,/span>span classw>        /span>span classs2>person/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>gender/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>idNumber/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>lastName/span>span classp>:/span>span classw> /span>span classs2>MORGAN/span>span classp>,/span>span classw>            /span>span classs2>addresses/span>span classp>:/span>span classw> /span>span classp>,/span>span classw>            /span>span classs2>firstName/span>span classp>:/span>span classw> /span>span classs2>SARAH/span>span classp>,/span>span classw>            /span>span classs2>citizenship/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>dateOfBirth/span>span classp>:/span>span classw> /span>span classs2>1990-01-09/span>span classp>,/span>span classw>            /span>span classs2>nationality/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>yearOfBirth/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>placeOfBirth/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>pepSanctionMatch/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>        /span>span classp>},/span>span classw>        /span>span classs2>reason/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>        /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>approved/span>span classp>,/span>span classw>        /span>span classs2>comments/span>span classp>:/span>span classw> /span>span classp>,/span>span classw>        /span>span classs2>document/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>type/span>span classp>:/span>span classw> /span>span classs2>DRIVERS_LICENSE/span>span classp>,/span>span classw>            /span>span classs2>state/span>span classp>:/span>span classw> /span>span classs2>NY/span>span classp>,/span>span classw>            /span>span classs2>number/span>span classp>:/span>span classw> /span>span classs2>1234569/span>span classp>,/span>span classw>            /span>span classs2>country/span>span classp>:/span>span classw> /span>span classs2>US/span>span classp>,/span>span classw>            /span>span classs2>validFrom/span>span classp>:/span>span classw> /span>span classs2>2024-04-20/span>span classp>,/span>span classw>            /span>span classs2>validUntil/span>span classp>:/span>span classw> /span>span classs2>2028-04-19/span>span classw>        /span>span classp>},/span>span classw>        /span>span classs2>endUserId/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>        /span>span classs2>reasonCode/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>        /span>span classs2>vendorData/span>span classp>:/span>span classw> /span>span classs2>12345678/span>span classp>,/span>span classw>        /span>span classs2>decisionTime/span>span classp>:/span>span classw> /span>span classs2>2024-08-15T17:57:03.376067Z/span>span classp>,/span>span classw>        /span>span classs2>acceptanceTime/span>span classp>:/span>span classw> /span>span classs2>2024-08-15T17:56:31.021837Z/span>span classp>,/span>span classw>        /span>span classs2>additionalVerifiedData/span>span classp>:/span>span classw> /span>span classp>{}/span>span classw>    /span>span classp>},/span>span classw>    /span>span classs2>technicalData/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classs2>ip/span>span classp>:/span>span classw> /span>span classs2>186.153.67.122/span>span classw>    /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h1 idbiometric-authentication>Biometric Authentication/h1>p>Veriff’s Biometric Authentication solution uses facial biometric analysis and advanced AI to swiftly and securelyverify that the person authenticating themselves is the person they claim they are. This fast and fully automatedprocess can be integrated into any stage of the user journey.Veriff Biometric Authentication is available via API, web flow, and native SDKs./p>h2 idprerequisites>Prerequisites/h2>ul>li>You need to have a strong>selfie enrollment integration/strong> set up/li>li>You need to have an strong>authentication integration/strong> set up and connected to the selfie enrollment integration/li>li>You must strong>generate and attach code>endUserId/code>* or code>vendorData/code>** to each end-user/strong>, and pass Veriff this info/li>li>The end-user needs to have an strong>approved session from the selfie enrollment integration/strong>/li>/ul>p>*If you have generated the unique end-user identifier in the UUID v4 format, we recommend sending it in thecode>endUserID/code> field./p>p>**If you have the unique end-user identifier in a format that is not UUID v4, you can send it in the code>vendorData/code> field./p>h2 idhow-to-set-up-a-biometric-authentication-solution>How to set up a Biometric Authentication solution?/h2>h3 idset-up-the-selfie-enrollment-integration>Set up the selfie enrollment integration/h3>p>To use Veriff’s biometric authentication solution, you first need the strong>selfie enrollment integration/strong>. Read on for moreinformation, but strong>contact your Solutions Engineer for configuration/strong>./p>p>In a hrefhttps://www.innovatrics.com/glossary/enrollment/>general terms/a>↗, strong>enrollment/strong> is a process of capturingbiometrics samples, processing them to create a biometrictemplate and storing the templates onto storage. In Veriff’s case, the strong>enrollment integration/strong> is the one duringwhich the raw biometrics data (e.g., end-user's face image) is processed and converted into a mathematicalbiometric template. The template is stored so it can be used in the future to verify the end-user during a strong>biometricauthentication session/strong>./p>p>The image is taken from an approved IDV session, or a selfie-only session that is run in the enrollment integration. If the sessionis approved (the image quality meets certain criteria, the code>endUserId/code>/code>vendorData/code> is present, there is no suspicion of fraudulentactivity, etc.) the selfie image from the session is stored and can be used as a strong>reference image/strong>./p>h4 idhow-to-pass-selfie-images-to-veriff>How to pass selfie images to Veriff?/h4>p>The image that is used for enrollment (biometric data capturing, processing and conversion into a biometric template)can come from different sources./br>/br>/p>table>  tr>    td styletext-align: center; vertical-align: middle;>b>Customers using the Veriff’s Doc & Selfie IDV solution/b>/td>    td styletext-align: center; vertical-align: middle; colspan2>b>Customers not using Veriff’s Doc & Selfie IDV solution/b>/td>  /tr>  tr>    td>The selfie image taken from an approved IDV session becomes the reference image. It is converted into a biometric      template and stored for future use. It is possible to migrate* images from previous IDV sessions for authentication./td>    td>An IDV/selfie-only session is done inside the biometric enrollment integration. If the session is approved, the selfie        enrollment image is converted into a biometric template and stored for future./td>    td>If existing face images are available: previously collected selfie images become reference images and are        enrolled. This may require migration*./td>  /tr>/table>p>*In cases of migration, contact your Solutions Engineer for more info./p>h3 idset-up-the-authentication-integration>Set up the authentication integration/h3>p>This is the integration that you will use to create biometric authentication sessions for the end-users. It must beconnected to the enrollment integration, so the system has access to the following end-user-related data in the enrollment integration:/p>ul>li>Biometric template/li>li>Approved session data/li>li>code>endUserId/code>/code>vendorData/code>/br>/br>/li>/ul>p>strong>Contact your Solutions Engineer for configuration./strong> Once ready, you can start creating authentication sessions foryour end-users in the SDKs, or send us collected end-user data over the API./p>p>When creating the verification sessions in the SDKs or sending us the end-users’ data over the API, use the strong>API keysand tokens/strong> of the strong>authentication integration/strong> (you can find these in the Veriff environment. See a href#prerequisites-to-create-api-requests>here/a>for more info about how to find the keys and tokens.)/p>p>Make sure to always include the code>endUserId/code>/code>vendorData/code> as we need to see that it matches the end-user’sapproved session’s code>endUserId/code>/code>vendorData/code> in the selfie enrollment integration./p>h2 idhow-to-use-biometric-authentication-over-the-sdk>How to use Biometric Authentication over the SDK?/h2>h3 idstep-by-step-guide>Step-by-step guide/h3>ol>li>Generate an authentication session using the authentication integration tokens (check the a href#post-sessions>POST /sessions/a> endpoint in the API reference)ul>li>Make sure that you include the same code>endUserId/code>/code>vendorData/code> that you used in the enrollment integration session/li>/ul>/li>li>Capture end-user’s face images with Veriff’s SDKsul>li>Send the end-user through the verification flow to capture the new face image (using one of Veriff SDKs: iOS, Android, React Native, Flutter, InContext)/li>li>You need the session URL generated in step 1 to use the SDKs/li>li>Session will be submitted automatically once the end-user takes and submits necessary images of their face/li>/ul>/li>li>Receive the results from Veriff via a href#decision-webhook>decision webhook/a>/li>/ol>h3 idfrom-the-end-user-point-of-view>From the end-user point of view/h3>p>When the end-user needs to authenticate, they simply take a selfie using their device camera. A new template is createdand compared against the stored template from enrollment. If they match within a set accuracy threshold, and thecode>endUserId/code>/code>vendorData/code> in the enrollment integration session match that in the authentication integration session, the useris successfully identified./p>h2 idhow-to-use-biometric-authentication-over-the-api>How to use Biometric Authentication over the API?/h2>p>This is applicable once the end-user has an approved session containing a populated code>endUserID/code>/code>vendorData/code>./p>h3 idstep-by-step-guide>Step-by-step guide/h3>ol>li>Generate an authentication session using the authentication integration tokens (check the a href#post-sessions>POST /sessions/a> endpoint in the API reference)ul>li>Make sure that you include the same code>endUserId/code>/code>vendorData/code> that you used in the enrollment integration session/li>/ul>/li>li>Use your face-capturing method, or prepare previously collected end-user face images/li>li>Upload the end-user's face image via the a href#post-sessions-sessionid-media>POST /sessions/{sessionId/}media/a> call. Specify a href#image-context-types>context parameter/a> as code>face/code>./li>li>Patch session status to code>submitted/code> status using a href#patch-sessions-sessionid>PATCH /sessions/{sessionId}/a> call/li>li>Receive the results from Veriff via a href#decision-webhook>decision webhook/a>/li>/ol>h2 idhow-to-get-the-verification-results>How to get the verification results?/h2>p>All biometric authentication results are returned via the strong>decision webhook/strong>, inside thecode>verification.biometricAuthentication/code> object./p>p>If the session was declined, you can find additional information by checking the code>verification.status/code>,code>verification.code/code>, code>verification.reason/code> and code>verification.reasonCode/code> data objects./p>h3 idrequest-properties>Request properties/h3>ul>li>code>status/code>: code>string/code> Status of the response/li>li>code>verification/code>: code>object/code> Verification request decision objectul>li>  …/li>li>code>endUserId/code>: code>UUID v4 | null/code> End-user-specific UUID v4 created by the customer to identify the end-user. Returnedunmodified in webhooks and public API calls, or as code>null/code> if not provided/li>li>code>vendorData/code>: code>string | null/code> End-user-specific string created by the customer to identify the end-user. Returnedunmodified in webhooks and public API calls, or as code>null/code> if not provided/li>li>code>status/code>: code>string/code> Verification status, one of code>approved/code>, code>resubmission_requested/code>, code>review/code>, code>declined/code>, code>expired/code>, code>abandoned/code>/li>li>code>code/code>: code>integer/code> Verification session decision code, one of code>9001/code>, code>9102/code>, code>9103/code>, code>9104/code>, code>9121/code>. a href#verification-session-status-and-decision-codes>More information aboutverification session decision codes/a>/li>li>code>reason/code>: code>string | null/code> Reason of failed verification/li>li>code>reasonCode/code>: code>string | null/code> Reason code of failed verification/li>li>code>biometricAuthentication/code>: code>object/code> Object containing data about the biometric authenticationul>li>code>matchedSessionId/code>: code>string | null/code> Refers to the verification session ID which the face matched/li>li>code>matchedSessionEndUserId/code>: code>string | null/code> Refers to the verification session code>endUserId/code>which the face matched/li>li>code>matchedSessionVendorData/code>: code>string | null/code> Refers to the verification session code>vendorData/code> which the face matched/li>li>code>details/code>: code>object/code> Lists the results of different checks that were made to verify the end-user. If you havebeen granted access to the Veriff environment, you can find these in the a hrefhttps://help.veriff.com/en/articles/9638913-biometric-authentication-results-in-decision-webhook>detailed request explanation/a>↗./li>/ul>/li>/ul>/li>/ul>h3 idsample-request-properties>Sample request properties/h3>pre classhighlight plaintext>code>{    status: success,    verification: {        ...        endUserId: a1b2c35d-e8f7-6d5e-3cd2-a1b2c35db3d4,        vendorData: 12345678,        status: approved,        code: 9001,        reason: null,        reasonCode: null        biometricAuthentication: {            matchedSessionId: d40edb60-6ae6-...,            matchedSessionEndUserId: a1b2c35d-e8f7-6d5e-3cd2-a1b2c35db3d4,            matchedSessionVendorData: 12345678,            details: {                  ...            }        },        ...    }}/code>/pre>h2 idhow-to-handle-authentication-integration-statuses-and-decisions>How to handle authentication integration statuses and decisions?/h2>h3 idbiometric-authentication-session-status-and-status-code>Biometric authentication session status and status code/h3>p>These values are available in the decision webhook payload, in code>verification.status/code> and code>verification.code/code> dataobjects./p>table>    tr>        td>code>verification.status/code>/td>        td>code>verification.code/code>/td>        td>b>What does it mean?/b>/td>    /tr>        td>approved/td>        td>9001/td>        td>Positive: end-user was verified. The verification process is complete. Accessing the sessionURL again will            show the end-user that nothing is to be done here./td>    tr>        td>declined/td>        td>9102/td>        td>Negative: end-user has not been verified. The verification process is complete.            Either it was a fraud case or some other severe reason that the end-user can not be verified. It could also            have been that due to a bad image quality the end-user could not be matched.            If you decide to give the end-user another try, you need to create a new session.        /td>    /tr>        td>expired/td>        td rowspan2>9104/td>        td>Negative: Verification has expired. The verification process is complete.            After the session creation, if the end-user has not started the verification in 7 days, the session gets expired.            /td>    tr>        td>abandoned/td>        td>Negative: Verification has been abandoned. The verification process is complete.            After the session creation, if the end-user has started but not completed the verification in 7 days, the session gets abandoned status.            /td>    /tr>/table>h3 idbiometric-authentication-session-decision-reason-and-reason-codes>Biometric authentication session decision reason and reason codes/h3>p>These values are available in the decision webhook payload, in code>verification.status/code>, code>verification.reasonCode/code> andcode>verification.reason/code> data objects./p>table>    tr>        td>code>verification.status/code>/td>        td>code>verification.reasonCode/code>/td>        td>code>verification.reason/code>/td>        td>b>What does it mean?/b>/td>    /tr>    tr>        td>declined/td>        td>105/td>        td>Decline - Suspicious behavior/td>        td>The session contains some suspicious behaviour, for example the face image is shown from a device, screen            or print-out. The end-user is declined./td>    /tr>    tr>        td>declined/td>        td>106/td>        td>Decline - Known fraud/td>        td>The session contains fraudulent behaviour, for example the photos are streamed. The end-user is declined./td>    /tr>    tr>        td>declined/td>        td>120/td>        td>Decline - Person on the portrait does not appear to match reference photo/td>        td>The end-user is declined/td>    /tr>    tr>        td>declined/td>        td>121/td>        td>Decline - user ID missing/td>        td>The code>vendorData/code> does not match the code>vendorData/code> used during enrollment, the end-user            is declined. To avoid this issue, ensure the same code>vendorData/code> is sent.          /td>    /tr>    tr>        td>declined/td>        td>122/td>        td>Decline - No reference found/td>        td>No enrollment face image (reference image) found that would match the code>endUserId/code>/code>vendorData/code>,            the end-user is declined./td>    /tr>    tr>        td>declined/td>        td>128/td>        td>Decline - code>endUserId/code> mismatch/td>        td>The code>endUserId/code> does not match the code>endUserId/code> used during enrollment, the end-user            is declined. To avoid this issue, ensure the same code>endUserId/code> is sent.          /td>    /tr>    tr>        td>expired/td>        td rowspan2>null/td>        td rowspan2>null/td>        td rowspan2>The end-user did not complete the verification flow. If you want to let them to try again,                        create a new session for them/td>    /tr>    tr>      td>abandoned/td>    /tr>/table>h1 idaml-screening>AML Screening/h1>h2 idpep-amp-sanction-screening-with-idv>PEP & Sanction screening with IDV/h2>p>PEP & Sanctions, adverse media screening together with identity verification/p>h4 idprerequisites>Prerequisites/h4>p>An strong>IDV integration/strong> with strong>PEP & Sanctions/strong> checks configured together with optionalstrong>adverse media checks/strong> and strong>ongoing monitoring/strong>. Turn to your dedicated Solutions Engineer for configuration./p>h4 idprocess-overview>Process overview/h4>ol>li>Once the integration is set up, strong>generate a verification session/strong> using the regular a href/#post-sessions>/sessions/a> endpoint./li>li>After the end-user has submitted the verification flow and the session has been verified,the AML result will be strong>sent in a separate/strong> a href/#watchlist-screening-webhook>webhook/a>. You can also query for theresult using the a href#get-sessions-sessionid-watchlist-screening>watchlist-screening API/a> endpoint/li>li>In case strong>ongoing monitoring/strong> is strong>enabled/strong>, we will send a new webhook if the PEP & Sanctions status of a verified person has changed./br>a. The Webhook PEP & Sanctions URL can be configured from the “Integrations” menu/li>/ol>h2 idpep-amp-sanction-screening-without-idv>PEP & Sanction screening without IDV/h2>p>PEP & Sanctions, adverse media screening without identity verification/p>h4 idprerequisites-2>Prerequisites/h4>p>A strong>non-IDV integration/strong> with strong>PEP & Sanctions/strong> checks configured together with optional strong>adverse media checks/strong>and strong>ongoing monitoring/strong>. Turn to your dedicated Solutions Engineer for configuration./p>h4 idprocess-overview-2>Process overview/h4>ol>li>Generate a strong>new verification session/strong> using the a href/#post-sessions>/sessions/a> endpoint andspecify the following fields in the request:/br>a. First name (required)/br>b. Last name (required)/br>c. Date of Birth (optional)/br>/li>li>strong>Change the status of the session to “Submitted”/strong> using a href/#patch-sessions-sessionid>PATCH /sessions/{sessionId}/a> endpoint /li>li>The results will be strong>sent in a separate/strong> a href/#watchlist-screening-webhook>webhook/a> and are also availableusing the a href/#get-sessions-sessionid-watchlist-screening>/watchlist-screening/a> end-point./br>a. The Webhook PEP & Sanctions URL can be configured from the “Integrations” menu/li>/ol>h1 iduk-diatf>UK DIATF/h1>p>Veriff is a certified IDSP under the strong>UK Digital Identity and Attributes Trust Framework (UK DIATF)/strong>,a hrefhttps://www.gov.uk/government/publications/uk-digital-identity-attributes-trust-framework-updated-version/trust-framework-certification>UK Government site/a>↗/p>p>Within the framework of UK DIATF, we offer the following solutions:/p>ul>li>strong>a href#ukdiatf-certified-identity-verification-m1a>UKDIATF Certified Identity Verification (M1A)/a>/strong> - used with Veriff’send-user flow (cannot be customized); no mandatory fields, 1 registry check: CIFAS/li>li>strong>a href#ukdiatf-certified-identity-verification-m1b>UKDIATF Certified Identity Verification (M1B)/a>/strong> - used with Veriff’send-user flow (cannot be customized), sending the address is mandatory; 3 registry checks: CIFAS, PEP and UK Electoral roll/li>li>strong>a href#ukdiatf-certified-identity-verification-l1b>UKDIATF Certified Identity Verification (L1B)/a>/strong> - used with Veriff'send-user flow (can be customized); no mandatory fields, no registry checks/li>/ul>aside classnotice>Please ask your b>solutions engineer/b> to configure the feature for your integration./aside>h3 idukdiatf-certified-identity-verification-m1a>UKDIATF Certified Identity Verification (M1A)/h3>p>This is a solution that is completed using Veriff’s end-user flow (cannot be customized). strong>Sending the address onsession creation is optional/strong>./p>p>Below is a step-by-step overview of the flow./p>h5 idstep-1-create-a-session-using-the-post-sessions-endpoint>Step 1: create a session using the POST /sessions endpoint/h5>p>See the a href#post-sessions>POST /sessions/a> section for a detailed overview of how to create a session.Sending the code>verification.address.fullAddress/code> parameter is strong>optional/strong>./p>h6 idstep-2-create-a-session-using-the-post-sessions-endpoint>Step 2: create a session using the POST /sessions endpoint/h6>p>Open the response payload of the a href#post-sessions>POST /sessions/a> request you just made and use the URL in the code>verification.url/code> parameter.A web flow will start, which will guide you through the process./p>h6 idstep-3-wait-for-session-decision-and-decision-webhook-response>Step 3: wait for session decision and decision webhook response/h6>p>As soon as the session is verified, the decision webhook will send the response with session status. It will be oneof a href#session-status>9000-code/a> statuses./p>p>In case the session is strong>declined/strong>, the webhook contains relevant info about the reason. This info is visible incode>verification.code/code>, code>verification.reason/code>, and code>verification.reasonCode/code> parameters./p>h4 idm1a-webhook-response>M1A webhook response/h4>p>M1A Webhook response  decision webhook response (see documentation a href#decision-webhook>here/a>)/p>h3 idukdiatf-certified-identity-verification-m1b>UKDIATF Certified Identity Verification (M1B)/h3>p>This is a solution that requires that the strong>end-user's address is provided/strong> to return info from registries,and that the flow must be completed using Veriff's verification flow (cannot be customized).Below is a step-by-step overview of the flow./p>h5 idstep-1-create-a-session-using-the-post-sessions-endpoint>Step 1: create a session using the POST /sessions endpoint/h5>p>See the a href#post-sessions>POST /sessions/a> section for a detailed overview of how to create a session.Sending the code>verification.address.fullAddress/code> parameter is strong>mandatory/strong>./p>h5 idstep-2-capture-user-pictures-and-videos-via-verification-flow>Step 2: capture user pictures and videos via verification flow/h5>p>Open the response payload of the a href#post-sessions>POST /sessions/a> request you just made and use the URLin the code>verification.url parameter/code>. A web flow will start, which will guide you through the process./p>h5 idstep-3-wait-for-session-approval-and-decision-webhook-response>Step 3: wait for session approval and decision webhook response/h5>p>As soon as the session is approved, the decision webhook will send an approved response./p>p>This response will include the session status, as well as all the data that was extracted from the UK DIATF checks.This info is visible in code>verification.additionalVerifiedData.UKTFCheckResult/code> array./p>p>In case the session is em>declined/em>, the webhook contains relevant info about the reason. This info is visiblein code>verification.code/code>, code>verification.reason/code>, code>verification.reasonCode/code> and code>verification.additionalVerifiedData.UKTFCheckResult/code> parameters./p>h4 idm1b-webhook-response>M1B webhook response/h4>p>strong>Response properties explained/strong>/p>ul>li>code>status/code>: code>string/code> Status of the response/li>li>code>verification/code>: code>object/code> Verification request decision objectul>li>…/li>li>code>additionalVerifiedData/code>: code>object/code> Data which has been optionally verified for sessionul>li>code>UKTFCheckResult/code>: code>array/code> Array of UK DIATF checks results. These are executed in succession. If the precedingcheck fails, the succeeding one is skipped. The order is as shown below, but in webhook response the ordermay be random.ul>li>code>CIFAS/code>: code>string/code> CIFAS registry check result/li>li>code>Electoral roll and Credit History UK/code>: code>string/code> UK Electoral Roll and Credit History check result/li>li>code>PEP/code>: code>string/code> PEP check result./li>/ul>/li>/ul>/li>/ul>/li>/ul>p>strong>Example response of approved session/strong>/p>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>    /span>span classs2>verification/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classerr>…/span>span classw>        /span>span classs2>additionalVerifiedData/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>UKTFCheckResult/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                /span>span classs2>CIFAS/span>span classp>:/span>span classw> /span>span classs2>Registry validation was successful/span>span classp>,/span>span classw>                /span>span classs2>Electoral roll and Credit History UK/span>span classp>:/span>span classw> /span>span classs2>Registry validation was successful/span>span classw>                /span>span classs2>PEP/span>span classp>:/span>span classw> /span>span classs2>Registry validation was successful/span>span classp>,/span>span classw>            /span>span classp>}/span>span classw>        /span>span classp>}/span>span classw>    /span>span classp>},/span>span classw>    /span>span classerr>…/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>p>strong>Example responses of declined session due to failed CIFAS check/strong>/p>p>Scenario: there may be a possible match in the CIFAS database/p>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>    /span>span classs2>verification/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classerr>…/span>span classw>        /span>span classs2>additionalVerifiedData/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>UKTFCheckResult/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                /span>span classs2>CIFAS/span>span classp>:/span>span classw> /span>span classs2>CIFAS registry detected a potential match./span>span classp>,/span>span classw>                /span>span classs2>Electoral roll and Credit History UK/span>span classp>:/span>span classw> /span>span classs2>Registry check did not result in a match/span>span classw>                /span>span classs2>PEP/span>span classp>:/span>span classw> /span>span classs2>Registry check was not executed/span>span classp>,/span>span classw>            /span>span classp>}/span>span classw>        /span>span classp>}/span>span classw>    /span>span classp>},/span>span classw>    /span>span classerr>…/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>p>strong>Example responses of declined session due to UK Electoral Roll and Credit History check/strong>/p>p>Scenario: the end-user data may be incorrect or missing in the database/p>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>    /span>span classs2>verification/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classerr>…/span>span classw>        /span>span classs2>additionalVerifiedData/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>UKTFCheckResult/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                /span>span classs2>CIFAS/span>span classp>:/span>span classw> /span>span classs2>Registry validation was successful/span>span classp>,/span>span classw>                /span>span classs2>Electoral roll and Credit History UK/span>span classp>:/span>span classw> /span>span classs2>Registry check did not result in a match/span>span classw>                /span>span classs2>PEP/span>span classp>:/span>span classw> /span>span classs2>Registry check was not executed/span>span classp>,/span>span classw>            /span>span classp>}/span>span classw>        /span>span classp>}/span>span classw>    /span>span classp>},/span>span classw>    /span>span classerr>…/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>p>strong>Example responses of declined session due to failed PEP check/strong>/p>p>Scenario: end-user detected as potential PEP/p>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>    /span>span classs2>verification/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classerr>…/span>span classw>        /span>span classs2>additionalVerifiedData/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>UKTFCheckResult/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                /span>span classs2>CIFAS/span>span classp>:/span>span classw> /span>span classs2>Registry validation was successful/span>span classp>,/span>span classw>                /span>span classs2>Electoral roll and Credit History UK/span>span classp>:/span>span classw> /span>span classs2>Registry validation was successful/span>span classw>                /span>span classs2>PEP/span>span classp>:/span>span classw> /span>span classs2>Person detected to be potentially a PEP/span>span classp>,/span>span classw>            /span>span classp>}/span>span classw>        /span>span classp>}/span>span classw>    /span>span classp>},/span>span classw>    /span>span classerr>…/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h3 idukdiatf-certified-identity-verification-l1b>UKDIATF Certified Identity Verification (L1B)/h3>p>The solution is a UK-certified version of Veriff’s standard identity verification. You must use Veriff’s end-user flowto capture the document & selfie, but you can customize the flow./p>p>If you are not integrated with us yet, see the a href#getting-started-with-veriff>Getting started with Veriff/a>for first steps. If you are, contact your Solutions Engineer for info and configuration./p>h1 idage-estimation>Age Estimation/h1>p>This solution estimates end-user's age from the selfie images that they capture. Customers receive theend-user's strong>estimated age/strong> and strong>estimated gender/strong>./p>aside classnotice>A separate integration is needed for this feature, please ask you b>Solutions Engineer/b> to set it up./aside>h2 idage-estimation-process-overview>Age Estimation process overview/h2>p>There are two different ways to utiliaze the strong>Age Estimation service/strong>: via Veriff's verification flow or trough API./p>h3 idage-estimation-via-veriff-39-s-verification-flow>Age Estimation via Veriff's verification flow/h3>ol>li>Create a session using the Age Estimation integration's tokens (see a href#post-sessions>POST /sessions/a> for more detailsabout how to create a session)ul>li>You can use code>vendorData/code> or code>endUserId/code> parameter to pass a unique identifier for the end-user in the flow. We require onlynon-semantic data to be submitted (e.g. UUID-s that can not be resolved or used outside the customer's environment)./li>/ul>/li>li>Direct the end-user into the verification flow/li>li>The end-user passes through the verification flow on their device, where they are required to capture only a selfie(no ID document is needed)/li>li>Session will be automatically set to code>submitted/code>/li>li>Receive the results from Veriff via a href#decision-webhook>decision webhook/a>; you can also query them usinga href#get-sessions-sessionid-decision>GET sessions/{sessionId/decision}/a>/li>/ol>h3 idage-estimation-over-the-api>Age Estimation over the API/h3>ol>li>Create a session using the Age Estimation integration's tokens (see a href#post-sessions>POST /sessions/a> for more detailsabout how to create a session)ul>li>You can use code>vendorData/code> or code>endUserId/code> parameter to pass a unique identifier for the end-user in the flow. We require onlynon-semantic data to be submitted (e.g. UUID-s that can not be resolved or used outside the customer's environment)./li>/ul>/li>li>Upload the end users selfie via a href#post-sessions-sessionid-media>POST sessions/{sessionId}/media/a> endpoint withcode>image.context/code> as code>face/code>/li>li>Patch the session to code>submitted/code> using the a href#patch-sessions-sessionid>PATCH sessions/{sessionId}/a>/li>li>Receive the results from Veriff via a href#decision-webhook>decision webhook/a>; you can also query them usinga href#get-sessions-sessionid-decision>GET sessions/{sessionId/decision}/a>/li>/ol>p>br/>/p>p>In the webhook and the endpoint, the data is in:/p>ul>li>code>verification.additionalVerifiedData.estimatedAge/code> as a code>number/code> of the estimated exact age/li>li>code>verification.additionalVerifiedData.estimatedGender/code> as a code>number/code> of the estimated* gender./li>/ul>p>*Values closer to 0.0 indicate that the end-user is likely to be male, values closer to 1.0 indicate that  the end-user is likely to be female./p>h2 idage-estimation-session-decisions>Age Estimation session decisions/h2>p>The code>verification.status/code> and code>verification.code/code> can be:/p>ul>li>code>approved/code>, code 9001/li>li>code>declined/code>, code 9102/li>li>code>resubmission/code> aka code>resubmission_requested/code>, code 9104/li>/ul>h2 idend-user-in-the-age-estimation-flow-diagram>End-user in the Age Estimation flow (diagram)/h2>p>img srcimages/end-user-in-age-estimation-flow.jpg alt />/p>h1 idproof-of-address-capture>Proof of Address Capture/h1>p>strong>Proof of Address Capture/strong> (strong>PoA Capture/strong>) feature captures the submitted document. No further analysis is performed./p>p>The flow is completed using several IDV endpoints./p>aside classnotice>Please ask your b>solutions engineer/b> to configure the feature for your integration./aside>h4 idbrief-overview-of-the-flow>Brief overview of the flow/h4>ol>li>Submit a session using the strong>POST sessions/strong> endpoint/li>li>Make a strong>POST /sessions/{sessionId}/media/strong> request to send image file/li>li>Update the session status to "submitted" using the strong>PATCH /sessions/{sessionId}/strong>/li>li>Now you can now use the following endpoints to query the document info:ul>li>strong>GET /sessions/{sessionId}/media/strong>/li>li>strong>GET /attempts/{attemptId}/media/strong>/li>li>strong>GET /media/{mediaId}/strong>/li>/ul>/li>/ol>h4 idstep-by-step-overview-of-the-flow>Step-by-step overview of the flow/h4>p>Click on the step to expand./p>div classexpandable>    details>        summary classexpandable-title>            span classicon>▸/span>b>Step 1: submit a session using the POST /sessions endpoint/b>        /summary>        div idexpandable-content classexpandable-content>            p>                br/>            p>                See the a href#post-sessions>POST /sessions/a> section for detailed overview of                how to create a session.            /p>            br/>        /div>    /details>/div>div classexpandable>    details>        summary classexpandable-title>            span classicon>▸/span>b>Step 2: make a POST /sessions/{sessionId}/media request/b>        /summary>        div idexpandable-content classexpandable-content>            p>                 br/>                 You can use this endpoint to send any number of image files (also for purposes other than b>PoA Capture/b>),                 but you need to upload them one at a time. Also, if you post several image files, make sure that the                 b>value of code>image.context/code> parameter/b> of the b>image relevant to the PoA Capture flow/b>                 is b>document-front/b>, otherwise the b>PoA Capture/b> flow will not work.br/>            /p>                h4>Request/h4>            p>                b>Request method/b>: POSTbr/>                b>Media type/b>: application/jsonbr/>                b>Type/b>: objectbr/>                b>Headers/b>:br/>            /p>                    ul>                        li>code>X-AUTH-CLIENT: string/code> (required)  b>API key/b>/li>                        li>code>X-HMAC-SIGNATURE: string/code> (required)  Request body signed with the b>shared secret key/b>br/>/li>                        li>code>Content-Type: application/json/code>/li>                    /ul>                h5>Request properties explained/h5>            p>                ul>                    li>                        code>image/code>: code>object/code> (required)                    /li>                        ul>                            li>                                code>context/code>: code>string/code> (required) In this case, it must be document-front                            /li>                            li>                                code>content/code>: code>string/code> (required) base64 encoded image (.jpg, .jpeg,                                 .png, .heif, .heic, .webp and .pdf formats are supported)                            /li>                        /ul>            /p>                /ul>                h5>Sample request body/h5>            pre>curlcurl -X POST \  --url /v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/media \  -H Content-Type: application/json \  -H X-AUTH-CLIENT: API-PUBLIC-KEY \  -H X-HMAC-SIGNATURE: 034c6da2bb31fd9e6892516c6d7b90ebe10f79b47cfb3d155d77b4d9b66e1d53 \  -d {    image: {        context: document-front,        content: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA+.../9fgAEAKcxisFjVfn0AAAAASUVORK5CYII    }}            /pre>            p>                See the a href#post-sessions-sessionid-media>POST /sessions/{sessionId}/media/a> endpoints b>Response/b>                 section for overview and explanation of the response body.            /p>            br/>        /div>    /details>/div>div classexpandable>    details>        summary classexpandable-title>            span classicon>▸/span>b>Step 3: update the session status to submitted/b>        /summary>        div idexpandable-content classexpandable-content>            br/>            p>                Use the a href#patch-sessions-sessionid>PATCH sessions/{sessionId}/a> endpoint to update the session                status to submitted. See the endpoints description for detailed overview of how to update the session                status.            /p>            br/>        /div>    /details>/div>div classexpandable>    details>        summary classexpandable-title>            span classicon>▸/span>b>Step 4: use endpoints to query b>PoA/b> document info/b>        /summary>        div idexpandable-content classexpandable-content>            br/>            p>                When the steps above have been successfully completed, you can use the following endpoints to                query the document info:            /p>                ul>                    li>                        a href#get-sessions-sessionid-media>GET /sessions/{sessionId}/media/a> - returns list of                        media objects and address media with the code>sessionId/code>                                            /li>                    li>                        a href#get-attempts-attemptid-media>GET /attempts/{attemptId}/media/a> - returns list of                        media objects and address media with the code>attemptId/code>.                     /li>                    li>                        a href#get-media-mediaid>GET /media/{mediaId}/a> - returns a media file with the                         code>mediaId/code>                    /li>                /ul>            p>                Note: to find the relevant code>attemptId/code>, check the code>attemptId/code> parameter in the                 b>Event webhook response/b>.             /p>            br/>        /div>    /details>/div>h1 idproof-of-address-extraction>Proof of Address Extraction/h1>p>strong>Proof of Address Extraction/strong> (strong>PoA Extraction/strong>) feature captures the submitted document and extracts thecode>firstName/code>, code>fullAddress/code> and code>document.validFrom/code> data from it./p>p>The flow is completed using several IDV endpoints./p>aside classnotice>Please ask your b>solutions engineer/b> to configure the feature for your integration./aside>p>It is possible to get the additional name match check enabled for your integration. See the a href#optional-proof-of-address-name-match-check>Optional Proof of Address name match check/a>section below for more info./p>h2 idbrief-overview-of-the-poa-extraction-flow>Brief overview of the PoA Extraction flow/h2>ol>li>Submit a session using the strong>POST sessions/strong> endpoint/li>li>Make a strong>POST /sessions/{sessionId}/media/strong> request to send image file/li>li>Update the session status to "submitted" using the strong>PATCH /sessions/{sessionId}/strong>/li>li>Wait for the session to be approved and decision webhook to send response/li>li>Now you can now use the following endpoints to query the document info:ul>li>strong>GET /sessions/{sessionId}/media/strong>/li>li>strong>GET /attempts/{attemptId}/media/strong>/li>li>strong>GET /media/{mediaId}/strong>/li>/ul>/li>/ol>h2 idstep-by-step-overview-of-the-poa-extraction-flow>Step-by-step overview of the PoA Extraction flow/h2>h3 idpoa-extraction-step-1-submit-a-session-using-the-post-sessions-endpoint>PoA Extraction step 1: submit a session using the POST /sessions endpoint/h3>p>See the a href#post-sessions>POST /sessions/a> section for detailed overview of how to create a session./p>h3 idpoa-extraction-step-2-make-a-post-sessions-sessionid-media-request>PoA Extraction step 2: make a POST /sessions/{sessionId}/media request/h3>p>You can use this endpoint to send any number of image files (also for purposes other than strong>PoA Extraction/strong>),but you need to upload them one at a time. Also, if you post several image files, make sure that thestrong>value of code>image.context/code> parameter/strong> of the strong>image relevant to the PoA Extraction flow/strong>is strong>"document-front"/strong>, otherwise the strong>PoA Extraction/strong> flow will not work./p>p>strong>Request/strong>/p>p>strong>Request method/strong>: POST/br>strong>Media type/strong>: application/json/br>strong>Type/strong>: object/br>strong>Headers/strong>:/br>code>X-AUTH-CLIENT/code>: code>string/code> (required)  strong>API key/strong>/br>code>X-HMAC-SIGNATURE/code>: code>string/code> (required)  Request body signed with the strong>shared secret key/strong>/br>code>Content-Type/code>: code>application/json/code>/p>p>/br>/p>p>strong>Request properties explained/strong>/p>ul>li>code>image/code>: code>object/code> (required)ul>li>code>context/code>: code>string/code> (required) In this case, it must be "document-front"/li>li>code>content/code>: code>string/code> (required) base64 encoded image (.jpg, .jpeg, .png, .heif, .heic, .webp and .pdf formats aresupported)/li>/ul>/li>/ul>p>/br>/p>p>strong>Sample request body/strong>/p>pre classhighlight plaintext>code>curl -X POST \  --url /v1/sessions/aea9ba6d-1b47-47fc-a4fc-f72b6d3584a7/media \  -H Content-Type: application/json \  -H X-AUTH-CLIENT: API-PUBLIC-KEY \  -H X-HMAC-SIGNATURE: 034c6da2bb31fd9e6892516c6d7b90ebe10f79b47cfb3d155d77b4d9b66e1d53 \  -d {    image: {        context: document-front,        content: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA+.../9fgAEAKcxisFjVfn0AAAAASUVORK5CYII    }}/code>/pre>h3 idpoa-extraction-step-3-update-the-session-status-to-quot-submitted-quot>PoA Extraction step 3: update the session status to "submitted"/h3>p>Use the a href#patch-sessions-sessionid>PATCH sessions/{sessionId}/a> endpoint to update the session status to "submitted".See the endpoint's description for detailed overview of how to update the session status./p>p>Once done, an event webhook with submitted status will be sent. See the "Verification webhooks" section ina href#event-webhook>Event webhooks/a> for more info./p>h3 idpoa-extraction-step-4-wait-for-session-approval-and-decision-webhook-response>PoA Extraction step 4: wait for session approval and decision webhook response/h3>p>As soon as the session is approved, the decision webhook will send an approved response. This response will include thesession status, as well as all the data that was extracted from the PoA document./p>p>/br>/p>p>strong>Webhook payload/strong>/p>p>strong>Request properties explained/strong>/p>ul>li>code>status/code>: code>string/code> Status of the response/li>li>code>verification/code>: code>object/code> Verification request decision objectul>li>code>id/code>: code>string | null/code>UUID v4 which identifies the verification session/li>li>code>code/code>: code>integer/code> Verification response code, one of 9001, 9102, 9103, 9104, 9121. See a href#common-http-status-codes>here/a>for more information about decision codes/li>li>code>person/code>: code>object/code> List of verified person's dataul>li>code>gender/code>: code>string | null/code> (one of M, F or code>null/code>) Person's gender/li>li>code>idNumber/code>: code>string | null/code> National identification number/li>li>code>firstName/code>: code>string | null/code> Person's first name as written on the document, if available/li>li>code>lastName/code>: code>string | null/code> Person's last name. code>null/code> unless prefilled by the customer/li>li>code>addresses/code>: code>array/code> Array of person's addressesul>li>code>fullAddress/code>: code>string | null/code> Person's full address/li>/ul>/li>li>code>citizenship/code>: code>string | null/code> Person's citizenship/li>li>code>dateOfBirth/code>: code>string | null/code> Person's date of birth/li>li>code>nationality/code>: code>string | null/code> Person's nationality/li>li>code>yearOfBirth/code>: code>string | null/code> (YYYY-MM-DD) Person's date of birth/li>li>code>placeOfBirth/code>: code>string | null/code> Person's place of birth/li>li>em>code>pepSanctionMatch/code>: code>string | null/code> Legacy field, may not be up-do-date, should be ignored/em>/li>/ul>/li>li>code>reason/code>: code>string | null/code> Reason of failed verification/li>li>code>status/code>: code>string | null/code> Verification status, one of code>approved/code>, code>resubmission_requested/code>, code>review/code>, code>declined/code>,code>expired/code>, code>abandoned/code>/li>li>em>code>comments/code>: code>array/code> (Deprecated)/em>/li>li>code>document/code>: code>object/code> List of data about the verified documentul>li>code>type/code>: code>string | null/code> Document type/li>li>code>number/code>: code>string | null/code> Document number, a-zA-Z0-9 characters only/li>li>code>country/code>: code>string | null/code> ISO-2 Document country/li>li>code>validFrom/code>: code>string | null/code> Document is valid from date/li>li>code>validUntil/code>: code>string | null/code> Document is valid until date/li>/ul>/li>li>code>reasonCode/code>: code>string | null/code> Reason code of failed Verification. (See a href#common-http-status-codes>Response and error codes/a>/li>li>code>vendorData/code>: code>string | null/code> End-user-specific data string, max 1000 characters long, created by thecustomer. Sent back unmodified via API responses and webhooks, or as code>null/code> if not provided/li>li>code>endUserId/code>: code>string | null/code> End-user-specific UUID, created by the customer. Sent back unmodified via APIresponses and webhooks or as code>null/code> if not provided/li>li>code>decisionTime/code>: code>string | null/code> Timestamp of the decision. Combined ISO 8601 date and time in UTCYYYY-MM-DDTHH:MM:SS.SSSSSS+Timezone Offset/li>li>code>acceptanceTime/code>: code>string | null/code> Timestamp of the session generation. Combined ISO 8601 date and time inUTC YYYY-MM-DDTHH:MM:SSS+Timezone Offset/li>li>code>additionalVerifiedData/code>: code>object/code> Data which has been optionally verified for sessionul>li>code>proofOfAddress/code>: code>object/code> Proof of address data. Optional, available only if the name match check has beenenabled for the integrationul>li>code>nameMatch/code>: code>boolean/code> Indicates if the name on the proof of address document matches the name from theinitial request data. code>null/code> if the check could not be completed./li>li>code>nameMatchPercentage/code>: code>float/code> Indicates the level of similarity the matched names have, in the rangeof 0.00-100.00. code>null/code> if the check could not be completed./li>/ul>/li>/ul>/li>/ul>/li>li>code>technicalData/code>: code>object/code> Technical dataul>li>code>ip/code>: code>string | null/code> IP of the device from which the verification was made/li>/ul>/li>/ul>p>strong>Sample request/strong>/p>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>    /span>span classs2>verification/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>ab1c2345-678d-4e3b-98a3-a75b00b715kj/span>span classp>,/span>span classw>        /span>span classs2>code/span>span classp>:/span>span classw> /span>span classmi>9001/span>span classp>,/span>span classw>        /span>span classs2>person/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>gender/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>idNumber/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>firstName/span>span classp>:/span>span classw> /span>span classs2>Jane Doe/span>span classp>,/span>span classw>            /span>span classs2>lastName/span>span classp>:/span>span classw> /span>span classs2>null/span>span classp>,/span>span classw>            /span>span classs2>addresses/span>span classp>:/span>span classw> /span>span classp>/span>span classw>                /span>span classp>{/span>span classw>                    /span>span classs2>fullAddress/span>span classp>:/span>span classw> /span>span classs2>Jaan Koorti 777, 99999 Tallinn, Estonia/span>span classw>                /span>span classp>}/span>span classw>            /span>span classp>,/span>span classw>            /span>span classs2>citizenship/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>dateOfBirth/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>nationality/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>yearOfBirth/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>placeOfBirth/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>pepSanctionMatch/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>        /span>span classp>},/span>span classw>        /span>span classs2>reason/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>        /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>approved/span>span classp>,/span>span classw>        /span>span classs2>comments/span>span classp>:/span>span classw> /span>span classp>,/span>span classw>        /span>span classs2>document/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>type/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>number/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>country/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>            /span>span classs2>validFrom/span>span classp>:/span>span classw> /span>span classs2>2022-11-25/span>span classp>,/span>span classw>            /span>span classs2>validUntil/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>        /span>span classp>},/span>span classw>        /span>span classs2>reasonCode/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>        /span>span classs2>vendorData/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>        /span>span classs2>endUserId/span>span classp>:/span>span classw> /span>span classs2>fa820aba-019f-455a-ae81-cfca8075bc3f/span>span classp>,/span>span classw>        /span>span classs2>decisionTime/span>span classp>:/span>span classw> /span>span classs2>2023-01-23T10:31:05.293000Z/span>span classp>,/span>span classw>        /span>span classs2>acceptanceTime/span>span classp>:/span>span classw> /span>span classs2>2023-01-23T10:25:40.026Z/span>span classp>,/span>span classw>        /span>span classs2>additionalVerifiedData/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>proofOfAddress/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                /span>span classs2>nameMatch/span>span classp>:/span>span classw> /span>span classkc>true/span>span classw>                /span>span classs2>nameMatcPercentage/span>span classp>:/span>span classw> /span>span classs2>100.00/span>span classw>            /span>span classp>},/span>span classw>        /span>span classp>},/span>span classw>    /span>span classp>},/span>span classw>    /span>span classs2>technicalData/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classs2>ip/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>    /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h3 idpoa-extraction-step-5-use-endpoints-to-query-poa-document-info>PoA Extraction step 5: use endpoints to query PoA document info/h3>p>When the steps above have been successfully completed, you can use the following endpoints to query the document info:/p>ul>li>a href#get-sessions-sessionid-media>GET /sessions/{sessionId}/media/a> - returns list of media objects and address mediawith the code>sessionId/code>/li>li>a href#get-attempts-attemptid-media>GET /attempts/{attemptId}/media/a> - returns list of media objects and address mediawith the code>attemptId/code>/li>li>p>a href#get-media-mediaid>GET /media/{mediaId}/a> - returns a media file with the code>mediaId/code>/p>/li>li>p>Note: to find the relevant code>attemptId/code>, check the code>attemptId/code> parameter in the a href#event-webhook>Event webhooks/a>./p>/li>/ul>h2 idoptional-proof-of-address-name-match-check>Optional Proof of Address name match check/h2>p>In order to do the strong>Proof of Address name match check/strong>, you can add the optional parameters code>person.firstName/code> andcode>person.lastName/code> to the POST /sessions request payload./p>p>If the check has been enabled, and you have sent us the first name and last namedata, the check will be performed. The results are displayed in strong>decision webhook response/strong>, incode>additionalVerifiedData.proofOfAddress/code> object, more specifically in code>proofOfAddress.nameMatch/code> andcode>proofOfAddress.nameMatchpercentage/code> strings. If the check has been enabled, but you do not send us the name data,the strings will be code>null/code>./p>aside classnotice>Note that the name match check is not performed by default, it needs to be configured for your integration. Please askyour b>solutions engineer/b> to configure the feature for your integration./aside>p>strong>Sample POST /sessions request payload to do the optional name match check/strong>/br>/p>p>strong>Request method/strong>: POST/br>strong>Media type/strong>: application/json/br>strong>Type/strong>: object/br>strong>Headers/strong>:/br>code>X-AUTH-CLIENT/code>: code>string (required)/code>  strong>API key/strong>/br>code>Content-Type/code>: code>application/json/code>/p>pre classhighlight plaintext>code>curl -X POST \  --url /v1/sessions/ \  -H Content-Type: application/json \  -H X-AUTH-CLIENT: API-PUBLIC-KEY \  -d {    verification: {        person: {            firstName: John,            lastName: Smith,        },    }}/code>/pre>p>strong>Sample decision webhook payload/strong>/p>p>The explanation and sample below show only the part of the payload that is relevant to the name match check. To seethe full decision webhook response related to Proof of Address check, see thea href#poa-extraction-step-4-wait-for-session-approval-and-decision-webhook-response>PoA Extraction Webhook payload/a>section above./p>p>strong>Request properties explained/strong>/p>ul>li>code>status/code>: code>string/code> Status of the response/li>li>code>verification/code>: code>object/code> Verification request decision objectul>li>.../li>li>code>additionalVerifiedData/code>: code>object/code> Data which has been optionally verified for session/li>li>code>proofOfAddress/code>: code>object/code> Proof of address data. Optional, available only if the name match check has beenenabled for the integrationul>li>code>nameMatch/code>: code>boolean/code> Indicates if the name on the proof of address document matches the name from theinitial request data. code>null/code> if the check could not be completed./li>li>code>nameMatchPercentage/code>: code>float/code> Indicates the level of similarity the matched names have, in the rangeof 0.00-100.00. code>null/code> if the check could not be completed./li>/ul>/li>/ul>/li>li>.../li>/ul>p>strong>Sample response/strong>/p>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>    /span>span classs2>verification/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classerr>.../span>span classw>        /span>span classs2>additionalVerifiedData/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>proofOfAddress/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                /span>span classs2>nameMatch/span>span classp>:/span>span classw> /span>span classkc>true/span>span classw>                /span>span classs2>nameMatcPercentage/span>span classp>:/span>span classw> /span>span classs2>100.00/span>span classw>            /span>span classp>},/span>span classw>        /span>span classp>},/span>span classw>    /span>span classp>},/span>span classw>    /span>span classerr>.../span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h1 idine-biometric-database-verification>INE Biometric Database Verification/h1>p>Veriff INE Biometric Database Verification aka INE Biometric Validation is a check required for establishing identityin the Mexican market./p>aside classnotice>Please ask your b>solutions engineer/b> to configure the feature for your integration./aside>h2 idine-biometric-validation-prerequisites>INE Biometric Validation prerequisites/h2>ul>li>Integration configured on the Veriff side to support the check/li>li>A strong>verification session/strong> generated for the end-user/li>li>strong>End-user has given consent/strong> to pass their image to conduct the INE Biometric Validation check/li>/ul>h2 idine-biometric-validation-flow>INE Biometric Validation flow/h2>ol>li>Create a identity verification session for the end-user. Make sure to include the a href#how-to-add-the-consent-to-the-session>consent/a>./li>li>Collect and pass the end-user's data and media:ul>li>If using the SDK solution, direct the end-user to the flow and wait for them to get approved/li>li>If you have collected end-user's data and images yourself, pass them using the API endpoints/li>/ul>/li>li>Veriff verifies the end-user/li>li>Check the verification results from a href#how-to-find-results-in-the-decision-webhook>decision webhook/a> and/ora href#how-to-find-results-in-the-get-decisions-response>GET /decision API call response/a>/li>/ol>h2 idhow-to-add-the-consent-to-the-session>How to add the consent to the session?/h2>p>When a href#post-sessions>generating a session/a> for INE Biometric Database Verification purposes, in the code>verification/code>object include the code>consents/code> array with code>type: ine/code> and code>approved: true/code> attributes (as shown below).code>true/code> is mandatory to start the INE Biometric Validation. If code>false/code> or missing, the session is not created./p>p>Below is an excerpt from the request payload, to highlight the relevant attributes. For full view of thepayload, see the a href#post-sessions>POST /sessions/a> documentation./p>pre classhighlight plaintext>code>curl -X POST \  --url /v1/sessions/ \  -H Content-Type: application/json \  -H X-AUTH-CLIENT: API-PUBLIC-KEY \  -d {    verification: {        callback: https://veriff.com,        consents:             {                type: ine,                approved: true            }        ,        ...    }}/code>/pre>div>/div>aside classnotice>Please ensure consent from the end-user that they permit sending their image to Veriff andVeriffs service provider for conducting the INE Biometric Registry Verification check, including biometric dataprocessing./aside>h2 idhow-to-find-results-in-the-decision-webhook>How to find  results in the decision webhook?/h2>p>You will find the INE Biometric Validation check results in the decision webhook request payload, ascode>additionalVerifiedData.ineBiometricRegistryValidation/code> object./p>p>Below is an excerpt from the request payload, to highlight the relevant attributes. For full view of thepayload, see the a href#decision-webhook>decision webhook documentation/a>./p>h4 idrequest-properties-explained>Request properties explained/h4>ul>li>code>status/code>: code>string/code> Status of the response/li>li>code>verification/code>: code>object/code> Verification request decision objectul>li>code>additionalVerifiedData/code>: code>object/code> Data which has been optionally verified for sessionul>li>code>ineBiometricRegistryValidation/code>: code>object/code> INE Biometric Database Verification check object. Optional, availableonly when the INE Biometric Validation check has been enabled for the integrationul>li>code>faceMatch/code>: code>boolean | null/code> Indicates if the person's selfie image is a match with their image in theregistry. This decision is made based on the value returned in code>faceMatchPercentage/code> (see below)code>null/code> if the check could not be completed/li>li>code>faceMatchPercentage/code>: code>integer | null/code> Indicates the level of similarity the system thinks the matched images have,in the range of 0-100. Values ≥85 indicate a match; values <85 indicate that images do not match.code>null/code> if the check could not be completed/li>li>code>responseStatus/code>: code>string | null/code> Indicates the response received from the service provider. One of code>success/code>or code>failure/code>; or code>null/code> if the check could not be completed/li>/ul>/li>/ul>/li>/ul>/li>/ul>h4 idsample-request>Sample request/h4>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classp>,/span>span classw>    /span>span classs2>verification/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classerr>.../span>span classw>        /span>span classs2>additionalVerifiedData/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>ineBiometricRegistryValidation/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                /span>span classs2>faceMatch/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw>                /span>span classs2>faceMatchPercentage/span>span classp>:/span>span classw> /span>span classmi>89/span>span classp>,/span>span classw>                /span>span classs2>responseStatus/span>span classp>:/span>span classw> /span>span classs2>success/span>span classw>            /span>span classp>},/span>span classw>          /span>span classerr>.../span>span classw>        /span>span classp>},/span>span classw>        /span>span classerr>.../span>span classw>    /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>h2 idhow-to-find-results-in-the-get-decisions-response>How to find results in the GET /decisions response?/h2>p>You will find the INE Biometric Validation check results in the GET /decision API call response, ascode>additionalVerifiedData.ineBiometricRegistryValidation/code> object./p>p>Below is an excerpt from the response payload, to highlight the relevant objects. For full view of thepayload, see the a href#get-sessions-sessionid-decision>GET /decisions response documentation/a>./p>h4 idresponse-properties-explained>Response properties explained/h4>ul>li>code>status/code>: code>string/code> Status of the response/li>li>code>verification/code>: code>object/code> Verification request decision objectul>li>code>additionalVerifiedData/code>: code>object/code> Data which has been optionally verified for sessionul>li>code>ineBiometricRegistryValidation/code>: code>object/code> INE Biometric Database Verification check object. Optional, availableonly when the INE Biometric Validation check has been enabled for the integrationul>li>code>faceMatch/code>: code>boolean | null/code> Indicates if the person's selfie image is a match with their image in theregistry. This decision is made based on the value returned in code>faceMatchPercentage/code> (see below). code>null/code>if the check could not be completed/li>li>code>faceMatchPercentage/code>: code>integer | null/code> Indicates the level of similarity the system thinks the matched images have,in the range of 0-100. Values ≥85 indicate a match; values <85 indicate that images do not match.code>null/code> if the check could not be completed/li>li>code>responseStatus/code>: code>string | null/code> Indicates the response received from the service provider. One of code>success/code>or code>failure/code>; or code>null/code> if the check could not be completed/li>/ul>/li>/ul>/li>/ul>/li>/ul>p>h4 idsample-response>Sample response/h4>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classs2>"status"/span>span classp>:/span>span classw> /span>span classs2>"success"/span>span classp>,/span>span classw>    /span>span classs2>"verification"/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classerr>.../span>span classw>        /span>span classs2>"additionalVerifiedData"/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classs2>"ineBiometricRegistryValidation"/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                /span>span classs2>"faceMatch"/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw>                /span>span classs2>"faceMatchPercentage"/span>span classp>:/span>span classw> /span>span classmi>89/span>span classp>,/span>span classw>                /span>span classs2>"responseStatus"/span>span classp>:/span>span classw> /span>span classs2>"success"/span>span classw>            /span>span classp>},/span>span classw>          /span>span classerr>.../span>span classw>        /span>span classp>},/span>span classw>        /span>span classerr>.../span>span classw>    /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/p>h1 idreference-info-codes-tables>Reference Info, Codes, Tables/h1>h2 idverification-session-status-and-decision-codes>Verification session status and decision codes/h2>h3 idsession-status>Session status/h3>table>tr>th>Session Status/th>th>Code/th>th>Sent by/th>th>Description/th>/tr>tr>    td>code>Started/code> /td>    td>7001/td>    td>Event webhook/td>    td>The end-user has started their session and landed in our verification flow./br>No decision is available yet./td>/tr>tr>    td>code>Submitted/code> /td>    td>7002/td>    td>Event webhook/td>    td>The end-user has submitted the requested data in the verification flow./br>No decision is available yet./td>/tr>tr>  td>code>Approved/code>/td>  td>9001/td>  td>Decision webhook/td>  td> The end-user was verified. The verification process is complete. /br>  Accessing the code>sessionURL/code> again will show the end-user that nothing is to be done here./td>/tr>tr>  td>code>Declined/code>/td>  td>9102/td>  td>Decision webhook/td>  td> The end-user has not been verified. The verification process is complete./br>    Either it was a fraud case or some other severe reason that the end-user could not be verified. You should investigate the    session further and read the a href#granular-reason-codes> reason and decision codes/a>. If you decide to give    the end-user another try, you need to a href#post-sessions>create a new session./a>./td>/tr>tr>  td>code>Resubmission/code>/br> aka code>resubmission_requested/code>/td>  td>9103/td>  td>Decision webhook/td>  td>Resubmission has been requested. The verification process has not been completed./br>    Something was missing from the end-user, and they need to go through the flow once more. The same code>sessionURL/code>    can and should be used for this purpose./td>/tr>tr>  td>code>Expired/Abandoned/code>/td>  td>9104/td>    td>Decision webhook/td>  td> Verification has been expired (a session will expire 7 days after having been createdunless it gets a conclusive decision before that). The verification process is complete.br>If the end-user started the verification process, the response shows code>abandoned/code>. If the end-user has neveraccessed the verification, the status will be code>expired/code>. If you decide to givethe end-user another try, you need to a href#post-sessions>create a new session./td>/tr>tr>    td>code>Review/code> /td>    td>9121/td>    td>Decision webhook/td>    td>Note that this status is sent only when you have implemented the fully automated verification    flow./br>code>Review/code> status is issued whenever the automation engine could not issue a conclusive decision    and the verification session needs to be reviewed by a human on your side./td>/tr>/table>p>Responses code>9001, 9102, 9121/code> and code>9104/code> are strong>conclusive responses/strong>. The session is closed and the code>sessionURL/code> isnot available for the end-user./p>p>Response code>9103/code> is an strong>inconclusive response/strong>. The session remains open until you receive one of the aboveconclusive responses. The session is re-opened for the end-user, accepting a new attempt./p>p>Additional info can be found in our strong>Knowledge base/strong> a hrefhttps://help.veriff.com/en/articles/3250231-meanings-of-various-verification-statuses-and-decisions>article ↗/a>(requires a login to the strong>Veriff environment/strong>)/p>h3 idverification-decision-declined>Verification decision: declined/h3>p>This table contains values for code>verification.reasonCode/code> in case the code>verfication.status/code> returned code>declined/code>.If you do not see the reason code you received here, see also a href#grc-verification-decision-declined>granular reason codes/a>/p>table>    thead>        tr>          th>Code/th>          th>Description/th>        /tr>    /thead>    tbody>        tr>          td>102/td>          td>Suspected document tampering/td>        /tr>        tr>          td>103/td>          td>Person showing the document does not appear to match document photo/td>        /tr>        tr>          td>105/td>          td>Suspicious behaviour/td>        /tr>        tr>          td>106/td>          td>Known fraud/td>        /tr>        tr>          td>108/td>          td>Velocity/abuse duplicated end-user/td>        /tr>        tr>          td>109/td>          td>Velocity/abuse duplicated device/td>        /tr>        tr>          td>110/td>          td>Velocity/abuse duplicated ID/td>        /tr>        tr>          td>112/td>          td>Restricted IP location/td>        /tr>        tr>          td>113/td>          td>Suspicious behaviour - Identity Farming/td>        /tr>    /tbody>/table>h3 idverification-decision-resubmission-required>Verification decision: resubmission required/h3>p>This table contains values for code>verification.reasonCode/code> in case the code>verfication.status/code> returned code>resubmission_requested/code>.If you do not see the reason code you received here, see also a href#grc-verification-decision-resubmit>granular reason codes/a>/p>p>Note about the strong>number of resubmissions/strong>: one user can resubmit their data up to 9 times. This means that the 10sup>th/sup>attempt is automatically declined, and code strong>539 - Resubmission limit exceeded/strong> is sent. If you wish to allow the end-userto retry verification, you need to create a new session for them (see a href#post-sessions>POST sessions/a> for info)./p>table>    thead>        tr>          th>Code/th>          th>Description/th>        /tr>    /thead>    tbody>        tr>          td>201/td>          td>Video and/or photos missing/td>        /tr>        tr>          td>204/td>          td>Poor image quality/td>        /tr>        tr>          td>205/td>          td>Document damaged/td>        /tr>        tr>          td>206/td>          td>Document type not supported/td>        /tr>        tr>          td>207/td>          td>Document expired/td>        /tr>    /tbody>/table>h2 idcommon-http-status-codes>Common HTTP status codes/h2>table>    thead>        tr>          th>Code/th>          th>Value/th>          th>Description/th>        /tr>    /thead>    tbody>        tr>          td>200/td>          td>code>status/code>: code>success/code>, code>data/code>/td>          td> Returned as a general OK code/td>        /tr>        tr>          td>201/td>          td>code>status/code>: code>created/code>, code>data/code>/td>          td>Returned when creating a session/td>        /tr>        tr>          td>400/td>          td>code>status/code>: code>fail/code>br/>code>code/code>: code>1102/code>/td>          td>Mandatory parameters are missing from the requestbr/>See the a href#some-troubleshooting-codes>troubleshooting codes table/a>/td>        /tr>        tr>          td>401/td>          td>code>status/code>: code>fail/code>/td>          td>Not authorized/td>        /tr>        tr>          td>404/td>          td>code>status/code>: code>fail/code>/td>          td>Entry not found/td>        /tr>        tr>          td>409/td>          td>code>status/code>: code>conflict/code>/td>          td>Returned when you try to upload media to a session that was already updated to code>submitted/code> status/td>        /tr>        tr>          td>500/td>          td>code>status/code>: code>fail/code>/td>          td>Something went wrong/td>        /tr>    /tbody>/table>h2 idcredentials-and-authorization-codes>Credentials and authorization codes/h2>table>    thead>        tr>          th>Code/th>          th>Description/th>        /tr>    /thead>    tbody>        tr>          td>1801/td>          td>Mandatory X-AUTH-CLIENT header containing the API key is missing from the request/td>        /tr>        tr>          td>1802/td>          td>API key is not a valid UUID/td>        /tr>        tr>          td>1803/td>          td>Integration with the API key was not found/td>        /tr>        tr>          td>1804/td>          td>Integration with the API key is not active/td>        /tr>        tr>          td>1812/td>          td>Signature is not a valid SHA256 hash/td>        /tr>        tr>          td>1813/td>          td>Signature does not match the SHA256 hash of query ID and integration API secret/td>        /tr>        tr>          td>1814/td>          td>Signature does not match the SHA256 hash of request body and integration API secret/td>        /tr>        tr>          td>1818/td>          td>Signature does not match the HMAC-SHA256 of query ID and integration API secret/td>        /tr>        tr>          td>1819/td>          td>Signature does not match the HMAC-SHA256 of request body and integration API secret/td>        /tr>    /tbody>/table>h2 idsome-troubleshooting-codes>Some troubleshooting codes/h2>table>    thead>        tr>            th>Code/th>            th>Description/th>        /tr>    /thead>    tbody>        tr>          td>1001/td>          td>Query ID must be between 20 and 40 symbols./td>        /tr>        tr>          td>1002/td>          td>Query ID must be a valid UUID V4/td>        /tr>        tr>          td>1003/td>          td>Query ID must be unique, it has already been used./td>        /tr>        tr>          td>1102/td>          td>Mandatory parameters are missing from the request./td>        /tr>        tr>          td>1104/td>          td>Request includes invalid parameters./td>        /tr>        tr>          td>1201/td>          td>Invalid timestamp. Timestamp must not be older than one hour./td>        /tr>        tr>          td>1202/td>          td>Timestamp format is incorrect. YYYY-MM-DDTHH:MM:S+Timezone Offset|Z or UTC./td>        /tr>        tr>          td>1203/td>          td>Invalid ISO 8601 date. Date needs to be in format YYYY-MM-DD./td>        /tr>        tr>          td>1301/td>          td>Requested features are not supported./td>        /tr>        tr>          td>1302/td>          td>Only HTTPS return URLs are allowed./td>        /tr>        tr>          td>1303/td>          td>Invalid status./td>        /tr>        tr>          td>1304/td>          td>Cannot transition to $STATUS status./td>        /tr>        tr>          td>1308/td>          td>ID number is missing./td>        /tr>        tr>          td>1309/td>          td>SSN validation requires person firstName + lastName OR fullName to be provided./td>        /tr>        tr>          td>1310/td>          td>SSN validation requires person.dateOfBirth or address data to be provided./td>        /tr>        tr>          td>1400/td>          td>Image data not found./td>        /tr>        tr>          td>1401/td>          td>Image is not in valid base64./td>        /tr>        tr>          td>1402/td>          td>Image context is not supported./td>        /tr>        tr>          td>1403/td>          td>Image property is missing./td>        /tr>        tr>          td>1500/td>          td>code>vendorData/code> field cannot be more than 1000 symbols. We require only non-semantic data to be submitted (UUID-s etc., that can not be resolved or used outside the customers domain)/td>        /tr>        tr>          td>1501/td>          td>code>vendorData/code> must be a string. We require only non-semantic data to be submitted (UUID-s etc., that can not be resolved or used outside the customers domain)/td>        /tr>        tr>          td>2003/td>          td>Date of birth is not a valid date./td>        /tr>        tr>          td>2101/td>          td>Document number has to be between 6 and 9 characters./td>        /tr>        tr>          td>2102/td>          td>Document number may contain only characters and numbers A-Z, 0-9./td>        /tr>        tr>          td>2103/td>          td>Document type is not supported./td>        /tr>        tr>          td>2104/td>          td>Document from provided country is not supported./td>        /tr>    /tbody>/table>h2 idgranular-reason-codes>Granular reason codes/h2>p>The granular reason codes (hereinafter the strong>GRC/strong>) mentioned here are strong>subject to custom configuration on integration level/strong>,meaning that you strong>may or may not receive/strong> all the reason codes listed here./p>h3 idgrc-verification-decision-declined>GRC verification decision: declined/h3>p>This table contains values for code>verification.reasonCode/code> in case the code>verfication.status/code> returned code>declined/code>./p>table>    thead>        tr>          th>Code/th>          th>Description/th>        /tr>    /thead>    tbody>        tr>          td>101/td>          td>Physical document not used/td>        /tr>        tr>          td>102/td>          td>Suspected document tampering/td>        /tr>        tr>          td>103/td>          td>Person showing the document does not appear to match document photo/td>        /tr>        tr>          td>105/td>          td>Suspicious behaviour/td>        /tr>        tr>          td>106/td>          td>Known fraud/td>        /tr>        tr>          td>108/td>          td>Velocity/abuse duplicated end-user/td>        /tr>        tr>          td>109/td>          td>Velocity/abuse duplicated device/td>        /tr>        tr>          td>110/td>          td>Velocity/abuse duplicated ID/td>        /tr>        tr>          td>112/td>          td>Restricted IP location/td>        /tr>        tr>          td>113/td>          td>Suspicious behaviour - Identity Farming/td>        /tr>        tr>          td>120/td>          td>Person on the portrait does not appear to match reference photo/td>        /tr>        tr>          td>121/td>          td>User ID missing/td>        /tr>        tr>          td>122/td>          td>No reference found/td>        /tr>        tr>          td>123/td>          td>Unable to pass registry checks/td>        /tr>        tr>          td>126/td>          td>Potential PEP match/td>        /tr>        tr>          td>127/td>          td>Face match with blocklist/td>        /tr>        tr>          td>502/td>          td>Multiple parties present in session/td>        /tr>        tr>          td>503/td>          td>Attempted deceit/td>        /tr>        tr>          td>504/td>          td>Attempted deceit, device screen used/td>        /tr>        tr>          td>505/td>          td>Attempted deceit, printout used/td>        /tr>        tr>          td>507/td>          td>Presented document tampered, data cross reference/td>        /tr>        tr>          td>508/td>          td>Presented document tampered, document similarity to specimen/td>        /tr>        tr>          td>509/td>          td>Person showing the document does not match document photo/td>        /tr>        tr>          td>510/td>          td>Presented document type not supported/td>        /tr>        tr>          td>511/td>          td>Presented document expired/td>        /tr>        tr>          td>515/td>          td>Attempted deceit, device screen used for face image/td>        /tr>        tr>          td>526/td>          td>Attempted deceit, photos streamed/td>        /tr>        tr>          td>527/td>          td>Unable to collect proof of address data/td>        /tr>        tr>          td>528/td>          td>Proof of address issue date too old/td>        /tr>        tr>          td>530/td>          td>Person is under 13 years old/td>        /tr>        tr>          td>531/td>          td>Person is under 14 years old/td>        /tr>        tr>          td>532/td>          td>Person is under 16 years old/td>        /tr>        tr>          td>533/td>          td>Person is under 18 years old/td>        /tr>        tr>          td>534/td>          td>Person is under 20 years old/td>        /tr>        tr>          td>535/td>          td>Person is under 21 years old/td>        /tr>        tr>          td>536/td>          td>Person is under 25 years old/td>        /tr>        tr>          td>537/td>          td>Unable to perform document media portrait cropping/td>        /tr>        tr>          td>539/td>          td>Resubmission limit exceeded/td>        /tr>        tr>          td>540/td>          td>Low confidence score for the session/td>        /tr>        tr>          td>541/td>          td>Name on document does not match with name in session initialisation data/td>        /tr>        tr>          td>542/td>          td>Unable to validate CPF/td>        /tr>        tr>          td>543/td>          td>Reference face image has poor quality/td>        /tr>        tr>          td>544/td>          td>Regisry did not respond/td>        /tr>        tr>          td>545/td>          td>Reference image missing/td>        /tr>        tr>          td>546/td>          td>Face image quality insufficient/td>        /tr>        tr>          td>547/td>          td>Face missing/td>        /tr>        tr>          td>548/td>          td>Attempted deceit, with face reference missing/td>        /tr>        tr>          td>549/td>          td>NFC validation failed/td>        /tr>    /tbody>/table>h3 idgrc-verification-decision-resubmit>GRC verification decision: resubmit/h3>p>This table contains values for code>verification.reasonCode/code> in case the code>verfication.status/code> returned code>resubmission_requested/code>./p>table>    thead>        tr>          th>Code/th>          th>Description/th>        /tr>    /thead>    tbody>        tr>          td>203/td>          td>Full document not visible/td>        /tr>        tr>          td>602/td>          td>Presented document type not supported/td>        /tr>        tr>          td>603/td>          td>Video missing/td>        /tr>        tr>          td>605/td>          td>Face image missing/td>        /tr>        tr>          td>606/td>          td>Face is not clearly visible/td>        /tr>        tr>          td>608/td>          td>Document front missing/td>        /tr>        tr>          td>609/td>          td>Document back missing/td>        /tr>        tr>          td>614/td>          td>Document front not fully in frame/td>        /tr>        tr>          td>615/td>          td>Document back not fully in frame/td>        /tr>        tr>          td>619/td>          td>Document data not visible/td>        /tr>        tr>          td>620/td>          td>Presented document expired/td>        /tr>        tr>          td>621/td>          td>Document annulled or damaged/td>        /tr>        tr>          td>625/td>          td>Unable to collect surname/td>        /tr>        tr>          td>626/td>          td>Unable to collect first names/td>        /tr>        tr>          td>627/td>          td>Unable to collect date of birth/td>        /tr>        tr>          td>628/td>          td>Unable to collect issue date/td>        /tr>        tr>          td>629/td>          td>Unable to collect expiry date/td>        /tr>        tr>          td>630/td>          td>Unable to collect gender/td>        /tr>        tr>          td>631/td>          td>Unable to collect document number/td>        /tr>        tr>          td>632/td>          td>Unable to collect personal number/td>        /tr>        tr>          td>633/td>          td>Unable to collect nationality/td>        /tr>        tr>          td>634/td>          td>Unable to collect home address/td>        /tr>        tr>          td>635/td>          td>Document and face image missing/td>        /tr>        tr>          td>636/td>          td>Presented document not real, screen used/td>        /tr>        tr>          td>637/td>          td>Presented document not real, printout used/td>        /tr>        tr>          td>640/td>          td>Person did not give consent/td>        /tr>           tr>          td>641/td>          td>Multiple Faces Detected/td>        /tr>        tr>          td>642/td>          td>Multiple Documents Uploaded/td>        /tr>        tr>          td>643/td>          td>Unable to crop face image from a document front/td>        /tr>        tr>          td>644/td>          td>Unable to collect Identificador de Ciudadano (INE)/td>        /tr>        tr>          td>645/td>          td>Resubmit - Unable to collect OCR (IFE)/td>        /tr>        tr>          td>646/td>          td>Unable to estimate age/td>        /tr>        tr>          td>647/td>          td>Document not recognised/td>        /tr>        tr>          td>648/td>          td>Technical issues/td>        /tr>        tr>          td>649/td>          td>Unable to collect foreigner information/td>        /tr>        tr>          td>650/td>          td>Unable to collect process number/td>        /tr>        tr>          td>651/td>          td>Unable to collect occupation information/td>        /tr>        tr>          td>652/td>          td>Unable to collect employer information/td>        /tr>        tr>          td>653/td>          td>Unable to collect residence permit type/td>        /tr>        tr>          td>654/td>          td>Unable to collect drivers license number/td>        /tr>        tr>          td>655/td>          td>Unable to collect additional name/td>        /tr>        tr>          td>657/td>          td>Open passport image missing/td>        /tr>        tr>          td>662/td>          td>Unable to collect document remarks/td>        /tr>    /tbody>/table>h2 idimage-context-types>Image context types/h2>p>The code>context/code> parameter in the request and response payload basically describes what the image or video was taken of,for example if the image/video is about the selfie (the end-users face), the document front or back, etc./p>p>Veriff captures multiple images. The image with the code>-pre/code> suffix is the first one, and the one without is the secondimage./p>h3 ididentity-verification-process>Identity verification process/h3>table>thead>tr>th>Context label name/th>th>Description/th>/tr>/thead>tbody>tr>td>code>face/code>/td>td>Returns the selfie picture/td>/tr>tr>td>code>face-pre/code>/td>td>Returns the selfie picture/td>/tr>tr>td>code>face-nfc/code>/td>td>Returns the selfie picture extracted from the document's NFC chip/td>/tr>tr>td>code>document-front/code>/td>td>Returns the picture of the ID document's front/td>/tr>tr>td>code>document-front-pre/code>/td>td>Returns the picture of the ID document's front/td>/tr>tr>td>code>document-front-qrcode/code>/td>td>Returns the picture of the ID document's front, to display the QR-code/td>/tr>tr>td>code>document-front-qrcode-pre/code>/td>td>Returns the picture of the ID document's front, to display the QR-code/td>/tr>tr>td>code>document-front-face-cropped/code>/td>td>Returns a cropped portrait image from a document/td>/tr>tr>td>code>document-back/code>/td>td>Returns the picture of the ID document's back/td>/tr>tr>td>code>document-back-pre/code>/td>td>Returns the picture of the ID document's back/td>/tr>tr>td>code>document-and-face/code>/td>td>Returns the selfie with the the ID document's front/td>/tr>tr>td>code>document-and-face-pre/code>/td>td>Returns the selfie with the the ID document's front/td>/tr>tr>td>code>document-back-barcode/code>/td>td>Returns the picture of the ID document's back, to display the barcode/td>/tr>tr>td>code>document-back-barcode-pre/code>/td>td>Returns the picture of the ID document's back, to display the barcode/td>/tr>tr>td>code>document-back-qrcode/code>/td>td>Returns the picture of the ID document's back, to display the QR-code/td>/tr>tr>td>code>document-back-qrcode-pre/code>/td>td>Returns the picture of the ID document's back, to display the QR-code/td>/tr>tr>td>code>registry-face/code>/td>td>Returns the selfie picture extracted from a third party registry/td>/tr>tr>td>code>face-reference/code>/td>td>Returns the selfie picture that is used as reference image/td>/tr>/tbody>/table>h3 idproof-of-address-verification-process>Proof of Address verification process/h3>table>thead>tr>th>Context label name/th>th>Description/th>/tr>/thead>tbody>tr>td>code>address-front/code>/td>td>Returns the image of the address that's displayed on the Proof of Address document's front/td>/tr>/tbody>/table>h2 idvideo-context-types>Video context types/h2>table>thead>tr>th>Context label name/th>th>Description/th>th>Platform/th>/tr>/thead>tbody>tr>td>code>selfid_video/code>/td>td>Returns one video of the whole session, comprising the selfie, document front and document back videos/td>td>Web flow and Native SDKs/td>/tr>tr>td>code>face-pre-video/code>/td>td>Returns the selfie video/td>td>only Native SDKs/td>/tr>tr>td>code>document-front-pre-video/code>/td>td>Returns the video of the document's front/td>td>only Native SDKs/td>/tr>tr>td>code>document-back-pre-video/code>/td>td>Returns the video of the document's back/td>td>only Native SDKs/td>/tr>tr>td>code>document-and-face-pre-video/code>/td>td>Returns the selfie video with the document's front/td>td>only Native SDKs/td>/tr>tr>td>code>document-back-barcode-pre-video/code>/td>td>Returns the selfie video with the document's back to display the document's barcode/td>td>only Native SDKs/td>/tr>tr>td>code>document-front-qrcode-pre-video/code>/td>td>Returns the selfie video with the document's front to display the document's QR-code/td>td>only Native SDKs/td>/tr>tr>td>code>document-back-qrcode-pre-video/code>/td>td>Returns the selfie video with the document's back to display the document's QR-code/td>td>only Native SDKs/td>/tr>/tbody>/table>h2 idsupported-document-types-for-idv>Supported document types for IDV/h2>p>In the strong>Identity Verification/strong> process, the request and response bodies can display the code>document/code> object.This contains the code>type/code> string. The code>type/code> can be one of the following document types:/p>ul>li>code>PASSPORT/code>/li>li>code>ID_CARD/code>/li>li>code>DRIVERS_LICENSE/code>/li>li>code>RESIDENCE_PERMIT/code>/li>li>code>VISA/code>/li>/ul>p>If it's not possible to classify the document as one of the above, the strong>response/strong> can show code>"type": "OTHER"/code>./p>p>See also:/p>ul>li>request body of a href#post-sessions>POST /sessions/a>/li>li>response body of a href#get-sessions-sessionid-decision>GET /sessions/{sessionId}/decision/a>/li>li>response body of a href#decision-webhook>decision webhook/a>/li>/ul>h2 iddocument-data-fields>Document data fields/h2>table>    thead>        tr>          th>Abbreviation/th>          th>Field name/th>          th>Explanation/th>        /tr>    /thead>    tbody>        tr>            td>VIZ/td>            td>Visual Inspection Zone/td>            td>The data group of this zone includes the photograph, the document designation, personal data and                the date of issue and validity of the document/td>        /tr>        tr>            td>MRZ/td>            td>Machine Readable Zone/td>            td>The two to three lines where the information from the viewing zone is strung together with alphanumeric                characters and the  symbol/td>        /tr>        tr>            td>/td>            td>Barcode/td>            td>The barcode or the QR code on the document/td>        /tr>        tr>            td>NFC/td>            td>Near Field Communication/td>            td>Documents NFC chip/td>        /tr>    /tbody>/table>h2 idmedia-file-mimetypes>Media file mimetypes/h2>p>In API responses, the code>mimetype/code> parameter indicates the format of the media file./p>p>Possible values are:/p>ul>li>code>image/jpg/code>/li>li>code>image/jpeg/code>/li>li>code>image/png/code>/li>li>code>image/heic/code>/li>li>code>image/heif/code>/li>li>code>image/webp/code>/li>li>code>image/pdf/code>/li>li>code>video/mp4/code>/li>li>code>video/webm/code> /li>/ul>h2 idreasons-for-different-types-of-decisions>Reasons for different types of decisions/h2>h3 idpreconditions-for-approval-decisions>Preconditions for approval decisions/h3>p>We give a positive conclusive decision (status approved, code 9001) when the end-user has provided us with:/p>ul>li>Photos and videos uploaded to us/li>li>The data on the document is readable and matches throughout the document/li>li>The end-user's portrait photo is recognizable/li>li>The end-user on the portrait photo corresponds to the person on the document photo/li>li>The document is valid (dates, etc.,) A positive decision means that the person was verified. The verification process is complete./li>/ul>p>Accessing the KYC session URL again will tell the end-user that nothing more is to be done./p>h3 idreasons-for-negative-conclusive-decisions>Reasons for negative conclusive decisions/h3>p>We give a negative conclusive decision (status declined, code 9102) when:/p>ul>li>Physical document not used/li>li>Suspected document tampering/li>li>Person showing the document does not appear to match document photo/li>li>Suspicious behaviour/li>li>Velocity/abuse/li>li>Known fraud/li>/ul>p>A negative decision means that the person has not been verified. The verification process is complete. Either it wasa fraud case or some other severe reason that the person can not be verified. You should investigate the sessionfurther and read the "reason". If you decide to give the client another try you need to create a new session./p>h3 idreasons-for-inconclusive-decisions>Reasons for inconclusive decisions/h3>p>We give an inconclusive decision (status resubmission_requested, code 9103), when/p>ul>li>Video and/or photos missing/li>li>Face not clearly visible/li>li>Full document not visible/li>li>Poor image quality/li>li>Document damaged/li>li>Document type not supported/li>li>Document expired/li>/ul>aside classnotice>When verifications receive a Resubmission requested decision from Veriff, it is stronglyadvised that you inform the end-user about the reasons for the verification failure and provide suggestions on howto improve their next attempt. This communication can be conducted through email, SMS, and/or within your platformto ensure better visibility.br/>For resubmitted verification attempts where certain elements were missing or the qualityof the submission was subpar, a new attempt is generated and made available through the same session URL.It is important to use the same session URL for verification attempts made by the same end-user./aside>h3 idfinal-decisions>Final decisions/h3>p>You have the right to make the final decision about verifying an end-user even after they have completedthe verification process with Veriff./p>p>In order for you to make the final decision, we recommend you create an appropriate functionality in your back-end.This will enable you to either approve or reject applications after the person has completed Veriff’s verification session./p>p>When you perform additional checks outside of Veriff’s service, it is necessary to have another layerof decision-making. The decision has to be motivated based on further checks or extra information independentof Veriff’s decision./p>p>The additional verification details can be determined in accordance with your business needs and the amountof data and background information available to you about the end-user./p>p>Potential use cases:/p>ul>li>Age checks/li>li>Name validation checks/li>li>An end-user is unable to pass verification as required, but their attempt is sincere and the document is legitimate/li>li>An end-user has made multiple fraudulent attempts to verify and cannot pass Veriff's verification anymore/li>li>You wish to restrict the end-user's access to your platform based on their earlier behavior/li>/ul>p>Veriff provides a more standardized solution where unconventional end-user behavior is not deferred to for thebenefit of overall decision quality./p>h2 idstoring-verification-media>Storing verification media/h2>p>For businesses which are regulated by various KYC and AML laws and rules, storing proof of the end-user's verificationis often a requirement. While Veriff stores and holds the end-user's media - photos and videos - it might alsobe mandatory and more convenient for the business to store this media internally./p>h3 iddownloading-the-photo-and-video-files>Downloading the photo and video files/h3>ol>li>You need to get the code>sessionId/code> of a session you want to download the media for. This can be found fromthe a href#decision-webhook>decision webhook/a> (code>verification.id/code> parameter), which is automatically sent after adecision has been made for a verification session./li>li>With the code>sessionId/code>, make a a href#get-sessions-sessionid-media>GET request to /sessions/{sessionId}/media/a> endpoint./li>li>From there, you will find a code>mediaId/code> for every media file we have stored./li>li>With the code>mediaId/code>-s, you can make a request to a href#get-media-mediaid>GET /media/{mediaId}/a> endpoint to get the mediafile in .jpeg or .mp4 format./li>/ol>aside classnotice>A separate request will have to be made for each media file./aside>h1 idglossary>Glossary/h1>table>    thead>        tr>            th>                Term            /th>            th>                Context            /th>            th>                Definition            /th>            th>                Additional info            /th>        /tr>    /thead>    tbody>        tr>            td>                b>API Key/b>            /td>            td>                Public API            /td>            td>                A unique identifier of an b>integration/b> and a required parameter for authentication. It is used                to create the b>X-AUTH-CLIENT/b> header value for b>API requests/b>.            /td>            td>                You can find it in b>Station/b> > b>Integrations page/b> (requires a b>Station/b> login).br/>Occasionally,                referred to as the b>API public key/b> or b>Publishable key/b>.            /td>            td>/td>        /tr>        tr>            td>                b>API request/b>            /td>            td>                Public API            /td>            td>                A message sent to a server asking for the API to provide service or information.            /td>            td>Also referred to as the b>API call/b>./td>        /tr>        tr>            td>                 b>API URL/b>            /td>            td>                Public API            /td>            td>                An address that allows you to access an API and its various features. It consists of a                b>BaseURL/b> and an b>Endpoint/b>.            /td>            td>Also referred to as the b>API URL path/b>./td>        /tr>        tr>            td>                b>Attempt ID/b>            /td>            td>                Public API, Webhooks            /td>            td>                An b>UUID v4/b> of a specific attempt.br/>You can find its value in your                a href#get-sessions-sessionid-attempts>GET /sessions/{sessionId}/attempts/a> response, as                code>verification.id/code>.            /td>            td>                In the b>API requests/b> context, an b>attempt/b> is one step (uploading required data                and getting a decision) inside a b>verification session/b>, and it can be made several times during                a b>verification session/b>. This means that calling the                a href#get-sessions-sessionid-attempts>GET /sessions/{sessionId}/attempts/a> can return several                code>verification/code> objects, each one with a unique code>id/code> value.            /td>        /tr>        tr>            td>                b>BaseURL/b>            /td>            td>                Public API            /td>            td>                A base address for the specific API that you’re using.br>Used to create the b>API URL/b>                value for b>API requests/b>.             /td>            td>                Found in b>Station/b> > b>Integration page/b> (requires a b>Station/b> login).            /td>        /tr>        tr>            td>                b>Body/b>            /td>            td>                Public API, Webhooks            /td>            td>                Data inside the b>request and response payloads/b> in an b>API request/b>.            /td>            td>                A GET b>requests payload/b> does not contain a b>body/b>.            /td>        /tr>        tr>            td>                b>Callback URL/b>            /td>            td>                Public API            /td>            td>                URL address of the page where the end-user is sent after they have completed the web                b>verification flow/b> You can find its value in the b>response payload/b> of your                a href#post-sessions>POST /sessions/a>, as code>verification.callback/code>.            /td>            td>                If the b>callback URL/b> is not specified for the session, the end-user will be redirected to                integrations default b>callback URL/b>, which is visible in b>the Veriff environment/b> >                 i>Integration/i> > b>Settings tab/b>. Changing the value in the POST /sessions request body will                overwrite the default b>callback URL/b>, but it will not change the b>callback URL/b> that is visible                in b>the Veriff environment/b>br/>                This does not yet contain any verification or decision info.br/>                See a hrefhttps://help.veriff.com/en/articles/3430334-where-can-you-change-the-callback-url-for-your-customers>here/a>                 ↗ for more info about how to set it up.br/>Also referred to as the b>redirect URL/b>.            /td>        /tr>        tr>            td>                b>Customer/b>            /td>            td>                General            /td>            td>                Veriffs customer who is using our verification services.            /td>            td>Occasionally, referred to as the b>vendor/b>/td>        /tr>        tr>            td>                b>Content-type header/b>            /td>            td>                Public API            /td>            td>                Indicates the media type of the resource, in Veriffs context, usually application/json.             /td>            td>/td>        /tr>        tr>            td>                b>Decision code/b>            /td>            td>                General            /td>            td>                Numeric value representing the decision given to a b>verification session/b>.            /td>            td>                See the                a href #verification-session-status-and-decision-codes>Verification session status and decision codes/a>                for more info.            /td>        /tr>        tr>            td>                b>End-user/b>            /td>            td>                General            /td>            td>                User of Veriffs b>customers/b> solution, the person who goes through the b>verification flow/b>                (aka the b>end-user/b> flow).            /td>        /tr>        tr>            td>                code>endUserId/code>            /td>            td>                General, Biometric Authentication            /td>            td>                A unique code>uuid/code> created by the customer for their end-user. It is recommended for Biometric                Authentication solutions, especially if you are not sending the code>vendorData/code> field, but can be used                for other solutions as well. It is always retruned unmodified in webhooks and public API calls,                or as code>null/code> if not provided.            /td>            td>                It must be code>uuid/code>, no text or .json values are allowed. /br>                It is stored by the customer, but also by Veriff for biometric authentication purposes. It must be                usable only inside customers environment and in relation to only the specific end-user. It is a great                alternative to code>vendorData/code>, especially if you are already using the UUID format to create                unique end-user identifiers.            /td>        /tr>        tr>            td>                b>Endpoint/b>            /td>            td>                Public API            /td>            td>                A specific “point of entry” in an API. You attach these to the end of your b>BaseURL/b>,                thus completing the b>API URL/b>. The results that youll get from the API request will depend on                the b>Endpoint/b> you attach.br/>                            /td>            td>                You can find a list of b>endpoints/b> in the a href#endpoints>Endpoints/a> section.            /td>        /tr>                tr>            td>                b>Granular Reason Code/b>            /td>            td>                General            /td>            td>                It is a kind of code which is sent depending on the configuration of the b>clients/b> integration.            /td>            td>                See the a href #granular-reason-codes>Granular reason codes table/a> for more info.            /td>        /tr>        tr>            td>                b>Headers/b>            /td>            td>                Public API            /td>            td>                Mandatory elements in the b>API requests/b>, containing the metadata.            /td>            td>/td>        /tr>        tr>            td>                b>IDV/b>            /td>            td>                General            /td>            td>                Abbreviation of b>Identity Verification/b>.            /td>            td>/td>        /tr>        tr>            td>                b>Integration/b>            /td>            td>                Station            /td>            td>                An environment created according to clients needs to carry out, manage and observe b>verifications/b>.             /td>            td>                Client can find the list of their b>integrations/b> in b>Station/b> > b>Integrations page/b>                on the top of the page (requires a b>Station/b> login.            /td>        /tr>        tr>            td>                b>Live Integration/b>            /td>            td>                General            /td>            td>                b>Integration/b> which is created as per your requirements. It is used for production and                b>verification sessions/b> created will count towards paid usage.            /td>            td>                For b>live integration/b> sessions, the b>sessions statuses/b> are set automatically.                You need to define the b>Webhook decisions URL/b> in b>Station/b>                (see a href#get-sessions-sessionid-decision>here/a> for instructions).             /td>        /tr>        tr>            td>                b>Payload/b>            /td>            td>                Public API, Webhooks, SDK            /td>            td>                The data that you send when you make an API request, or that you receive when you get a response.             /td>            td>In the b>API requests/b> context, the hashed hex encoded b>payload/b> is signed with the                b>shared secret key/b> to generate the b>X-HMAC-SIGNATURE/b>.            /td>        /tr>        tr>            td>                b>PoA/b>            /td>            td>                General            /td>            td>                Abbreviation of b>Proof of Address/b>.            /td>            td>                See a hrefhttps://help.veriff.com/en/articles/6584901-proof-of-address>the article/a> ↗ in                the Knowledge Base for more info.            /td>        /tr>        tr>            td>                b>Reason code/b>            /td>            td>                General            /td>            td>                Numeric value representing the reason for rejecting a b>verification session/b> or for asking it                to be resubmitted.            /td>            td>                See the tables a href#verification-decision-declined>here/a> for more info.            /td>        /tr>        tr>            td>                b>Session status/b>            /td>            td>                General            /td>            td>                A label describing the status of a b>verification session/b>.            /td>            td>                See the table a href#verification-session-status-and-decision-codes>here/a> for more info.            /td>        /tr>        tr>            td>                b>Session ID/b>            /td>            td>                Public API, Webhooks            /td>            td>                A unique identifier of a b>verification session/b>.br/>It is automatically created as soon as you                create a session.br/>You can find its value in the b>response payload/b> of your                a href#post-sessions>POST /sessions/a>, as code>verification.id/code>.            /td>            td>                In the b>API requests/b> context, one verification session comprises many steps (uploading data,                uploading images, getting a decision, etc.). You can call several                a href#endpoints>b>endpoints/b>/a> using the same b>session ID/b>, to get all kinds of                different data from that specific session.            /td>        /tr>        tr>            td>                code>sessionToken/code>            /td>            td>                Public API            /td>            td>                Session-specific token for a b>verification session/b>.br/>                You can find its value in the b>response payload/b> of the a href#post-sessions>POST /sessions/a>,                as code>verification.sessionToken/code>.            /td>            td>                It is a JSON Web Token (JWT) that consists of the b>session ID/b> and the session creation timestamp.                It is valid for 7 days and should b>always have the variable max length type/b>. If absolutely needed,                you can set the length to max value: 4096 characters. It must be able to accept data up to 8KB.br/>                /td>        /tr>        tr>            td>                b>Session URL/b>            /td>            td>                Public API, SDKs            /td>            td>                A combination of the code>base URL/code> and the code>sessionToken/code>, created as soon as a                session is started.br/>You can find its value in the b>response payload/b> of your                a href#post-sessions>POST /sessions/a>, as code>verification.url/code>.            /td>            td>                This where the b>end-user/b> is directed to go through the verification flow,                and it is unique for each verification session.br/>                /td>        /tr>        tr>            td>                b>Shared secret key/b>            /td>            td>                Public API            /td>            td>                Required parameter for authentication, used to sign the b>payload/b> to create the b>X-HMAC-SIGNATURE/b>                for b>API requests/b>.            /td>            td>                This is a secret credential. You can find it in b>Station/b> > b>Integrations page/b>                (requires a b>Station/b> login).br/>Occasionally, referred to as the b>API private key/b>                or the b>Private key/b>.            /td>        /tr>        tr>            td>                b>Test Integration/b>            /td>            td>                General            /td>            td>                b>Integration/b> which is automatically created for every b>client/b> who onboards with Veriff. It is used                for development purposes, and b>verification sessions/b> that are created will not count towards                paid usage.            /td>            td>                Veriff will not provide b>statuses/b> for sessions created in b>test integration/b>, you need to                set them manually in the b>Station/b> (see a href#get-sessions-sessionid-decision>here/a> for                instructions). The b>Webhook decision URL/b> is automatically created.            /td>        /tr>        tr>            td>                code>UUID/code>            /td>            td>                General            /td>            td>                Abbreviation of the b>Universal Unique Identifier/b>. It is a 128-bit value used to uniquely identify                an object or entity on the internet. Must meet the regular expression pattern                0-9a-f{8}-0-9a-f{4}-0-9a-f{4}-0-9a-f{4}-0-9a-f{12}.            /td>            td>/td>        /tr>        tr>            td>                code>UUID v4/code>            /td>            td>                General            /td>            td>                It is an b>UUID/b> (see above) which has been created using a random number generator. In Veriff context,                whenever a code>UUID/code> is needed, it is the b>v4/b>.            /td>            td>/td>        /tr>        tr>            td>                code>vendorData/code>            /td>            td>                General            /td>            td>                A unique identifier of the end-user, created by the customer.            /td>            td>                It can be max 1,000 characters long and contain only non-semantic data, for example UUID-s etc., that                can not be resolved or used outside your systems or environments. Veriff returns it unmodified in webhooks                and API response payloads, or as code>null/code> if it has not been provided./br> It has many use-cases, but it is                a recommended field to improve fraud mitigation solutions./br> It is an alternative to code>endUserId/code>                if you have been creating the unique end-user identifiers in some non-UUID format./br>                See this a hrefhttps://help.veriff.com/en/articles/7182858-what-is-vendor-data>article/a>↗ for more                info (requires a signin to b>the Veriff environment/b>).            /td>        /tr>        tr>            td>                b>Veriff Environment/b>            /td>            td>                General            /td>            td>                Veriff customer back-office, a dashboard where the b>customers/b> can see their b>end-users/b>                verification data.            /td>            td>                See an introductory video a hrefhttps://www.youtube.com/watch?vh1h_G304C-o>here/a>↗.br/>                Depending on your setup, you may be required to access the environment via station.veriff.com or                hub.veriff.com. b>Please check your sign-up email to make sure that you log in via correct address./b>            /td>        /tr>        tr>            td>                b>Verification flow/b>            /td>            td>                General            /td>            td>                A process where the b>end-user/b> submits the data required to get verified.            /td>            td>Also referred to as the b>end-user flow/b>./td>        /tr>        tr>            td>                b>Verification session/b>            /td>            td>                General            /td>            td>                One b>verification session/b> from start to end, i.e., from the moment a session is created until                the moment a conclusive decision (“approved”, “declined”, “expired”/”abandoned”) is granted.            /td>            td>                Each b>verification session/b> receives an unique ID, aka the b>session ID/b> used in                the b>API request endpoints/b>.            /td>        /tr>        tr>            td>                b>Verification session lifecycle/b>            /td>            td>                General            /td>            td>                Umbrella term for the whole process of completing a verification process, comprising the stages                completed by the b>client/b>, the b>end-user/b>, and Veriff.             /td>            td>/td>        /tr>        tr>            td>                b>Webhook/b>            /td>            td>                Public API            /td>            td>                An event-triggered API, meaning that rather than sending information or performing a function as                a response to an applications request, it performs this when a certain trigger event happens.            /td>            td>                There are different types of b>webhooks/b>, see the a href#webhooks>Webhooks/a> section for                more info.            /td>        /tr>        tr>            td>                b>X-AUTH-CLIENT header/b>            /td>            td>                Public API            /td>            td>                A mandatory b>header/b> field in API requests, required to identify the request sender.                Its value is the b>API Key/b> (see above).            /td>            td>/td>        /tr>        tr>            td>                b>X-HMAC-SIGNATURE header/b>            /td>            td>                Public API            /td>            td>                A mandatory b>header/b> field in API requests, required to authenticate the request sender.br/>                Its value is a HMAC-SHA256 hex encoded hashed value of the b>request payload/b> that has been signed                using a b>shared secret key/b> known to both the sending and receiving party.            /td>            td>                See the relevant b>API request/b> in the a href#api-reference>API Reference/a>                section for more details about which payload to encode, and the a href#api-requests-signing-with-x-hmac-signature>X-HMAC-SIGNATURE/a>                section for more info about the signature itself.            /td>        /tr>        tr>            td>                b>X-SIGNATURE/b>br/>i>Legacy solution/i>            /td>            td>                Public API            /td>            td>                 A solution used before the b>X-HMAC-SIGNATURE header/b> was implemented (see above).            /td>            td>/td>        /tr>    /tbody>/table>      /div>    /div>    script>  window.intercomSettings  {    app_id: yn2gxy8s  };/script>script>(function(){var wwindow;var icw.Intercom;if(typeof icfunction){ic(reattach_activator);ic(update,w.intercomSettings);}else{var ddocument;var ifunction(){i.c(arguments);};i.q;i.cfunction(args){i.q.push(args);};w.Intercomi;var lfunction(){var sd.createElement(script);s.typetext/javascript;s.asynctrue;s.srchttps://widget.intercom.io/widget/yn2gxy8s;var xd.getElementsByTagName(script)0;x.parentNode.insertBefore(s,x);};if(w.attachEvent){w.attachEvent(onload,l);}else{w.addEventListener(load,l,false);}}})();/script>  /body>/html>

Subdomains

Date	Domain	IP
static.veriff.com	2024-04-05	18.161.6.28
stationapi.veriff.com	2024-04-13	3.163.24.34
station.veriff.com	2024-04-13	52.210.138.37
developers.veriff.com	2024-10-29	54.246.77.194
support.veriff.com	2024-07-25	18.161.6.90
webhook-test.veriff.com	2024-05-13	54.228.156.120
www.veriff.com	2021-02-26	99.84.79.86
alchemy.veriff.com	2024-03-05	204.246.191.72

View on OTX | View on ThreatMiner

Data with thanks to AlienVault OTX, VirusTotal, Malwr and others. [Sitemap]

Domain > developers.veriff.com

Is this malicious?

Whois

DNS Resolutions

Port 80

Port 443

Subdomains