Identitypass Docs
V2
V2
  • Introduction
  • Webhook
  • PRODUCTS
    • Data Verification
      • 🇷🇼Rwanda
        • NID
        • Passport
      • 🇺🇬Uganda
        • Business Verification
      • 🇳🇬Nigeria
        • Stamp Duty
        • Vehicle verification
          • Plate number verification
        • BVN Verification
          • igree
          • BVN 2.0 + (Face Validation)
          • BVN 2.0
          • BVN 1.0
        • NIN Verification
          • Lookup NIN Slip (Image)
          • Lookup Virtual NIN
          • Lookup NIN With Face
        • Tax Identification Number
        • CAC Verification
          • Basic CAC
          • Basic CAC (using Name)
          • Advance CAC
        • Phone number
          • Basic Phone number
          • Advance Phone Number
        • Bank Account
          • Get Bank Codes
          • Get Bank Codes (Advance)
          • Account number 1.0
          • Account with Name comparison
          • Account number 2.0
          • Retrieve bank list
        • Voters Card
          • Lookup VIN (ID Image)
          • Lookup VIN
        • Drivers License
          • Driver's license(Basic)
          • Advance drivers license
          • Drivers License (Image)
          • Lookup Driver's License
          • Driver's License(+ Face Validation)
        • International Passport
          • International Passport(Sync)
          • International Passport(Image)
          • International Passport (+ Face Validation)
          • International Passport(Async)
        • Credit Bureau
          • Consumer(individual)
            • Advance
            • Basic
          • Comercial(Business)
            • Advance
            • Basic
          • Credit Bureau
          • Credit Bureau(Mashup)
        • Mashup
          • BVN - Credit Bureau
          • BVN OR PHONE
          • BVN - NIN - PHONE
      • 🇬🇭Ghana
        • SSNIT
          • SSNIT
          • SSNIT with Face
        • International Passport
        • Drivers License
        • Voters Card
      • 🇰🇪Kenya
        • National Identity
        • National Identity Number
        • Passport
        • Serial Number
        • Drivers license
      • 🇿🇦South Africa
        • National Identity
        • Business Verification
      • 🇸🇱Sierra Leone
        • Voters Card
        • Drivers License
    • Biometric
      • Face Recognition
        • Age and Gender
        • Face Comparison
        • Face Enrollment
        • Face Liveliness Check
        • Face Authentication
        • ID-FACE matching
    • Document Verification
      • APAC Region
        • 🇦🇺Australia
        • 🇲🇾Malaysia
        • 🇸🇬Singapore
        • 🇹🇼Taiwan
        • 🇮🇩Indonesia
        • 🇰🇷Republic of Korea
        • 🇭🇰Hong Kong
        • 🇯🇵Japan
        • 🇱🇰Sri Lanka
        • 🇧🇩Bangladesh
        • 🇧🇳Brunei Darussalam
        • 🇰🇭Cambodia
        • 🇮🇳India
        • 🇲🇲Myanmar
        • 🇳🇿New Zealand
        • 🇵🇭Phillippines
        • 🇹🇭Thailand
        • 🇻🇳Vietnam
        • 🇧🇹Bhutan
        • 🇲🇳Mongolia
        • 🇫🇯Fiji
        • 🇳🇵Nepal
        • 🇵🇫French Polynesia
        • 🇹🇴Tonga
        • 🇻🇺Vanuatu
        • 🇼🇸Samoa
        • 🇰🇵Democratic Peoples Republic of Korea
        • 🇲🇴Macao
        • 🇵🇬Papua New Guinea
        • 🇱🇦Lao Peoples Democratic Republic
        • 🇲🇻Maldives
        • 🇫🇲Micronesia
        • 🇵🇼Palau
      • EMEA Region
        • Europe
          • 🇭🇺Hungary
          • 🇵🇱Poland
          • 🇲🇰The Former Yugoslav Republic of Macedonia
          • 🇵🇹Portugal
          • 🇮🇪Ireland
          • 🇷🇴Romania
          • 🇸🇰Slovakia
          • 🇬🇧United Kingdom
          • 🇷🇸Serbia
          • 🇫🇮Finland
          • 🇩🇪Germany
          • 🇩🇰Denmark
          • 🇦🇹Austria
          • 🇨🇿Czech Republic
          • 🇫🇷France
          • 🇷🇺Russian Federation
          • 🇮🇹Italy
          • 🇪🇸Spain
          • 🇦🇱Albania
          • 🇦🇲Armenia
          • 🇧🇾Belarus
          • 🇧🇪Belgium
          • 🇧🇦Bosnia and Herzegovina
          • 🇧🇬Bulgaria
          • 🇭🇷Croatia
          • 🇨🇾Cyprus
          • 🇪🇪Estonia
          • 🇬🇪Georgia
          • 🇬🇷Greece
          • 🇬🇬Guernsey
          • 🇮🇸Iceland
          • 🇮🇲Isle of Man
          • 🇯🇪Jersey
          • 🇱🇻Latvia
          • 🇱🇹Lithuania
          • 🇲🇹Malta
          • 🇲🇪Montenegro
          • 🇳🇴Norway
          • 🇸🇮Slovenia
          • 🇸🇪Sweden
          • 🇨🇭Switzerland
          • 🇺🇦Ukraine
          • 🇱🇺Luxembourg
          • 🇽🇰Kosovo
          • 🇦🇩Andorra
          • 🇪🇺European Union
          • 🇱🇮Liechtenstein
          • 🇲🇨Monaco
          • 🇻🇦Holy See
          • 🇸🇲San Marino
          • 🇳🇱Netherlands
        • Middle East
          • 🇮🇶Iraq
          • 🇮🇱Israel
          • 🇰🇿Kazakhstan
          • 🇰🇼Kuwait
          • 🇴🇲Oman
          • 🇵🇰Pakistan
          • 🇸🇦Saudi Arabia
          • 🇦🇪United Arab Emirates
          • 🇧🇭Bahrain
          • 🇯🇴Jordan
          • 🇶🇦Qatar
          • 🇹🇷Turkey
          • 🇹🇯Tajikistan
          • 🇺🇿Uzbekistan
          • 🇦🇫Afghanistan
          • 🇦🇿Azerbaijan
          • 🇾🇪Yemen
          • 🇵🇸Palestinian Authority
          • 🇹🇲Turkmenistan
          • 🇸🇾Syrian Arab Republic
          • 🇰🇬Kyrgyzstan
          • 🇱🇧Lebanon
        • Africa
          • 🇲🇼Malawi
          • 🇲🇺Mauritius
          • 🇸🇳Senegal
          • 🇿🇲Zambia
          • 🇳🇬Nigeria
          • 🇧🇮Burundi
          • 🇰🇪Kenya
          • 🇨🇲Cameroon
          • 🇨🇮Cote d'Ivoire
          • 🇲🇦Morocco
          • 🇳🇦Namibia
          • 🇷🇼Rwanda
          • 🇪🇬Egypt
          • 🇺🇬Uganda
          • 🇦🇴Angola
          • 🇩🇿Algeria
          • 🇿🇦South Africa
          • 🇨🇬Republic of the Congo
          • 🇨🇩Democratic Republic of Congo
          • 🇸🇴Somalia
          • 🇧🇯Benin
          • 🇪🇹Ethiopia
          • 🇪🇷Eritrea
          • 🇸🇱Sierra Leone
          • 🇹🇩Chad
          • 🇬🇶Equatorial Guinea
          • 🇬🇲Gambia
          • 🇱🇾Libya Arab Jamahiriya
          • 🇲🇱Mali
          • 🇧🇫Burkina Faso
          • 🇧🇼Botswana
          • 🇨🇻Cape verde
          • 🇩🇯Djibouti
          • 🇬🇦Gabon
          • 🇬🇼Guinea-Bissau
          • 🇳🇪Niger
      • NA Region
        • 🇺🇸United States
        • 🇨🇦Canada
        • 🇦🇼Aruba
        • 🇧🇸Bahamas
        • 🇧🇲Bermuda
        • 🇰🇾Cayman Islands
        • 🇨🇼Curacao
        • 🇩🇴Dominican Republic
        • 🇬🇩Grenada
        • 🇯🇲Jamaica
        • 🇹🇹Trinidad and Tobago
        • 🇭🇹Haiti
        • 🇨🇺Cuba
        • 🇧🇧Barbados
        • 🇦🇬Antigua and Barbuda
        • 🇧🇶Caribbean Netherlands
        • 🇩🇲Dominica
        • 🇸🇽Sint Maarten
        • 🇹🇨Turks and Caicos Islands
        • 🇲🇸Montserrat
        • 🇲🇽Mexico
        • 🇨🇷Costa Rica
        • 🇬🇹Guatemala
        • 🇭🇳Honduras
        • 🇵🇦Panama
        • 🇳🇮Nicaragua
        • 🇧🇿Belize
        • Netherlands Antilles
        • Saint Kitts and Nevis
        • Saint Lucia
        • Saint Vincent and the Grenadines
      • SA Region
        • 🇵🇪Peru
        • 🇨🇴Columbia
        • 🇪🇨Ecuador
        • 🇧🇷Brazil
        • 🇦🇷Argentina
        • 🇧🇴Bolivia
        • 🇨🇱Chile
        • 🇵🇾Paraguay
        • 🇺🇾Uruguay
        • 🇻🇪Venezuela
        • 🇬🇾Guyana
  • OTHER VERIFICATION PRODUCTS
    • Global Business Verification
    • Global Business Search
    • Email Verification
    • Card BIN
    • VIN/CAR CHASIS
    • Ban Lists
      • Interpol Ban List
  • Radar
    • Introduction
    • Phone Intelligence
    • Email Intelligence
    • IP Intelligence
  • General
    • Get Wallet Balance
    • Get Verification Status
    • Get All Verification Endpoints
  • Libraries
    • Bank Statement SDK
    • Identity Verification SDK
Powered by GitBook
On this page
  • Introduction
  • Events

Webhook

PreviousIntroductionNextData Verification

Last updated 2 years ago

Introduction

Identitypass Webhook

We trigger an event when certain actions are performed, this event sends a structured payload to your configured webhook URL.

Setup Webhook

Setting up your company wehbook can be achieved using the following steps.

  • Login to the

  • Navigate to Settings from the sidebar

  • Click on the Merchant Profile tab

  • Edit the Webhook URL input with your reachable webhook endpoint.

  • Save your update

  • You are good to go

Authorisation and Security

Every webhook event sent to your URL contains two headers.

  • x-identitypass-signature This is a base64 encoding of your public key

  • token This is a unique verification reference generated by Identitpass

Note: these two headers can be used to verify that the data coming to the endpoint are from our system and we also recommend you verify the host of every request and make sure it is coming from our API BASE URL.

Please make sure to return a status code of 200 for every webhook event sent to your endpoint to prevent us from trying to process the event again.

Events

{
  "source":"PORTAL",
  "data":{
      "status":True, // True or False
      "response_code":"00",
      ... 
      ...
    
      // other data structures (same as API responses)
   }
}
{
  "source":"CHECKOUT",
  "user_info": {
        "date": "",
        "first_name": "",
        "last_name": "",
        "email": "",
        "user_ref": ""
   },
  "data":{
      "status":True, // True or False
      "response_code":"00",
      ... 
      ...
    
      // other data structures (same as API responses)
   }
}
👍
portal