uqudo
HomeCustomer PortalBook a Demo
  • KYC
    • Getting Started
      • Use Cases
        • User Enrolment
        • Face Authentication
      • Integration Options
        • Uqudo SDK
        • Uqudo API
        • No-code KYC
      • Customer Portal
        • Manage your SDK/API credentials
        • Create a new secret
        • Create a support request
    • Uqudo SDK
      • Integration
        • Android
          • Prepare Environment
          • Enrolment Flow
          • Lookup Flow
          • Face Session Flow
          • UI Customisation
            • UX & Branding
            • Dark / Night mode
            • Text & Language
              • General Strings
              • Scanning
              • Reading
              • Face Recognition
              • Background Check
              • Lookup
          • Analytics
        • iOS
          • Prepare Environment
          • Usage
          • Enrolment Flow
          • Lookup Flow
          • Face Session Flow
          • UI Customisation
            • UX & Branding
            • Dark / Night mode
            • Text & Language
          • Analytics
        • Web
          • SDK installation
            • Vanilla HTML+JS project
            • JS Frameworks (React, Angular, VueJs, etc...)
          • SDK Initialisation
          • CORS
          • Enrolment Flow
          • Face Session Flow
          • Javascript Usage
          • Typescript Usage
          • Operation Error
          • UI Customisation
            • Styles Configuration
            • Text & Language
            • Assets & Images
          • Webview Usage
          • Analytics
        • Capacitor
          • Plugin Installation
          • Enrolment Flow
          • Lookup Flow
          • Face Session Flow
        • Cordova
          • Plugin Installation
          • Enrolment Flow
          • Lookup Flow
          • Face Session Flow
        • Flutter
          • Plugin Installation
          • Enrolment Flow
          • Lookup Flow
          • Face Session Flow
        • React Native
          • Plugin Installation
          • Enrolment Flow
          • Lookup Flow
          • Face Session Flow
        • Xamarin and .NET
          • Plugin Installation
          • Enrolment Flow
          • Lookup Flow
          • Face Session Flow
          • Analytics
      • SDK result
        • Validation and Parsing
        • Data Structure
          • Common Object
          • Scan Object
          • Reading Object
            • Algerian ID
            • Bahrain ID
            • Ghana ID
            • Iraqi ID
            • Netherlands DL
            • Oman ID
            • Moroccan ID
            • Qatar ID
            • Saudi ID
            • Senegal ID
            • Turkish ID
            • UAE ID
            • Passports
          • Face Object
          • Lookup Object
            • Ghana SSNIT
            • Ghana Voter ID
            • Ghana Passport
            • Ghana Driving Licence
            • India PAN card
            • India Aadhaar ID
            • Nigeria Voter ID
            • Nigeria Driving Licence
            • Nigeria NIN
            • Nigeria BVN
            • Kenya National ID
            • South Africa ID
            • Uganda Voter ID
            • UAE Emirates ID
          • Verification Object
        • Download a Resource
        • Encrypt the SDK result
        • Security & Best Practices
      • Upgrade the SDK
      • Changelog
        • Mobile SDK
        • Web SDK
    • Uqudo API
      • Authorisation API
      • Scan API
        • Passports
          • AUS (Australia)
          • BEL (Belgium)
          • BHR (Bahrain)
          • CAN (Canada)
          • CHE (Switzerland)
          • DEU (Germany)
          • EGY (Egypt)
          • FRA (France)
          • GBR (UK)
          • IND (India)
          • JOR (Jordan)
          • KWT (Kuwait)
          • LBN (Lebanon)
          • MAR (Morocco)
          • OMN (Oman)
          • PAK (Pakistan)
          • PHL (Philippines)
          • PSE (Palestine)
          • QAT (Qatar)
          • SAU (Saudi Arabia)
          • SDN (Sudan)
          • SYR (Syria)
          • TUN (Tunisia)
          • TUR (Turkey)
          • UAE (UAE)
          • USA (USA)
          • YEM (Yemen)
          • ZAF (South Africa)
        • Generic National IDs
        • Country Specific IDs
          • BHR_DL (Bahrain Driving Licence)
          • BHR_ID (Bahrain ID)
          • BHR_VL (Bahrain Vehicle License)
          • COD_DL (DRC Driving Licence)
          • COD_VOTER_ID (DRC Voter ID)
          • DZA_ID (Algerian ID)
          • EGY_ID (Egypt ID)
          • GBR DL (UK Driving License)
          • GBR_ID (UK Resident ID)
          • GHA_DL (Ghana Driving Licence)
          • GHA_ID (Ghana National ID)
          • GHA_SSNIT (Ghana Social Security and National Insurance Trust)
          • GHA_VOTER_ID (Ghana Voter ID)
          • IND_ID (India Identity Card)
          • IND_PAN (Indian PAN Card)
          • IRQ_ID (Iraqi ID)
          • JOR_VL (Jordan Vehicle License)
          • KEN_ID (Kenya ID)
          • KWT_ID (Kuwait ID)
          • LBN DL (Lebanese Driving Licence)
          • LBN_ID (Lebanese ID)
          • MAR_ID (Moroccan ID)
          • NGA_DL (Nigeria Driving Licence)
          • NGA_NIN (Nigeria Digital NIN)
          • NGA_VOTER_ID (Nigeria Voter Card)
          • NLD_DL (Netherlands Driving Licence)
          • OMN_DL (Oman Driving Licence)
          • OMN_ID (Oman ID)
          • OMN_VL (Oman Vehicle License)
          • PAK_ID (Pakistan ID)
          • PHL_DL (Philippines Driving License)
          • QAT_DL (Qatar Driving Licence)
          • QAT_ID (Qatar ID)
          • RSL_ID (Somaliland National ID)
          • RWA_ID (Rwanda ID)
          • SAU_DL (Saudi Arabia Driving Licence)
          • SAU_ID (Saudi Arabia ID)
          • SAU_VL (Saudi Vehicle License)
          • SDN_DL (Sudan Driving Licence)
          • SDN_ID (Sudan ID)
          • SDN_VL (Sudan Vehicle License)
          • SEN_ID (Senegal ID)
          • SOM_ID (Somali ID)
          • TUN_ID (Tunisian ID)
          • TUR_ID (Turkish ID)
          • UAE_DL (UAE Driving Licence)
          • UAE_ID (UAE Emirates ID)
          • UAE_ID_DIGITAL (UAE Emirates ID digital version)
          • UAE_VISA (UAE Visa)
          • UAE_VL (UAE Vehicle Licence)
          • UAE_EVISA (UAE e-visa)
          • UAE_ID_APPLICATION_FORM (UAE ID application form)
          • UAE_PASSPORT_DIGITAL (Digital Emirates Passport)
          • UGA_ID (Uganda ID)
          • UGA_VOTER_ID (Uganda Voter ID)
          • USA_DL (USA Driving Licence)
          • ZAF_DL (South Africa Driving License)
          • ZAF_ID (South Africa ID)
        • MRZ only (TD1 or TD3)
      • Info API
      • Face API
      • Lookup API
        • Ghana
        • India
        • Kenya
        • Nigeria
        • South Africa
        • Uganda
        • UAE
      • Background Check API
    • No-code KYC
      • Workflow Settings
      • Text Settings
      • Other Settings
      • Onboard Users
  • KYB
    • Getting Started
      • Use Cases
        • Low-complexity
        • Medium-complexity
        • High-complexity
      • Integration Options
        • Uqudo API
    • Uqudo API
      • Company API
      • Screening API
      • Data Matching API
      • Session API
  • Coverage
    • Middle East
      • ๐Ÿ‡ง๐Ÿ‡ญBahrain
      • ๐Ÿ‡ฎ๐Ÿ‡ทIran
      • ๐Ÿ‡ฎ๐Ÿ‡ถIraq
      • ๐Ÿ‡ฎ๐Ÿ‡ฑIsrael
      • ๐Ÿ‡ฏ๐Ÿ‡ดJordan
      • ๐Ÿ‡ฐ๐Ÿ‡ผKuwait
      • ๐Ÿ‡ฑ๐Ÿ‡งLebanon
      • ๐Ÿ‡ด๐Ÿ‡ฒOman
      • ๐Ÿ‡ต๐Ÿ‡ธPalestine
      • ๐Ÿ‡ถ๐Ÿ‡ฆQatar
      • ๐Ÿ‡ธ๐Ÿ‡ฆSaudi Arabia
      • ๐Ÿ‡ธ๐Ÿ‡พSyria
      • ๐Ÿ‡น๐Ÿ‡ทTurkey
      • ๐Ÿ‡ฆ๐Ÿ‡ชUnited Arab Emirates
      • ๐Ÿ‡พ๐Ÿ‡ชYemen
    • Africa
      • ๐Ÿ‡ฉ๐Ÿ‡ฟAlgeria
      • ๐Ÿ‡ฆ๐Ÿ‡ดAngola
      • ๐Ÿ‡ง๐Ÿ‡ฏBenin
      • ๐Ÿ‡ง๐Ÿ‡ผBotswana
      • ๐Ÿ‡ง๐Ÿ‡ซBurkina Faso
      • ๐Ÿ‡ง๐Ÿ‡ฎBurundi
      • ๐Ÿ‡จ๐Ÿ‡ฒCameroon
      • ๐Ÿ‡จ๐Ÿ‡ปCape Verde
      • ๐Ÿ‡จ๐Ÿ‡ซCentral African Republic
      • ๐Ÿ‡น๐Ÿ‡ฉChad
      • ๐Ÿ‡ฐ๐Ÿ‡ฒComoros
      • ๐Ÿ‡จ๐Ÿ‡ฉDemocratic Republic of Congo
      • ๐Ÿ‡ฉ๐Ÿ‡ฏDjibouti
      • ๐Ÿ‡ช๐Ÿ‡ฌEgypt
      • ๐Ÿ‡ฌ๐Ÿ‡ถEquatorial Guinea
      • ๐Ÿ‡ช๐Ÿ‡ทEritrea
      • ๐Ÿ‡ธ๐Ÿ‡ฟEswatini
      • ๐Ÿ‡ช๐Ÿ‡นEthiopia
      • ๐Ÿ‡ฌ๐Ÿ‡ฆGabon
      • ๐Ÿ‡ฌ๐Ÿ‡ฒGambia
      • ๐Ÿ‡ฌ๐Ÿ‡ญGhana
      • ๐Ÿ‡ฌ๐Ÿ‡ณGuinea
      • ๐Ÿ‡ฌ๐Ÿ‡ผGuinea-Bissau
      • ๐Ÿ‡จ๐Ÿ‡ฎIvory Coast
      • ๐Ÿ‡ฐ๐Ÿ‡ชKenya
      • ๐Ÿ‡ฑ๐Ÿ‡ธLesotho
      • ๐Ÿ‡ฑ๐Ÿ‡ทLiberia
      • ๐Ÿ‡ฑ๐Ÿ‡พLibya
      • ๐Ÿ‡ฒ๐Ÿ‡ฌMadagascar
      • ๐Ÿ‡ฒ๐Ÿ‡ผMalawi
      • ๐Ÿ‡ฒ๐Ÿ‡ฑMali
      • ๐Ÿ‡ฒ๐Ÿ‡ทMauritania
      • ๐Ÿ‡ฒ๐Ÿ‡บMauritius
      • ๐Ÿ‡ฒ๐Ÿ‡ฆMorocco
      • ๐Ÿ‡ฒ๐Ÿ‡ฟMozambique
      • ๐Ÿ‡ณ๐Ÿ‡ฆNamibia
      • ๐Ÿ‡ณ๐Ÿ‡ชNiger
      • ๐Ÿ‡ณ๐Ÿ‡ฌNigeria
      • ๐Ÿ‡จ๐Ÿ‡ฉRepublic of Congo
      • ๐Ÿ‡ท๐Ÿ‡ผRwanda
      • ๐Ÿ‡ธ๐Ÿ‡นSao Tome and Principe
      • ๐Ÿ‡ธ๐Ÿ‡ณSenegal
      • ๐Ÿ‡ธ๐Ÿ‡จSeychelles
      • ๐Ÿ‡ธ๐Ÿ‡ฑSierra Leone
      • ๐Ÿ‡ธ๐Ÿ‡ดSomalia
      • ๐Ÿ‡ธ๐Ÿ‡ดSomaliland
      • ๐Ÿ‡ฟ๐Ÿ‡ฆSouth Africa
      • ๐Ÿ‡ธ๐Ÿ‡ธSouth Sudan
      • ๐Ÿ‡ธ๐Ÿ‡ฉSudan
      • ๐Ÿ‡น๐Ÿ‡ฟTanzania
      • ๐Ÿ‡น๐Ÿ‡ฌTogo
      • ๐Ÿ‡น๐Ÿ‡ณTunisia
      • ๐Ÿ‡บ๐Ÿ‡ฌUganda
      • ๐Ÿ‡ฟ๐Ÿ‡ฒZambia
      • ๐Ÿ‡ฟ๐Ÿ‡ผZimbabwe
    • Asia
      • ๐Ÿ‡ฆ๐Ÿ‡ซAfghanistan
      • ๐Ÿ‡ฆ๐Ÿ‡ฒArmenia
      • ๐Ÿ‡ฆ๐Ÿ‡ฟAzerbaijan
      • ๐Ÿ‡ง๐Ÿ‡ฉBangladesh
      • ๐Ÿ‡ง๐Ÿ‡นBhutan
      • ๐Ÿ‡ง๐Ÿ‡ณBrunei
      • ๐Ÿ‡ฐ๐Ÿ‡ญCambodia
      • ๐Ÿ‡จ๐Ÿ‡ณChina
      • ๐Ÿ‡น๐Ÿ‡ฑEast Timor
      • ๐Ÿ‡ฌ๐Ÿ‡ชGeorgia
      • ๐Ÿ‡ญ๐Ÿ‡ฐHong-Kong (China)
      • ๐Ÿ‡ฎ๐Ÿ‡ณIndia
      • ๐Ÿ‡ฎ๐Ÿ‡ฉIndonesia
      • ๐Ÿ‡ฏ๐Ÿ‡ตJapan
      • ๐Ÿ‡ฐ๐Ÿ‡ฟKazakhstan
      • ๐Ÿ‡ฐ๐Ÿ‡ฌKyrgyzstan
      • ๐Ÿ‡ฑ๐Ÿ‡ฆLaos
      • ๐Ÿ‡ฒ๐Ÿ‡ดMacau (China)
      • ๐Ÿ‡ฒ๐Ÿ‡พMalaysia
      • ๐Ÿ‡ฒ๐Ÿ‡ปMaldives
      • ๐Ÿ‡ฒ๐Ÿ‡ณMongolia
      • ๐Ÿ‡ฒ๐Ÿ‡ฒMyanmar
      • ๐Ÿ‡ณ๐Ÿ‡ตNepal
      • ๐Ÿ‡ฐ๐Ÿ‡ตNorth Korea
      • ๐Ÿ‡ต๐Ÿ‡ฐPakistan
      • ๐Ÿ‡ต๐Ÿ‡ญPhilippines
      • ๐Ÿ‡ธ๐Ÿ‡ฌSingapore
      • ๐Ÿ‡ฐ๐Ÿ‡ทSouth Korea
      • ๐Ÿ‡ฑ๐Ÿ‡ฐSri Lanka
      • ๐Ÿ‡น๐Ÿ‡ผTaiwan (China)
      • ๐Ÿ‡น๐Ÿ‡ฏTajikistan
      • ๐Ÿ‡น๐Ÿ‡ญThailand
      • ๐Ÿ‡น๐Ÿ‡ฒTurkmenistan
      • ๐Ÿ‡บ๐Ÿ‡ฟUzbekistan
      • ๐Ÿ‡ป๐Ÿ‡ณVietnam
    • Europe
      • ๐Ÿ‡ฆ๐Ÿ‡ฑAlbania
      • ๐Ÿ‡ฆ๐Ÿ‡ฉAndorra
      • ๐Ÿ‡ฆ๐Ÿ‡นAustria
      • ๐Ÿ‡ง๐Ÿ‡พBelarus
      • ๐Ÿ‡ง๐Ÿ‡ชBelgium
      • ๐Ÿ‡ง๐Ÿ‡ฆBosnia and Herzegovina
      • ๐Ÿ‡ง๐Ÿ‡ฌBulgaria
      • ๐Ÿ‡ญ๐Ÿ‡ทCroatia
      • ๐Ÿ‡จ๐Ÿ‡พCyprus
      • ๐Ÿ‡จ๐Ÿ‡ฟCzech Republic
      • ๐Ÿ‡ฉ๐Ÿ‡ฐDenmark
      • ๐Ÿ‡ช๐Ÿ‡ชEstonia
      • ๐Ÿ‡ซ๐Ÿ‡ดFaroe Islands (Denmark)
      • ๐Ÿ‡ซ๐Ÿ‡ฎFinland
      • ๐Ÿ‡ซ๐Ÿ‡ทFrance
      • ๐Ÿ‡ฉ๐Ÿ‡ชGermany
      • ๐Ÿ‡ฌ๐Ÿ‡ฎGibraltar (UK)
      • ๐Ÿ‡ฌ๐Ÿ‡ทGreece
      • ๐Ÿ‡ฌ๐Ÿ‡ฑGreenland (Denmark)
      • ๐Ÿ‡ฌ๐Ÿ‡ฌGuernsey (UK)
      • ๐Ÿ‡ญ๐Ÿ‡บHungary
      • ๐Ÿ‡ฎ๐Ÿ‡ธIceland
      • ๐Ÿ‡ฎ๐Ÿ‡ชIreland
      • ๐Ÿ‡ฎ๐Ÿ‡ฒIsle of Man (UK)
      • ๐Ÿ‡ฎ๐Ÿ‡นItaly
      • ๐Ÿ‡ฏ๐Ÿ‡ชJersey (UK)
      • ๐Ÿ‡ฝ๐Ÿ‡ฐKosovo
      • ๐Ÿ‡ฑ๐Ÿ‡ปLatvia
      • ๐Ÿ‡ฑ๐Ÿ‡ฎLiechtenstein
      • ๐Ÿ‡ฑ๐Ÿ‡นLithuania
      • ๐Ÿ‡ฑ๐Ÿ‡บLuxembourg
      • ๐Ÿ‡ฒ๐Ÿ‡นMalta
      • ๐Ÿ‡ฒ๐Ÿ‡ฉMoldova
      • ๐Ÿ‡ฒ๐Ÿ‡จMonaco
      • ๐Ÿ‡ฒ๐Ÿ‡ชMontenegro
      • ๐Ÿ‡ณ๐Ÿ‡ฑNetherlands
      • ๐Ÿ‡ฒ๐Ÿ‡ฐNorth Macedonia
      • ๐Ÿ‡จ๐Ÿ‡พNorthern Cyprus
      • ๐Ÿ‡ณ๐Ÿ‡ดNorway
      • ๐Ÿ‡ต๐Ÿ‡ฑPoland
      • ๐Ÿ‡ต๐Ÿ‡นPortugal
      • ๐Ÿ‡ท๐Ÿ‡ดRomania
      • ๐Ÿ‡ท๐Ÿ‡บRussia
      • ๐Ÿ‡ธ๐Ÿ‡ฒSan Marino
      • ๐Ÿ‡ท๐Ÿ‡ธSerbia
      • ๐Ÿ‡ธ๐Ÿ‡ฐSlovakia
      • ๐Ÿ‡ธ๐Ÿ‡ฎSlovenia
      • ๐Ÿ‡ช๐Ÿ‡ธSpain
      • ๐Ÿ‡ธ๐Ÿ‡ชSweden
      • ๐Ÿ‡จ๐Ÿ‡ญSwitzerland
      • ๐Ÿ‡บ๐Ÿ‡ฆUkraine
      • ๐Ÿ‡ฌ๐Ÿ‡งUnited Kingdom
      • ๐Ÿ‡ป๐Ÿ‡ฆVatican City
    • North America
      • ๐Ÿ‡ฆ๐Ÿ‡ฎAnguilla (UK)
      • ๐Ÿ‡ฆ๐Ÿ‡ฌAntigua and Barbuda
      • ๐Ÿ‡ง๐Ÿ‡ธBahamas
      • ๐Ÿ‡ง๐Ÿ‡งBarbados
      • ๐Ÿ‡ง๐Ÿ‡ฟBelize
      • ๐Ÿ‡ง๐Ÿ‡ฒBermuda (UK)
      • ๐Ÿ‡ป๐Ÿ‡ฌBritish Virgin Islands (UK)
      • ๐Ÿ‡จ๐Ÿ‡ฆCanada
      • ๐Ÿ‡ฐ๐Ÿ‡พCayman Islands (UK)
      • ๐Ÿ‡จ๐Ÿ‡ทCosta Rica
      • ๐Ÿ‡จ๐Ÿ‡บCuba
      • ๐Ÿ‡ฉ๐Ÿ‡ฒDominica
      • ๐Ÿ‡ฉ๐Ÿ‡ดDominican Republic
      • ๐Ÿ‡ธ๐Ÿ‡ปEl Salvador
      • ๐Ÿ‡ฌ๐Ÿ‡ฉGrenada
      • ๐Ÿ‡ฌ๐Ÿ‡นGuatemala
      • ๐Ÿ‡ญ๐Ÿ‡นHaiti
      • ๐Ÿ‡ญ๐Ÿ‡ณHonduras
      • ๐Ÿ‡ฏ๐Ÿ‡ฒJamaica
      • ๐Ÿ‡ฒ๐Ÿ‡ฝMexico
      • ๐Ÿ‡ฒ๐Ÿ‡ธMontserrat (UK)
      • ๐Ÿ‡ต๐Ÿ‡ฆPanama
      • ๐Ÿ‡ฐ๐Ÿ‡ณSaint Kitts and Nevis
      • ๐Ÿ‡ฑ๐Ÿ‡จSaint Lucia
      • ๐Ÿ‡ป๐Ÿ‡จSaint Vincent and the Grenadines
      • ๐Ÿ‡น๐Ÿ‡จTurks and Caicos Islands (UK)
      • ๐Ÿ‡บ๐Ÿ‡ธUnited States of America
    • South America
      • ๐Ÿ‡ฆ๐Ÿ‡ทArgentina
      • ๐Ÿ‡ง๐Ÿ‡ดBolivia
      • ๐Ÿ‡ง๐Ÿ‡ทBrazil
      • ๐Ÿ‡จ๐Ÿ‡ฑChile
      • ๐Ÿ‡จ๐Ÿ‡ดColombia
      • ๐Ÿ‡ช๐Ÿ‡จEcuador
      • ๐Ÿ‡ฌ๐Ÿ‡พGuyana
      • ๐Ÿ‡ณ๐Ÿ‡ฎNicaragua
      • ๐Ÿ‡ต๐Ÿ‡พParaguay
      • ๐Ÿ‡ต๐Ÿ‡ชPeru
      • ๐Ÿ‡ธ๐Ÿ‡ทSuriname
      • ๐Ÿ‡น๐Ÿ‡นTrinidad and Tobago
      • ๐Ÿ‡บ๐Ÿ‡พUruguay
      • ๐Ÿ‡ป๐Ÿ‡ชVenezuela
    • Oceania
      • ๐Ÿ‡ฆ๐Ÿ‡บAustralia
      • ๐Ÿ‡ซ๐Ÿ‡ฏFiji
      • ๐Ÿ‡ต๐Ÿ‡ซFrench Polynesia (France)
      • ๐Ÿ‡ฐ๐Ÿ‡ฎKiribati
      • ๐Ÿ‡ฒ๐Ÿ‡ญMarshall Islands
      • ๐Ÿ‡ซ๐Ÿ‡ฒMicronesia
      • ๐Ÿ‡ณ๐Ÿ‡ทNauru
      • ๐Ÿ‡ณ๐Ÿ‡จNew Caledonia (France)
      • ๐Ÿ‡ณ๐Ÿ‡ฟNew Zealand
      • ๐Ÿ‡ต๐Ÿ‡ผPalau
      • ๐Ÿ‡ต๐Ÿ‡ฌPapua New Guinea
      • ๐Ÿ‡ธ๐Ÿ‡ญSaint Helena (UK)
      • ๐Ÿ‡ผ๐Ÿ‡ธSamoa
      • ๐Ÿ‡ธ๐Ÿ‡งSolomon Islands
      • ๐Ÿ‡น๐Ÿ‡ดTonga
      • ๐Ÿ‡น๐Ÿ‡ปTuvalu
      • ๐Ÿ‡ป๐Ÿ‡บVanuatu
Powered by GitBook
On this page

Was this helpful?

  1. KYC
  2. Uqudo API

Info API

PreviousMRZ only (TD1 or TD3)NextFace API

Last updated 1 year ago

Was this helpful?

You can find the full YAML swagger specification

You can find the full JSON swagger specification

Every API below requires an access token that you can retrieve using the API

Info API

The following API allows you to get the final result of the SDK session.

Note: This endpoint itโ€™s only necessary when you use the QR code flow, see QR Code APP for details. The SDK returns the same result and makes it available directly to your application.

Info delete API

This endpoint allows you to delete the session data that has been cached without waiting for the automatic deletion. The session id is the value of the "jti" property of the JWS returned by the uqudo SDK.

Info image API

This endpoint allows you to download the image based on the resource id provided in the SDK result and returns directly the binary in the response

See for details about the JWS result

SDK result
here
here
Authorisation

Info API

get

Returns the information collected during the SDK session. Note: This endpoint it's only necessary when you use the QR code flow, see https://docs.uqudo.com/docs/getting-started/qr-code-app for details.

Path parameters
sessionIdstringRequiredPattern: [\p{XDigit}]{8}-[\p{XDigit}]{4}-[\p{XDigit}]{4}-[\p{XDigit}]{4}-[\p{XDigit}]{12}
Header parameters
AuthorizationstringRequired

Bearer token

Responses
200
String representing a JWS Compact Serialization, a representation of the JWS as a compact, URL-safe string
application/jwt
Responsestring
400
Bad Request: Missing required input or invalid format
401
Unauthorized: No valid access token has been provided
403
Forbidden: Access token doesn't have permission to use the requested feature
500
Internal Server Error: Unexpected error
get
GET /api/v1/info/{sessionId} HTTP/1.1
Host: id.uqudo.io
Authorization: text
Accept: */*
text

Info API

get

Returns the information collected during the SDK session. Note: This endpoint it's only necessary when you use the QR code flow, see https://docs.uqudo.com/docs/getting-started/qr-code-app for details.

Header parameters
UQ-Session-IDstringRequired

Session ID

Pattern: [\p{XDigit}]{8}-[\p{XDigit}]{4}-[\p{XDigit}]{4}-[\p{XDigit}]{4}-[\p{XDigit}]{12}
AuthorizationstringRequired

Bearer token

Responses
200
String representing a JWS Compact Serialization, a representation of the JWS as a compact, URL-safe string
application/jwt
Responsestring
400
Bad Request: Missing required input or invalid format
401
Unauthorized: No valid access token has been provided
403
Forbidden: Access token doesn't have permission to use the requested feature
500
Internal Server Error: Unexpected error
get
GET /api/v1/info HTTP/1.1
Host: id.uqudo.io
UQ-Session-ID: text
Authorization: text
Accept: */*
text

Info delete API

delete

This endpoint allows you to delete the session data that have been cached without waiting for the automatic deletion. The session id is the value of the "jti" property of the JWS returned by the uqudo SDK.

Path parameters
sessionIdstringRequiredPattern: [\p{XDigit}]{8}-[\p{XDigit}]{4}-[\p{XDigit}]{4}-[\p{XDigit}]{4}-[\p{XDigit}]{12}
Header parameters
AuthorizationstringRequired

Bearer token

Responses
204
No Content
401
Unauthorized: No valid access token has been provided
403
Forbidden: Access token doesn't have permission to use the requested feature
500
Internal Server Error: Unexpected error
delete
DELETE /api/v1/info/{sessionId} HTTP/1.1
Host: id.uqudo.io
Authorization: text
Accept: */*

No content

Info image API

get

The following API allows you to download the image based on the resource id provided in the SDK result

Path parameters
idstringRequired
Header parameters
AuthorizationstringRequired

Bearer token

Responses
200
Image file
image/jpeg
Responsestring ยท binary
400
Bad Request: Missing required input or invalid format
401
Unauthorized: No valid access token has been provided
403
Forbidden: Access token doesn't have permission to use the requested feature
404
Not Found: Resource not found or expired. Images are kept only for the duration of the session, 30 minutes.
500
Internal Server Error: Unexpected error
get
GET /api/v1/info/img/{id} HTTP/1.1
Host: id.uqudo.io
Authorization: text
Accept: */*
binary
  • Info API
  • GETInfo API
  • GETInfo API
  • Info delete API
  • DELETEInfo delete API
  • Info image API
  • GETInfo image API