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
    • KYB Bulk Upload
    • 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
  • Credit Report
    • πŸ‡¬πŸ‡§UK Business Credit Report
  • 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

Request a Business Address Verification

This endpoint request business address verification

Last updated 1 year ago

Was this helpful?

Note: Before you create an address verification you must have created a candidate (the information of the person to be verified). If you missed how to create a candidate click .

Company Address Request

POST {{baseurl}}/v2/api/addresses/business/request

Headers

Name
Type
Description

token*

String

API secret token

Request Body

Name
Type
Description

candidateId*

String

candidate ID

subjectConsent*

Boolean

Candidate consent. Must be true

description

String

Description or any information for the agent

address*

Object

Candidate address object

flatNumber

String

Address flat number

buildingName

String

Address building name

buildingNumber*

String

Address building number

landmark*

String

Address landmark

street*

String

Address street

subStreet

String

Address sub street

state*

String

Address state

city*

String

Address city

lga

String

Address local government

business*

Object

Business object

name*

String

Business name

email*

String

Business email

mobile*

String

Business mobile

registrationNumber*

String

Business registrationNumber

metadata

Object

Metadata object. Any valid object can be passed here. It gets returned as is.

{
    "candidateId": "6184e3c081ee238921cb9e86",
    "description": "Verify the candidate and business",
    "business": {
        "name": "Youcheck Online Services Limited",
        "email": "support@youverify.co",
        "mobile": "08036xxxxxx",
        "registrationNumber": "123456789"
    },
    "address": {
        "flatNumber": "1st floor",
        "buildingName": "Sum house",
        "buildingNumber": "350",
        "landmark": "Police Station",
        "street": "Borno way",
        "subStreet": "Hughes avenue",
        "state": "Lagos",
        "city": "Yaba",
        "lga": "Lagos Mainland"
    },
    "subjectConsent": true,
    "metadata": {
        "requestId": "1209348756"
},
}
HTTP/1.1 201 CREATED
{
            "success": true,
            "statusCode": 201,
            "message": "Address requested successfully!",
            "data": {
                "candidate": {
                    "candidateId": "618e33dd0b96f3c4397332f1",
                    "firstName": "FAMOUS",
                    "middleName": "PRIOR",
                    "lastName": "EHICHIOYA",
                    "photo": null,
                    "email": null,
                    "mobile": "08036xxxxxx"
                },
                "business": {
                    "name": "Youcheck Online Services Limited",
                    "registrationNumber": "123456789",
                    "email": "support@youverify.co",
                    "mobile": "08036000000"
                },
                "agent": {
                    "firstName": null,
                    "middleName": null,
                    "lastName": null,
                    "signature": null,
                    "photo": null
                },
                "address": {
                    "latlong": {
                        "lat": "0",
                        "lon": "0"
                    },
                    "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": "61ba87d3b559f",
                "status": "pending",
                "taskStatus": "PENDING",
                "subjectConsent": "true",
                "startDate": null,
                "endDate": null,
                "submittedAt": null,
                "executionDate": null,
                "completedAt": null,
                "acceptedAt": null,
                "revalidationDate": null,
                "notes": [],
                "isFlagged": false,
                "agentSubmittedLongitude": null,
                "agentSubmittedLatitude": null,
                "reportGeolocationUrl": null,
                "mapAddressUrl": null,
                "submissionDistanceInMeters": null,
                "reasons": null,
                "signature": null,
                "images": [],
                "buildingType": null,
                "buildingColor": null,
                "gatePresent": null,
                "gateColor": null,
                "availabilityConfirmedBy": null,
                "closestLandmark": null,
                "additionalInfo": null,
                "reportAgentAccess": null,
                "incidentReport": null,
                "description": "Verify the candidate and business",
                "reportId": "reports_23e42a91-28b3-4a45-9b12-2ae12a28c124",
                "downloadUrl": null,
                "businessType": "organization",
                "businessId": "619b683ecb55a2a588f4b83c",
                "userId": "619b683ecb55a2a588f4b839",
                "type": "business",
                "createdAt": "2021-12-16T00:27:07.801Z",
                "lastModifiedAt": "2021-12-16T00:27:07.801Z",
                "_createdAt": "2021-12-16T01:27:077+01:00",
                "_lastModifiedAt": "2021-12-16T01:27:077+01:00",
                "verificationId": "61ba87d3b559f",
                "id": "61ba87dbf5e3a21724ad8219"
            },
            "links": []
        }
HTTP/1.1 402 Payment Required
  {
    "success": false,
    "statusCode": 402,
    "message": "Insufficient fund",
    "name": "PaymentRequiredError",
    "data": {}
}


HTTP/1.1 500 Internal Server Error
{
    "success": false,
    "statusCode": 500,
    "message": "Service unavailable",
    "name": "Error",
    "data": {}
}

HTTP/1.1 403 Forbidden
{
    "success": false,
    "statusCode": 403,
    "message": "Permission denied",
    "name": "UnauthorizedError",
    "data": {}
}

πŸ‡³πŸ‡¬
here