LogoLogo
Home
  • Youverify API Documentation
  • Getting Started
    • Getting your API Key
    • Getting your Public Merchant Key
    • Environment
    • Response Codes
  • Know Your Customer Services (KYC)
    • ID Document Verification (SDK)
      • Web SDK
      • iOS SDK
        • iOS Liveness SDK
        • iOS (Compat) Liveness SDK
        • iOS Document Capture SDK
      • Android SDK
        • Android Document Capture SDK
        • Android Liveness SDK
      • Document Capture Supported Countries
        • 🌏Asia
        • πŸ‡ͺπŸ‡ΊEurope
        • 🌎Latin America and the Caribbean
        • 🌍Middle East and Africa
        • 🌎North America
        • 🌏Oceania
    • ID Data Matching (eIDV)
      • 🌐Global
        • Supported Countries
      • πŸ‡ΏπŸ‡¦South Africa
        • Verify South African ID Number (SAID)
        • Verify South African Phone Number
        • Bank Account Verification
        • Proof of Address Verification
      • πŸ‡°πŸ‡ͺKenya
        • Verify International Passport
        • Verify Alien ID
        • Verify Drivers License
        • Verify Plate Number
        • Verify Collateral ID
        • Kenyan Bank Account Verification
          • Bank List
        • Credit History
        • Employment History
        • Verify Address Information
        • Verify Phone Number
        • Verify Identity Number
        • Verify Tax PIN
      • πŸ‡¬πŸ‡­Ghana
        • Verify International Passport
        • Verify Social Security and National Insurance Trust (SSNIT)
        • Verify Ghana Voters Card (GVC)
      • πŸ‡³πŸ‡¬Nigeria
        • Verify Bank Verification Number (BVN)
        • Verify Bank Verification Number (BVN Premium)
        • Verify Virtual National Identification Number (vNIN)
        • Verify National Identification Number (NIN)
        • Verify Nigerian Driver's License (Driver's License)
        • Advanced Phone Search
        • Verify Nigerian International Passport (Passport)
        • Verify Nigerian Permanent Voters Card (PVC)
        • Verify Phone Number
        • Individual Credit Report
        • Bank Account Verification
          • Basic Bank Account Verification
          • Bank List
            • Getting the list of Banks for Basic Bank Account
    • Facial Comparison
    • Retrieve an Identity
    • Identity History
  • Know Your Business Services (KYB)
    • 🌍Business Verification
    • 🌍Search for Businesses
    • Get Supported Countries and Regions
    • Retrieve Business details
    • Country-Specific KYB Services
      • πŸ‡³πŸ‡¬Nigeria
        • Tax Identification Number (TIN) Verification
      • πŸ‡ΏπŸ‡¦South Africa
        • Business Account Verification
        • Business Address Verification
  • Know Your Transaction Service (KYT)
    • Customer Management
      • Create an Individual Client
      • Create a Business Client
      • Initiate an Individual Client Assessment
      • Initiate an Business Client Assessment
      • Update a Client
      • Retrieve all Clients
      • Retrieve a Client
      • Delete a Client
    • Transaction Management
      • Create a Transaction
      • Retrieve an Evaluation
  • Risk Intelligence
    • Risk Intelligence: Initialise Risk Check
    • Retrieve Risk Intelligence Profile
    • Retrieve Risk Intelligence History
  • AML Services (Anti-Money Laundering)
    • PEP and Sanction Screening
      • Search using Name
        • Advanced Filters
      • Search using Identity
        • Advanced Filters
      • Search using Crypto
        • Advanced Filters
      • Retrieve a PEP and Sanction Screening Search
      • Screening Data Sources
      • Domestic PEP Search
    • Adverse Media Intelligence
    • Custom AML Watchlist
      • AML Watchlist (Sample list)
      • AML Watchlist Upload (Bulk Upload)
      • AML Watchlist Upload
      • Retrieve AML Watchlist
      • AML Watchlist Entity Update
      • AML Watchlist Entity Removal
  • Custom Workflow Builder (CWB)
    • CWB Webhook
    • CWB External API
      • Retrieve CWB History
      • Retrieve CWB Responses
      • Retrieve CWB Report
  • Youverify OS Error Codes
  • Webhooks
    • Know Your Customer Webhooks
      • Identity Verification
      • Address Verification
    • Know Your Transaction Webhooks
      • Customer Management Webhooks
        • Client Created
        • Client Updated
      • Alert Service Webhooks
        • Alert Created
        • Alert Triage Created
        • Alert Updated
      • Evaluation Webhooks
        • Evaluation Completed
        • Evaluation Started
        • Transaction Updated
  • Test Data
  • Our Legacy API and SDK
Powered by GitBook
On this page

Was this helpful?

  1. Know Your Business Services (KYB)
  2. Country-Specific KYB Services
  3. Nigeria
  4. Address Verification Services for Businesses

Address History

This endpoint allows the user to retrieve their verified address verification history.

GET {{baseurl}}/v2/api/addresses/history

Path Parameters

Name
Type
Description

page

String

Page number of the requested page.

Default value: 1

limit

String

Number of addresses to return.

Default value: 20

Maximum Value: 100

Headers

Name
Type
Description

token*

String

API secret token

HTTP/1.1 200 OK
{
            "success": true,
            "statusCode": 200,
            "message": "Addresses retrieved successfully!",
            "data": {
                "docs": [
                    {
                        "candidate": {
                            "candidateId": "618e7f4b48fe5f0ee26d5667",
                            "firstName": "Famous",
                            "middleName": "Prior",
                            "lastName": "Ehichioya",
                            "photo": "https://youverify-api-bucket.nyc3.digitaloceanspaces.com/reports/live_photos/2021-11-12/photo_618e7f54be210c9056.jpg",
                            "email": "famous@youverify.co",
                            "mobile": "08030000000"
                        },
                        "address": {
                            "latlong": {
                                "lat": null,
                                "lon": null
                            },
                            "flatNumber": "1st floor",
                            "buildingName": "Sum house",
                            "buildingNumber": "350",
                            "subStreet": "Hughes avenue",
                            "street": "Borno way",
                            "landmark": "Police Station",
                            "state": "Lagos",
                            "city": "Yaba",
                            "country": "Nigeria",
                            "lga": "Lagos Mainland"
                        },
                        "referenceId": "618e7f5cb9c42",
                        "status": "pending",
                        "taskStatus": "PENDING",
                        "businessType": "admin",
                        "businessId": "615c2deb203b96532838418b",
                        "userId": "615c2deb203b96532838418c",
                        "type": "individual",
                        "createdAt": "2021-11-12T14:51:19.525Z",
                        "lastModifiedAt": "2021-11-12T14:51:19.525Z",
                        "_createdAt": "2021-11-12T15:51:1919+01:00",
                        "_lastModifiedAt": "2021-11-12T15:51:1919+01:00",
                        "verificationId": "618e7f5cb9c42",
                        "id": "618e7f6748fe5f0ee26d5668",
                        "user": {
                            "firstName": "Famous",
                            "lastName": "Ehichioya",
                            "middleName": "Prior",
                            "email": "test@gmail.com",
                            "mobile": "+2348036000000",
                            "countryCode": "NG",
                            "id": "615c2deb203b96532838418c"
                        }
                    }
                ],
                "pagination": {
                    "totalDocs": 11,
                    "perPage": 1,
                    "totalPages": 11,
                    "currentPage": 1,
                    "serialNo": 1,
                    "hasPrevPage": false,
                    "hasNextPage": true,
                    "prevPage": null,
                    "nextPage": 2
                }
            },
            "links": []
        }

Last updated 1 year ago

Was this helpful?

πŸ‡³πŸ‡¬